Digi XBee 3 ZigBee User Manual

API Operation Send ZDO commands with the API
Digi XBee® 3 Zigbee® RF Module
241
ZDO command Cluster ID
Simple Descriptor Request 0x0004
Active Endpoints Request 0x0005
Match Descriptor Request 0x0006
Mgmt LQI Request 0x0031
Mgmt Routing Request 0x0032
Mgmt Leave Request 0x0034
Mgmt Permit Joining Request 0x0036
Mgmt Network Update Request 0x0038
Use the Explicit Addressing Command frame - 0x11 to send Zigbee device objects commands to
devices in the network. Sending ZDO commands with the Explicit Transmit API frame requires some
formatting of the data payload field.
When sending a ZDO command with the API, all multiple byte values in the ZDO command (API
payload), for example, u16, u32, and 64-bit addresses, must be sent in little endian byte order for the
command to be executed correctly on a remote device.
For an API XBee to receive ZDO responses, set AO (API Options) to 1 to enable the explicit receive API
frame.
The following table shows how you can use the Explicit API frame to send an “Active Endpoints”
request to discover the active endpoints on a device with a 16-bit address of 0x1234.
Frame data fields Offset Description
Frame type 3 0x11
Frame ID 4 Identifies the data frame for the host to correlate with a
subsequent transmit status. If set to
0
, the device does not send a
response out the serial port.
64-bit destination
address
5-12
MSB first, LSB last. The 64-bit address of the destination device (big
endian byte order). For unicast transmissions, set to the 64-bit
address of the destination device, or to 0x0000000000000000 to
send a unicast to the coordinator. Set to 0x000000000000FFFF for
broadcast.
16-bit destination
network address
13 MSB first, LSB last. The 16-bit address of the destination device (big
endian byte order). Set to 0xFFFE for broadcast, or if the 16-bit
address is unknown.
14
Source endpoint
15 Set to 0x00 for ZDO transmissions (endpoint 0 is the ZDO
endpoint).
Destination endpoint 16 Set to 0x00 for ZDO transmissions (endpoint 0 is the ZDO
endpoint).

Digi XBee 3 ZigBee Specifications

General

Brand	Digi
Model	XBee 3 ZigBee
Category	Control Unit
Language	English