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. 31
NO (v1xC5)
Networking
{Identification}
Node Discover Options. Enables node discover self-response on the module. 0-1 0
DN ( v1.x80*)
Networking
{Identification}
Destination Node. Resolves an NI (Node Identifier) string to a physical address. The
following events occur upon successful command execution:
1. DL and DH are set to the address of the module with the matching Node Identifier.
2. “OK” is returned.
3. RF module automatically exits AT Command Mode
If there is no response from a module within 200 msec or a parameter is not specified
(left blank), the command is terminated and an “ERROR” message is returned.
20-character ASCII string -
CE ( v1.x80*)
Networking
{Association}
Coordinator Enable. Set/Read the coordinator setting.
0 - 1
0 = End Device
1 = Coordinator
0
SC ( v1.x80*)
Networking
{Association}
Scan Channels. Set/Read list of channels to scan for all Active and Energy Scans as a
bitfield. This affects scans initiated in command mode (AS, ED) and during End Device
Association and Coordinator startup:
bit 0 - 0x0B bit 4 - 0x0F bit 8 - 0x13 bit12 - 0x17
bit 1 - 0x0C bit 5 - 0x10 bit 9 - 0x14 bit13 - 0x18
bit 2 - 0x0D bit 6 - 0x11 bit 10 - 0x15 bit14 - 0x19
bit 3 - 0x0E bit 7 - 0x12 bit 11 - 0x16 bit 15 - 0x1A
0 - 0xFFFF [bitfield]
(bits 0, 14, 15 not allowed on
the XBee-PRO)
0x1FFE
(all XBee-
PRO
Channels)
SD ( v1.x80*)
Networking
{Association}
Scan Duration. Set/Read the scan duration exponent.
End Device - Duration of Active Scan during Association.
Coordinator - If ‘ReassignPANID’ option is set on Coordinator [refer to A2 parameter],
SD determines the length of time the Coordinator will scan channels to locate existing
PANs. If ‘ReassignChannel’ option is set, SD determines how long the Coordinator will
perform an Energy Scan to determine which channel it will operate on.
‘Scan Time’ is measured as (# of channels to scan] * (2 ^ SD) * 15.36ms). The number
of channels to scan is set by the SC command. The XBee can scan up to 16 channels
(SC = 0xFFFF). The XBee PRO can scan up to 13 channels (SC = 0x3FFE).
Example: The values below show results for a 13 channel scan:
If SD = 0, time = 0.18 sec SD = 8, time = 47.19 sec
SD = 2, time = 0.74 sec SD = 10, time = 3.15 min
SD = 4, time = 2.95 sec SD = 12, time = 12.58 min
SD = 6, time = 11.80 sec SD = 14, time = 50.33 min
0-0x0F [exponent] 4
A1 ( v1.x80*)
Networking
{Association}
End Device Association. Set/Read End Device association options.
bit 0 - ReassignPanID
0 - Will only associate with Coordinator operating on PAN ID that matches module ID
1 - May associate with Coordinator operating on any PAN ID
bit 1 - ReassignChannel
0 - Will only associate with Coordinator operating on matching CH Channel setting
1 - May associate with Coordinator operating on any Channel
bit 2 - AutoAssociate
0 - Device will not attempt Association
1 - Device attempts Association until success
Note: This bit is used only for Non-Beacon systems. End Devices in Beacon-enabled
system must always associate to a Coordinator
bit 3 - PollCoordOnPinWake
0 - Pin Wake will not poll the Coordinator for indirect (pending) data
1 - Pin Wake will send Poll Request to Coordinator to extract any pending data
bits 4 - 7 are reserved
0 - 0x0F [bitfield] 0
A2 ( v1.x80*)
Networking
{Association}
Coordinator Association. Set/Read Coordinator association options.
bit 0 - ReassignPanID
0 - Coordinator will not perform Active Scan to locate available PAN ID. It will operate
on ID (PAN ID).
1 - Coordinator will perform Active Scan to determine an available ID (PAN ID). If a
PAN ID conflict is found, the ID parameter will change.
bit 1 - ReassignChannel -
0 - Coordinator will not perform Energy Scan to determine free channel. It will operate
on the channel determined by the CH parameter.
1 - Coordinator will perform Energy Scan to find a free channel, then operate on that
channel.
bit 2 - AllowAssociation -
0 - Coordinator will not allow any devices to associate to it.
1 - Coordinator will allow devices to associate to it.
bits 3 - 7 are reserved
0 - 7 [bitfield] 0
Tabl e3‐02. XBee®/XBee‐PRO®Com mands‐Networking&Security(Sub‐categoriesdesignatedwithin{brackets})
AT
Command
Command
Category
Name and Description Parameter Range Default