Zigbee shell

The Zigbee shell library implements a set of Zigbee shell commands that allow you to control the device behavior and perform operations in the Zigbee network, such as steering the network, discovering devices, and reading the network properties. Enabling a device to work with these commands simplifies testing and debugging of an existing network and reduces the amount of reprogramming operations.

Adding support for Zigbee shell commands

The Zigbee shell commands are implemented using Zephyr’s Shell interface. By default, it uses the UART backend. To change this and other Zephyr’s shell settings (for example, the prompt or the maximum amount of accepted command arguments), check the documentation page in Zephyr.

Zigbee shell command support can be added to any Zigbee sample. Some of the commands use an endpoint to send packets from, so no endpoint handler is allowed to be registered for this endpoint.

To extend a sample with the Zigbee shell command support, set the following KConfig options:

Running Zigbee shell commands

Zigbee shell commands are available for the following backends when testing samples:

  • UART

  • Segger RTT

You can run the Zigbee shell commands after connecting and configuring the backend for testing. For more information, see Testing a sample application.

Zigbee shell command list

This section lists commands that are supported by Zigbee samples.

Description convention

Every command prints Done when it is finished, or Error: <reason> in case of errors.

The command argument description uses the following convention:

  • command [arg] - square brackets mean that an argument is optional.

  • command <d:arg1> <h:arg2> - a single letter before an argument name defines the format of the argument:

    • h stands for hexadecimal strings.

    • d stands for decimal values.

  • command <arg> ... - the ellipsis after an argument means that the preceding argument can be repeated several times.

bdb role

Set or get the Zigbee role of a device.

bdb role [<role>]

Note

Setting only before bdb start. Reading only after bdb start.

If the optional argument is not provided, get the state of the device. Returns the following values:

  • zc if it is a coordinator.

  • zr it it is a router.

  • zed if it is an end device.

If the optional argument is provided, set the device role to role. Can be either zc or zr.

Note

Zigbee End Device is not currently supported by the CLI sample.

bdb extpanid

Set or get the Zigbee Extended Pan ID value.

bdb extpanid [<h:id>]

Note

Setting only before bdb start. Reading only after bdb start.

If the optional argument is not provided, gets the extended PAN ID of the joined network.

If the optional argument is provided, gets the extended PAN ID to id.

bdb panid

Set or get the Zigbee PAN ID value.

bdb panid [<h:id>]

Note

Setting only before bdb start. Reading only after bdb start.

If the optional argument is not provided, gets the PAN ID of the joined network. If the optional argument is provided, sets the PAN ID to id.

bdb start

Start the commissioning process.

> bdb start
Started coordinator
Done

bdb channel

Set or get the 802.15.4 channel.

bdb channel <n>

Note

Setting only before bdb start.

If the optional argument is not provided, get the current number and bitmask of the channel.

If the optional argument is provided:

  • If n is in [11:26] range, set to that channel.

  • Otherwise, treat n as bitmask (logical or of a single bit shifted by channel number).

Example:

> bdb channel 0x110000
Setting channel bitmask to 110000
Done

bdb ic

Set install code on the device, add information about the install code on the trust center, set the trust center install code policy.

bdb ic add <h:install code> <h:eui64>
bdb ic set <h:install code>
bdb ic policy <enable|disable>

Note

Setting and defining policy only before bdb start. Adding only after bdb start.

  • bdb ic set must only be used on a joining device.

  • bdb ic add must only be used on a coordinator. For <h:eui64>, use the address of the joining device.

  • bdb ic policy must only be used on a coordinator.

Provide the install code as an ASCII-encoded HEX file that includes CRC16/X-25 in little-endian order.

For production devices, an install code must be installed by the production configuration present in flash.

Example:

> bdb ic add 83FED3407A939723A5C639B26916D505C3B5 0B010E2F79E9DBFA
Done

bdb legacy

Enable or disable the legacy device support.

bdb legacy <enable|disable>

Allow or disallow legacy pre-r21 devices on the Zigbee network.

Example:

> bdb legacy enable
Done

bdb nwkkey

Set network key.

bdb nwkkey <h:key>>

Set a pre-defined network key instead of a random one.

Note

Setting only before bdb start.

Example:

> bdb nwkkey 00112233445566778899aabbccddeeff
Done

bdb factory_reset

Perform a factory reset via local action. See Base Device Behavior specification chapter 9.5 for details.

> bdb factory_reset
Done

bdb child_max

Set the amount of child devices that is equal to <d:nbr>.

> bdb child_max <d:nbr>

Note

Setting only before bdb start.

Example:

> bdb child_max 16
Setting max children to: 16
Done

zdo simple_desc_req

Send Simple Descriptor Request.

zdo simple_desc_req <h:16-bit destination address> <d:endpoint>

Send Simple Descriptor Request to the given node and endpoint.

Example:

> zdo simple_desc_req 0xefba 10
src_addr=0xEFBA ep=0x260 profile_id=0x0102 app_dev_id=0x0 app_dev_ver=0x5
in_clusters=0x0000,0x0003,0x0004,0x0005,0x0006,0x0008,0x0300 out_clusters=0x0300
Done

zdo active_ep

Send Active Endpoint Request.

zdo active_ep <h:16-bit destination address> *

Send Active Endpoint Request to the node addressed by the short address.

Example:

> zdo active_ep 0xb4fc
> src_addr=B4FC ep=10,11,12
Done

zdo match_desc

Send match descriptor request.

zdo match_desc <h:16-bit destination address>
               <h:requested address/type> <h:profile ID>
               <d:number of input clusters> [<h:input cluster IDs> ...]
               <d:number of output clusters> [<h:output cluster IDs> ...]

Send Match Descriptor Request to the dst_addr node that is a query about the req_addr node of the prof_id profile ID, which must have at least one of n_input_clusters``(whose IDs are listed in ``{...}) or n_output_clusters (whose IDs are listed in {...}). The IDs can be either decimal values or hexadecimal strings.

Example:

match_desc 0xfffd 0xfffd 0x0104 1 6 0

In this example, the command sends a Match Descriptor Request to all non-sleeping nodes regarding all non-sleeping nodes that have 1 input cluster ON/OFF (ID 6) and 0 output clusters.

zdo bind on

Create a binding between two endpoints on two nodes.

zdo bind on <h:source eui64> <d:source ep> <h:destination addr>
            <d:destination ep> <h:source cluster id> <h:request dst addr>

Create bound connection between a device identified by source eui64 and endpoint source ep, and a device identified by destination addr and endpoint destination ep. The connection is created for ZCL commands and attributes assigned to the ZCL cluster source cluster id on the request dst addr node (usually short address corresponding to source eui64 argument).

Example:

zdo bind on 0B010E0405060708 1 0B010E4050607080 2 8

zdo bind off

Remove a binding between two endpoints on two nodes.

zdo bind off <h:source eui64> <d:source ep> <h:destination eui64>
             <d:destination ep> <h:source cluster id> <h:request dst addr>

Remove bound connection between a device identified by source eui64 and endpoint source ep, and a device identified by destination eui64 and endpoint destination ep. The connection is removed for ZCL commands and attributes assigned to the ZCL cluster source cluster id on the request dst addr node (usually, the same address as for the source eui64 device).

zdo mgmt_bind

Read the binding table from a node.

zdo mgmt_bind <h:16-bit dst_addr> [d:start_index]

Send a request to the remote device identified by dst_addr to read the binding table through zdo mgmt_bind_req (see spec. 2.4.3.3.4). If the whole binding table does not fit into a single mgmt_bind_resp frame, the request initiates a series of mgmt_bind_req requests to perform the full download of the binding table. start_index is the index of the first entry in the binding table where the reading starts. It is zero by default.

Example:

zdo mgmt_bind 0x1234

This command sends mgmt_bind_req to the device with short address 0x1234, asking it to return its binding table.

Sample output:

[idx] src_address      src_endp cluster_id dst_addr_mode dst_addr         dst_endp
[  0] 0b010ef8872c633e       10     0x0402             3 0b010e21591eef3e       64
[  1] 0b010ef8872c633e       10     0x0403             3 0b010e21591eef3e       64
Total entries for the binding table: 2
Done

zdo mgmt_lqi

Send a ZDO Mgmt_Lqi_Req command to a remote device.

zdo mgmt_lqi <h:short> [d:start index]

Example:

zdo mgmt_lqi 0x1234

This command sends mgmt_lqi_req to the device with short address 0x1234, asking it to return its neighbor table.

zdo nwk_addr

Resolve the EUI64 address to a short network address.

zdo nwk_addr <h:eui64>

Example:

zdo nwk_addr 0B010E0405060708

zdo ieee_addr

Resolve the EUI64 address by sending the IEEE address request.

zdo ieee_addr <h:short_addr>

zdo eui64

Get the EUI64 address of the Zigbee device.

> zdo eui64
0b010eaafd745dfa
Done

zdo short

Get the short 16-bit address of the Zigbee device.

> zdo short
0000
Done

zdo mgmt_leave

Send a request to a remote device to leave the network through zdo mgmt_leave_req (see the specification section 2.4.3.3.5).

zdo mgmt_leave <h:16-bit dst_addr> [h:device_address eui64] [--children] [--rejoin]

Send mgmt_leave_req to a remote node specified by dst_addr. If device_address is omitted or it has value 0000000000000000, the remote device at address dst_addr will remove itself from the network. If device_address has other value, it must be a long address corresponding to dst_addr or a long address of child node of dst_addr. The request is sent with Remove Children and Rejoin flags set to 0 by default. Use options \--children or \--rejoin to change the respective flags to 1. For more details, see the section 2.4.3.3.5 of the specification.

Examples:

zdo mgmt_leave 0x1234

This command sends mgmt_leave_req to the device with the short address 0x1234, asking it to remove itself from the network.

zdo mgmt_leave 0x1234 --rejoin

This command sends mgmt_leave_req to the device with the short address 0x1234, asking it to remove itself from the network and perform rejoin.

zdo mgmt_leave 0x1234 0b010ef8872c633e

This command sends mgmt_leave_req to the device with the short address 0x1234, asking it to remove device 0b010ef8872c633e from the network. If the target device with the short address 0x1234 also has a long address 0b010ef8872c633e, it will remove itself from the network. If the target device with the short address 0x1234 has a child with long address 0b010ef8872c633e, it will remove the child from the network.

zdo mgmt_leave 0x1234 --children

This command sends mgmt_leave_req to the device with the short address 0x1234, asking it to remove itself and all its children from the network.

version

Print the firmware version.

version

Example:

> version
CLI: Sep  3 2020 13:34:28
ZBOSS: 3.3.0.2
Zephyr kernel version: 2.3.99
Done

debug

Enable or disable the debug mode in the CLI.

debug <on|off>

This command unblocks several additional commands in the CLI.

Warning

When used, the additional commands can render the device unstable.

zscheduler suspend

Suspend Zigbee scheduler processing.

zscheduler suspend

zscheduler resume

Resume Zigbee scheduler processing.

zscheduler resume