User Manual
Table Of Contents
- 1. Overview
- 2. RF Module Operation
- 3. XBee ZigBee Networks
- Introduction to ZigBee
- ZigBee Stack Layers
- Networking Concepts
- ZigBee Application Layers: In Depth
- Coordinator Operation
- Router Operation
- End Device Operation
- Channel Scanning
- 4. Transmission, Addressing, and Routing
- 5. Security
- 6. Network Commissioning and Diagnostics
- 7. Managing End Devices
- 8. XBee Analog and Digital IO Lines
- 9. API Operation
- API Frame Specifications
- API UART Exchanges
- Supporting the API
- API Frames
- AT Command
- AT Command - Queue Parameter Value
- ZigBee Transmit Request
- Explicit Addressing ZigBee Command Frame
- Remote AT Command Request
- Create Source Route
- AT Command Response
- Modem Status
- ZigBee Transmit Status
- ZigBee Receive Packet
- ZigBee Explicit Rx Indicator
- ZigBee IO Data Sample Rx Indicator
- XBee Sensor Read Indicator
- Node Identification Indicator
- Remote Command Response
- Over-the-Air Firmware Update Status
- Route Record Indicator
- Many-to-One Route Request Indicator
- Sending ZigBee Device Objects (ZDO) Commands with the API
- Sending ZigBee Cluster Library (ZCL) Commands with the API
- Sending Public Profile Commands with the API
- 10. XBee Command Reference Tables
- 11. Module Support
- Appendix A: Definitions
- Appendix B: Agency Certifications
- Appendix C: Migrating from ZNet 2.5 to XBee ZB
- Appendix D: Additional Information
XBee®/XBee‐PRO®ZBRFModules
©2011DigiInternational,Inc. 125
In the above example, the Frame Control field (offset 23) was constructed as follows:
See the ZigBee Cluster Library specification for details.
Sending Public Profile Commands with the API
Commands in public profiles such as Smart Energy and Home Automation can be sent with the XBee API using the
Explicit Transmit API frame (0x11). 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 the previous section.
The following table shows how the Explicit API frame can be used 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 message will be a "Load Control Event" (command ID 0x00) and will be sent to a device with 64-
bit address of 0x0013A200 40401234 with a 16-bit address of 0x5678. The event will start a load control event for
water heaters and smart appliances, for a duration of 1 minute, starting immediately.
Note: When sending public profile commands, the AO command should be set to 1 to enable the explicit receive API
frame. This will provide 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.
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.