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. 65
TX (Transmit) Status
API Identifier Value: 0x89
When a TX Request is completed, the module sends a TX Status message. This message will indi-
cate if the packet was transmitted successfully or if there was a failure.
Figure3‐22. TXStatusFrames
NOTES:
• “STATUS = 1” occurs when all retries are expired and no ACK is received.
• If transmitter broadcasts (destination address = 0x000000000000FFFF), only
“STATUS = 0 or 2” will be returned.
• “STATUS = 3” occurs when Coordinator times out of an indirect transmission.
Timeout is defined as (2.5 x SP (Cyclic Sleep Period) parameter value).
RX (Receive) Packet: 64-bit Address
API Identifier Value: 0x80
When the module receives an RF packet, it is sent out the UART using this message type.
Figure3‐23. RXPacket(64‐bitaddress)Frames
RX (Receive) Packet: 16-bit Address
API Identifier Value: 0x81
When the module receives an RF packet, it is sent out the UART using this message type.
Figure3‐24. RXPacket(16‐bitaddress)Frames
cmdData0x89
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific Structure
Frame ID (Byte 5) Status (Byte 6)
0 = Success
1 = No ACK (Acknowledgement) received
2 = CCA failure
3 = Purged
Identifies UART data frame being reported.
Note: If Frame ID = 0 in the TX Request, no
AT Command Response will be given.
cmdData0x80
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific Structure
bit 0 [reserved]
bit 1 = Address broadcast
bit 2 = PAN broadcast
bits 3-7 [reserved]
Up to 100 Bytes per packet
Received Signal Strength Indicator -
Hexadecimal equivalent of (-dBm) value.
(For example: If RX signal strength = -40
dBm, “0x28” (40 decimal) is returned)
Source Address (Bytes 5-12) Options (Byte 14) RF Data (Byte(s) 15-n)RSSI (Byte 13)
MSB (most significant byte) first,
LSB (least significant) last
cmdData0x81
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific Structure
bit 0 [reserved]
bit 1 = Address broadcast
bit 2 = PAN broadcast
bits 3-7 [reserved]
Up to 100 Bytes per packet
Received Signal Strength Indicator -
Hexadecimal equivalent of (-dBm) value.
(For example: If RX signal strength = -40
dBm, “0x28” (40 decimal) is returned)
Source Address (Bytes 5-6) RSSI (Byte 7)
MSB (most significant byte) first,
LSB (least significant) last
Options (Byte 8) RF Data (Byte(s) 9-n)










