hmsniff: fix typo
[hmcfgusb] / README.md
CommitLineData
54b55f0f
MG
1This repository contains utilities to use the [HM-CFG-USB(2)][] (HomeMatic USB
2Konfigurations-Adapter) from [ELV][] on Linux/Unix by using [libusb 1.0][].
a3182fa5 3
54b55f0f
MG
4The HM-CFG-USB can be used to send and receive [BidCoS-Packets][] to control
5[HomeMatic][] home automation devices (like remote controllable sockets,
6switches, sensors, ...).
a3182fa5 7
54b55f0f
MG
8This repository contains, amongst others, an application, which emulates the
9HomeMatic LAN configuration adapter-protocol to make it possible to use the
10HM-CFG-USB in [Fhem][] or as a lan configuration tool for the CCU or the
11HomeMatic windows configuration software, also supporting devices using
12AES-signing like [KeyMatic][].
13
14[HM-CFG-USB(2)]: http://www.elv.de/homematic-usb-konfigurations-adapter-1.html
15[ELV]: http://www.elv.de/
16[libusb 1.0]: http://www.libusb.org/
17[BidCoS-Packets]: http://homegear.eu/index.php/BidCoS%C2%AE_Packets
18[HomeMatic]: http://www.homematic.com/
19[Fhem]: http://fhem.de/
20[KeyMatic]: http://www.elv.de/homematic-funk-tuerschlossantrieb-keymatic-silber-inkl-funk-handsender.html
a3182fa5
MG
21
22### Short hmland HowTo: ###
23
54b55f0f
MG
241. Install prerequisites:
25 `apt-get install libusb-1.0-0-dev build-essential git`
a3182fa5 262. Get the current version of this software (choose **one** option):
e052333d
MG
27 * Get the current *release*-version as a .tar.gz:
28 1. Download the latest version from the [releases-directory][].
29 Version 0.100 is used as an example for the following commands.
30 2. Extract the archive: `tar xzf hmcfgusb-0.100.tar.gz`
31 3. Change into the new directory: `cd hmcfgusb-0.100`
32 * Get the current *development*-version via git (can be easily updated with `git pull`):
a3182fa5
MG
33 1. `git clone git://git.zerfleddert.de/hmcfgusb`
34 2. Change into the new directory: `cd hmcfgusb`
e052333d 35 * Get the current *development*-version as an archive:
54b55f0f
MG
36 1. [hmcfgusb-HEAD-xxxxxxx.tar.gz][] (xxxxxxx is part of the commit-id.
37 xxxxxxx is just a placeholder for this HowTo, use your value)
a3182fa5
MG
38 2. Extract the archive: `tar xzf hmcfgusb-HEAD-xxxxxxx.tar.gz`
39 3. Change into the new directory: `cd hmcfgusb-HEAD-xxxxxxx`
403. Build the code: `make`
54b55f0f
MG
414. Optional: Install udev-rules so normal users can access the device:
42 `sudo cp hmcfgusb.rules /etc/udev/rules.d/`
a3182fa5 435. Plug in the HM-CFG-USB
54b55f0f
MG
446. Run hmland (with debugging the first time, see `-h` switch):
45 `./hmland -p 1234 -D`
a3182fa5
MG
467. Configure Fhem to use your new HMLAN device:
47 ``define hmusb HMLAN 127.0.0.1:1234``
48 ``attr hmusb hmId <hmId>``
49
e052333d
MG
50**Important compatibility information:**
51If older Fhem-versions (before 2015-06-19) or other software ([Homegear][],
52[LXCCU][], a real [CCU][], Windows configuration software, ...) is used
53to connect to hmland, the `-I` switch might be needed to impersonate a
54LAN-interface (this replaces the identity string HM-USB-IF with HM-LAN-IF).
55Software which needs this will not keep a stable connection open to
56hmland without this switch. It was the hardcoded default in versions
57< 0.100.
58
59This incompatibility is needed so connecting software is able to
60differentiate between HM-CFG-LAN and HM-CFG-USB.
61
62[releases-directory]: https://git.zerfleddert.de/hmcfgusb/releases/
54b55f0f 63[hmcfgusb-HEAD-xxxxxxx.tar.gz]: https://git.zerfleddert.de/cgi-bin/gitweb.cgi/hmcfgusb/snapshot/HEAD.tar.gz
e052333d
MG
64[Homegear]: https://www.homegear.eu/
65[LXCCU]: http://www.lxccu.com/
66[CCU]: http://www.elv.de/homematic-zentrale-ccu-2.html
54b55f0f 67
a3182fa5
MG
68### Updating the HM-CFG-USB firmware to version 0.967: ###
69
54b55f0f
MG
701. Compile the hmcfgusb utilities like in the hmland HowTo above
71 (steps 1 to 5) and stay in the directory
722. Download the new firmware: [hmusbif.03c7.enc][]:
73 `wget https://git.zerfleddert.de/hmcfgusb/firmware/hmusbif.03c7.enc`
a3182fa5 743. Make sure that hmland is not running
54b55f0f
MG
754. Flash the update to the USB-stick:
76 `./flash-hmcfgusb hmusbif.03c7.enc` (You might need to use `sudo` for this)
77
78[hmusbif.03c7.enc]: https://git.zerfleddert.de/hmcfgusb/firmware/hmusbif.03c7.enc
a3182fa5 79
13bb1a62 80### Updating HomemMatic devices over the air (OTA) (also for CUL devices): ###
a3182fa5 81
54b55f0f
MG
821. Compile the hmcfgusb utilities like in the hmland HowTo above
83 (steps 1 to 5) and stay in the directory
842. Download the new firmware from [eQ-3][], in this example the HM-CC-RT-DN
85 firmware version 1.4
a3182fa5
MG
863. Extract the tgz-file: `tar xvzf hm_cc_rt_dn_update_V1_4_001_141020.tgz`
874. Make sure that hmland is not running
13bb1a62
MG
88* When using the **[HM-CFG-USB(2)][]**, flash the new firmware to the device
89 with serial *KEQ0123456*:
a3182fa5 90 `./flash-ota -f hm_cc_rt_dn_update_V1_4_001_141020.eq3 -s KEQ0123456`
ae679348
MG
91* When using a **[culfw][]**-based device (**[CUL][]/[COC][]/...**), flash
92 the new firmware to the device with serial *KEQ0123456*:
a3182fa5 93 `./flash-ota -f hm_cc_rt_dn_update_V1_4_001_141020.eq3 -s KEQ0123456 -c /dev/ttyACM0`
54b55f0f
MG
94
95[eQ-3]: http://www.eq-3.de/downloads.html
ae679348
MG
96[culfw]: http://culfw.de/culfw.html
97[CUL]: http://busware.de/tiki-index.php?page=CUL
98[COC]: http://busware.de/tiki-index.php?page=COC
Impressum, Datenschutz