Skip to content

zigpy/zigpy-cc

Repository files navigation

zigpy-cc

Build Status Coverage

zigpy-cc is a Python 3 implementation for the Zigpy project to implement support for CC2531/CC2530 and possible other Texas Instruments Zigbee radio modules flashed with custom Z-Stack coordinator firmware.

The goal of this project is to add native support for inexpensive CC2531 based USB sticks in Home Assistant ZHA integration via Zigpy to directly control compatible Zigbee HA (Home Automation) devices such as Philips HUE, GE, Osram Lightify, Xiaomi/Aqara, IKEA Tradfri, Samsung SmartThings, and many more.

zigpy-cc allows Zigpy to interact with Texas Instruments CC253x Zigbee Network Processor(ZNP) via TI Z-Stack Monitor and Test(MT) APIs using an UART interface.

The zigpy-cc library is a port of the zigbee-herdsman project (version 0.12.24) by the Zigbee2mqtt project by Koen Kanters (a.k.a. Koenkk GitHub) which in turn was originally forked from the zigbee-shepherd project by zigbeer. Therefore, if any improvements like support for new Zigbee devices that gets added in the Zigbee2MQTT project it could be possible to port those improvements and benifit much of that to the zigpy-cc library.

WARNING!!! - Work in progress

This project is under development as WIP (work in progress), it is not working yet.

TODO list:

  • uart communication
  • init coordinator
  • handling join requests
  • get node descriptor
  • get endpoint list
  • get endpoint info
  • bind
  • fix entities in Home Assistant
  • fix lint problems
  • add more tests
  • ...more coming?

Hardware requirement

The necessary hardware and equipment for flashing firmware and the device preparation process is best described by the Zigbee2mqtt project whos community develops the custom Z-Stack coordinator firmware that zigpy-cc requires. They have intructions for several alternative metods on how to initially flash their Z-Stack coordinator firmware on a new CC253x based adapter that does not have a bootloader. They also have a FAQ and knowledgebase that can be useful for working with the supported hardware adapters/equipment and Zigbee devices.

Releases via PyPI

Tagged versions will also be released via PyPI

External documentation and reference

  • TODO

How to contribute

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

Related projects

Zigpy

Zvigpy** 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 zigbe exist in Home Assistant (Python based open source home automation software) as part of its ZHA component

ZHA Device Handlers

ZHA deviation handling in Home Assistant relies on 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 Classics platform as well as that of Zigbee-Shepherd 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.

About

Texas Instruments Z-Stack ZNP handler for zigpy

Topics

Resources

License

GPL-3.0, Unknown licenses found

Licenses found

GPL-3.0
LICENSE
Unknown
COPYING

Stars

Watchers

Forks

Packages

No packages published

Contributors 6