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. 62
AT Command Response
API Identifier Value: 0x88
Response to previous command.
In response to an AT Command message, the module will send an AT Command Response mes-
sage. Some commands will send back multiple frames (for example, the ND (Node Discover) and
AS (Active Scan) commands). These commands will end by sending a frame with a status of
ATCMD_OK and no cmdData.
Figure3‐16. ATCommandResponseFrames.
Figure3‐17. ATCommandResponseFrames.
Remote AT Command Request
API Identifier Value: 0x17
Allows for module parameter registers on a remote device to be queried or set
Figure3‐18. RemoteATCommandRequest
cmdData0x88
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific Structure
Frame ID (Byte 5 )
Identifies the UART data frame being reported.
Note: If Frame ID = 0 in AT Command Mode,
no AT Command Response will be given.
AT Command (Bytes 6-7)
Command Name - Two
ASCII characters that
identify the AT Command.
Status (Byte 8)
0 = OK
1 = ERROR
2 = Invalid Command
3 = Invalid Parameter
The HEX (non-ASCII) value
of the requested register
Value (Byte(s) 9-n)
cmdData0x88
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific Structure
Frame ID (Byte 5 )
Identifies the UART data frame being reported.
Note: If Frame ID = 0 in AT Command Mode,
no AT Command Response will be given.
AT Command (Bytes 6-7)
Command Name - Two
ASCII characters that
identify the AT Command.
Status (Byte 8)
0 = OK
1 = ERROR
2 = Invalid Command
3 = Invalid Parameter
The HEX (non-ASCII) value
of the requested register
Value (Byte(s) 9-n)
0x17 cmdData
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific Structure
Frame ID (Byte 5)
Identifies the UART data frame for the host to
correlate with a subsequent ACK (acknowledgement).
If set to ‘0’, no AT Command Response will be given.
Command Name (bytes
17-18)
Name of the
command
Set to match the 64-bit address
of the destination, MSB first,
LSB last. Broadcast =
0x000000000000FFFF. This field is ignored if the 16-bit
network address field equals anything other than
0xFFFE.
64-bit Destination Address
(bytes 6-13)
0x02 - Apply changes on remote. (If
not set, AC command must be sent
before changes will take effect.)
All other bits must be set to 0.
Command Options (byte 16)
If present, indicates the requested
parameter value to set the given
register. If no characters present,
the register is queried.
Command Data (byte 19-n)
16-bit Destination Network Address
(bytes 14-15)
Set to match the 16-bit network
address of the destination, MSB
first, LSB last. Set to 0xFFFE if 64-bit
addressing is being used.