Digi XBee 3 ZigBee User Manual

Network commissioning and diagnostics Group Table API
Digi XBee® 3 Zigbee® RF Module
140
Group Table API
Unlike the Binding Table that 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. Configure
the Zigbee XBee firmware to forward all ZCL commands addressed to this Group Cluster out the UART
(see ATAO3). The XBee Zigbee will not use remote Groups Cluster commands to manage its own
Group Table.
But to implement multicast (group) addressing within the XBee, the external processor must keep the
XBee device's group table state in sync with its own. For this reason, a Group Table API has been
defined where the external processor can manage the state of the XBee 3 Zigbee RF Module group
table.
The design of the Group Table API of the XBee firmware derives from the ZCL Group Cluster 0x0006.
Use the Explicit Addressing Command 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.
The Zigbee home automation public application profile says groups should only be used for sets of
more than five devices. This implies sets of five or fewer devices should be managed with multiple
binding table entries.
There are five commands implemented in the API:
n Add Group command
n View group
n Remove Group
n Remove All Groups
There is a sixth command of the Group Cluster described in the ZCL: Add Group If Identifying. This
command 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 needs to implement that server
command while using the Group Table API to keep the XBee device's group table in sync using the five
command primitives.
Add Group command
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 following example adds 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 used to associate
the response with the command request. The third field is the command identifier for “Add Group”
(0x00).
ZCL_payload = “3412 04 41 42 43 44"

Digi XBee 3 ZigBee Specifications

General

Brand	Digi
Model	XBee 3 ZigBee
Category	Control Unit
Language	English