User's 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. Data 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
- United States FCC
- OEM Labeling Requirements
- FCC Notices
- FCC-Approved Antennas (2.4 GHz)
- Europe (ETSI)
- OEM Labeling Requirements
- Restrictions
- Declarations of Conformity
- Approved Antennas
- XBee RF Module
- XBee-PRO (S2) RF Module
- XBee-PRO (S2B) RF Module
- Canada (IC)
- Transmitters for Detachable Antennas
- Detachable Antenna
- Appendix C: Migrating from ZNet 2.5 to XBee ZB
- Appendix D: Additional Information
XBee®/XBee‐PRO®ZBRFModules
©2009DigiInternational,Inc. 119
In the above example, the Frame Control field (offset 23) was constructed as follows:
ZCL Payload -
Load Control
Event Data
Issuer Event ID
26 0x78 4-byte unique identifier.
Note the 4-byte ID is sent in little endian byte order
(0x78563412).
The event ID in this example (0x12345678) was
arbitrarily selected.
27 0x56
28 0x34
29 0x12
Device Class
30 0x14 to apply the load control event.
A bit value of 0x0014 enables smart appliances and
water heaters.
Note the 2-byte bit field value is sent in little endian byte
order.
31 0x00
Utility
Enrollment
Group
32 0x00
Used to identify sub-groups of devices in the device-
class. 0x00 addresses all groups.
Start Time
33 0x00
UTC timestamp representing when the event should
start. A value of 0x00000000 indicates "now".
34 0x00
35 0x00
36 0x00
Duration in
Minutes
37 0x01
This 2-byte value must be sent in little endian byte order.
38 0x00
Criticality Level 39 0x04
Indicates the criticality level of the event. In this example,
the level is "voluntary".
Cooling
Temperature
40 0xFF
Requested offset to apply to the normal cooling set point.
A value of 0xFF indicates the temperature offset value is
not used.
Heating
Temperature
Offset
41 0xFF
Requested offset to apply to the normal heating set point.
A value of 0xFF indicates the temperature offset value is
not used.
Cooling
Temperature
Set Point
42 0x00 Requested cooling set point in 0.01 degrees Celsius.
A value of 0x8000 means the set point field is not used in
this event.
Note the 0x80000 is sent in little endian byte order.
43 0x80
Heating
Temperature
Set Point
44 0x00 Requested heating set point in 0.01 degrees Celsius.
A value of 0x8000 means the set point field is not used in
this event.
Note the 0x80000 is sent in little endian byte order.
45 0x80
Average Load
Adjustment
Percentage
46 0x80
Maximum energy usage limit.
A value of 0x80 indicates the field is not used.
Duty Cycle 47 0xFF
Defines the maximum "On" duty cycle.
A value of 0xFF indicates the duty cycle is not used in this
event.
Duty Cycle
Event Control
48 0x00 A bitmap describing event options.
Checksum 49 0x5B
0xFF minus the 8 bit sum of bytes from offset 3 to this
byte.
Name Bits Example Value Description
Frame Type 0-1 01 - Command is specific to a cluster
Manufacturer Specific 2 0 - The manufacturer code field is omitted from the ZCL Frame Header.
Direction 3 1 - The command is being sent from the server side to the client side.
Disable Default Response 4 0 - Default response not disabled
Reserved 5-7 Set to 0.
Frame Fields Offset Example Description