zigpy-znp is a Python library implemention which adds support for common Texas Instruments ZNP (Zigbee Network Processors) based Zigbee radio module chips hardware to Zigpy, a Python Zigbee stack project.
The goal of this project is to add native support for Texas Instruments Z-Stack 3 based adapters/modules in Home Assistant's built-in ZHA (Zigbee Home Automation) integration component (via the zigpy library), allowing Home Assistant with such hardware to nativly support direct control of compatible Zigbee devices such as Philips HUE, GE, Osram Lightify, Xiaomi/Aqara, IKEA Tradfri, Samsung SmartThings, and many more.
This zigpy-znp library allows Zigpy to interact with Texas Instruments ZNP (Zigbee Network Processor) coordinator firmware via TI Z-Stack Monitor and Test(MT) APIs using an UART/serial interface. Radio module hardware compatible include but is possibly not limited to Texas Instruments CC13x2 and CC26x2R based chips flashed with Z-Stack 3.x coordinator firmware.
Disclaimer: This software library is provided "AS IS", without warranty of any kind. The zigpy-znp project is still under early development as WIP (work in progress), as such it is not fully working yet. Testing of this library is currently onky recommended to developers and advanced testers of bleeding edge software looking to assist with early alpha-testing in on non-production systems, just for test purposes.
USB-adapters, GPIO-modules, and development-boards hardware capable of running the TI Z-Stack versions 3.0 and above (i.e. CC13x2 and CC26x2) should in theory all be supported by the zigpy-znp library but testing by the developers is currently only done with the LAUNCHXL-CC26X2R1 (Texas Instruments official CC2652 chip based development board) running Z-Stack 3.30.00.03 with @Koenkk's config tweaks as as reference hardware for the project.
CC253x based hardware is not recommended by zigpy-znp developers as those chips might not be powerful enough to run the TI Z-Stack 3 coordinator firmware without performance related issues.
Note that you also have to flash the chip a custom Z-Stack 3.x coordinator firmware before you can use the hardware, read the firmware requirement section below.
- CC2531 USB stick hardware flashed with Z-Stack 3 coordinator firmware from the Zigbee2mqtt project
- CC2652R dev board hardware flashed with Z-Stack 3 coordinator firmware from the Zigbee2mqtt project
- CC2531 USB stick hardware flashed with Z-Stack 3 coordinator firmware from the Zigbee2mqtt project
- CC2530 + CC2591 USB stick hardware flashed with Z-Stack 3 coordinator firmware from the Zigbee2mqtt project
- CC2530 + CC2592 dev board hardware flashed with Z-Stack 3 coordinator firmware from the Zigbee2mqtt project
- CC2538 + CC2592 dev board hardware flashed with Z-Stack 3 coordinator firmware from the Zigbee2mqtt project
Z-Stack 3 firmware requirement is that they support Texas Instruments Z-Stack Monitor and Test(MT) APIs using an UART interface (serial communcation protocol), which they should do if they are flashed with Z-Stack 3.x "coordinator" firmware with config tweaks by @Koenkk (originally made for the Zigbee2mqtt project).
Texas Instruments CC13x2 and CC26x2 based adapters/boards already come with a bootloader so can be flashed over USB using the official "Flash Programmer v2" from Texas Instruments.
Again, using Texas Instruments CC253x based adapters/boards as a Z-Stack 3 coordinator is not recommended though they could potentially still be used for development porposes, (however note that Z-Stack 3 coordinator firmware should in theory perform better on CC2538 based adapters than on CC2530 or CC2531 based adapters). CC253x based adapters/boards does however not come with a bootloader so you will normally need special hardware equipment for flashing firmware them with using the "Flash Programmer v1" (not v2) from Texas Instruments and that device preparation process is best described by the Zigbee2mqtt project whos community develops the Z-Stack coordinator firmware that this zigpy-znp libary requires. The Zigbee2mqtt project also has intructions for several alternative metods on how to initially flash their special Z-Stack 3 coordinator firmware on a new CC253x as well as other Texas Instruments CC based USB adapters and development boards that does not have a bootloader. They also have a FAQ and knowledgebase that can be useful for working with these supported hardware adapters/equipment as well as with Zigbee devices.
- https://www.zigbee2mqtt.io/information/supported_adapters.html
- https://www.zigbee2mqtt.io/getting_started/what_do_i_need.html
- https://www.zigbee2mqtt.io/getting_started/flashing_the_cc2531.html
- https://www.zigbee2mqtt.io/information/alternative_flashing_methods.html
- To configure usb port path for your TI CC serial device, just specify the TTY (serial com) port, example :
/dev/ttyACM0
Developers should note that that Texas Instruments recommends different baud rates for UART interface of different TI CC chips.
- CC13x2 and CC26x2 supports flexible UART baud rate generation up to a maximum of 1.5 Mbps.
- CC2538 also supports flexible UART baud rate generation but only up to a maximum of 460800 baud.
- CC2530 and CC2531 default recommended UART baud rate is 115200 baud.
Tagged versions will also be released via PyPI
If you are looking to make a code or documentation contribution 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
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. A working implementation of zigpy exist in Home Assistant (Python based open source home automation software) as part of its ZHA component