zigpy-cc 0.4.1

A library which communicates with Texas Instruments CC2531 radios for zigpy

zigpy-cc

zigpy-cc is a Python 3 library implemention to add support for Texas Instruments CC series of Zigbee radio module chips hardware to the zigpy project. Including but possibly not limited to Texas Instruments CC253x, CC26x2R, and CC13x2 chips flashed with a custom Z-Stack coordinator firmware.

The goal of this project is to add native support for inexpensive Texas Instruments CC chip based USB sticks 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.

• https://www.home-assistant.io/integrations/zha/

zigpy-cc 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.

The zigpy-cc library itself 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

Disclaimer: This software is provided "AS IS", without warranty of any kind. The zigpy-cc project is under development as WIP (work in progress), it is not fully 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?

Testing new releases

Testing a new release of the zigpy-cc 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-cc==0.2.3
  apk: []
  

  where 0.2.3 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-cc==0.2.3
  

Hardware requirement

The zigpy-cc library is currently being tested by developers with Texas Instruments CC2531 and CC2652R based adapters as as reference hardware but it should in theory be possible to get it working with work most USB-adapters and GPIO-modules based on Texas Instruments CC Zigbee radio module chips hardware. Note that you also have to flash the chip a custom Z-Stack coordinator firmware before you can use the hardware, read the firmware requirement section below.

Hardware being tested by zigpy-cc developers

• CC2531 USB stick 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

Hardware not yet tested by zigpy-cc developers

• 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
• 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

Firmware requirement

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 custom Z-Stack "coordinator" firmware for Zigbee 1.2 or Zigbee 3.0 from the Zigbee2mqtt project.

• https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator

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 this zigpy-cc libary requires.

The Zigbee2mqtt project has intructions for several alternative metods on how to initially flash their special Z-Stack coordinator firmware on a new CC253x, CC26x2R, CC13x2, CC2538 or other Texas Instruments CCxxxx 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

Port configuration

• To configure usb port path for your TI CC serial device, just specify the TTY (serial com) port, example : /dev/ttyACM0
  • Alternatively you could try to set just port to auto to enable automatic usb port discovery (not garanteed to work).
• Texas Instruments default recommend Baud rate of CC253x serial device is 115200 (this could be different for other TI CC chips).

Releases via PyPI

Tagged versions will also be released via PyPI

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

External documentation and reference

• http://www.ti.com/tool/LAUNCHXL-CC26X2R1
• http://www.ti.com/tool/LAUNCHXL-CC1352P

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:

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

Related projects

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. 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 Zigbee-Herdsman Converters / Zigbee-Shepherd Converters as used by Zigbee2mqtt as well as that of Hub-connected Device Handlers for the SmartThings Classics platform, 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 Map

Home Assistant can build ZHA network topology map using the zha-map project.

zha-network-visualization-card

zha-network-visualization-card is a custom Lovelace element for visualizing the ZHA Zigbee network in Home Assistant.

ZHA Network Card

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