Zigbee for Domoticz plugin: Connect all your Zigbee devices to Domoticz

Zigbee for Domoticz

Zigbee for Domoticz a plugin for Domoticz home automation software to connect Zigbee devices through Zigbee coordinator (Zigbee controllers), like ZiGate, as well as Texas Instruments CC253x/CC13x2/CC26x2 Zigbee adapters/dongles/sticks/keys like zzh, as well as Silicon Labs Zigbee adapters/dongles/sticks/keys like elelabs

This plugin is an evolution of the mature Zigate plugin for Domoticz, which will continue to manage and handle Zigate in native mode, while Texas Instruments's will be handle through unified communication libraries from the zigpy project. Please acknowledge that we are not developping nor maintaining zigpy project, and we rely on the zigpy community for zigpy related issues. If you want to get more insight here are the list of open issue on zigpy related modules

For Windows users, please check the Plugin V6 running on Windows V6 running on Windows

Pre requisities

• Domoticz 2021.1 or above
• You need Python 3.7 at least
• Zigpy layers will requires additional python3 modules to be install:

Plugin first installation or first time on release 6.xxx (stable6)

1. Make sure the pre-requisites steps (here above) have been executed

2. Go in your Domoticz directory using a command line and open the plugins directory. Usually you should be under domoticz/plugins

3. Run: git clone https://github.com/zigbeefordomoticz/Domoticz-Zigbee.git It will create a folder 'Domoticz-Zigbee'

4. Go in the Zigbee for Domoticz folder ( Domoticz-Zigbee ). Usally you should be under domoticz/plugins/Domoticz-Zigbee

5. run: sudo pip3 install -r requirements.txt

6. run: git config --add submodule.recurse true

7. run: git submodule update --init --recursive Finally, make the plugin.py file executable chmod +x Domoticz-Zigbee/plugin.py

8. Restart Domoticz.

Plugin first time on release 6 (stable6 or beta6)

This is the case where you have move from the stable5 branch to stable6/beta6.

1. Make sure the pre-requisites steps (here above) have been executed

2. Go in the Zigbee for Domoticz folder ( Domoticz-Zigbee ). Usally you should be under domoticz/plugins/Domoticz-Zigbee

3. run: git config --add submodule.recurse true

4. run: git submodule update --init --recursive Finally, make the plugin.py file executable chmod +x Domoticz-Zigbee/plugin.py

5. run: sudo pip3 install -r requirements.txt

6. Restart Domoticz. (you need a FULL restart of Domotciz)

More information available here

Regular Plugin update (when already on stable6)

1. Go in the Zigbee for Domoticz plugin directory Usally you should be under domoticz/plugins/Domoticz-Zigbee

2. run: git pull --recurse-submodules

3. run: sudo pip3 install -r requirements.txt

4. Restart Domoticz or plugin.

Tested Hardware Zigbee adapters/dongles/sticks/keys

The plugin was originally developed for the Zigate Coordinators in close relationship with Zigate manufactuer.

Texas Instrument Zigbee Coordinators

Since late 2021 where we have started opening the plugin to further brands of Zigbee Coordinators and begun focusing on compatibility with the zzh from Electrolama, thanks to their sponsorship.

Any Texas Instruments CC2531, CC13x2, CC26x2 adapters based on the Zigbee Network Processors should be supported, more information could be found on zigpy-znp which provided the layer to interface with the coordinator.

You can also find a list of Texas Instruments supported adapters which also works with zigpy-znp and as such should also work with this plugin

Silicon Labs Zigbee Coordinators

A big thanks to Elelabs sponsorship and whom have help us to ensure full compatibility with their Zigbee Coordinator ELU013 and ELR023.

As for TI coordinator, we rely on zigpy-bellows for the Silicon Labs compatibility . A list of compatible hardware is available here

LIMITATIONS

• Please do consider that the current plugin is limited to create a maximum of 255 "Widgets" (Domoticz devices). This will still give you the possibility to integrate a large number of Zigbee devices , but not an unlimited number.

  • Note that as with all Zigbee hubs/gateways/bridges you will need to add several "Zigbee Router" devices in order to increase the size of your Zigbee network mesh to reach that maximum number of devices, as the Zigbee Coordinator adapter will only support a smaller number of direct connected devices. See documentation troubleshooting section for best practices.

• Currently there is a limitation with the non-ZiGate coordinator to have only 1 coordinator instance.

Documentation

Documentation are available on the Wiki

Support

Your first place to get support is via the Forums.

• English channel : https://www.domoticz.com/forum/viewforum.php?f=68
• French Channel : https://easydomoticz.com/forum/viewforum.php?f=28

About release channels

In order to provide stability and also provide more recent development, Zigbee for Domoticz plugin has the following channels

• beta6: Current developement branch adds ConBee/RaspBee (deconz) compatibility on top of ZiGate/TI/Silabs support in stable branch.

• stable6: default branch provides stable support for these types of Zigbee Coordinator adapters/dongles/sticks/modules:

  • ZiGate models known today,
  • Electrolama zzh/zoe models as well as other Texas Instruments CC26x2/CC13x2 based adapters with newer Z-Stack_3.x.0 firmware,
  • Elelabs/Popp models as well as other Silicon Labs EFR32MG1x/EFR32MG2x based adapters with newer EZSP v8 firmware.

• Not supported

  • stable5: Support ALL ZiGate models known today and requires Domoticz 2020.x at minima (not supported anymore)
  • beta: lastest version 6.0.15 - February 2022
  • stable: latest version 4.11. - Feb. 2021) deprecated
  • master: latest version 3.0. - Sept. 2018) deprecated

How to switch from one channel to the other

git pull --recurse-submodules git checkout stable6 // will move you to the stable6 channel

git checkout beta6 // will move you to the beta channel git pull --recurse-submodules

Donations

Donations are more than welcome and will be used to buy new hard, devices, sensors and in such testing and making them working with the Zigate plugin. Please feel free to use the current link :

• Donate via PayPal