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. 35
*Firmwareversioninwhichthecommand wasfirstintroduced(firmwareversionsarenumberedinhexadecimalnotation.)
Diagnostics
D5 (v1.x80*) I/O Settings
DIO5 Configuration. Configure settings for the DIO5 line (pin 15) of the RF module.
Options include Associated LED indicator (blinks when associated) and I/O line
settings.
0 - 1
0 = Disabled
1 = Associated indicator
2 = ADC
3 = DI
4 = DO low
5 = DO high
1
D0 - D4
(v1.xA0*)
I/O Settings
(DIO4 -DIO4) Configuration. Select/Read settings for the following lines: AD0/DIO0
(pin 20), AD1/DIO1 (pin 19), AD2/DIO2 (pin 18), AD3/DIO3 (pin 17), AD4/DIO4 (pin 11).
Options include: Analog-to-digital converter, Digital Input and Digital Output.
0 - 1
0 = Disabled
1 = (n/a)
2 = ADC
3 = DI
4 = DO low
5 = DO high
0
IU (v1.xA0*) I/O Settings
I/O Output Enable. Disables/Enables I/O data received to be sent out UART. The data
is sent using an API frame regardless of the current AP parameter value.
0 - 1
0 = Disabled
1 = Enabled
1
IT (v1.xA0*) I/O Settings
Samples before TX. Set/Read the number of samples to collect before transmitting
data. Maximum number of samples is dependent upon the number of enabled inputs.
1 - 0xFF 1
IS (v1.xA0*) I/O Settings
Force Sample. Force a read of all enabled inputs (DI or ADC). Data is returned through
the UART. If no inputs are defined (DI or ADC), this command will return error.
8-bit bitmap (each bit
represents the level of an I/O
line setup as an output)
-
IO (v1.xA0*) I/O Settings
Digital Output Level. Set digital output level to allow DIO lines that are setup as
outputs to be changed through Command Mode.
--
IC (v1.xA0*) I/O Settings
DIO Change Detect. Set/Read bitfield values for change detect monitoring. Each bit
enables monitoring of DIO0 - DIO7 for changes. If detected, data is transmitted with
DIO data only. Any samples queued waiting for transmission will be sent first.
0 - 0xFF [bitfield] 0 (disabled)
IR (v1.xA0*) I/O Settings
Sample Rate. Set/Read sample rate. When set, this parameter causes the module to
sample all enabled inputs at a specified interval.
0 - 0xFFFF [x 1 msec] 0
IA (v1.xA0*)
I/O Settings {I/O
Line Passing}
I/O Input Address. Set/Read addresses of module to which outputs are bound. Setting
all bytes to 0xFF will not allow any received I/O packet to change outputs. Setting
address to 0xFFFF will allow any received I/O packet to change outputs.
0 - 0xFFFFFFFFFFFFFFFF
0xFFFFFFF
FFFFFFFFF
T0 - T7
(v1.xA0*)
I/O Settings {I/O
Line Passing}
(D0 - D7) Output Timeout. Set/Read Output timeout values for lines that correspond
with the D0 - D7 parameters. When output is set (due to I/O line passing) to a non-
default level, a timer is started which when expired will set the output to it default level.
The timer is reset when a valid I/O packet is received.
0 - 0xFF [x 100 ms] 0xFF
P0
I/O Settings {I/O
Line Passing}
PWM0 Configuration. Select/Read function for PWM0 pin.
0 - 2
0 = Disabled
1 = RSSI
2 = PWM Output
1
P1 (v1.xA0*)
I/O Settings {I/O
Line Passing}
PWM1 Configuration. Select/Read function for PWM1 pin.
0 - 2
0 = Disabled
1 = RSSI
2 = PWM Output
0
M0 (v1.xA0*)
I/O Settings {I/O
Line Passing}
PWM0 Output Level. Set/Read the PWM0 output level. 0 - 0x03FF -
M1 (v1.xA0*)
I/O Settings {I/O
Line Passing}
PWM1 Output Level. Set/Read the PWM1 output level. 0 - 0x03FF -
PT (v1.xA0*)
I/O Settings {I/O
Line Passing}
PWM Output Timeout. Set/Read output timeout value for both PWM outputs. When
PWM is set to a non-zero value: Due to I/O line passing, a time is started which when
expired will set the PWM output to zero. The timer is reset when a valid I/O packet is
received.]
0 - 0xFF [x 100 ms] 0xFF
RP
I/O Settings {I/O
Line Passing}
RSSI PWM Timer. Set/Read PWM timer register. Set the duration of PWM (pulse width
modulation) signal output on the RSSI pin. The signal duty cycle is updated with each
received packet and is shut off when the timer expires.]
0 - 0xFF [x 100 ms] 0x28 (40d)
Tabl e3‐07. XBee®/XBee‐
PRO®Commands‐Diagnostics
AT
Command
Command
Category
Name and Description Parameter Range Default
VR Diagnostics Firmware Version. Read firmware version of the RF module. 0 - 0xFFFF [read-only] Factory-set
VL (v1.x80*) Diagnostics
Firmware Version - Verbose. Read detailed version information (including application
build date, MAC, PHY and bootloader versions). The VL command has been
deprecated in version 10C9. It is not supported in firmware versions after 10C8
--
Tabl e3‐06. XBee‐PROCommands‐I/OSettings(sub‐categorydesignatedwithin{brackets})
AT
Command
Command
Category
Name and Description Parameter Range Default