| 1 | This repository contains utilities to use the [HM-CFG-USB(2)][] (HomeMatic USB |
| 2 | Konfigurations-Adapter) from [ELV][] on Linux/Unix by using [libusb 1.0][]. |
| 3 | |
| 4 | The HM-CFG-USB can be used to send and receive [BidCoS-Packets][] to control |
| 5 | [HomeMatic][] home automation devices (like remote controllable sockets, |
| 6 | switches, sensors, ...). |
| 7 | |
| 8 | This repository contains, amongst others, an application, which emulates the |
| 9 | HomeMatic LAN configuration adapter-protocol to make it possible to use the |
| 10 | HM-CFG-USB in [Fhem][] or as a lan configuration tool for the CCU or the |
| 11 | HomeMatic windows configuration software, also supporting devices using |
| 12 | AES-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 |
| 21 | |
| 22 | ### Short hmland HowTo: ### |
| 23 | |
| 24 | 1. Install prerequisites: |
| 25 | `apt-get install libusb-1.0-0-dev build-essential git` |
| 26 | 2. Get the current version of this software (choose **one** option): |
| 27 | * Get the current version via git (can be easily updated with `git pull`): |
| 28 | 1. `git clone git://git.zerfleddert.de/hmcfgusb` |
| 29 | 2. Change into the new directory: `cd hmcfgusb` |
| 30 | * Get the current version as an archive: |
| 31 | 1. [hmcfgusb-HEAD-xxxxxxx.tar.gz][] (xxxxxxx is part of the commit-id. |
| 32 | xxxxxxx is just a placeholder for this HowTo, use your value) |
| 33 | 2. Extract the archive: `tar xzf hmcfgusb-HEAD-xxxxxxx.tar.gz` |
| 34 | 3. Change into the new directory: `cd hmcfgusb-HEAD-xxxxxxx` |
| 35 | 3. Build the code: `make` |
| 36 | 4. Optional: Install udev-rules so normal users can access the device: |
| 37 | `sudo cp hmcfgusb.rules /etc/udev/rules.d/` |
| 38 | 5. Plug in the HM-CFG-USB |
| 39 | 6. Run hmland (with debugging the first time, see `-h` switch): |
| 40 | `./hmland -p 1234 -D` |
| 41 | 7. Configure Fhem to use your new HMLAN device: |
| 42 | ``define hmusb HMLAN 127.0.0.1:1234`` |
| 43 | ``attr hmusb hmId <hmId>`` |
| 44 | |
| 45 | [hmcfgusb-HEAD-xxxxxxx.tar.gz]: https://git.zerfleddert.de/cgi-bin/gitweb.cgi/hmcfgusb/snapshot/HEAD.tar.gz |
| 46 | |
| 47 | ### Updating the HM-CFG-USB firmware to version 0.967: ### |
| 48 | |
| 49 | 1. Compile the hmcfgusb utilities like in the hmland HowTo above |
| 50 | (steps 1 to 5) and stay in the directory |
| 51 | 2. Download the new firmware: [hmusbif.03c7.enc][]: |
| 52 | `wget https://git.zerfleddert.de/hmcfgusb/firmware/hmusbif.03c7.enc` |
| 53 | 3. Make sure that hmland is not running |
| 54 | 4. Flash the update to the USB-stick: |
| 55 | `./flash-hmcfgusb hmusbif.03c7.enc` (You might need to use `sudo` for this) |
| 56 | |
| 57 | [hmusbif.03c7.enc]: https://git.zerfleddert.de/hmcfgusb/firmware/hmusbif.03c7.enc |
| 58 | |
| 59 | ### Updating HomemMatic devices over the air (OTA) (also for CUL devices): ### |
| 60 | |
| 61 | 1. Compile the hmcfgusb utilities like in the hmland HowTo above |
| 62 | (steps 1 to 5) and stay in the directory |
| 63 | 2. Download the new firmware from [eQ-3][], in this example the HM-CC-RT-DN |
| 64 | firmware version 1.4 |
| 65 | 3. Extract the tgz-file: `tar xvzf hm_cc_rt_dn_update_V1_4_001_141020.tgz` |
| 66 | 4. Make sure that hmland is not running |
| 67 | * When using the **[HM-CFG-USB(2)][]**, flash the new firmware to the device |
| 68 | with serial *KEQ0123456*: |
| 69 | `./flash-ota -f hm_cc_rt_dn_update_V1_4_001_141020.eq3 -s KEQ0123456` |
| 70 | * When using a **[culfw][]**-based device (**[CUL][]/[COC][]/...**), flash |
| 71 | the new firmware to the device with serial *KEQ0123456*: |
| 72 | `./flash-ota -f hm_cc_rt_dn_update_V1_4_001_141020.eq3 -s KEQ0123456 -c /dev/ttyACM0` |
| 73 | |
| 74 | [eQ-3]: http://www.eq-3.de/downloads.html |
| 75 | [culfw]: http://culfw.de/culfw.html |
| 76 | [CUL]: http://busware.de/tiki-index.php?page=CUL |
| 77 | [COC]: http://busware.de/tiki-index.php?page=COC |