![]() |
nRF5 SDK for Thread and Zigbee v1.0.0
|
Choose documentation: | nRF5 SDK | S112 SoftDevice API | S132 SoftDevice API | S140 SoftDevice API | S212 SoftDevice API |
The Zigbee Command Line Interface Agent example demonstrates a Zigbee router (with the possibility of being a coordinator) that interacts with the user by employing the Command Line Interface. This CLI Agent is a tool can be used for several purposes, including:
The CLI can be accessed by using two interfaces:
The interfaces are completely independent one from another and can be used simultaneously or exclusively.
Both interfaces use the following speed and parity settings:
The CLI uses its own dedicated library. See the Zigbee CLI library for more details.
The Command Line Interface consists of several commands. See the zigbee_example_cli_agent_commands section for details.
The CLI example requires for the host PC to be able to connect to it. Some PC USB drivers can be needed.
The driver installation depends on the host operating system:
Operating System | Installation procedure |
---|---|
Windows XP or 7 | If the native USB CDC connectivity is used, you must manually install the nordic_cdc_acm.inf driver.The file that is located at <InstallFolder>\examples\usb_drivers |
Windows 8 and later | Hosts pick the correct usbser.sys driver file automatically. |
Most of modern Linux and MacOS | Hosts handle the driver installation automatically. |
The CLI application starts in the disconnected state and remains in this state until the appropriate commands are issued by the user. These commands can be issued by using a serial line connection with a terminal application like PuTTy.
You can find the source code and the makefiles in the following folder: <InstallFolder>\examples\zigbee\experimental\cli\cli_agent_router
To set up the example:
To test the CLI Agent example, you need two boards and a Zigbee Coordinator or a third board:
The board pings the other board with 30 bytes of payload data and prints the time passed between sending a request and receiving a reply.
For a full list of CLI commands, see zigbee_example_cli_reference.