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. 33
RF Interfacing
*Firmwareversioninwhichthecommand wasfirstintroduced(firmwareversionsarenumberedinhexadecimalnotation.)
Sleep (Low Power)
Tabl e3‐03. XBee/XBee‐PROCommands‐RFInterfacing
AT
Command
Command
Category
Name and Description Parameter Range Default
PL RF Interfacing
Power Level. Select/Read the power level at which the RF module transmits conducted
power.
0 - 4 (XBee / XBee-PRO)
0 = -10 / 10 dBm
1 = -6 / 12 dBm
2 = -4 / 14 dBm
3 = -2 / 16 dBm
4 = 0 / 18 dBm
XBee-PRO International
variant:
PL=4: 10 dBm
PL=3: 8 dBm
PL=2: 2 dBm
PL=1: -3 dBm
PL=0: -3 dBm
4
CA (v1.x80*) RF Interfacing
CCA Threshold. Set/read the CCA (Clear Channel Assessment) threshold. Prior to
transmitting a packet, a CCA is performed to detect energy on the channel. If the
detected energy is above the CCA Threshold, the module will not transmit the packet.
0x24 - 0x50 [-dBm]
0x2C
(-44d dBm)
Tabl e3‐04. XBee®/XBee‐PRO®Com mands‐Sleep(LowPower)
AT
Command
Command
Category
Name and Description Parameter Range Default
SM
Sleep
(Low Power)
Sleep Mode. Set/Read Sleep Mode configurations.
0 - 5
0 = No Sleep
1 = Pin Hibernate
2 = Pin Doze
3 = Reserved
4 = Cyclic sleep remote
5 = Cyclic sleep remote
w/ pin wake-up
6 = [Sleep Coordinator] for
backwards compatibility
w/ v1.x6 only; otherwise,
use CE command.
0
SO
Sleep (Low
Power)
Sleep Options Set/Read the sleep mode options.
Bit 0 - Poll wakeup disable
0 - Normal operations. A module configured for cyclic sleep will poll for data on waking.
1 - Disable wakeup poll. A module configured for cyclic sleep will not poll for data on
waking.
Bit 1 - ADC/DIO wakeup sampling disable.
0 - Normal operations. A module configured in a sleep mode with ADC/DIO sampling
enabled will automatically perform a sampling on wakeup.
1 - Suppress sample on wakeup. A module configured in a sleep mode with ADC/DIO
sampling enabled will not automatically sample on wakeup.
0-4 0
ST
Sleep
(Low Power)
Time before Sleep. <NonBeacon firmware> Set/Read time period of inactivity (no
serial or RF data is sent or received) before activating Sleep Mode. ST parameter is
only valid with Cyclic Sleep settings (SM = 4 - 5).
Coordinator and End Device ST values must be equal.
Also note, the GT parameter value must always be less than the ST value. (If GT > ST,
the configuration will render the module unable to enter into command mode.) If the ST
parameter is modified, also modify the GT parameter accordingly.
1 - 0xFFFF [x 1 ms]
0x1388
(5000d)
SP
Sleep
(Low Power)
Cyclic Sleep Period. <NonBeacon firmware> Set/Read sleep period for cyclic sleeping
remotes. Coordinator and End Device SP values should always be equal. To send
Direct Messages, set SP = 0.
End Device - SP determines the sleep period for cyclic sleeping remotes. Maximum
sleep period is 268 seconds (0x68B0).
Coordinator - If non-zero, SP determines the time to hold an indirect message before
discarding it. A Coordinator will discard indirect messages after a period of (2.5 * SP).
0 - 0x68B0 [x 10 ms] 0
DP (1.x80*)
Sleep
(Low Power)
Disassociated Cyclic Sleep Period. <NonBeacon firmware>
End Device - Set/Read time period of sleep for cyclic sleeping remotes that are
configured for Association but are not associated to a Coordinator. (i.e. If a device is
configured to associate, configured as a Cyclic Sleep remote, but does not find a
Coordinator, it will sleep for DP time before reattempting association.) Maximum sleep
period is 268 seconds (0x68B0). DP should be > 0 for NonBeacon systems.
1 - 0x68B0 [x 10 ms]
0x3E8
(1000d)