cotugno/zigbee2mqtt
2
Fork 0
mirror of https://github.com/Koenkk/zigbee2mqtt.git synced 2024-11-16 02:18:31 -07:00
Code Issues Packages Projects Releases Wiki Activity
Zigbee 🐝 to MQTT bridge 🌉, get rid of your proprietary Zigbee bridges 🔨
19 Commits 7 Branches 104 Tags 184 MiB
JavaScript 67.5%
TypeScript 31.8%
Shell 0.6%
Dockerfile 0.1%
fb60982077
Go to file
Koen Kanters fb60982077 Refactor.
2018-04-08 15:00:36 +02:00
.gitignore Initial commit 2017-09-27 19:39:10 +03:00
index.js Refactor. 2018-04-08 15:00:36 +02:00
LICENSE Initial commit 2017-09-27 16:38:22 +03:00
npm-shrinkwrap.json Allow to set device and mqtt url with CLI arguments. 2018-04-08 14:46:20 +02:00
package.json Allow to set device and mqtt url with CLI arguments. 2018-04-08 14:46:20 +02:00
README.md updated readme 2018-01-01 11:37:03 +02:00

README.md

xiaomi-zb2mqtt

Xiaomi Zigbee to MQTT bridge using zigbee-shepherd.

This little script allows you to use Xiaomi Zigbee sensors and switches without Xiaomi's gateway. It bridges the events sent from the sensors to MQTT. You can integrate the cheap and nice Zigbee sensors and switches with whatever smart home infrastructure you are using.

To run the bridge

  • Install
$ git clone https://github.com/AndrewLinden/xiaomi-zb2mqtt.git  
$ cd xiaomi-zb2mqtt  
/xiaomi-zb2mqtt$ npm install

  • Configuration: for the moment you have to edit index.js and set your serial port and mqtt broker.

  • Run it

/xiaomi-zb2mqtt$ node index.js
  • To see whats happening behind the scenes run it with debug enabled:
/xiaomi-zb2mqtt$ DEBUG=* node index.js

Supports

  • WXKG01LM - Single, double, triple, quad and "more than five" click. Push and hold long click.
  • WXKG02LM - Left, right and both click
  • WSDCGQ11LM - Aqara Temperature Hudimity sensor with Temperature, Humidity and Pressure
  • RTCGQ11LM - Xiaomi Smart Home Aqara Human Body Sensor
  • MCCGQ11LM - Xiaomi Aqara Window Door Sensor

Notes

  • You need CC2531 USB stick flashed with CC2531ZNP-Pro-Secure_LinkKeyJoin.hex from here: https://github.com/mtornblad/zstack-1.2.2a.44539/tree/master/CC2531
  • Zigbee shepherd's pairing process can take quite a while (more than a minute).
  • When pairing WXKG01LM, after reset you need to toggle (short keypress) the reset button every couple of seconds to keep the switch from going to sleep until the pairing is complete.