ZigBee Device Object Commands (ZDO)

Zigbee Application Framework Command Line Interface (CLI)

zdo active [nodeId:2]

• Send an active endpoint request to the device with the given short id.
  • nodeId - INT16U - Two byte short id, destination for the active endpoint request

zdo bind [destination:2] [source Endpoint:1] [destEndpoint:1] [cluster:2] [remoteEUI64:8] [destEUI64:8]

• Send a ZDO Bind command to a device specified in the command arguments.
  • destination - INT16U - Two byte destination node id
  • source Endpoint - INT8U - Remote device's source endpoint to bind
  • destEndpoint - INT8U - Remote endpoint to bind
  • cluster - INT16U - Cluster on which to bind
  • remoteEUI64 - IEEE_ADDRESS - Remote node EUI64
  • destEUI64 - IEEE_ADDRESS - Binding's dest EUI64. Usually the local node's EUI64

zdo ieee [nodeId:2]

• Request an ieee address based on a given node id.
  • nodeId - INT16U - Short address of the device for which a long address is requested

zdo in-cl-list add [clusterId:2]

• Add clusters to the known server (in) clusters on this device.
  • clusterId - INT16U - Server cluster id

zdo in-cl-list clear

• Clear the ZDO list of server (in) clusters.

zdo leave [target:2] [removeChildren:1] [rejoin:1]

• Send a ZDO Management Leave command to the target device.
  • target - INT16U - Target node ID
  • removeChildren - BOOLEAN - Remove children
  • rejoin - BOOLEAN - Rejoin after leave

zdo match [nodeId:2] [profile:2]

• Sends a matchDescriptorsRequest to the given destination with the given profile.
  • nodeId - INT16U - Two byte node id indicating wher
  • profile - INT16U - Two byte profile id for the match descriptor request

zdo mgmt-bind [target:2] [startIndex:1]

• Send a ZDO MGMT-Bind (Binding Table) Request to the target device.
  • target - INT16U - Target node ID
  • startIndex - INT8U - Starting index into table query

zdo mgmt-lqi [target:2] [startIndex:1]

• Send a ZDO MGMT-LQI (LQI Table) Request to the target device.
  • target - INT16U - Target node ID
  • startIndex - INT8U - Starting index into table query

zdo node [target:2]

• Sends a node descriptor request to a given target device
  • target - INT16U - Two byte address for the target device.

zdo nwk [ieee:8]

• Sends a network address request for the given IEEE address.
  • ieee - IEEE_ADDRESS - IEEE address for which a short address is being requested

zdo nwk-upd chan [channel:1]

• Sends an update channel request.
  • channel - INT8U - One byte channel to change to.

zdo nwk-upd chanPg [channel:1] [page:1]

• Sends an update channel page request. The stack shall send network enhanced update request if page is non-zero.
  • channel - INT8U - One byte channel to change to.
  • page - INT8U - One byte page to change to.

zdo nwk-upd scan [targetNodeId:2] [scanDuration:1] [scanCount:2]

• Performs an energy scan.
  • targetNodeId - INT16U - Two byte short id of the target device
  • scanDuration - INT8U - One byte scan duration. Must be in range 0 - 5
  • scanCount - INT16U - Number of scans to perform. Must be in range 1 - 8

zdo nwk-upd scan-chan-mask [targetNodeId:2] [scanDuration:1] [scanCount:2] [channelMask:4]

• Performs an energy scan on given channel mask. This can be used to perform scanning with page number embedded in channel mask, it mainly used for subghz network. The stack shall send network enhanced update request if page is non-zero.
  • targetNodeId - INT16U - Two byte short id of the target device
  • scanDuration - INT8U - One byte scan duration. Must be in range 0 - 5
  • scanCount - INT16U - Number of scans to perform. Must be in range 1 - 8
  • channelMask - INT32U - Four byte channel mask

zdo nwk-upd set [nwkMgrId:2] [channelMask:4]

• Broadcasts the ID of the new network manager and active channels.
  • nwkMgrId - INT16U - Two byte network manager id
  • channelMask - INT32U - Four byte channel mask

zdo out-cl-list add [clusterId:2]

• Add clusters to the known client (out) clusters on this device.
  • clusterId - INT16U - Client cluster ids

zdo out-cl-list clear

• Clear the ZDO list of client (out) clusters.

zdo power [target:2]

• Send a ZDO Power Descriptor Request to the target device.
  • target - INT16U - Target node ID

zdo route [target:2] [index:1]

• Send a ZDO route request command to the target.
  • target - INT16U - Target node ID
  • index - INT8U - The index of the remote node's routing table to request.

zdo simple [dest:2] [targetEndpoint:1]

• Sends out a simple descriptor request for the short address and endpoint specified.
  • dest - INT16U - Short address of the device where the simple descriptor request should be sent
  • targetEndpoint - INT8U - The endpoint on the target device where the simple descriptor request will be sent

zdo unbind group [target:2] [source eui64:8] [source endpoint:1] [clusterID:2] [groupAddress:2]

• Sends an unbind request for a multicast binding to the target device.
  • target - INT16U - Target node ID
  • source eui64 - IEEE_ADDRESS - The source EUI64 of the binding (the remote device's EUI64)
  • source endpoint - INT8U - The source endpoint of the binding.
  • clusterID - INT16U - The cluster ID to unbind.
  • groupAddress - INT16U - The group address in the binding

zdo unbind unicast [target:2] [source eui64:8] [source endpoint:1] [clusterID:2] [destinationEUI64:8] [destEndpoint:1]

• Sends an unbind request for a unicast binding to the target device.
  • target - INT16U - Target node ID
  • source eui64 - IEEE_ADDRESS - The source EUI64 of the binding (the remote device's EUI64)
  • source endpoint - INT8U - The source endpoint of the binding.
  • clusterID - INT16U - The cluster ID to unbind.
  • destinationEUI64 - IEEE_ADDRESS - The destination EUI64 in the binding (usually the local node's EUI64
  • destEndpoint - INT8U - The destination endpoint of the binding