User Manual
Table Of Contents
- 1. XBee®/XBee-PRO® RF Modules
- 2. RF Module Operation
- 3. RF Module Configuration
- Programming the RF Module
- Remote Configuration Commands
- Command Reference Tables
- Command Descriptions
- A1 (End Device Association) Command
- A2 (Coordinator Association) Command
- AC (Apply Changes) Command
- AI (Association Indication) Command
- AP (API Enable) Command
- AS (Active Scan) Command
- BD (Interface Data Rate) Command
- CA (CCA Threshold) Command
- CC (Command Sequence Character) Command
- CE (Coordinator Enable) Command
- CH (Channel) Command
- CN (Exit Command Mode) Command
- CT (Command Mode Timeout) Command
- D0 - D4 (DIOn Configuration) Commands
- D5 (DIO5 Configuration) Command
- D6 (DIO6 Configuration) Command
- D7 (DIO7 Configuration) Command
- D8 (DI8 Configuration) Command
- DA (Force Disassociation) Command
- DB (Received Signal Strength) Command
- DH (Destination Address High) Command
- DL (Destination Address Low) Command
- DN (Destination Node) Command
- DP (Disassociation Cyclic Sleep Period) Command
- EA (ACK Failures) Command
- EC (CCA Failures) Command
- ED (Energy Scan) Command
- EE (AES Encryption Enable) Command
- FP (Force Poll) Command
- FR (Software Reset) Command
- GT (Guard Times) Command
- HV (Hardware Version) Command
- IA (I/O Input Address) Command
- IC (DIO Change Detect) Command
- ID (Pan ID) Command
- IO (Digital Output Level) Command
- IR (Sample Rate) Command
- IS (Force Sample) Command
- IT (Samples before TX) Command
- IU (I/O Output Enable) Command
- KY (AES Encryption Key) Command
- M0 (PWM0 Output Level) Command
- M1 (PWM1 Output Level) Command
- MM (MAC Mode) Command
- MY (16-bit Source Address) Command
- NB (Parity) Command
- ND (Node Discover) Command
- NI (Node Identifier) Command
- NO (Node Discover Options) Command
- NT (Node Discover Time) Command
- P0 (PWM0 Configuration) Command
- P1 (PWM1 Configuration) Command
- PL (Power Level) Command
- PR (Pull-up Resistor) Command
- PT (PWM Output Timeout) Command
- RE (Restore Defaults) Command
- RN (Random Delay Slots) Command
- RO (Packetization Timeout) Command
- RP (RSSI PWM Timer) Command
- RR (XBee Retries) Command
- SC (Scan Channels) Command
- SD (Scan Duration) Command
- SH (Serial Number High) Command
- SL (Serial Number Low) Command
- SM (Sleep Mode) Command
- SO (Sleep Mode Command)
- SP (Cyclic Sleep Period) Command
- ST (Time before Sleep) Command
- T0 - T7 ((D0-D7) Output Timeout) Command
- VL (Firmware Version - Verbose)
- VR (Firmware Version) Command
- WR (Write) Command
- API Operation
- Appendix A: Agency Certifications
- Appendix B. Additional Information
XBee®/XBee‐PRO®RFModules‐802.15.4‐v1.xEx[2011.06.1]
©2011DigiInternatonal,Inc. 60
Data bytes that need to be escaped:
• 0x7E – Frame Delimiter
•0x7D – Escape
• 0x11 – XON
• 0x13 – XOFF
Note: In the above example, the length of the raw data (excluding the checksum) is 0x0002 and
the checksum of the non-escaped data (excluding frame delimiter and length) is calculated as:
0xFF - (0x23 + 0x11) = (0xFF - 0x34) = 0xCB.
Checksum
To test data integrity, a checksum is calculated and verified on non-escaped data.
To calculate: Not including frame delimiters and length, add all bytes keeping only the lowest 8
bits of the result and subtract from 0xFF.
To verify: Add all bytes (include checksum, but not the delimiter and length). If the checksum is
correct, the sum will equal 0xFF.
API Types
Frame data of the UART data frame forms an API-specific structure as follows:
Figure3‐11. UARTDataFrame&API‐specificStructure:
The cmdID frame (API-identifier) indicates which API messages will be contained in the cmdData
frame (Identifier-specific data). Refer to the sections that follow for more information regarding
the supported API types. Note that multi-byte values are sent big endian.
Modem Status
API Identifier: 0x8A
RF module status messages are sent from the module in response to specific conditions.
Figure3‐12. ModemStatusFrames
Example - Raw UART Data Frame (before escaping interfering bytes):
0x7E 0x00 0x02 0x23 0x11 0xCB
0x11 needs to be escaped which results in the following frame:
0x7E 0x00 0x02 0x23 0x7D 0x31 0xCB
Length
(Bytes 2-3)
Checksum
(Byte n + 1)
MSB LSB 1 Byte
Start Delimiter
(Byte 1)
0x7E
Frame Data
(Bytes 4-n)
API-specific Structure
Identifier-specific Data
cmdData
API Identifier
cmdID
cmdData0x8A
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI -specific Structure
Status (Byte 5)
0 = Hardware reset
1 = Watchdog timer reset
2 = Associated
3 = Disassociated
4 = Synchronization Lost
(Beacon-enabled only )
5 = Coordinator realignment
6 = Coordinator started