Group Table Api - Digi XBee-PRO User Manual

Bind_req
The Bind request (ZDO cluster 0x0021) is described in the ZigBee Specification. 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.

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 sync 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
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 sync using the five command primitives described hereafter.
Add Group
The purpose of the Add Group command is to add a group table entry to associate an active endpoint with a
groupID and optionally a groupName. The groupID is a two byte value. The groupName consists of zero to 16
ASCII characters.
The intent of the example which follows is to add a group table entry which associates endpoint E7 with groupID
1234 and groupName "ABCD".
The example packet is given in three parts, the preamble, ZCL Header, and ZCL payload:
Preamble = "11 01 "+LocalDevice64Addr+"FFFE E6 E7 0006 C105 00 00"
The packet is addressed to the local node, using a source endpoint of 0xE6, clusterID of 0x0006, and profileID of
0xC105. The destination endpoint E7 holds the endpoint parameter for the "Add Group" command.
ZCL_header = "01 ee 00"
The first field (byte) is a frame control field which specifies a Cluster Specific command (0x01) using a Client-
>Server direction(0x00). The second field is a transaction sequence number which is used to associate the
response with the command request. The third field is the command identifier for "Add Group" (0x00)[2].
XBee/XBee-PRO ZigBee RF Modules User Guide
ZigBee Home Automation Public Application Profile
Commissioning Pushbutton and Associate LED
says groups should only be used for
107