zigpy-zigate 0.6.0

A library which communicates with ZiGate radios for zigpy

zigpy-zigate

WARNING: EXPERIMENTAL! This project is under development as WIP (work in progress). Developer’s work provided “AS IS”.

zigpy-zigate is a Python 3 implementation for the Zigpy project to implement ZiGate based Zigbee radio devices.

• https://github.com/zigpy/zigpy-zigate

ZiGate is a open source ZigBee adapter hardware that was initially launched on Kickstarter by @fairecasoimeme

• https://www.zigate.fr
• https://www.kickstarter.com/projects/1361563794/zigate-universal-zigbee-gateway-for-smarthome

Compatible hardware

The ZiGate USB adapter communicates via a PL-2303HX USB to Serial Bridge Controller module by Prolific. There's also a Wi-Fi adapter to communicate with ZiGate over network.

Note! ZiGate open source ZigBee adapter hardware requires ZiGate firmware 3.1a or later to work with this zigpy-zigate module.

Known working Zigbee radio modules

• ZiGate USB-TTL
• ZiGate USB-DIN
• PiZiGate (ZiGate module for Raspberry Pi GPIO)

Experimental Zigbee radio modules

• ZiGate Pack WiFi (work in progress)

Port configuration

• To configure usb ZiGate port, just specify the port, example : /dev/ttyUSB0
  • Alternatively you could set port to auto to enable automatic usb port discovery
• To configure pizigate port, prefix the port with pizigate:, example : pizigate:/dev/serial0
• To configure wifi ZiGate, specify IP address and port, example : socket://192.168.1.10:9999

Note! Requires ZiGate firmware 3.1a and later

• https://zigate.fr/tag/firmware/

Testing new releases

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

  where 0.5.1 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-zigate==0.5.1
  
  

Releases via PyPI

Tagged versions are also released via PyPI

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

Developer references

Documents that layout the serial protocol used for ZiGate serial interface communication can be found here:

• https://github.com/fairecasoimeme/ZiGate/tree/master/Protocol

How to contribute

If you are looking to make a 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

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

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

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