zigpy 0.20.2

Library implementing a ZigBee stack

zigpy

zigpy is Zigbee protocol stack integration project to implement the Zigbee Home Automation standard as a Python 3 library.

Zigbee Home Automation integration with zigpy allows you to connect one of many off-the-shelf Zigbee adapters using one of the available Zigbee radio library modules compatible with zigpy to control Zigbee based devices. There is currently support for controlling Zigbee device types such as binary sensors (e.g., motion and door sensors), sensors (e.g., temperature sensors), lightbulbs, switches, and fans.

zigpy contains common code implementing Zigbee ZCL, ZDO and application state management which is being used by various radio libraries implementing the actual interface with the radio modules from different manufacturers. The separate radio libraries interface with radio hardware adapters/modules over USB and GPIO using different native UART serial protocols.

Reference implementation of the zigpy library exist in Home Assistant (Python based open source home automation software) as part of its ZHA integration component.

Compatible hardware

Radio libraries for zigpy include bellows (which communicates with EZSP/EmberZNet based radios), zigpy-xbee (which communicates with XBee based Zigbee radios), and as zigpy-deconz for deCONZ serial protocol (for communicating with ConBee and RaspBee USB and GPIO radios from Dresden-Elektronik). There are also experimental radio libraries called zigpy-zigate for communicating with ZiGate based radios and zigpy-cc for communicating with Texas Instruments based radios based radios that have custom Z-Stack coordinator firmware.

Known working Zigbee radio modules

• EmberZNet based radios using the EZSP protocol (via the bellows library for zigpy)
  • Nortek GoControl QuickStick Combo Model HUSBZB-1 (Z-Wave & Zigbee USB Adapter)
  • Elelabs Zigbee USB Adapter
  • Elelabs Zigbee Raspberry Pi Shield
  • Telegesis ETRX357USB (Note! First have to be flashed with other EmberZNet firmware)
  • Telegesis ETRX357USB-LRS (Note! First have to be flashed with other EmberZNet firmware)
  • Telegesis ETRX357USB-LRS+8M (Note! First have to be flashed with other EmberZNet firmware)
• XBee Zigbee based radios (via the zigpy-xbee library for zigpy)
  • Digi XBee Series 2C (S2C) modules
  • Digi XBee Series 2 (S2) modules. Note: These will need to be manually flashed with the Zigbee Coordinator API firmware via XCTU.
  • Digi XBee Series 3 (xbee3-24) modules
• deCONZ based radios (via the zigpy-deconz library for zigpy)
  • ConBee II (a.k.a. ConBee 2) USB adapter from Dresden-Elektronik
  • ConBee USB radio adapter from Dresden-Elektronik
  • RaspBee GPIO radio adapter from Dresden-Elektronik

Experimental support for additional Zigbee radio modules

• ZiGate open source ZigBee adapter hardware (via the zigpy-zigate library for zigpy)
  • ZiGate USB-TTL (Note! Requires ZiGate firmware 3.1a or later)
  • ZiGate USB-DIN (Note! Requires ZiGate firmware 3.1a or later)
  • PiZiGate (ZiGate module for Raspberry Pi GPIO) (Note! Requires ZiGate firmware 3.1a or later)
  • ZiGate Pack WiFi (Note! Requires ZiGate firmware 3.1a or later)
• Texas Instruments CC253x, CC26x2R, and CC13x2 based radios (via the zigpy-cc library for zigpy)
  • CC2531 USB stick hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project
  • CC2530 + CC2591 USB stick hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project
  • CC2530 + CC2592 dev board hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project
  • CC2652R dev board hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project
  • CC1352P-2 dev board hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project
  • CC2538 + CC2592 dev board hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project

Testing new releases

Testing a new release of the zigpy library before it is released in Home Assistant.

If you are using Supervised Home Assistant (formerly known as the Hassio/Hass.io distro):

• Add https://github.com/home-assistant/hassio-addons-development as "add-on" repository
• Install "Custom deps deployment" addon
• Update config like:

  pypi:
    - zigpy==0.20.0
  apk: []
  

  where 0.20.0 is the new version
• Start the addon

If you are instead using some custom python installation of Home Assistant then do this:

• Activate your python virtual env
• Update package with pip

  pip install zigpy==0.20.0
  
  

Troubleshooting

For troubleshooting with Home Assistant, the general recommendation is to first only enable DEBUG logging for homeassistant.core and homeassistant.components.zha in Home Assistant, then look in the home-assistant.log file and try to get the Home Assistant community to exhausted their combined troubleshooting knowledge of the ZHA component before posting issue directly to a radio library, like example zigpy-deconz or zigpy-xbee.

That is, begin with checking debug logs for Home Assistant core and the ZHA component first, (troubleshooting/debugging from the top down instead of from the bottom up), trying to getting help via Home Assistant community forum before moving on to posting debug logs to zigpy and radio libraries. This is a general suggestion to help filter away common problems and not flood the zigpy-cc developer(s) with too many logs.

Please also try the very latest versions of zigpy and the radio library, (see the section above about "Testing new releases"), and only if you still have the same issues with the latest versions then enable debug logging for zigpy and the radio libraries in Home Assistant in addition to core and zha. Once enabled debug logging for all those libraries in Home Assistant you should try to reproduce the problem and then raise an issue to the zigpy repo (or to a specific radio library) repo with a copy of those logs.

To enable debugging in Home Assistant to get debug logs, either update logger configuration section in configuration.yaml or call logger.set_default_level service with {"level": "debug"} data. Check logger component configuration where you want something this in your configuration.yaml

logger: default: info logs: asyncio: debug homeassistant.core: debug homeassistant.components.zha: debug zigpy: debug bellows: debug zigpy_xbee: debug zigpy_deconz: debug zigpy_zigate: debug zigpy_cc: debug

Release packages available via PyPI

New packages of tagged versions are also released via the "zigpy" project on PyPI

• https://pypi.org/project/zigpy/
  • https://pypi.org/project/zigpy/#history
  • https://pypi.org/project/zigpy/#files

Older packages of tagged versions are still available on the "zigpy-homeassistant" project on PyPI

• https://pypi.org/project/zigpy-homeassistant/

Packages of tagged versions of the radio libraries are released via separate projects on PyPI

• https://pypi.org/project/zigpy/
  • https://pypi.org/project/bellows/
  • https://pypi.org/project/zigpy-xbee/
  • https://pypi.org/project/zigpy-deconz/
  • https://pypi.org/project/zigpy-zigate/
  • https://pypi.org/project/zigpy-cc/

How to contribute

You can contribute to this project either as an end-user, a tester (advanced user contributing constructive issue/bug-reports) or as a developer contributing code.

How to contribute as an end-user

If you think that you are having problems due to a bug then please see the section below on reporting issues as a tester, but be aware that reporting issues put higher responsibility on your active involvement on your part as a tester.

Some developers might be also interested in receiving donations in the form of money or hardware such as Zigbee modules and devices, and even if such donations are most often donated with no strings attached it could in many cases help the developers motivation and indirectly improve the development of this project.

Sometimes it might just be simpler to just donate money earmarked to specifically let a willing developer buy the exact same type Zigbee device that you are having issues with to be able to replicate the issue themselves in order to troubleshoot and hopefully also solve the problem.

Consider submitting a post on GitHub projects issues tracker about willingness to making a donation (please see section below on posing issues).

How to report issues or bugs as a tester

Issues or bugs are normally first to be submitted upstream to the software/project that it utilizing zigpy and its radio libraries, (like for example Home Assistant), however if and when the issue is determined to be in the zigpy or underlying radio library then you should continue by submitting a detailed issue/bug report via the GitHub projects issues tracker.

Always be sure to first check if there is not already an existing issue posted with the same description before posting a new issue.

• https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue
  • https://guides.github.com/features/issues/

How to contribute as a developer

If you are looking to make a contribution as a developer to this project we suggest that you follow the steps in these guides:

• https://github.com/firstcontributions/first-contributions/blob/master/README.md
  • https://github.com/firstcontributions/first-contributions/blob/master/github-desktop-tutorial.md

Code changes or additions can then be submitted to this project on GitHub via pull requests:

• https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
  • https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request

Developer references

Silicon Labs video playlist of ZigBee Concepts: Architecture basics, MAC/PHY, node types, and application profiles

• https://www.youtube.com/playlist?list=PL-awFRrdECXvAs1mN2t2xaI0_bQRh2AqD

Related projects

ZHA Device Handlers

ZHA deviation handling in Home Assistant relies on the third-party ZHA Device Handlers project. Zigbee devices that deviate from or do not fully conform to the standard specifications set by the Zigbee Alliance may require the development of custom ZHA Device Handlers (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA component in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from non-compliant Zigbee devices. The custom quirks implementations for zigpy implemented as ZHA Device Handlers for Home Assistant are a similar concept to that of Hub-connected Device Handlers for the SmartThings platform as well as that of zigbee-herdsman converters as used by Zigbee2mqtt, meaning they are each virtual representations of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms.