API Operation Send Zigbee cluster library (ZCL) commands with the API
Digi XBee® 3 Zigbee® RF Module
246
Frame fields Offset
Description
Transaction
sequence
number
24 A sequence number used to correlate a ZCL command
with a ZCL response. (The hardware version response
will include this byte as a sequence number in the
response.) The value 0x01 was arbitrarily selected.
Command
ID
25 Since the frame control “frame type” bits are 00, this
byte specifies a general command. Command ID 0x00
is a Read Attributes command.
ZCL
payload
Attribute ID 26
The payload for a “Read Attributes” command is a list
of Attribute Identifiers that are being read.
Note The 16-bit Attribute ID (0x0003) is sent in little
endian byte order (0x0300). All multi- byte ZCL header
and payload values must be sent in little endian byte
order.
27 0xFF minus the 8 bit sum of bytes from offset 3 to this
byte.
Example
In this example, the Frame Control field (offset 23) is constructed as follows:
Name Bits Example Value Description
Frame Type 0-1 00 - Command acts across the entire profile.
Manufacturer Specific 2 0 - The manufacturer code field is omitted from the ZCL Frame
Header.
Direction 3 0 - The command is being sent from the client side to the server
side.
Disable Default
Response
4 0 - Default response not disabled.
Reserved 5-7 Set to 0.
For more information, see the Zigbee Cluster Library specification.
Frame data fields Offset Example
Start delimiter 0 0x7E
Length MSB 1 0x00
LSB 2 0x19
Frame type 3 0x11
Frame ID 4 0x01