Package: zigpy-zigate
zigpy-zigatezigpy-zigateis a Python 3 implementation for theZigpyproject to implementZiGatebasedZigbeeradio devices.https://github.com/zigpy/zigpy-zigateZiGate is a open source ZigBee adapter hardware that was initially launched on Kickstarter by @fairecasoimemehttps://www.zigate.frhttps://www.kickstarter.com/projects/1361563794/zigate-universal-zigbee-gateway-for-smarthomeHardware and firmware compatibilityThe 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 USB and GPIO adapter hardware requires ZiGate 3.1a firmware or later to work with this zigpy-zigate module, however ZiGate 3.1d firmware or later is recommended as it contains a specific bug-fix related to zigpy. See all available official ZiGate firmware releaseshere (link).Known working ZiGate compatible Zigbee radio modulesZiGate + USB / ZiGate USB-TTLZiGate + USB-DIN / ZiGate USB-DINPiZiGate + / PiZiGate (ZiGate HAT/Shield module for Raspberry Pi compatible GPIO header)Tip! PiZiGate are not limited to Raspberry Pi series as works with all computers with a Raspberry Pi compatible GPIO header.ZiGate Ethernet (ZiGate Ethernet serial-to-IP server)(Note! Requires thePiZiGate + radio module)Tip!ZiGate Ethernetcan as alternativly also be used viaESPHome serial bridge firmware for ESP32as an option.ZiGate + WiFi Pack / ZiGate WiFi Pack (ZiGate WiFi serial-to-IP server)Tip!ZiGate compatible WiFi modulecan also be used to convert radio board fromZiGate USB-TTLinto this "ZiGate WiFi Pack".Experimental ZiGate compatible Zigbee radio modulesOpen Lumi Gateway-DIY ZiGate WiFi bridge hacked from an Xiaomi Lumi Gateway with modded OpenWRT firmwarePort configurationTo configureusbZiGate (USB TTL or DIN) port, just specify the port, example :/dev/ttyUSB0Alternatively you could manually set port toautoto enable automatic usb port discoveryTo configurepizigateport, specify the port, example :/dev/serial0or/dev/ttyAMA0To configurewifiZiGate, manually specify IP address and port, example :socket://192.168.1.10:9999pizigatedoes require some additional adjustements on Raspberry Pi 3/Zero, and 4:Raspberry Pi 3 and Raspberry Pi Zero configuration adjustementsRaspberry Pi 4 configuration adjustementsFlasher (ZiGate Firmware Tool)zigpy-zigate has an integrated Python "flasher" tool to flash firmware updates on your ZiGate (NXP Jennic JN5168).Thanks to Sander Hoentjen (tjikkun) zigpy-zigate now has an integrated firmware flasher tool!tjikkun original zigate-flasher repoSee all available official ZiGate firmware releaseshere (link).Flasher Usageusage:python3-mzigpy_zigate.tools.flasher[-h]-p{/dev/ttyUSB0}[-wWRITE][-sSAVE][-u][-d][--gpio][--din]optionalarguments:-h,--helpshowthishelpmessageandexit-p{/dev/ttyUSB0},--serialport{/dev/ttyUSB0}Serialport,e.g./dev/ttyUSB0-wWRITE,--writeWRITEFirmwarebintoflashontothechip-sSAVE,--saveSAVEFiletosavethecurrentlyloadedfirmwareto-u,--upgradeDownloadandflashthelastestavailablefirmware-d,--debugSetlogleveltoDEBUG--gpioConfigureGPIOforPiZiGateflash--dinConfigureUSBforZiGateDINflashTesting new releasesTesting 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):Addhttps://github.com/home-assistant/hassio-addons-developmentas "add-on" repositoryInstall "Custom deps deployment" addonUpdate config like:pypi:
  - zigpy-zigate==0.5.1
apk: []where 0.5.1 is the new versionStart the addonIf you are instead using some custom python installation of Home Assistant then do this:Activate your python virtual envUpdate package withpippip install zigpy-zigate==0.5.1Releases via PyPITagged versions are also released via PyPIhttps://pypi.org/project/zigpy-zigate/https://pypi.org/project/zigpy-zigate/#historyhttps://pypi.org/project/zigpy-zigate/#filesDeveloper referencesDocuments that layout the serial protocol used for ZiGate serial interface communication can be found here:https://github.com/fairecasoimeme/ZiGate/tree/master/Protocolhttps://github.com/doudz/zigatehttps://github.com/Neonox31/zigatehttps://github.com/nouknouk/node-zigateHow to contributeIf 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.mdhttps://github.com/firstcontributions/first-contributions/blob/master/github-desktop-tutorial.mdSome 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 projectsZigpyZigpyisZigbee protocol stackintegration project to implement theZigbee Home Automationstandard 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 inHome Assistant(Python based open source home automation software) as part of itsZHA componentZHA Device HandlersZHA deviation handling in Home Assistant relies on the third-partyZHA Device Handlersproject. Zigbee devices that deviate from or do not fully conform to the standard specifications set by theZigbee Alliancemay require the development of customZHA 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 ofHub-connected Device Handlers for the SmartThings platformas well as that ofzigbee-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 AssistantZHA integration component for Home Assistantis a reference implementation of the zigpy library as integrated into the core ofHome 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 Radioszha-custom-radiosadds support for custom radio modules for zigpy to[Home Assistant's ZHA (Zigbee Home Automation) integration component]. This custom component for Home Assistant allows users to test out new modules for zigpy in Home Assistant's ZHA integration component before they are integrated into zigpy ZHA and also helps developers new zigpy radio modules without having to modify the Home Assistant's source code.ZHA Customzha_customis 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 Mapzha-mapfor Home Assistant's ZHA component can build a Zigbee network topology map.ZHA Network Visualization Cardzha-network-visualization-cardis a custom Lovelace element for Home Assistant which visualize the Zigbee network for the ZHA component.ZHA Network Cardzha-network-cardis a custom Lovelace card for Home Assistant that displays ZHA component Zigbee network and device information in Home AssistantZigzagZigzagis an custom card/panel forHome Assistantthat 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 thezha-mapintegration commponent.ZHA Device Exporterzha-device-exporteris a custom component for Home Assistant to allow the ZHA component to export lists of Zigbee devices.