Send Public Profile Commands With The Api; Frame Specific Data - Digi XBee 3 ZigBee User Manual

API Operation

Send Public Profile Commands with the API

You can use the XBee API using the Explicit Transmit API frame (0x11) to send commands in public
profiles such as Smart Energy and Home Automation. Sending public profile commands with the
Explicit Transmit API frame requires some formatting of the data payload field. Most of the public
profile commands fit into the Zigbee cluster library (ZCL) architecture as described in
cluster library (ZCL) commands with the
The following table shows how you can use the Explicit API frame to send a demand response and load
control message (cluster ID 0x701) in the smart energy profile (profile ID 0x0109) in the revision 14
Smart Energy specification. The device sends a "Load Control Event"message (command ID 0x00) and
to a device with 64- bit address of 0x0013A200 40401234 with a 16-bit address of 0x5678. The event
starts a load control event for water heaters and smart appliances for a duration of 1 minute, starting
immediately.
Note When sending public profile commands, set the AO command to 1 to enable the explicit receive
API frame. This provides indication of the source 64- and 16-bit addresses, cluster ID, profile ID, and
endpoint information for each received packet. This information is required to properly decode
received data.

Frame specific data

Frame Fields
Frame type
Frame ID
64-bit
destination
address
16-bit
destination
network
address
Source
endpoint
Digi XBee® 3 Zigbee® RF Module
Send Public Profile Commands with the API
API.
Offset Description
3
4 Identifies the serial port data frame for the host to
correlate with a subsequent transmit status. If set
to 0, no transmit status frame will be sent out the
serial port.
MSB 5 The 64-bit address of the destination device (big
endian byte order). For unicast transmissions, set to
6
the 64-bit address of the destination device, or to
0x0000000000000000 to send a unicast to the
7
coordinator. Set to 0x000000000000FFFF for
8
broadcast.
9
10
11
LSB
12
MSB The 16-bit address of the destination device (big
13 endian byte order). Set to 0xFFFE for broadcast, or if
the 16-bit address is unknown.
LSB
14
15 Set to the source endpoint on the sending device.
(0x41 arbitrarily selected).
Send Zigbee
248