zigbee2mqtt/README.md

40 lines
2.4 KiB
Markdown
Raw Normal View History

[![Travis](https://img.shields.io/travis/Koenkk/zigbee2mqtt.svg)](https://api.travis-ci.org/Koenkk/zigbee2mqtt.svg)
2018-04-26 12:15:13 -07:00
# zigbee2mqtt :bridge_at_night: :honeybee:
2018-04-20 15:10:20 -07:00
![Thumbs up or down?](header.png)
2018-06-04 04:18:31 -07:00
<img align="right" height="40px" src="https://user-images.githubusercontent.com/7738048/40915536-1993dd32-6805-11e8-9f22-4dfca52133c0.png">
2018-01-01 02:37:03 -07:00
2018-06-04 04:18:31 -07:00
Allows you to use your Zigbee devices **without** the vendors (Xiaomi/TRADFRI/Hue) bridge or gateway.
2017-09-27 09:39:10 -07:00
2018-06-04 04:18:31 -07:00
It bridges events and allows you to control your Zigbee devices via MQTT. In this way you can integrate your Zigbee devices with whatever smart home infrastructure you are using.
2018-04-18 09:48:35 -07:00
2018-06-04 04:18:31 -07:00
The [wiki](https://github.com/Koenkk/zigbee2mqtt/wiki) provides you all the information needed to get up and running!
## Integrations
Below you will find the most popular home automation integrations available for **zigbee2mqtt**.
<img align="left" height="100px" width="100px" src="https://user-images.githubusercontent.com/7738048/40914297-49e6e560-6800-11e8-8904-36cce896e5a8.png">
### [Home Assistant](https://www.home-assistant.io/)
- [Hassio](https://www.home-assistant.io/hassio/): Using [the official addon](https://github.com/danielwelch/hassio-zigbee2mqtt) from [danielwelch](https://github.com/danielwelch)
- Generic install or Hassbian: Using instructions [here](https://github.com/Koenkk/zigbee2mqtt/wiki/Running-the-bridge#2-installing)
---
## Architecture
2018-04-23 08:55:44 -07:00
![Architecture](architecture.png)
2018-06-04 04:18:31 -07:00
## Supported devices
See [Supported devices](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-devices) to check wether your device is supported. There is quite an extensive list including devices from vendors like Xiaomi, Ikea, Philips, OSRAM and more.
2017-09-27 09:39:10 -07:00
2018-06-04 04:18:31 -07:00
If it's not listed in [Supported devices](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-devices), support can be added (fairly) easy, see [How to support new devices](https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices).
## Support & help
If you need assistantce you can check [opened issues](https://github.com/Koenkk/zigbee2mqtt/issues). Feel free to help with Pull Requests when you were able to fix things or add new devices or just share the love on social media.
2017-09-27 09:39:10 -07:00
2018-06-04 04:18:31 -07:00
## Contributors
2018-04-09 11:46:12 -07:00
* [AndrewLinden](https://github.com/AndrewLinden)
* [oskarn97](https://github.com/oskarn97)
* [dgomes](https://github.com/dgomes)
2018-04-11 13:06:12 -07:00
* [Koenkk](https://github.com/Koenk)
* [kirovilya](https://github.com/kirovilya)