Group Table Api - Digi PS2CSM Product Manual

® ®
XBee /XBee‐PRO ZB RF Modules
01f2995cb5474000a21300e605c1010100010200RFData (ZDO payload)
46
Here is the RFData (the ZDO payload) broken into labeled fields. Note the multibyte fields of a ZDO
payload are represented in little-endian format.
01
f299
5cb5474000a21300 (64 bit address of sending device)
e6
05c1
01
0100
01
0200
Example of a End_Device_Bind_req
Bind_req
The Bind request (ZDO cluster 0x0021) is described in the ZigBee Specification in section 2.4.3.2.2.
A binding may be coded for either a unicast or a multicast/groupID message.
Unbind_req
The Unbind request (ZDO cluster 0x0022) is described in the ZigBee Specification in section 2.4.3.2.3.

Group Table API

Unlike the Binding Table which is managed with ZDO commands, a ZigBee Group Table is managed by the
ZigBee Cluster Library Groups Cluster (0x0006) with ZCL commands.
The Digi ZigBee XBee firmware is intended to work with an external processor where a Public Application
Profile with endpoints and clusters is implemented, including a Groups Cluster. The ZigBee XBee firmware
should be configured to forward all ZCL commands addressed to this Group Cluster out the UART (see
ATAO3). The ZigBee XBee will not use remote Groups Cluster commands to manage its own Group Table.
But for the sake of implementing multicast (group) addressing within the XBee, the external processor
must keep the XBee's group table state in synch with its own. And so a Group Table API has been defined
whereby the external processor can manage the state of the ZigBee XBee's group table.
The design of the Group Table API of the XBee firmware is derived from the ZCL Group Cluster 0x0006.
Developers should use the Explicit API frame 0x11 addressed to the Digi Device Object endpoint (0xE6)
with the Digi XBee ProfileID (0xC105) to send commands and requests to the local device.
As a design note, the Home Automation public application profile (section 5.9.5) says groups should only be
used for sets of more than 5 devices. This implies sets of 5 or fewer devices should be managed with
multiple binding table entries.
There are five commands implemented in the API: Add Group, View Group, Get Group Membership,
Remove Group, and Remove All Groups.
There is a sixth command of the Group Cluster described in the ZCL, Add Group If Identifying, which is not
supported in this API, because its implementation requires access to the Identify Cluster, which is not
maintained on the XBee. The external processor will need to implement that server command while using
the Group Table API to keep the XBee's group table in synch using the five command primitives described
hereafter.
© 2014 Digi International Inc.
Checksum
Transaction Sequence Number
Binding Target (16 bit network address of sending device)
Source Endpoint on sending device
ProfileID (0xC105) - used when matching End_Device_Bind_requests
Number of input clusters
Input cluster ID list (0x0100)
Number of output clusters
Output cluster ID list (0x0200)
91