Skip to content

schurgan/zigbee2mqtt-plugin

 
 

Repository files navigation

Zigbee2MQTT - Domoticz Python Plugin

Python plugin for Domoticz to add integration with zigbee2mqtt project

image

IMPORTANT! Upgrade notice

If you are upgrading from plugin version < 3.0 be aware that this version doesn't fully compatible with previous versions.

It is recommended to remove plugin instance from Domoticz Hardware before upgrade and create new instance afterwards, otherwise some duplicated devices might be created. In other case you will need to remove devices manually.

Prerequisites

Installation

You can use Plugins Manager for automatic installation or follow manual steps:

  1. Clone repository into your domoticz plugins folder
cd domoticz/plugins
git clone https://github.com/schurgan/zigbee2mqtt-plugin.git zigbee2mqtt
  1. Restart domoticz
  2. Make sure that "Accept new Hardware Devices" is enabled in Domoticz settings
  3. Go to "Hardware" page and add new item with type "Zigbee2MQTT"
  4. Set your MQTT server address and port to plugin settings

Once plugin receive device list from zigbee2mqtt server it will create appropriate domoticz devices. You will find these devices on Setup -> Devices page.

Plugin update

  1. Go to plugin folder and pull new version
cd domoticz/plugins/zigbee2mqtt
git pull
  1. Restart domoticz

Zigbee groups support

Plugin supports zigbee groups. It is impossible to automatically identify what device should represent the group (OnOff switch, dimmer, etc.), so plugin relies on suffixes in zigbee group name. Currently following suffixes are supported:

Suffix Device Type Example
_dimmer Dimmer Switch mygroup_dimmer
_ct Dimmer Switch with Color Temperature mygroup_ct
_rgb RGB Switch mygroup_rgb
_rgbw RGBW Switch mygroup_rgbw

if no suffix will be found then On/Off switch will be created by default

Supported zigbee devices

see the full list here

About

zigbee2mqtt plugin for domoticz

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 74.9%
  • JavaScript 14.5%
  • HTML 5.8%
  • CSS 4.8%