Zigbee CLI wrapper

Table of Contents

• Usage
  • Supported CLI commands
• Installing the wrapper

Zigbee CLI wrapper (zb_cli_wrapper) is a Python package for the nRF5 SDK for Zigbee that includes a wrapper for automating communication with the Zigbee CLI Agent example and improving the control of the Zigbee network.

It is a standalone package and can be used on both Windows and Linux machines.

---

Usage

The wrapper allows you to:

• Communicate with multiple boards that run Zigbee CLI example, send Zigbee commands, and parse responses.
• Connect to the board specified by SEGGER number, serial number or the COM port the board is connected to.

Supported CLI commands

Zigbee CLI Wrapper automates the communication with Zigbee CLI Agent example by wrapping the following CLI commands to Python functions and by parsing command responses:

• Network and device management:
  • Discovering devices
  • Requesting device addresses and endpoints
  • Binding devices
• Zigbee device control over network:
  • Reading attribute value and writing to attribute
  • Sending ping command
  • Sending ZCL command
• Zigbee CLI device control:
  • Setting role and channels to operate
  • Creating Zigbee network
  • Subscribing to cluster attributes
  • Collecting CLI responses and logs for individual parsing

---

Installing the wrapper

The Zigbee CLI wrapper package is available for download from the Zigbee CLI wrapper PyPI repository.

After downloading the package, check the example subfolder for an example application that uses the wrapper package.