Receive Zigbee Commands And Responses; Examples: Explicit Data And Zdo - Digi XBee Zigbee Mesh Kit User Manual

Zigbee communication in depth

Receive Zigbee commands and responses

To receive ZDP, ZCL, and application profile commands and responses:
XBees modules must work in API mode, that is AP must be set to API enabled [1] or API
n
enabled with escaping [2].
The API Output Mode (AO) setting must be set to Explicit [1] or Explicit with ZDO Passthru [3].
n
The Explicit [1] output mode (AO = 1) enables the explicit receive API frame (0x91) which indicates the
source and destination endpoints, cluster ID, and profile ID.
The Explicit with ZDO Passthru [3] mode (AO = 3) is similar to the Explicit [1] mode, but it also outputs
some ZDO packets received by the XBee module through the serial interface as explicit data to be
responded by external processors:
ZDO requests that are not supported by the stack.
n
ZDO Simple descriptor request (Cluster ID: 0x0004).
n
ZDO Active endpoints request (Cluster ID: 0x0005).
n
ZDO Match descriptor request (Cluster ID: 0x0006).
n
For an XBee to received ZDP, ZCL, or application profile responses:
API mode (AP) must be enabled (AP = 1 or AP = 2).
n
AO parameter must be set to Explicit [1] or Explicit with ZDO Passthru [3] to enable the explicit
n
receive API frame.

Examples: explicit data and ZDO

These examples illustrate how to use the Explicit Addressing Command Frame (0x11) to work with
profiles, clusters, and endpoints. Both examples request the neighbor table of a remote node, but the
procedure is different. First, you use the XCTU console to create the packet and analyze the response.
Then you use a Java application and the XBee Java Library to abstract the process of sending and
receiving the packets.
Use the Zigbee Device Object (ZDO) to obtain the neighbors of a remote node. You can use a similar
approach for other profiles and cluster IDs by adjusting the request to send, the parse of the received
data, and the actions to perform depending on what is received.
In the remote node, the ZDO is the application object that manages the neighbor list. It is located at
endpoint 0 and under the Zigbee Device Profile (ZDP). The request must be addressed to the cluster of
this object that is able to return a neighbor's table, the LQI Request (cluster ID: 0x0031).
On receipt, the remote node's ZDO generates an answer from the 0x8031 cluster (LQI Response)
addressed to the same application object, ZDO at endpoint 0, of the requester node.
Source endpoint
Destination endpoint ZDO
Profile ID
Cluster ID
XBee® Zigbee® Mesh Kit
Request to remote node Response from remote node
ZDO 0
0
ZDP 0x0000
LQI Request 0x0031
Examples: explicit data and ZDO
ZDO 0
ZDO 0
ZDP 0x0000
LQI Response 0x8031
164