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. 14
Flow Control
Figure2‐03. InternalDataFlowDiagram
DI (Data In) Buffer
When serial data enters the RF module through the DI pin (pin 3), the data is stored in the DI Buf-
fer until it can be processed.
Hardware Flow Control (CTS
). When the DI buffer is 17 bytes away from being full; by default,
the module de-asserts CTS
(high) to signal to the host device to stop sending data [refer to D7
(DIO7 Configuration) parameter]. CTS
is re-asserted after the DI Buffer has 34 bytes of memory
available.
How to eliminate the need for flow control:
Case in which the DI Buffer may become full and possibly overflow:
Refer to the RO (Packetization Timeout), BD (Interface Data Rate) and D7 (DIO7 Configuration) com-
mand descriptions for more information.
DO (Data Out) Buffer
When RF data is received, the data enters the DO buffer and is sent out the serial port to a host
device. Once the DO Buffer reaches capacity, any additional incoming RF data is lost.
Hardware Flow Control (RTS
). If RTS is enabled for flow control (D6 (DIO6 Configuration)
Parameter = 1), data will not be sent out the DO Buffer as long as RTS
(pin 16) is de-asserted.
Two cases in which the DO Buffer may become full and possibly overflow:
Refer to the D6 (DIO6 Configuration) command description for more information.
1. Send messages that are smaller than the DI buffer size (202 bytes).
2. Interface at a lower baud rate [BD (Interface Data Rate) parameter] than the throughput
data rate.
If the module is receiving a continuous stream of RF data, any serial data that arrives on the DI
pin is placed in the DI Buffer. The data in the DI buffer will be transmitted over-the-air when the
module is no longer receiving RF data in the network.
1. If the RF data rate is set higher than the interface data rate of the module, the module will
receive data from the transmitting module faster than it can send the data to the host.
2. If the host does not allow the module to transmit data out from the DO buffer because of
being held off by hardware or software flow control.