zigpy 0.30.0

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.

Zigbee coordinator hardware from many different hardware manufacturers are supported via radio libraries which translate their proprietary communication protocol into a common API which is shared among all radio libraries for zigpy. If some Zigbee coordinator hardware for other manufacturers is not supported by yet zigpy it is possible for any independent developer to step-up and develop a new radio library for zigpy which translates its proprietary communication protocol into the common API that zigpy can understand.

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.

How to install and test, report bugs, or contribute to this project

For specific instructions on how-to install and test zigpy or contribute bug-reports and code to this project please see the guidelines in the CONTRIBUTING.md file:

• Guidelines in CONTRIBUTING.md

This CONTRIBUTING.md file will contain information about using zigpy, testing new releases, troubleshooting and bug-reporting as, as well as library + code instructions for developers and more.

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.

Compatible Zigbee coordinator hardware

Radio libraries for zigpy are separate projects with their own repositories and include bellows (for communicating with Silicon Labs EmberZNet based radios), zigpy-deconz (for communicating with deCONZ based radios from Dresden Elektronik), and zigpy-xbee (for communicating with XBee based Zigbee radios), zigpy-znp and zigpy-cc for communicating with newer and older Texas Instruments based radios that have Z-Stack 3.x.x or Z-Stack Home 1.2.x ZNP coordinator firmware respectively, and zigpy-zigate for communicating with ZiGate based radios.

Note! Zigbee 3.0 support or not in zigpy depends primarily on your Zigbee coordinator hardware and its firmware. Some Zigbee coordinator hardware support Zigbee 3.0 but might be shipped with an older firmware which does not, in which case may want to upgrade the firmware manually yourself. Some other Zigbee coordinator hardware may not support a firmware that is capable of Zigbee 3.0 at all but can still be fully functional and feature complete for your needs, (this is very common as many if not most Zigbee devices do not yet Zigbee 3.0 or are backwards-compable with a Zigbee profile that is support by your Zigbee coordinator hardware and its firmware). As a general rule, newer Zigbee coordinator hardware released can normally support Zigbee 3.0 firmware and it is up to its manufacturer to make such firmware available for them.

Known working Zigbee radio modules

• Silicon Labs EmberZNet based radios using the EZSP protocol (via the bellows library for zigpy)
  • ITEAD Sonoff ZBBridge WiFi-bridge (Note! This first have to be flashed with Tasmota firmware and EmberZNet firmware)
  • Elelabs Zigbee USB Adapter
  • Elelabs Zigbee Raspberry Pi Shield
  • Nortek GoControl QuickStick Combo Model HUSBZB-1 (Z-Wave & Zigbee USB Adapter)
  • Telegesis ETRX357USB (Note! First have to be flashed with other EmberZNet NCP firmware)
  • Telegesis ETRX357USB-LRS (Note! First have to be flashed with other EmberZNet NCP firmware)
  • Telegesis ETRX357USB-LRS+8M (Note! First have to be flashed with other EmberZNet NCP firmware)
• dresden elektronik deCONZ based radios (via the zigpy-deconz library for zigpy)
  • ConBee II (a.k.a. ConBee 2) USB adapter from dresden dlektronik
  • RaspBee II (a.k.a. RaspBee 2) GPIO radio adapter from dresden elektronik
  • ConBee USB radio adapter from dresden elektronik
  • RaspBee GPIO radio adapter from dresden elektronik
• Texas Instruments based radios with Z-Stack 3.x.x firmware (via the zigpy-znp library for zigpy)
  • CC2652P/CC2652R/CC2652RB USB stick and dev board hardware flashed with Z-Stack 3.x.x firmware
  • CC1352P/CC1352R USB stick and dev board hardware flashed with Z-Stack 3.x.x firmware
• Digi XBee Zigbee based radios (via the zigpy-xbee library for zigpy)
  • Digi XBee Series 3 (xbee3-24) modules
  • Digi XBee Series 2C (S2C) modules
  • Digi XBee Series 2 (S2) modules (Note! First have to be flashed with XBee Zigbee Coordinator API firmware via XCTU)
• ZiGate open source ZigBee adapter hardware (via the zigpy-zigate library for zigpy)
  • ZiGate USB-TTL (Note! Requires ZiGate firmware 3.1d or later)
  • ZiGate USB-DIN (Note! Requires ZiGate firmware 3.1d or later)
  • PiZiGate (ZiGate module for Raspberry Pi GPIO) (Note! Requires ZiGate firmware 3.1d or later)
  • ZiGate Pack WiFi (Note! Requires ZiGate firmware 3.1d or later)

Experimental support for additional Zigbee radio modules

• Texas Instruments with Z-Stack Home 1.2.x firmware (via the zigpy-cc library for zigpy)
  • CC2538 + CC2592 dev board hardware flashed with Z-Stack Home 1.2.x firmware
  • CC2531 USB stick hardware flashed with Z-Stack Home 1.2.x firmware
  • CC2530 + CC2591/CC2592 USB stick hardware flashed with Z-Stack Home 1.2.x firmware

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-deconz/
  • https://pypi.org/project/zigpy-cc/
  • https://pypi.org/project/zigpy-xbee/
  • https://pypi.org/project/zigpy-zigate/
  • https://pypi.org/project/zigpy-znp/

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.

ZHA integration component for Home Assistant

ZHA integration component for Home Assistant is a reference implementation of the zigpy library as integrated into the core of Home Assistant (a Python based open source home automation software). There are also other GUI and non-GUI projects for Home Assistant's ZHA components which builds on or depends on its features and functions to enhance or improve its user-experience, some of those are listed and linked below.

ZHA Custom

zha_custom is a custom component package for Home Assistant (with its ZHA component for zigpy integration) that acts as zigpy commands service wrapper, when installed it allows you to enter custom commands via to zigy to example change advanced configuration and settings that are not available in the UI.

ZHA Map

zha-map for Home Assistant's ZHA component can build a Zigbee network topology map.

ZHA Network Visualization Card

zha-network-visualization-card is a custom Lovelace element for Home Assistant which visualize the Zigbee network for the ZHA component.

ZHA Network Card

zha-network-card is a custom Lovelace card for Home Assistant that displays ZHA component Zigbee network and device information in Home Assistant

Zigzag

Zigzag is a custom card/panel for Home Assistant that displays a graphical layout of Zigbee devices and the connections between them. Zigzag can be installed as a panel or a custom card and relies on the data provided by the zha-map integration component.

ZHA Device Exporter

zha-device-exporter is a custom component for Home Assistant to allow the ZHA component to export lists of Zigbee devices.

ZHA Custom Radios

zha-custom-radios A now obsolete custom component package for Home Assistant (with its ZHA component for zigpy integration) that allows users to test out new zigpy radio libraries and hardware modules before they have officially been integrated into ZHA. This enables developers and testers to test new or updated zigpy radio modules without having to modify the Home Assistant source code.

Zigpy Deconz Parser

zigpy-deconz-parser allow you to parse Home Assistant's ZHA component debug log using zigpy-deconz library if you are using a deCONZ based adapter like ConBee or RaspBee.

ZigCoHTTP

ZigCoHTTP is a stand-alone python application project that creates a ZigBee network using zigpy and bellows. ZigBee devices joining this network can be controlled via a HTTP API. It was developed for a Raspberry Pi using a Matrix Creator Board but should also work with other computers with Silicon Labs Zigbee hardware, or with other Zigbee hardware if replace bellows with other radio library for zigpy.