Package: zigpy-znp
zigpy-znpzigpy-znpis a Python library that adds support for commonTexas Instruments ZNP (Zigbee Network Processors)Zigbeeradio modules tozigpy, a Python Zigbee stack project.Together with zigpy and compatible home automation software (namely Home Assistant'sZHA (Zigbee Home Automation) integration component), you can directly control Zigbee devices such as Philips Hue, GE, OSRAM LIGHTIFY, Xiaomi/Aqara, IKEA Tradfri, Samsung SmartThings, and many more.InstallationPython moduleInstall the Python module within your virtual environment:$virtualenv-ppython3.8venv# if you don't already have one$sourcevenv/bin/activate(venv)$pipinstallgit+https://github.com/zigpy/zigpy-znp/# latest commit from Git(venv)$pipinstallzigpy-znp# or, latest stable from PyPIHome AssistantStable releases of zigpy-znp are automatically installed when you install the ZHA component.Testingdevwith Home Assistant CoreUpgrade the package within your virtual environment (requiresgit):(venv)$pipinstallgit+https://github.com/zigpy/zigpy-znp/Launch Home Assistant with the--skip-pipcommand line option to prevent zigpy-znp from being downgraded. Running with this option may prevent newly added integrations from installing required packages.Testingdevwith Home Assistant OSAddhttps://github.com/home-assistant/hassio-addons-developmentas an addon repository.Install the "Custom deps deployment" addon.Add the following to yourconfiguration.yamlfile:apk:[]pypi:-git+https://github.com/zigpy/zigpy-znp/ConfigurationBelow are the defaults with the top-level Home Assistantzha:key.You do not need to copy this configuration, it is provided only for reference:zha:zigpy_config:znp_config:# Only if your stick has a built-in power amplifier (i.e. CC1352P and CC2592)# If set, must be between:#  * CC1352/2652:  -22 and 19#  * CC253x:       -22 and 22tx_power:# Only if your stick has a controllable LED (the CC2531)# If set, must be one of: off, on, blink, flash, toggleled_mode:off### Internal configuration, there's no reason to touch these values# Skips the 60s bootloader delay on CC2531 sticksskip_bootloader:True# Timeout for synchronous requests' responsessreq_timeout:15# Timeout for asynchronous requests' callback responsesarsp_timeout:30# Delay between auto-reconnect attempts in case the device gets disconnectedauto_reconnect_retry_delay:5# Pin states for skipping the bootloaderconnect_rts_pin_states:[off,on,off]connect_dtr_pin_states:[off,off,off]ToolsVarious command line Zigbee utilities are a part of the zigpy-znp package and can be run
withpython -m zigpy_znp.tools.name_of_tool. More detailed documentation can be found
inTOOLS.mdbut a brief description of each tool is included below:energy_scan: Performs a continuous energy scan to check for non-Zigbee interference.flash_read: For CC2531s, reads firmware from flash.flash_write: For CC2531s, writes a firmware.binto flash.form_network: Forms a network with randomized settings on channel 15.network_backup: Backs up the network data and device information into a human-readable JSON document.network_restore: Restores a JSON network backup to the adapter.network_scan: Actively sends beacon requests for network stumbling.nvram_read: Reads all possible NVRAM entries into a JSON document.nvram_reset: Deletes all possible NVRAM entriesnvram_write: Writes all NVRAM entries from a JSON document.Hardware requirementsUSB-adapters, GPIO-modules, and development-boards flashed with TI's Z-Stack are compatible with zigpy-znp:CC2652P/CC2652R/CC2652RB USB stick and dev board hardwareCC1352P/CC1352R USB stick and dev board hardwareCC2538 + CC2592 USB stick and dev board hardware (not recommended, old hardware and end-of-life firmware)CC2531 USB stick hardware (not recommended for Zigbee networks with more than 20 devices)CC2530 + CC2591/CC2592 USB stick hardware (not recommended for Zigbee networks with more than 20 devices)Tip! Adapters listed as "Texas Instruments sticks compatible with Zigbee2MQTT" also works with zigpy-znp.Reference hardware for this projectThese specific adapters are used as reference hardware for development and testing by zigpy-znp developers:TI LAUNCHXL-CC26X2R1runningZ-Stack 3 firmware (based on version 4.40.00.44). You can flashCC2652R_20210120.hexusingTI's UNIFLASH.Electrolama zzh CC2652RandSlaesh CC2652Rsticks runningZ-Stack 3 firmware (based on version 4.40.00.44). You can flashCC2652R_20210120.hexorCC2652RB_20210120.hexrespectively usingcc2538-bsl.CC2531 runningZ-Stack Home 1.2. You can flashCC2531ZNP-Prod.binto your stick directly withzigpy_znp:python -m zigpy_znp.tools.flash_write -i /path/to/CC2531ZNP-Prod.bin /dev/serial/by-id/YOUR-CC2531if your stick already has a serial bootloader.Texas Instruments Chip Part NumbersTexas Instruments (TI) has quite a few different wireless MCU chips and they are all used/mentioned in open-source Zigbee world which can be daunting if you are just starting out. Here is a quick summary of part numbers and key features.Supported newer generation TI chips2.4GHz frequency only chipsCC2652R: 2.4GHz only wireless MCU for IEEE 802.15.4 multi-protocol (Zigbee, Bluetooth, Thread, IEEE 802.15.4g IPv6-enabled smart objects like 6LoWPAN, and proprietary systems). Cortex-M0 core for radio stack and Cortex-M4F core for application use, plenty of RAM. Free compiler option from TI.CC2652RB: Pin compatible "Crystal-less" CC2652R (so you could use it if you were to build your own zzh and omit the crystal) but not firmware compatible.CC2652P: CC2652R with a built-in RF PA. Not pin or firmware compatible with CC2652R/CC2652RB.Multi frequency chipsCC1352R: Sub 1 GHz & 2.4 GHz wireless MCU. Essentially CC2652R with an extra sub-1GHz radio.CC1352P: CC1352R with a built in RF PA.Supported older generation TI chipsCC2538: 2.4GHz Zigbee, 6LoWPAN, and IEEE 802.15.4 wireless MCU. ARM Cortex-M3 core with with 512kB Flash and 32kB RAM.CC2531: CC2530 with a built-in UART/TTL to USB Bridge. Used in the cheap "Zigbee sticks" sold everywhere. Intel 8051 core, 256 Flash, only has 8kB RAM.CC2530: 2.4GHz Zigbee and IEEE 802.15.4 wireless MCU. Intel 8051 core, 256 Flash, only has 8kB RAM.Auxiliary TI chipsCC2591 and CC2592: 2.4 GHz range extenders. These are not wireless MCUs, just auxiliary PA (Power Amplifier) and LNA (Low Noise Amplifier) in the same package to improve RF (Radio Frequency) range of any 2.4 GHz radio chip.Releases via PyPITagged versions will also be released via PyPIhttps://pypi.org/project/zigpy-znp/https://pypi.org/project/zigpy-znp/#historyhttps://pypi.org/project/zigpy-znp/#filesExternal documentation and referencehttp://www.ti.com/tool/LAUNCHXL-CC26X2R1http://www.ti.com/tool/LAUNCHXL-CC1352PHow to contributeIf 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.mdhttps://github.com/firstcontributions/first-contributions/blob/master/github-desktop-tutorial.mdRelated projectsZigpyzigpyisZigbee protocol stackintegration project to implement theZigbee Home Automationstandard as a Python 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 devices. There is currently support for controlling Zigbee device types such as binary sensors (e.g. motion and door sensors), analog sensors (e.g. temperature sensors), lightbulbs, switches, and fans. Zigpy is tightly integrated withHome Assistant'sZHA componentand provides a user-friendly interface for working with a Zigbee network.