Xbee /Xbee-Pro Oem RF Modules: Product Manual - 802.15.4 Protocol

XBee/XBee-PRO OEM RF Modules
XBee/XBee-PRO OEM RF Modules RF Module Operation RF Module Configuration Appendices
Product Manual v1.xCx - 802.15.4 Protocol

For OEM RF Module Part Numbers: XB24-...-001, XBP24-...-001
IEEE 802.15.4 OEM RF Modules by Digi International
Digi International Inc. 11001 Bren Road East Minnetonka, MN 55343 877 912-3444 or 952 912-3444 http://www.digi.com
90000982_A 2008.09.04
XBee/XBeePROOEMRFModules802.15.4v1.xCx[2008.09.04]
2008 Digi International, Inc. All rights reserved

Thecontentsofthismanualmaynotbetransmittedorreproducedinanyformor byanymeanswithoutthewrittenpermissionofDigi,Inc. XBeeandXBeePROareregisteredtrademarksofDigi,Inc.
Phone:(801)7659885 LiveChat:www.digi.com OnlineSupport:http://www.digi.com/supporteservice/eservicelogin.jsp
2008DigiInternational,Inc.
ii
Contents
1. XBee/XBee-PRO OEM RF Modules Key Features Specifications 4 4 6 6 8 9 9 10 5 4 API Frame Specifications API Types 57 63 4. Agency Certifications United States (FCC) FCC Notices Europe (ETSI) Restrictions 63 64 66 66 66 66 67 67 67 68 63 63 56 Worldwide Acceptance Mechanical Drawings Pin Signals 7
OEM Labeling Requirements
Mounting Considerations Electrical Characteristics 2. RF Module Operation Serial Communications UART Data Flow API Operation Flow Control 9 Transparent Operation 10 11
FCC-Approved Antennas (2.4 GHz) OEM Labeling Requirements Declarations of Conformity Approved Antennas Canada (IC) Japan 67 67
Labeling Requirements 12 Labeling Requirements 5. Additional Information 1-Year Warranty 13 13 14 15 15 19 Contact Digi 69 68
ADC and Digital I/O Line Support I/O Data Format API Support 13 13 Sleep Support 12
DIO Pin Change Detect Sample Rate (Interval) I/O Line Passing 14 Configuration Example Peer-to-Peer Association Unicast Mode 15 16 19 19 20
Ordering Information
68
XBee/XBee-PRO Networks NonBeacon (w/ Coordinator) XBee/XBee-PRO Addressing Broadcast Mode Idle Mode Sleep Mode 20 20 22 24
Modes of Operation
Transmit/Receive Modes Command Mode
3. RF Module Configuration Programming the RF Module Programming Examples 25 26 26 26 26 26 25
25
Remote Configuration Commands Sending a Remote Command Applying Changes on Remote Remote Command Responses Command Reference Tables Command Descriptions API Operation 56 35
2008DigiInternational,Inc.
iii
1.XBee/XBeePROOEMRFModules
The XBee and XBee-PRO OEM RF Modules were engineered to meet IEEE 802.15.4 standards and support the unique needs of low-cost, low-power wireless sensor networks. The modules require minimal power and provide reliable delivery of data between devices. The modules operate within the ISM 2.4 GHz frequency band and are pin-for-pin compatible with each other.
Key Features
Long Range Data Integrity XBee Indoor/Urban: up to 100 (30 m) Outdoor line-of-sight: up to 300 (90 m) Transmit Power: 1 mW (0 dBm) Receiver Sensitivity: -92 dBm XBee-PRO Indoor/Urban: up to 300 (90 m), 200' (60 m) for International variant Outdoor line-of-sight: up to 1 mile (1600 m), 2500' (750 m) for International variant Transmit Power: 63mW (18dBm), 10mW (10dBm) for International variant Receiver Sensitivity: -100 dBm RF Data Rate: 250,000 bps Advanced Networking & Security Retries and Acknowledgements DSSS (Direct Sequence Spread Spectrum) Each direct sequence channels has over 65,000 unique network addresses available Source/Destination Addressing Unicast & Broadcast Communications Point-to-point, point-to-multipoint and peer-to-peer topologies supported Low Power XBee TX Peak Current: 45 mA (@3.3 V) RX Current: 50 mA (@3.3 V) Power-down Current: < 10 A XBee-PRO TX Peak Current: 250mA (150mA for international variant) TX Peak Current (RPSMA module only): 340mA (180mA for international variant RX Current: 55 mA (@3.3 V) Power-down Current: < 10 A ADC and I/O line support Analog-to-digital conversion, Digital I/O I/O Line Passing Easy-to-Use No configuration necessary for out-of box RF communications Free X-CTU Software (Testing and configuration software) AT and API Command Modes for configuring module parameters Extensive command set Small form factor
Worldwide Acceptance
FCC Approval (USA) Refer to Appendix A [p63] for FCC Requirements. Systems that contain XBee/XBee-PRO RF Modules inherit Digi Certifications. ISM (Industrial, Scientific & Medical) 2.4 GHz frequency band Manufactured under ISO 9001:2000 registered standards XBee/XBee-PRO RF Modules aare optimized for use in the United States, Canada, Australia, Israel, Japan, and Europe. Contact Digi for complete list of government agency approvals.
2008DigiInternationalInc.
Specifications
Table101. SpecificationsoftheXBee/XBeePROOEMRFModules XBee XBee-PRO Specification Performance Indoor/Urban Range Outdoor RF line-of-sight Range Transmit Power Output (software selectable) RF Data Rate Serial Interface Data Rate (software selectable) Receiver Sensitivity Power Requirements Supply Voltage Transmit Current (typical) Idle / Receive Current (typical) Power-down Current General Operating Frequency Dimensions Operating Temperature Antenna Options Networking & Security Supported Network Topologies Number of Channels (software selectable) Addressing Options Agency Approvals United States (FCC Part 15.247) Industry Canada (IC) Europe (CE) Japan Austraila OUR-XBEE 4214A XBEE ETSI R201WW07215214 C-Tick OUR-XBEEPRO 4214A XBEEPRO ETSI (Max. 10 dBm transmit power output)* R201WW08215111" (Max. 10 dBm transmit power output)** C-Tick Point-to-point, Point-to-multipoint & Peer-to-peer 16 Direct Sequence Channels PAN ID, Channel and Addresses 12 Direct Sequence Channels PAN ID, Channel and Addresses ISM 2.4 GHz 0.960 x 1.087 (2.438cm x 2.761cm) -40 to 85 C (industrial) Integrated Whip, Chip or U.FL Connector, RPSMA Connector ISM 2.4 GHz 0.960 x 1.297 (2.438cm x 3.294cm) -40 to 85 C (industrial) Integrated Whip, Chip or U.FL Connector, RPSMA Connector 2.8 3.4 V 45mA (@ 3.3 V) 50mA (@ 3.3 V) < 10 A 2.8 3.4 V 250mA (@3.3 V) (150mA for international variant) RPSMA module only: 340mA (@3.3 V) (180mA for international variant) 55mA (@ 3.3 V) < 10 A Up to 100 ft (30 m) Up to 300 ft (90 m) 1mW (0 dBm) 250,000 bps 1200 bps - 250 kbps (non-standard baud rates also supported) -92 dBm (1% packet error rate) Up to 300 ft. (90 m), up to 200 ft (60 m) International variant Up to 1 mile (1600 m), up to 2500 ft (750 m) international variant 63mW (18dBm)* 10mW (10 dBm) for International variant 250,000 bps 1200 bps - 250 kbps (non-standard baud rates also supported) -100 dBm (1% packet error rate)
*WhenoperatinginEurope,XBeePRO802.15.4modulesmustoperateatorbelowatransmitpoweroutputlevelof10dBm. Customershavetwochoicesfortransmittingatorbelow10dBm: a.OrderthestandardXBeePROmoduleandchangethePLcommandto0(10dBm), b.OrdertheInternationalvariantoftheXBeePROmodule,whichhasamaximumtransmitoutputpowerof10dBm(@PL=4). Additionally,EuropeanregulationsstipulateanEIRPpowermaximumof12.86dBm(19mW)fortheXBeePROand12.11dBm fortheXBeewhenintegratingantennas. **WhenoperatinginJapan,onlytheInternationalvariantoftheXBeePRO802.15.4moduleisapprovedforuse. Antenna Options: The ranges specified are typical when using the integrated Whip (1.5 dBi) and Dipole (2.1 dBi) antennas. The Chip antenna option provides advantages in its form factor; however, it typically yields shorter range than the
2008DigiInternatonal,Inc.
Whip and Dipole antenna options when transmitting outdoors.For more information, refer to the "XBee Antennas" Knowledgebase Article located on Digi's Support Web site
Mechanical Drawings
Figure101. MechanicaldrawingsoftheXBee/XBeePROOEMRFModules(antennaoptionsnotshown) TheXBeeandXBeePRORFModulesarepinforpincompatible.
Mounting Considerations
The XBee/XBee-PRO RF Module was designed to mount into a receptacle (socket) and therefore does not require any soldering when mounting it to a board. The XBee Development Kits contain RS-232 and USB interface boards which use two 20-pin receptacles to receive modules. Figure102. XBeeModuleMountingtoanRS232InterfaceBoard.
The receptacles used on Digi development boards are manufactured by Century Interconnect. Several other manufacturers provide comparable mounting solutions; however, Digi currently uses the following receptacles: Through-hole single-row receptacles Samtec P/N: MMS-110-01-L-SV (or equivalent) Surface-mount double-row receptacles Century Interconnect P/N: CPRMSL20-D-0-1 (or equivalent) Surface-mount single-row receptacles Samtec P/N: SMM-110-02-SM-S Digi also recommends printing an outline of the module on the board to indicate the orientation the module should be mounted.
Pin Signals
Figure103. XBee/XBeePRORFModulePin Numbers (topsidesshownshieldsonbottom)
Pin 1 Pin 20 Pin 10 Pin 10 Pin 11 Pin 11 Pin 1 Pin 20
Table102. Pin # 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
PinAssignmentsfortheXBeeandXBeePROModules (Lowassertedsignalsaredistinguishedwithahorizontallineabovesignalname.) Name VCC DOUT DIN / CONFIG DO8* RESET PWM0 / RSSI PWM1 [reserved] DTR / SLEEP_RQ / DI8 GND AD4 / DIO4 CTS / DIO7 ON / SLEEP VREF Associate / AD5 / DIO5 RTS / AD6 / DIO6 AD3 / DIO3 AD2 / DIO2 AD1 / DIO1 AD0 / DIO0 Direction Output Input Output Input Output Output Input Either Either Output Input Either Either Either Either Either Either Description Power supply UART Data Out UART Data In Digital Output 8 Module Reset (reset pulse must be at least 200 ns) PWM Output 0 / RX Signal Strength Indicator PWM Output 1 Do not connect Pin Sleep Control Line or Digital Input 8 Ground Analog Input 4 or Digital I/O 4 Clear-to-Send Flow Control or Digital I/O 7 Module Status Indicator Voltage Reference for A/D Inputs Associated Indicator, Analog Input 5 or Digital I/O 5 Request-to-Send Flow Control, Analog Input 6 or Digital I/O 6 Analog Input 3 or Digital I/O 3 Analog Input 2 or Digital I/O 2 Analog Input 1 or Digital I/O 1 Analog Input 0 or Digital I/O 0
*Functionisnotsupportedatthetimeofthisrelease Design Notes: Minimum connections: VCC, GND, DOUT & DIN Minimum connections for updating firmware: VCC, GND, DIN, DOUT, RTS & DTR Signal Direction is specified with respect to the module Module includes a 50k pull-up resistor attached to RESET Several of the input pull-ups can be configured using the PR command Unused pins should be left disconnected
Electrical Characteristics
Table103. Symbol VIL VIH VOL VOH IIIN IIOZ TX RX PWR-DWN Table104. Symbol VREFH IREF VINDC DCCharacteristics(VCC=2.83.4VDC) Characteristic Input Low Voltage Input High Voltage Output Low Voltage Output High Voltage Input Leakage Current High Impedance Leakage Current Transmit Current Receive Current Power-down Current ADCCharacteristics(Operating) Characteristic VREF - Analog-to-Digital converter reference range VREF - Reference Supply Current Analog Input Voltage1 Condition Min 2.08 Enabled Disabled or Sleep Mode VSSAD - 0.3 Typical 200 < 0.01 Max VDDAD 0.02 VDDAD + 0.3 Unit V A A V Condition All Digital Inputs All Digital Inputs IOL = 2 mA, VCC >= 2.7 V IOH = -2 mA, VCC >= 2.7 V VIN = VCC or GND, all inputs, per pin VIN = VCC or GND, all I/O High-Z, per pin VCC = 3.3 V VCC = 3.3 V SM parameter = 1 Min 0.7 * VCC VCC - 0.5 Typical 0.025 0.025 215, 140 45 (PRO, (XBee) Int) 50 55 (XBee) (PRO) < 10 Max 0.35 * VCC 0.5 1 1 Unit V V V V A A mA mA A
1. Maximumelectricaloperatingrange,notvalidconversionrange. Table105. Symbol RAS VAIN RES DNL INL EZS FFS EIL ETU ADCTiming/PerformanceCharacteristics1 Characteristic Source Impedance at Input2 Analog Input Voltage3 Ideal Resolution (1 LSB)4 Differential Non-linearity5 Integral Non-linearity6 Zero-scale Error7 Full-scale Error8 Input Leakage Error
9
Condition
Min VREFL
Typical 0.5 0.5 0.4 0.4 0.05 1.1
Max
10
Unit k V mV LSB LSB LSB LSB LSB LSB
VREFH 3.516 1.0 1.0 1.0 1.0 5.0 2.5
2.08V < VDDAD < 3.6V
2.031 -
Total Unadjusted Error10
1. AllACCURACYnumbersarebasedonprocessorandsystembeinginWAITstate(verylittleactivityandnoIOswitching) andthatadequatelowpassfilteringispresentonanaloginputpins(filterwith0.01Fto0.1Fcapacitorbetweenanalog inputandVREFL).Failuretoobservetheseguidelinesmayresultinsystemormicrocontrollernoisecausingaccuracyerrors whichwillvarybasedonboardlayoutandthetypeandmagnitudeoftheactivity. Datatransmissionandreceptionduringdataconversionmaycausesomedegradationofthesespecifications,dependingon thenumberandtimingofpackets.ItisadvisabletotesttheADCsinyourinstallationifbestaccuracyisrequired. 2. RASistherealportionoftheimpedanceofthenetworkdrivingtheanaloginputpin.Valuesgreaterthanthisamountmay notfullychargetheinputcircuitryoftheATDresultinginaccuracyerror. 3. AnaloginputmustbebetweenVREFLandVREFHforvalidconversion.ValuesgreaterthanVREFHwillconvertto$3FF. 4. Theresolutionistheidealstepsizeor1LSB=(VREFHVREFL)/1024 5. Differentialnonlinearityisthedifferencebetweenthecurrentcodewidthandtheidealcodewidth(1LSB).Thecurrent codewidthisthedifferenceinthetransitionvoltagestoandfromthecurrentcode. 6. Integralnonlinearityisthedifferencebetweenthetransitionvoltagetothecurrentcodeandtheadjustedidealtransition voltageforthecurrentcode.Theadjustedidealtransitionvoltageis(CurrentCode1/2)*(1/((VREFH+EFS)(VREFL+EZS))). 7. Zeroscaleerroristhedifferencebetweenthetransitiontothefirstvalidcodeandtheidealtransitiontothatcode.The Idealtransitionvoltagetoagivencodeis(Code1/2)*(1/(VREFHVREFL)). 8. Fullscaleerroristhedifferencebetweenthetransitiontothelastvalidcodeandtheidealtransitiontothatcode.Theideal transitionvoltagetoagivencodeis(Code1/2)*(1/(VREFHVREFL)). 9. Inputleakageerroriserrorduetoinputleakageacrosstherealportionoftheimpedanceofthenetworkdrivingtheanalog pin.Reducingtheimpedanceofthenetworkreducesthiserror. 10. Totalunadjustederroristhedifferencebetweenthetransitionvoltagetothecurrentcodeandtheidealstraightlinetrans ferfunction.Thismeasureoferrorincludesinherentquantizationerror(1/2LSB)andcircuiterror(differential,integral,zero scale,andfullscale)error.ThespecifiedvalueofETUassumeszeroEIL(noleakageorzerorealsourceimpedance).
2.RFModuleOperation
Serial Communications
The XBee/XBee-PRO OEM RF Modules interface to a host device through a logic-level asynchronous serial port. Through its serial port, the module can communicate with any logic and voltage compatible UART; or through a level translator to any serial device (For example: Through a Digi proprietary RS-232 or USB interface board).
UART Data Flow

Devices that have a UART interface can connect directly to the pins of the RF module as shown in the figure below. Figure201. SystemDataFlowDiagraminaUARTinterfacedenvironment (Lowassertedsignalsdistinguishedwithhorizontallineoversignalname.)
Serial Data Data enters the module UART through the DI pin (pin 3) as an asynchronous serial signal. The signal should idle high when no data is being transmitted. Each data byte consists of a start bit (low), 8 data bits (least significant bit first) and a stop bit (high). The following figure illustrates the serial bit pattern of data passing through the module. Figure202. UARTdatapacket0x1F(decimalnumber31)astransmittedthroughtheRFmodule ExampleDataFormatis8N1(bitsparity#ofstopbits)
The module UART performs tasks, such as timing and parity checking, that are needed for data communications. Serial communications depend on the two UARTs to be configured with compatible settings (baud rate, parity, start bits, stop bits, data bits).
Transparent Operation
By default, XBee/XBee-PRO RF Modules operate in Transparent Mode. When operating in this mode, the modules act as a serial line replacement - all UART data received through the DI pin is queued up for RF transmission. When RF data is received, the data is sent out the DO pin. Serial-to-RF Packetization Data is buffered in the DI buffer until one of the following causes the data to be packetized and transmitted: 1. 2. 3. No serial characters are received for the amount of time determined by the RO (Packetization Timeout) parameter. If RO = 0, packetization begins when a character is received. The maximum number of characters that will fit in an RF packet (100) is received. The Command Mode Sequence (GT + CC + GT) is received. Any character buffered in the DI buffer before the sequence is transmitted.
If the module cannot immediately transmit (for instance, if it is already receiving RF data), the serial data is stored in the DI Buffer. The data is packetized and sent at any RO timeout or when 100 bytes (maximum packet size) are received. If the DI buffer becomes full, hardware or software flow control must be implemented in order to prevent overflow (loss of data between the host and module).
API Operation
API (Application Programming Interface) Operation is an alternative to the default Transparent Operation. The frame-based API extends the level to which a host application can interact with the networking capabilities of the module. When in API mode, all data entering and leaving the module is contained in frames that define operations or events within the module. Transmit Data Frames (received through the DI pin (pin 3)) include: RF Transmit Data Frame Command Frame (equivalent to AT commands) Receive Data Frames (sent out the DO pin (pin 2)) include: RF-received data frame Command response Event notifications such as reset, associate, disassociate, etc. The API provides alternative means of configuring modules and routing data at the host application layer. A host application can send data frames to the module that contain address and payload information instead of using command mode to modify addresses. The module will send data frames to the application containing status packets; as well as source, RSSI and payload information from received data packets. The API operation option facilitates many operations such as the examples cited below: -> Transmitting data to multiple destinations without entering Command Mode -> Receive success/failure status of each transmitted RF packet -> Identify the source address of each received packet
To implement API operations, refer to API sections [p56].
10
Flow Control
Figure203. 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 Buffer 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: 1. 2. Send messages that are smaller than the DI buffer size (202 bytes). Interface at a lower baud rate [BD (Interface Data Rate) parameter] than the throughput data rate.
Case in which the DI Buffer may become full and possibly overflow: 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.
Refer to the RO (Packetization Timeout), BD (Interface Data Rate) and D7 (DIO7 Configuration) command 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: 1. 2. 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. 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.
Refer to the D6 (DIO6 Configuration) command description for more information.
11
ADC and Digital I/O Line Support

The XBee/XBee-PRO RF Modules support ADC (Analog-to-digital conversion) and digital I/O line passing. The following pins support multiple functions: Table201. Pinfunctionsandtheirassociatedpinnumbersandcommands AD=AnalogtoDigitalConverter,DIO=DigitalInput/Output Pinfunctionsnotapplicabletothissectionaredenotedwithin(parenthesis). Pin Function AD0 / DIO0 AD1 / DIO1 AD2 / DIO2 AD3 / DIO3 / (COORD_SEL) AD4 / DIO4 AD5 / DIO5 / (ASSOCIATE) DIO6 / (RTS) DIO7 / (CTS) DI8 / (DTR) / (Sleep_RQ) To enable ADC and DIO pin functions: For ADC Support: For Digital Input support: For Digital Output Low support: For Digital Output High support: Set ATDn = 2 Set ATDn = 3 Set ATDn = 4 Set ATDn = 5 Pin# 20 19 18 17 11 15 16 12 9 AT Command D0 D1 D2 D3 D4 D5 D6 D7 D8
I/O Data Format

I/O data begins with a header. The first byte of the header defines the number of samples forthcoming. The last 2 bytes of the header (Channel Indicator) define which inputs are active. Each bit represents either a DIO line or ADC channel. Figure204. Header
Header
Byte 1 Bytes 2 - 3 (Channel Indicator)
Total number of samples
na
bit 15
A5
A4
A3
A2
A1
A0
D8
D7
D6
D5
D4
D3
D2
D1
D0
bit 0
Bit set to 1 if channel is active
Sample data follows the header and the channel indicator frame is used to determine how to read the sample data. If any of the DIO lines are enabled, the first 2 bytes are the DIO sample. The ADC data follows. ADC channel data is represented as an unsigned 10-bit value right-justified on a 16- bit boundary. Figure205. SampleData
Sample Data
DIO Line Data is first (if enabled) ADC Line Data
ADCn MSB
ADCn LSB
12
API Support
I/O data is sent out the UART using an API frame. All other data can be sent and received using Transparent Operation [refer to p10] or API framing if API mode is enabled (AP > 0). API Operations support two RX (Receive) frame identifiers for I/O data (set 16-bit address to 0xFFFE and the module will do 64-bit addressing): 0x82 for RX (Receive) Packet: 64-bit address I/O 0x83 for RX (Receive) Packet: 16-bit address I/O The API command header is the same as shown in the RX (Receive) Packet: 64-bit Address and RX (Receive) Packet: 64-bit Address API types [refer to p62]. RX data follows the format described in the I/O Data Format section [p12]. Applicable Commands: AP (API Enable)
Sleep Support
Automatic wakeup sampling can be suppressed by setting SO bit 1.When an RF module wakes, it will always do a sample based on any active ADC or DIO lines. This allows sampling based on the sleep cycle whether it be Cyclic Sleep (SM parameter = 4 or 5) or Pin Sleep (SM = 1 or 2). To gather more samples when awake, set the IR (Sample Rate) parameter. For Cyclic Sleep modes: If the IR parameter is set, the module will stay awake until the IT (Samples before TX) parameter is met. The module will stay awake for ST (Time before Sleep) time. Applicable Commands: IR (Sample Rate), IT (Samples before TX), SM (Sleep Mode), IC (DIO Change Detect), SO (Sleep Options)
DIO Pin Change Detect

When DIO Change Detect is enabled (using the IC command), DIO lines 0-7 are monitored. When a change is detected on a DIO line, the following will occur: 1. 2. An RF packet is sent with the updated DIO pin levels. This packet will not contain any ADC samples. Any queued samples are transmitted before the change detect data. This may result in receiving a packet with less than IT (Samples before TX) samples.
Note: Change detect will not affect Pin Sleep wake-up. The D8 pin (DTR/Sleep_RQ/DI8) is the only line that will wake a module from Pin Sleep. If not all samples are collected, the module will still enter Sleep Mode after a change detect packet is sent. Applicable Commands: IC (DIO Change Detect), IT (Samples before TX) NOTE: Change detect is only supported when the Dx (DIOx Configuration) parameter equals 3,4 or 5.
Sample Rate (Interval)

The Sample Rate (Interval) feature allows enabled ADC and DIO pins to be read periodically on modules that are not configured to operate in Sleep Mode. When one of the Sleep Modes is enabled and the IR (Sample Rate) parameter is set, the module will stay awake until IT (Samples before TX) samples have been collected. Once a particular pin is enabled, the appropriate sample rate must be chosen. The maximum sample rate that can be achieved while using one A/D line is 1 sample/ms or 1 KHz (Note that the modem will not be able to keep up with transmission when IR & IT are equal to 1 and that configuring the modem to sample at rates greater than once every 20ms is not recommended). Applicable Commands: IR (Sample Rate), IT (Samples before TX), SM (Sleep Mode)
13
I/O Line Passing

Virtual wires can be set up between XBee/XBee-PRO Modules. When an RF data packet is received that contains I/O data, the receiving module can be setup to update any enabled outputs (PWM and DIO) based on the data it receives. Note that I/O lines are mapped in pairs. For example: AD0 can only update PWM0 and DI5 can only update DO5. The default setup is for outputs not to be updated, which results in the I/O data being sent out the UART (refer to the IU (Enable I/O Output) command). To enable the outputs to be updated, the IA (I/O Input Address) parameter must be setup with the address of the module that has the appropriate inputs enabled. This effectively binds the outputs to a particular modules input. This does not affect the ability of the module to receive I/O line data from other modules only its ability to update enabled outputs. The IA parameter can also be setup to accept I/O data for output changes from any module by setting the IA parameter to 0xFFFF. When outputs are changed from their non-active state, the module can be setup to return the output level to it non-active state. The timers are set using the Tn (Dn Output Timer) and PT (PWM Output Timeout) commands. The timers are reset every time a valid I/O packet (passed IA check) is received. The IC (Change Detect) and IR (Sample Rate) parameters can be setup to keep the output set to their active output if the system needs more time than the timers can handle. Note: DI8 cannot be used for I/O line passing. Applicable Commands: IA (I/O Input Address), Tn (Dn Output Timeout), P0 (PWM0 Configuration), P1 (PWM1 Configuration), M0 (PWM0 Output Level), M1 (PWM1 Output Level), PT (PWM Output Timeout), RP (RSSSI PWM Timer)
Configuration Example
As an example for a simple A/D link, a pair of RF modules could be set as follows: Remote Configuration DL = 0x1234 MY = 0x5678 D0 = 2 D1 = 2 IR = 0x14 IT = 5 Base Configuration DL = 0x5678 MY = 0x1234 P0 = 2 P1 = 2 IU = 1 IA = 0x5678 (or 0xFFFF)
These settings configure the remote module to sample AD0 and AD1 once each every 20 ms. It then buffers 5 samples each before sending them back to the base module. The base should then receive a 32-Byte transmission (20 Bytes data and 12 Bytes framing) every 100 ms.
14
XBee/XBee-PRO Networks
The following terms will be used to explicate the network operations: Table202. Term PAN Coordinator End Device Association Termsanddefinitions Definition Personal Area Network - A data communication network that includes one or more End Devices and optionally a Coordinator. A Full-function device (FFD) that provides network synchronization by polling nodes [NonBeacon (w/ Coordinator) networks only] When in the same network as a Coordinator - RF modules that rely on a Coordinator for synchronization and can be put into states of sleep for low-power applications. The establishment of membership between End Devices and a Coordinator. Association is only applicable in NonBeacon (w/Coordinator) networks.
Peer-to-Peer
By default, XBee/XBee-PRO RF Modules are configured to operate within a Peer-to-Peer network topology and therefore are not dependent upon Master/Slave relationships.NonBeacon systems operate within a Peer-to-Peer network topology and therefore are not dependent upon Master/ Slave relationships. This means that modules remain synchronized without use of master/server configurations and each module in the network shares both roles of master and slave. Digi's peerto-peer architecture features fast synchronization times and fast cold start times. This default configuration accommodates a wide range of RF data applications. Figure206. PeertoPeerArchitecture
A peer-to-peer network can be established by configuring each module to operate as an End Device (CE = 0), disabling End Device Association on all modules (A1 = 0) and setting ID and CH parameters to be identical across the network.
NonBeacon (w/ Coordinator)

A device is configured as a Coordinator by setting the CE (Coordinator Enable) parameter to 1. Coordinator power-up is governed by the A2 (Coordinator Association) parameter. In a Coordinator system, the Coordinator can be configured to use direct or indirect transmissions. If the SP (Cyclic Sleep Period) parameter is set to 0, the Coordinator will send data immediately. Otherwise, the SP parameter determines the length of time the Coordinator will retain the data before discarding it. Generally, SP (Cyclic Sleep Period) and ST (Time before Sleep) parameters should be set to match the SP and ST settings of the End Devices.
15
Association
Association is the establishment of membership between End Devices and a Coordinator. The establishment of membership is useful in scenarios that require a central unit (Coordinator) to relay messages to or gather data from several remote units (End Devices), assign channels or assign PAN IDs. An RF data network that consists of one Coordinator and one or more End Devices forms a PAN (Personal Area Network). Each device in a PAN has a PAN Identifier [ID (PAN ID) parameter]. PAN IDs must be unique to prevent miscommunication between PANs. The Coordinator PAN ID is set using the ID (PAN ID) and A2 (Coordinator Association) commands. An End Device can associate to a Coordinator without knowing the address, PAN ID or channel of the Coordinator. The A1 (End Device Association) parameter bit fields determine the flexibility of an End Device during association. The A1 parameter can be used for an End Device to dynamically set its destination address, PAN ID and/or channel. For example: If the PAN ID of a Coordinator is known, but the operating channel is not; the A1 command on the End Device should be set to enable the Auto_Associate and Reassign_Channel bits. Additionally, the ID parameter should be set to match the PAN ID of the associated Coordinator. Coordinator / End Device Setup and Operation To configure a module to operate as a Coordinator, set the CE (Coordinator Enable) parameter to 1. Set the CE parameter of End Devices to 0 (default). Coordinator and End Devices should contain matching firmware versions. NonBeacon (w/ Coordinator) Systems The Coordinator can be configured to use direct or indirect transmissions. If the SP (Cyclic Sleep Period) parameter is set to 0, the Coordinator will send data immediately. Otherwise, the SP parameter determines the length of time the Coordinator will retain the data before discarding it. Generally, SP (Cyclic Sleep Period) and ST (Time before Sleep) parameters should be set to match the SP and ST settings of the End Devices. Coordinator Start-up Coordinator power-up is governed by the A2 (Coordinator Association) command. On power-up, the Coordinator undergoes the following sequence of events: 1. Check A2 parameter- Reassign_PANID Flag Set (bit 0 = 1) - The Coordinator issues an Active Scan. The Active Scan selects one channel and transmits a request to the broadcast address (0xFFFF) and broadcast PAN ID (0xFFFF). It then listens on that channel for beacons from any Coordinator operating on that channel. The listen time on each channel is determined by the SD (Scan Duration) parameter value. Once the time expires on that channel, the Active Scan selects another channel and again transmits the BeaconRequest as before. This process continues until all channels have been scanned, or until 5 PANs have been discovered. When the Active Scan is complete, the results include a list of PAN IDs and Channels that are being used by other PANs. This list is used to assign an unique PAN ID to the new Coordinator. The ID parameter will be retained if it is not found in the Active Scan results. Otherwise, the ID (PAN ID) parameter setting will be updated to a PAN ID that was not detected. Not Set (bit 0 = 0) - The Coordinator retains its ID setting. No Active Scan is performed.
16
2. Check A2 parameter - Reassign_Channel Flag (bit 1) Set (bit 1 = 1) - The Coordinator issues an Energy Scan. The Energy Scan selects one channel and scans for energy on that channel. The duration of the scan is specified by the SD (Scan Duration) parameter. Once the scan is completed on a channel, the Energy Scan selects the next channel and begins a new scan on that channel. This process continues until all channels have been scanned. When the Energy Scan is complete, the results include the maximal energy values detected on each channel. This list is used to determine a channel where the least energy was detected. If an Active Scan was performed (Reassign_PANID Flag set), the channels used by the detected PANs are eliminated as possible channels. Thus, the results of the Energy Scan and the Active Scan (if performed) are used to find the best channel (channel with the least energy that is not used by any detected PAN). Once the best channel has been selected, the CH (Channel) parameter value is updated to that channel. Not Set (bit 1 = 0) - The Coordinator retains its CH setting. An Energy Scan is not performed. 3. Start Coordinator The Coordinator starts on the specified channel (CH parameter) and PAN ID (ID parameter). Note, these may be selected in steps 1 and/or 2 above. The Coordinator will only allow End Devices to associate to it if the A2 parameter AllowAssociation flag is set. Once the Coordinator has successfully started, the Associate LED will blink 1 time per second. (The LED is solid if the Coordinator has not started.) 4. Coordinator Modifications Once a Coordinator has started: Modifying the A2 (Reassign_Channel or Reassign_PANID bits), ID, CH or MY parameters will cause the Coordinators MAC to reset (The Coordinator RF module (including volatile RAM) is not reset). Changing the A2 AllowAssociation bit will not reset the Coordinators MAC. In a nonbeaconing system, End Devices that associated to the Coordinator prior to a MAC reset will have knowledge of the new settings on the Coordinator. Thus, if the Coordinator were to change its ID, CH or MY settings, the End Devices would no longer be able to communicate with the nonbeacon Coordinator. Once a Coordinator has started, the ID, CH, MY or A2 (Reassign_Channel or Reassign_PANID bits) should not be changed. End Device Start-up End Device power-up is governed by the A1 (End Device Association) command. On power-up, the End Device undergoes the following sequence of events: 1. Check A1 parameter - AutoAssociate Bit Set (bit 2 = 1) - End Device will attempt to associate to a Coordinator. (refer to steps 2-3). Not Set (bit 2 = 0) - End Device will not attempt to associate to a Coordinator. The End Device will operate as specified by its ID, CH and MY parameters. Association is considered complete and the Associate LED will blink quickly (5 times per second). When the AutoAssociate bit is not set, the remaining steps (2-3) do not apply. 2. Discover Coordinator (if Auto-Associate Bit Set) The End Device issues an Active Scan. The Active Scan selects one channel and transmits a BeaconRequest command to the broadcast address (0xFFFF) and broadcast PAN ID (0xFFFF). It then listens on that channel for beacons from any Coordinator operating on that channel. The listen time on each channel is determined by the SD parameter. Once the time expires on that channel, the Active Scan selects another channel and again transmits the BeaconRequest command as before. This process continues until all channels have been scanned, or until 5 PANs have been discovered. When the Active Scan is complete, the results include a list of PAN IDs and Channels that are being used by detected PANs.
17
The End Device selects a Coordinator to associate with according to the A1 parameter Reassign_PANID and Reassign_Channel flags: Reassign_PANID Bit Set (bit 0 = 1)- End Device can associate with a PAN with any ID value. Reassign_PANID Bit Not Set (bit 0 = 0) - End Device will only associate with a PAN whose ID setting matches the ID setting of the End Device. Reassign_Channel Bit Set (bit 1 = 1) - End Device can associate with a PAN with any CH value. Reassign_Channel Bit Not Set (bit 1 = 0)- End Device will only associate with a PAN whose CH setting matches the CH setting of the End Device. After applying these filters to the discovered Coordinators, if multiple candidate PANs exist, the End Device will select the PAN whose transmission link quality is the strongest. If no valid Coordinator is found, the End Device will either go to sleep (as dictated by its SM (Sleep Mode) parameter) or retry Association. Note - An End Device will also disqualify Coordinators if they are not allowing association (A2 AllowAssociation bit); or, if the Coordinator is not using the same NonBeacon scheme as the End Device. (They must both be programmed with NonBeacon code.) 3. Associate to Valid Coordinator Once a valid Coordinator is found (step 2), the End Device sends an AssociationRequest message to the Coordinator. It then waits for an AssociationConfirmation to be sent from the Coordinator. Once the Confirmation is received, the End Device is Associated and the Associate LED will blink rapidly (2 times per second). The LED is solid if the End Device has not associated. 4. End Device Changes once an End Device has associated Changing A1, ID or CH parameters will cause the End Device to disassociate and restart the Association procedure. If the End Device fails to associate, the AI command can give some indication of the failure.
18
XBee/XBee-PRO Addressing
Every RF data packet sent over-the-air contains a Source Address and Destination Address field in its header. The RF module conforms to the 802.15.4 specification and supports both short 16-bit addresses and long 64-bit addresses. A unique 64-bit IEEE source address is assigned at the factory and can be read with the SL (Serial Number Low) and SH (Serial Number High) commands. Short addressing must be configured manually. A module will use its unique 64-bit address as its Source Address if its MY (16-bit Source Address) value is 0xFFFF or 0xFFFE. To send a packet to a specific module using 64-bit addressing: Set the Destination Address (DL + DH) of the sender to match the Source Address (SL + SH) of the intended destination module. To send a packet to a specific module using 16-bit addressing: Set DL (Destination Address Low) parameter to equal the MY parameter of the intended destination module and set the DH (Destination Address High) parameter to '0'.
Unicast Mode
By default, the RF module operates in Unicast Mode. Unicast Mode is the only mode that supports retries. While in this mode, receiving modules send an ACK (acknowledgement) of RF packet reception to the transmitter. If the transmitting module does not receive the ACK, it will re-send the packet up to three times or until the ACK is received. Short 16-bit addresses. The module can be configured to use short 16-bit addresses as the Source Address by setting (MY < 0xFFFE). Setting the DH parameter (DH = 0) will configure the Destination Address to be a short 16-bit address (if DL < 0xFFFE). For two modules to communicate using short addressing, the Destination Address of the transmitter module must match the MY parameter of the receiver. The following table shows a sample network configuration that would enable Unicast Mode communications using short 16-bit addresses. Table203. SampleUnicastNetworkConfiguration(using16bitaddressing) RF Module 1 0x01 0 0x02 RF Module 2 0x02 0 0x01 Parameter MY (Source Address) DH (Destination Address High) DL (Destination Address Low)
Long 64-bit addresses. The RF modules serial number (SL parameter concatenated to the SH parameter) can be used as a 64-bit source address when the MY (16-bit Source Address) parameter is disabled. When the MY parameter is disabled (MY = 0xFFFF or 0xFFFE), the modules source address is set to the 64-bit IEEE address stored in the SH and SL parameters. When an End Device associates to a Coordinator, its MY parameter is set to 0xFFFE to enable 64bit addressing. The 64-bit address of the module is stored as SH and SL parameters. To send a packet to a specific module, the Destination Address (DL + DH) on the sender must match the Source Address (SL + SH) of the desired receiver.
Broadcast Mode
Any RF module within range will accept a packet that contains a broadcast address. When configured to operate in Broadcast Mode, receiving modules do not send ACKs (Acknowledgements) and transmitting modules do not automatically re-send packets as is the case in Unicast Mode. To send a broadcast packet to all modules regardless of 16-bit or 64-bit addressing, set the destination addresses of all the modules as shown below. Sample Network Configuration (All modules in the network): DL (Destination Low Address) = 0x0000FFFF DH (Destination High Address) = 0x00000000 (default value) NOTE: When programming the module, parameters are entered in hexadecimal notation (without the 0x prefix). Leading zeros may be omitted.
19
Modes of Operation
XBee/XBee-PRO RF Modules operate in five modes. Figure207. ModesofOperation
Idle Mode
When not receiving or transmitting data, the RF module is in Idle Mode. The module shifts into the other modes of operation under the following conditions: Transmit Mode (Serial data is received in the DI Buffer) Receive Mode (Valid RF data is received through the antenna) Sleep Mode (Sleep Mode condition is met) Command Mode (Command Mode Sequence is issued)
Transmit/Receive Modes
RF Data Packets Each transmitted data packet contains a Source Address and Destination Address field. The Source Address matches the address of the transmitting module as specified by the MY (Source Address) parameter (if MY >= 0xFFFE), the SH (Serial Number High) parameter or the SL (Serial Number Low) parameter. The <Destination Address> field is created from the DH (Destination Address High) and DL (Destination Address Low) parameter values. The Source Address and/or Destination Address fields will either contain a 16-bit short or long 64-bit long address. The RF data packet structure follows the 802.15.4 specification. [Refer to the XBee/XBee-PRO Addressing section for more information] Direct and Indirect Transmission There are two methods to transmit data: Direct Transmission - data is transmitted immediately to the Destination Address Indirect Transmission - A packet is retained for a period of time and is only transmitted after the destination module (Source Address = Destination Address) requests the data. Indirect Transmissions can only occur on a Coordinator. Thus, if all nodes in a network are End Devices, only Direct Transmissions will occur. Indirect Transmissions are useful to ensure packet delivery to a sleeping node. The Coordinator currently is able to retain up to 2 indirect messages.
20
Direct Transmission A Coordinator can be configured to use only Direct Transmission by setting the SP (Cyclic Sleep Period) parameter to "0". Also, a Coordinator using indirect transmissions will revert to direct transmission if it knows the destination module is awake. To enable this behavior, the ST (Time before Sleep) value of the Coordinator must be set to match the ST value of the End Device. Once the End Device either transmits data to the Coordinator or polls the Coordinator for data, the Coordinator will use direct transmission for all subsequent data transmissions to that module address until ST time occurs with no activity (at which point it will revert to using indirect transmissions for that module address). "No activity" means no transmission or reception of messages with a specific address. Global messages will not reset the ST timer. Indirect Transmission To configure Indirect Transmissions in a PAN (Personal Area Network), the SP (Cyclic Sleep Period) parameter value on the Coordinator must be set to match the longest sleep value of any End Device. The sleep period value on the Coordinator determines how long (time or number of beacons) the Coordinator will retain an indirect message before discarding it. An End Device must poll the Coordinator once it wakes from Sleep to determine if the Coordinator has an indirect message for it. For Cyclic Sleep Modes, this is done automatically every time the module wakes (after SP time). For Pin Sleep Modes, the A1 (End Device Association) parameter value must be set to enable Coordinator polling on pin wake-up. Alternatively, an End Device can use the FP (Force Poll) command to poll the Coordinator as needed. CCA (Clear Channel Assessment) Prior to transmitting a packet, a CCA (Clear Channel Assessment) is performed on the channel to determine if the channel is available for transmission. The detected energy on the channel is compared with the CA (Clear Channel Assessment) parameter value. If the detected energy exceeds the CA parameter value, the packet is not transmitted. Also, a delay is inserted before a transmission takes place. This delay is settable using the RN (Backoff Exponent) parameter. If RN is set to 0, then there is no delay before the first CCA is performed. The RN parameter value is the equivalent of the minBE parameter in the 802.15.4 specification. The transmit sequence follows the 802.15.4 specification. By default, the MM (MAC Mode) parameter = 0. On a CCA failure, the module will attempt to resend the packet up to two additional times. When in Unicast packets with RR (Retries) = 0, the module will execute two CCA retries. Broadcast packets always get two CCA retries. Acknowledgement If the transmission is not a broadcast message, the module will expect to receive an acknowledgement from the destination node. If an acknowledgement is not received, the packet will be resent up to 3 more times. If the acknowledgement is not received after all transmissions, an ACK failure is recorded.
21
Sleep Mode
Sleep Modes enable the RF module to enter states of low-power consumption when not in use. In order to enter Sleep Mode, one of the following conditions must be met (in addition to the module having a non-zero SM parameter value): Sleep_RQ (pin 9) is asserted and the module is in a pin sleep mode (SM = 1, 2, or 5) The module is idle (no data transmission or reception) for the amount of time defined by the ST (Time before Sleep) parameter. [NOTE: ST is only active when SM = 4-5.] Table204. SleepModeConfigurations Transition out of Sleep Mode (wake) Characteristics Related Power Commands Consumption (SM) < 10 A (@3.0 VCC) < 50 A Sleep Mode Transition into Setting Sleep Mode Pin Hibernate (SM = 1) Pin Doze (SM = 2) Assert (high) Sleep_RQ (pin 9) Assert (high) Sleep_RQ (pin 9) Automatic transition to Sleep Mode as defined by the SM (Sleep Mode) and ST (Time before Sleep) parameters. Automatic transition to Sleep Mode as defined by the SM (Sleep Mode) and ST (Time before Sleep) parameters or or on a falling edge transition of the SLEEP_RQ pin.
Pin/Host-controlled / De-assert (low) Sleep_RQ NonBeacon systems only / Lowest Power
Pin/Host-controlled / De-assert (low) Sleep_RQ NonBeacon systems (SM) only / Fastest wake-up Transition occurs after the cyclic sleep time interval elapses. The time interval is defined by the SP (Cyclic Sleep Period) parameter. Transition occurs after the cyclic sleep time interval elapses. The time interval is defined by the SP (Cyclic Sleep Period) parameter. RF module wakes in pre-determined time intervals to detect if RF (SM), SP, ST data is present / When SM = 5 RF module wakes in pre-determined time intervals to detect if RF (SM), SP, ST data is present. Module also wakes on a falling edge of SLEEP_RQ
Cyclic Sleep (SM = 4)
< 50 A when sleeping
Cyclic Sleep (SM = 5)
< 50 A when sleeping
The SM command is central to setting Sleep Mode configurations. By default, Sleep Modes are disabled (SM = 0) and the module remains in Idle/Receive Mode. When in this state, the module is constantly ready to respond to serial or RF activity. Pin/Host-controlled Sleep Modes The transient current when waking from pin sleep (SM = 1 or 2) does not exceed the idle current of the module. The current ramps up exponentially to its idle current. Pin Hibernate (SM = 1) Pin/Host-controlled Typical power-down current: < 10 A (@3.0 VCC) Wake-up time: 13.2 msec Pin Hibernate Mode minimizes quiescent power (power consumed when in a state of rest or inactivity). This mode is voltage level-activated; when Sleep_RQ (pin 9) is asserted, the module will finish any transmit, receive or association activities, enter Idle Mode, and then enter a state of sleep. The module will not respond to either serial or RF activity while in pin sleep. To wake a sleeping module operating in Pin Hibernate Mode, de-assert Sleep_RQ (pin 9). The module will wake when Sleep_RQ is de-asserted and is ready to transmit or receive when the CTS line is low. When waking the module, the pin must be de-asserted at least two 'byte times' after CTS goes low. This assures that there is time for the data to enter the DI buffer. Pin Doze (SM = 2) Pin/Host-controlled Typical power-down current: < 50 A Wake-up time: 2 msec Pin Doze Mode functions as does Pin Hibernate Mode; however, Pin Doze features faster wake-up time and higher power consumption. To wake a sleeping module operating in Pin Doze Mode, de-assert Sleep_RQ (pin 9). The module will wake when Sleep_RQ is de-asserted and is ready to transmit or receive when the CTS line is
22
low. When waking the module, the pin must be de-asserted at least two 'byte times' after CTS goes low. This assures that there is time for the data to enter the DI buffer. Cyclic Sleep Modes Cyclic Sleep Remote (SM = 4) Typical Power-down Current: < 50 A (when asleep) Wake-up time: 2 msec The Cyclic Sleep Modes allow modules to periodically check for RF data. When the SM parameter is set to 4, the module is configured to sleep, then wakes once a cycle to check for data from a module configured as a Cyclic Sleep Coordinator (SM = 0, CE = 1). The Cyclic Sleep Remote sends a poll request to the coordinator at a specific interval set by the SP (Cyclic Sleep Period) parameter. The coordinator will transmit any queued data addressed to that specific remote upon receiving the poll request. If no data is queued for the remote, the coordinator will not transmit and the remote will return to sleep for another cycle. If queued data is transmitted back to the remote, it will stay awake to allow for back and forth communication until the ST (Time before Sleep) timer expires. Also note that CTS will go low each time the remote wakes, allowing for communication initiated by the remote host if desired. Cyclic Sleep Remote with Pin Wake-up (SM = 5) Use this mode to wake a sleeping remote module through either the RF interface or by the deassertion of Sleep_RQ for event-driven communications. The cyclic sleep mode works as described above (Cyclic Sleep Remote) with the addition of a pin-controlled wake-up at the remote module. The Sleep_RQ pin is edge-triggered, not level-triggered. The module will wake when a low is detected then set CTS low as soon as it is ready to transmit or receive. Any activity will reset the ST (Time before Sleep) timer so the module will go back to sleep only after there is no activity for the duration of the timer. Once the module wakes (pin-controlled), further pin activity is ignored. The module transitions back into sleep according to the ST time regardless of the state of the pin. [Cyclic Sleep Coordinator (SM = 6)] Typical current = Receive current Always awake NOTE: The SM=6 parameter value exists solely for backwards compatibility with firmware version 1.x60. If backwards compatibility with the older firmware version is not required, always use the CE (Coordinator Enable) command to configure a module as a Coordinator. This mode configures a module to wake cyclic sleeping remotes through RF interfacing. The Coordinator will accept a message addressed to a specific remote 16 or 64-bit address and hold it in a buffer until the remote wakes and sends a poll request. Messages not sent directly (buffered and requested) are called "Indirect messages". The Coordinator only queues one indirect message at a time. The Coordinator will hold the indirect message for a period 2.5 times the sleeping period indicated by the SP (Cyclic Sleep Period) parameter. The Coordinator's SP parameter should be set to match the value used by the remotes.
23
Command Mode
To modify or read RF Module parameters, the module must first enter into Command Mode - a state in which incoming characters are interpreted as commands. Two Command Mode options are supported: AT Command Mode [refer to section below] and API Command Mode [p56]. AT Command Mode To Enter AT Command Mode: Send the 3-character command sequence +++ and observe guard times before and after the command characters. [Refer to the Default AT Command Mode Sequence below.] Default AT Command Mode Sequence (for transition to Command Mode): No characters sent for one second [GT (Guard Times) parameter = 0x3E8] Input three plus characters (+++) within one second [CC (Command Sequence Character) parameter = 0x2B.] No characters sent for one second [GT (Guard Times) parameter = 0x3E8] All of the parameter values in the sequence can be modified to reflect user preferences. NOTE: Failure to enter AT Command Mode is most commonly due to baud rate mismatch. Ensure the Baud setting on the PC Settings tab matches the interface data rate of the RF module. By default, the BD parameter = 3 (9600 bps). To Send AT Commands: Send AT commands and parameters using the syntax shown below. Figure208.SyntaxforsendingATCommands
To read a parameter value stored in the RF modules register, omit the parameter field. The preceding example would change the RF module Destination Address (Low) to 0x1F. To store the new value to non-volatile (long term) memory, subsequently send the WR (Write) command. For modified parameter values to persist in the modules registry after a reset, changes must be saved to non-volatile memory using the WR (Write) Command. Otherwise, parameters are restored to previously saved values after the module is reset. System Response. When a command is sent to the module, the module will parse and execute the command. Upon successful execution of a command, the module returns an OK message. If execution of a command results in an error, the module returns an ERROR message. To Exit AT Command Mode: 1. 2. Send the ATCN (Exit Command Mode) command (followed by a carriage return). [OR] If no valid AT Commands are received within the time specified by CT (Command Mode Timeout) Command, the RF module automatically returns to Idle Mode.
For an example of programming the RF module using AT Commands and descriptions of each configurable parameter, refer to the RF Module Configuration chapter [p25].
24
3.RFModuleConfiguration
Programming the RF Module
Refer to the Command Mode section [p24] for more information about entering Command Mode, sending AT commands and exiting Command Mode. For information regarding module programming using API Mode, refer to the API Operation sections [p56].
Programming Examples
RefertotheXCTUsec tionoftheDevelop mentGuide[Appendix B]formoreinformation regardingtheXCTU configurationsoftware. Setup The programming examples in this section require the installation of Digi's X-CTU Software and a serial connection to a PC. (Digi stocks RS-232 and USB boards to facilitate interfacing with a PC.) 1. Install Digi's X-CTU Software to a PC by double-clicking the "setup_X-CTU.exe" file. (The file is located on the Digi CD and under the 'Software' section of the following web page: www.digi.com/support) Mount the RF module to an interface board, then connect the module assembly to a PC. Launch the X-CTU Software and select the 'PC Settings' tab. Verify the baud and parity settings of the Com Port match those of the RF module.
2. 3.
NOTE: Failure to enter AT Command Mode is most commonly due to baud rate mismatch. Ensure the Baud setting on the PC Settings tab matches the interface data rate of the RF module. By default, the BD parameter = 3 (which corresponds to 9600 bps). Sample Configuration: Modify RF Module Destination Address Example: Utilize the X-CTU Terminal tab to change the RF module's DL (Destination Address Low) parameter and save the new address to non-volatile memory. After establishing a serial connection between the RF module and a PC [refer to the 'Setup' section above], select the Terminal tab of the X-CTU Software and enter the following command lines (CR stands for carriage return): Method 1 (One line per command) Send AT Command +++ ATDL <Enter> ATDL1A0D <Enter> ATWR <Enter> ATCN <Enter> System Response OK <CR> (Enter into Command Mode) {current value} <CR> (Read Destination Address Low) OK <CR> (Modify Destination Address Low) OK <CR> (Write to non-volatile memory) OK <CR> (Exit Command Mode)
Method 2 (Multiple commands on one line) Send AT Command +++ ATDL <Enter> ATDL1A0D,WR,CN <Enter> System Response OK <CR> (Enter into Command Mode) {current value} <CR> (Read Destination Address Low) OK<CR> OK<CR> OK<CR>
Sample Configuration: Restore RF Module Defaults Example: Utilize the X-CTU Modem Configuration tab to restore default parameter values. After establishing a connection between the module and a PC [refer to the 'Setup' section above], select the Modem Configuration tab of the X-CTU Software. 1. 2. Select the 'Read' button. Select the 'Restore' button.
25
Remote Configuration Commands

The API firmware has provisions to send configuration commands to remote devices using the Remote Command Request API frame (see API Operation). This API frame can be used to send commands to a remote module to read or set command parameters. The API firmware has provisions to send configuration commands (set or read) to a remote module using the Remote Command Request API frame (see API Operations). Remote commands can be issued to read or set command parameters on a remote device.
Sending a Remote Command

To send a remote command, the Remote Command Request frame should be populated with values for the 64 bit and 16 bit addresses. If 64 bit addressing is desired then the 16 bit address field should be filled with 0xFFFE. If any value other than 0xFFFE is used in the 16 bit address field then the 64 bit address field will be ignored and 16 bit addressing will be used. If a command response is desired, the Frame ID should be set to a non-zero value.
Applying Changes on Remote

When remote commands are used to change command parameter settings on a remote device, parameter changes do not take effect until the changes are applied. For example, changing the BD parameter will not change the actual serial interface rate on the remote until the changes are applied. Changes can be applied using remote commands in one of three ways: Set the apply changes option bit in the API frame Issue an AC command to the remote device Issue a WR + FR command to the remote device to save changes and reset the device.
Remote Command Responses

If the remote device receives a remote command request transmission, and the API frame ID is non-zero, the remote will send a remote command response transmission back to the device that sent the remote command. When a remote command response transmission is received, a device sends a remote command response API frame out its UART. The remote command response indicates the status of the command (success, or reason for failure), and in the case of a command query, it will include the register value. The device that sends a remote command will not receive a remote command response frame if: The destination device could not be reached The frame ID in the remote command request is set to 0.
Command Reference Tables

XBee/XBee-PRO RF Modules expect numerical values in hexadecimal. Hexadecimal values are designated by a 0x prefix. Decimal equivalents are designated by a d suffix. Commands are contained within the following command categories (listed in the order that their tables appear): Special Networking & Security RF Interfacing Sleep (Low Power) Serial Interfacing I/O Settings Diagnostics AT Command Options All modules within a PAN should operate using the same firmware version.
26
Special Table301. AT Command WR RE FR ( v1.x80*) XBeePROCommandsSpecial Command Category Special Special Special Name and Description Write. Write parameter values to non-volatile memory so that parameter modifications persist through subsequent power-up or reset. Note: Once WR is issued, no additional characters should be sent to the module until after the response "OK\r" is received. Restore Defaults. Restore module parameters to factory defaults. Software Reset. Responds immediately with an OK then performs a hard reset ~100ms later. Parameter Range Default
*Firmwareversioninwhichthecommandwasfirstintroduced(firmwareversionsarenumberedinhexadecimalnotation.) Networking & Security Table302. AT Command CH ID DH XBee/XBeePROCommandsNetworking&Security(Subcategoriesdesignatedwithin{brackets}) Command Category Networking {Addressing} Networking {Addressing} Networking {Addressing} Networking {Addressing} Networking {Addressing} Networking {Addressing} Networking {Addressing} Networking {Addressing} Networking {Addressing} Name and Description Channel. Set/Read the channel number used for transmitting and receiving data between RF modules (uses 802.15.4 protocol channel numbers). PAN ID. Set/Read the PAN (Personal Area Network) ID. Use 0xFFFF to broadcast messages to all PANs. Parameter Range 0x0B - 0x1A (XBee) 0x0C - 0x17 (XBee-PRO) 0 - 0xFFFF Default 0x0C (12d) 0x3332 (13106d) 0
Destination Address High. Set/Read the upper 32 bits of the 64-bit destination address. When combined with DL, it defines the destination address used for 0 - 0xFFFFFFFF transmission. To transmit using a 16-bit address, set DH parameter to zero and DL less than 0xFFFF. 0x000000000000FFFF is the broadcast address for the PAN. Destination Address Low. Set/Read the lower 32 bits of the 64-bit destination address. When combined with DH, DL defines the destination address used for 0 - 0xFFFFFFFF transmission. To transmit using a 16-bit address, set DH parameter to zero and DL less than 0xFFFF. 0x000000000000FFFF is the broadcast address for the PAN. 16-bit Source Address. Set/Read the RF module 16-bit source address. Set MY = 0xFFFF to disable reception of packets with 16-bit addresses. 64-bit source address (serial number) and broadcast address (0x000000000000FFFF) is always enabled. Serial Number High. Read high 32 bits of the RF module's unique IEEE 64-bit address. 64-bit source address is always enabled. 0 - 0xFFFF 0 - 0xFFFFFFFF [read-only]
DL
MY SH SL RR ( v1.xA0*) RN
0 Factory-set Factory-set 0 0
Serial Number Low. Read low 32 bits of the RF module's unique IEEE 64-bit address. 0 - 0xFFFFFFFF [read-only] 64-bit source address is always enabled. XBee Retries. Set/Read the maximum number of retries the module will execute in addition to the 3 retries provided by the 802.15.4 MAC. For each XBee retry, the 802.15.4 MAC can execute up to 3 retries. Random Delay Slots. Set/Read the minimum value of the back-off exponent in the CSMA-CA algorithm that is used for collision avoidance. If RN = 0, collision avoidance is disabled during the first iteration of the algorithm (802.15.4 - macMinBE). MAC Mode. MAC Mode. Set/Read MAC Mode value. MAC Mode enables/disables the use of a Digi header in the 802.15.4 RF packet. When Modes 0 or 3 are enabled (MM=0,3), duplicate packet detection is enabled as well as certain AT commands. Please see the detailed MM description on page 47 for additional information. Node Identifier. Stores a string identifier. The register only accepts printable ASCII data. A string can not start with a space. Carriage return ends command. Command will automatically end when maximum bytes for the string have been entered. This string is returned as part of the ND (Node Discover) command. This identifier is also used with the DN (Destination Node) command. 0-6 0 - 3 [exponent] 0-3 0 = Digi Mode 1 = 802.15.4 (no ACKs) 2 = 802.15.4 (with ACKs) 3 = Digi Mode (no ACKs) 20-character ASCII string
MM ( v1.x80*)
Networking {Addressing}
NI ( v1.x80*)
Networking {Identification}
ND ( v1.x80*)
Node Discover. Discovers and reports all RF modules found. The following information is reported for each module discovered (the example cites use of Transparent operation (AT command format) - refer to the long ND command description regarding differences between Transparent and API operation). MY<CR> SH<CR> SL<CR> optional 20-character NI value DB<CR> NI<CR><CR> The amount of time the module allows for responses is determined by the NT parameter. In Transparent operation, command completion is designated by a <CR> (carriage return). ND also accepts a Node Identifier as a parameter. In this case, only a module matching the supplied identifier will respond. If ND self-response is enabled (NO=1) the module initiating the node discover will also output a response for itself. Node Discover Time. Set/Read the amount of time a node will wait for responses from 0x01 - 0xFC [x 100 ms] other nodes when using the ND (Node Discover) command. 0x19
NT ( v1.xA0*)
27
Table302. AT Command NO (v1xC5) XBee/XBeePROCommandsNetworking&Security(Subcategoriesdesignatedwithin{brackets}) Command Category Networking {Identification} Name and Description Node Discover Options. Enables node discover self-response on the module. 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. Coordinator Enable. Set/Read the coordinator setting. Parameter Range 0-1 Default 0
DN ( v1.x80*)
20-character ASCII string
CE ( v1.x80*)
Networking {Association}
0-1 0 = End Device 1 = Coordinator
SC ( v1.x80*)
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: 0 - 0xFFFF [bitfield] bit 0 - 0x0B bit 4 - 0x0F bit 8 - 0x13 bit12 - 0x17 (bits 0, 14, 15 not allowed on bit 1 - 0x0C bit 5 - 0x10 bit 9 - 0x14 bit13 - 0x18 the XBee-PRO) bit 2 - 0x0D bit 6 - 0x11 bit 10 - 0x15 bit14 - 0x19 bit 3 - 0x0E bit 7 - 0x12 bit 11 - 0x16 bit 15 - 0x1A 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 0-0x0F [exponent] 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 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 - 0x0F [bitfield] 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 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 0 - 7 [bitfield] 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
0x1FFE (all XBeePRO Channels)
SD ( v1.x80*)
A1 ( v1.x80*)
A2 ( v1.x80*)
28
Table302. AT Command XBee/XBeePROCommandsNetworking&Security(Subcategoriesdesignatedwithin{brackets}) Command Category Name and Description Association Indication. Read errors with the last association request: 0x00 - Successful Completion - Coordinator successfully started or End Device association complete 0x01 - Active Scan Timeout 0x02 - Active Scan found no PANs 0x03 - Active Scan found PAN, but the CoordinatorAllowAssociation bit is not set 0x04 - Active Scan found PAN, but Coordinator and End Device are not configured to support beacons 0x05 - Active Scan found PAN, but the Coordinator ID parameter does not match the ID parameter of the End Device 0x06 - Active Scan found PAN, but the Coordinator CH parameter does not match the CH parameter of the End Device 0x07 - Energy Scan Timeout 0x08 - Coordinator start request failed 0x09 - Coordinator could not start due to invalid parameter 0x0A - Coordinator Realignment is in progress 0x0B - Association Request not sent 0x0C - Association Request timed out - no reply was received 0x0D - Association Request had an Invalid Parameter 0x0E - Association Request Channel Access Failure. Request was not transmitted CCA failure 0x0F - Remote Coordinator did not send an ACK after Association Request was sent 0x10 - Remote Coordinator did not reply to the Association Request, but an ACK was received after sending the request 0x11 - [reserved] 0x12 - Sync-Loss - Lost synchronization with a Beaconing Coordinator 0x13 - Disassociated - No longer associated to Coordinator 0xFF - RF Module is attempting to associate Parameter Range Default
AI ( v1.x80*)
0 - 0x13 [read-only]
DA ( v1.x80*) FP ( v1.x80*)
Networking {Association} Networking {Association}
Force Disassociation. End Device will immediately disassociate from a Coordinator (if associated) and reattempt to associate. Force Poll. Request indirect messages being held by a coordinator. -
AS ( v1.x80*)
Active Scan. Send Beacon Request to Broadcast Address (0xFFFF) and Broadcast PAN (0xFFFF) on every channel. The parameter determines the time the radio will listen for Beacons on each channel. A PanDescriptor is created and returned for every Beacon received from the scan. Each PanDescriptor contains the following information: CoordAddress (SH, SL)<CR> CoordPanID (ID)<CR> CoordAddrMode <CR> 0x02 = 16-bit Short Address 0x03 = 64-bit Long Address Channel (CH parameter) <CR> SecurityUse<CR> ACLEntry<CR> SecurityFailure<CR> SuperFrameSpec<CR> (2 bytes): bit 15 - Association Permitted (MSB) 0-6 bit 14 - PAN Coordinator bit 13 - Reserved bit 12 - Battery Life Extension bits 8-11 - Final CAP Slot bits 4-7 - Superframe Order bits 0-3 - Beacon Order GtsPermit<CR> RSSI<CR> (RSSI is returned as -dBm) TimeStamp<CR> (3 bytes) <CR> A carriage return <CR> is sent at the end of the AS command. The Active Scan is capable of returning up to 5 PanDescriptors in a scan. The actual scan time on each channel is measured as Time = [(2 ^SD PARAM) * 15.36] ms. Note the total scan time is this time multiplied by the number of channels to be scanned (16 for the XBee and 13 for the XBee-PRO). Also refer to SD command description. Energy Scan. Send an Energy Detect Scan. This parameter determines the length of scan on each channel. The maximal energy on each channel is returned & each value is followed by a carriage return. An additional carriage return is sent at the end of the command. The values returned represent the detected energy level in units of -dBm. 0-6 The actual scan time on each channel is measured as Time = [(2 ^ED) * 15.36] ms. Note the total scan time is this time multiplied by the number of channels to be scanned (refer to SD parameter). AES Encryption Enable. Disable/Enable 128-bit AES encryption support. Use in conjunction with the KY command. AES Encryption Key. Set the 128-bit AES (Advanced Encryption Standard) key for encrypting/decrypting data. The KY register cannot be read. 0-1 0 - (any 16-Byte value)
ED ( v1.x80*)
EE ( v1.xA0*) KY ( v1.xA0*)
Networking {Security} Networking {Security}
0 (disabled) -
*Firmwareversioninwhichthecommandwasfirstintroduced(firmwareversionsarenumberedinhexadecimalnotation.)
29
RF Interfacing Table303. AT Command XBee/XBeePROCommandsRFInterfacing Command Category Name and Description Parameter Range 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 PL RF Interfacing Power Level. Select/Read the power level at which the RF module transmits conducted XBee-PRO International power. variant: PL=4: 10 dBm PL=3: 8 dBm PL=2: 2 dBm PL=1: -3 dBm PL=0: -3 dBm 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. 4 Default
CA (v1.x80*)
RF Interfacing
0x24 - 0x50 [-dBm]
0x2C (-44d dBm)
*Firmwareversioninwhichthecommandwasfirstintroduced(firmwareversionsarenumberedinhexadecimalnotation.) Sleep (Low Power) Table304. AT Command XBee/XBeePROCommandsSleep(LowPower) 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 0 5 = Cyclic sleep remote w/ pin wake-up 6 = [Sleep Coordinator] for backwards compatibility w/ v1.x6 only; otherwise, use CE command.
SO
Sleep (Low Power)
ST
Sleep (Low Power)
SP
Sleep (Low Power)
DP (1.x80*)
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. 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. 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). 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.
0-4
1 - 0xFFFF [x 1 ms]
0x1388 (5000d)
0 - 0x68B0 [x 10 ms]
1 - 0x68B0 [x 10 ms]
0x3E8 (1000d)
30
*Firmwareversioninwhichthecommandwasfirstintroduced(firmwareversionsarenumberedinhexadecimalnotation.) Serial Interfacing Table305. AT Command XBeePROCommandsSerialInterfacing Command Category Name and Description Parameter Range Default
BD
Serial Interfacing
Interface Data Rate. Set/Read the serial interface data rate for communications between the RF module serial port and host. Request non-standard baud rates with values above 0x80 using a terminal window. Read the BD register to find actual baud rate achieved.
0 - 7 (standard baud rates) 0 = 1200 bps 1 = 2400 2 = 4800 3 = 9600 4 = 19200 3 5 = 38400 6 = 57600 7 = 115200 0x80 - 0x3D090 (non-standard baud rates up to 250 Kbps) 3
RO
Serial Interfacing
AP (v1.x80*)
Serial Interfacing
NB
Serial Interfacing
PR (v1.x80*)
Serial Interfacing
Packetization Timeout. Set/Read number of character times of inter-character delay required before transmission. Set to zero to transmit characters as they arrive instead of 0 - 0xFF [x character times] buffering them into one RF packet. 0-2 0 = Disabled 1 = API enabled API Enable. Disable/Enable API Mode. 2 = API enabled (w/escaped control characters) 0-4 0 = 8-bit (no parity or 7-bit (any parity) Parity. Set/Read parity settings. 1 = 8-bit even 2 = 8-bit odd 3 = 8-bit mark 4 = 8-bit space Pull-up Resistor Enable. Set/Read bitfield to configure internal pull-up resistor status for I/O lines Bitfield Map: bit 0 - AD4/DIO4 (pin11) bit 1 - AD3 / DIO3 (pin17) bit 2 - AD2/DIO2 (pin18) 0 - 0xFF bit 3 - AD1/DIO1 (pin19) bit 4 - AD0 / DIO0 (pin20) bit 5 - RTS / AD6 / DIO6 (pin16) bit 6 - DTR / SLEEP_RQ / DI8 (pin9) bit 7 - DIN/CONFIG (pin3) Bit set to 1 specifies pull-up enabled; 0 specifies no pull-up
0xFF
*Firmwareversioninwhichthecommandwasfirstintroduced(firmwareversionsarenumberedinhexadecimalnotation.) I/O Settings Table306. AT Command D8 XBeePROCommandsI/OSettings(subcategorydesignatedwithin{brackets}) Command Category I/O Settings Name and Description Parameter Range 0-1 0 = Disabled 3 = DI (1,2,4 & 5 n/a) Default
DI8 Configuration. Select/Read options for the DI8 line (pin 9) of the RF module.
D7 (v1.x80*)
I/O Settings
0-1 0 = Disabled 1 = CTS Flow Control 2 = (n/a) DIO7 Configuration. Select/Read settings for the DIO7 line (pin 12) of the RF module. 3 = DI Options include CTS flow control and I/O line settings. 4 = DO low 5 = DO high 6 = RS485 Tx Enable Low 7 = RS485 Tx Enable High 0-1 0 = Disabled 1 = RTS flow control DIO6 Configuration. Select/Read settings for the DIO6 line (pin 16) of the RF module. 2 = (n/a) Options include RTS flow control and I/O line settings. 3 = DI 4 = DO low 5 = DO high
D6 (v1.x80*)
I/O Settings
31
Table306. AT Command XBeePROCommandsI/OSettings(subcategorydesignatedwithin{brackets}) Command Category Name and Description Parameter Range 0-1 0 = Disabled 1 = Associated indicator 2 = ADC 3 = DI 4 = DO low 5 = DO high Default
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.
D0 - D4 (v1.xA0*)
I/O Settings
0-1 0 = Disabled (DIO4 -DIO4) Configuration. Select/Read settings for the following lines: AD0/DIO0 1 = (n/a) (pin 20), AD1/DIO1 (pin 19), AD2/DIO2 (pin 18), AD3/DIO3 (pin 17), AD4/DIO4 (pin 11). 2 = ADC 3 = DI Options include: Analog-to-digital converter, Digital Input and Digital Output. 4 = DO low 5 = DO high 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. 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. 0-1 0 = Disabled 1 = Enabled 1 - 0xFF
IU (v1.xA0*) IT (v1.xA0*) IS (v1.xA0*) IO (v1.xA0*) IC (v1.xA0*) IR (v1.xA0*) IA (v1.xA0*) T0 - T7 (v1.xA0*)
I/O Settings I/O Settings I/O Settings I/O Settings I/O Settings I/O Settings I/O Settings {I/O Line Passing} I/O Settings {I/O Line Passing} I/O Settings {I/O Line Passing} I/O Settings {I/O Line Passing} I/O Settings {I/O Line Passing} I/O Settings {I/O Line Passing} I/O Settings {I/O Line Passing} I/O Settings {I/O Line Passing}
1 1 0 (disabled) 0 0xFFFFFFF FFFFFFFFF 0xFF
8-bit bitmap (each bit Force Sample. Force a read of all enabled inputs (DI or ADC). Data is returned through represents the level of an I/O the UART. If no inputs are defined (DI or ADC), this command will return error. line setup as an output) Digital Output Level. Set digital output level to allow DIO lines that are setup as outputs to be changed through Command Mode. 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. Sample Rate. Set/Read sample rate. When set, this parameter causes the module to sample all enabled inputs at a specified interval. 0 - 0xFF [bitfield] 0 - 0xFFFF [x 1 msec]
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 0 - 0xFFFFFFFFFFFFFFFF address to 0xFFFF will allow any received I/O packet to change outputs. (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 non0 - 0xFF [x 100 ms] 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. PWM0 Configuration. Select/Read function for PWM0 pin. 0-2 0 = Disabled 1 = RSSI 2 = PWM Output 0-2 0 = Disabled 1 = RSSI 2 = PWM Output 0 - 0x03FF 0 - 0x03FF 0 - 0xFF [x 100 ms]
P0
P1 (v1.xA0*) M0 (v1.xA0*) M1 (v1.xA0*) PT (v1.xA0*)
PWM1 Configuration. Select/Read function for PWM1 pin. PWM0 Output Level. Set/Read the PWM0 output level. PWM1 Output Level. Set/Read the PWM1 output level. 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
RP
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 0 - 0xFF [x 100 ms] received packet and is shut off when the timer expires.]
0x28 (40d)
*Firmwareversioninwhichthecommandwasfirstintroduced(firmwareversionsarenumberedinhexadecimalnotation.) Diagnostics Table307. AT Command VR VL (v1.x80*) XBee/XBeePROCommandsDiagnostics Command Category Diagnostics Diagnostics Name and Description Firmware Version. Read firmware version of the RF module. Parameter Range 0 - 0xFFFF [read-only] Default Factory-set -
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
32
Table307. AT Command HV (v1.x80*) DB XBee/XBeePROCommandsDiagnostics Command Category Diagnostics Diagnostics Name and Description Hardware Version. Read hardware version of the RF module. Received Signal Strength. Read signal level [in dB] of last good packet received (RSSI). Absolute value is reported. (For example: 0x58 = -88 dBm) Reported value is accurate between -40 dBm and RX sensitivity. CCA Failures. Reset/Read count of CCA (Clear Channel Assessment) failures. This parameter value increments when the module does not transmit a packet because it detected energy above the CCA threshold level set with CA command. This count saturates at its maximum value. Set count to 0 to reset count. Parameter Range 0 - 0xFFFF [read-only] 0x17-0x5C (XBee) 0x24-0x64 (XBee-PRO) [read-only] 0 - 0xFFFF Default Factory-set -
EC (v1.x80*)
Diagnostics
EA (v1.x80*)
Diagnostics
ACK Failures. Reset/Read count of acknowledgment failures. This parameter value increments when the module expires its transmission retries without receiving an ACK 0 - 0xFFFF on a packet transmission. This count saturates at its maximum value. Set the parameter to 0 to reset count. Energy Scan. Send Energy Detect Scan. ED parameter determines the length of scan on each channel. The maximal energy on each channel is returned and each value is followed by a carriage return. Values returned represent detected energy levels in units 0 - 6 of -dBm. Actual scan time on each channel is measured as Time = [(2 ^ SD) * 15.36] ms. Total scan time is this time multiplied by the number of channels to be scanned.
ED (v1.x80*)
Diagnostics
33
AT Command Options Table308. AT Command CT CN AC (v1.xA0*) GT CC XBee/XBeePROCommandsATCommandOptions Command Category AT Command Mode Options AT Command Mode Options AT Command Mode Options AT Command Mode Options AT Command Mode Options Name and Description Command Mode Timeout. Set/Read the period of inactivity (no valid commands received) after which the RF module automatically exits AT Command Mode and returns to Idle Mode. Exit Command Mode. Explicitly exit the module from AT Command Mode. Apply Changes. Explicitly apply changes to queued parameter value(s) and reinitialize module. Parameter Range 2 - 0xFFFF [x 100 ms] --Default 0x64 (100d) --0x3E8 (1000d) 0x2B (+ ASCII)
Guard Times. Set required period of silence before and after the Command Sequence Characters of the AT Command Mode Sequence (GT+ CC + GT). The period of silence 2 - 0x0CE4 [x 1 ms] is used to prevent inadvertent entrance into AT Command Mode. Command Sequence Character. Set/Read the ASCII character value to be used between Guard Times of the AT Command Mode Sequence (GT+CC+GT). The AT Command Mode Sequence enters the RF module into AT Command Mode. 0 - 0xFF
34
Command Descriptions
Command descriptions in this section are listed alphabetically. Command categories are designated within "< >" symbols that follow each command title. XBee/XBee-PRO RF Modules expect parameter values in hexadecimal (designated by the "0x" prefix). All modules operating within the same network should contain the same firmware version. A1 (End Device Association) Command <Networking {Association}> The A1 command is used to set and read association options for an End Device. Use the table below to determine End Device behavior in relation to the A1 parameter. AT Command: ATA1 Parameter Range: 0 - 0x0F [bitfield] Default Parameter Value: 0 Related Commands: ID (PAN ID), NI (Node Identifier), CH (Channel), CE (Coordinator Enable), A2 (Coordinator Association) Minimum Firmware Version Required: v1.x80 Bit number 0 - ReassignPanID 1 - ReassignChannel End Device Association Option 0 - Will only associate with Coordinator operating on PAN ID that matches Node Identifier 1 - May associate with Coordinator operating on any PAN ID 0 - Will only associate with Coordinator operating on Channel that matches CH setting 1 - May associate with Coordinator operating on any Channel 0 - Device will not attempt Association 2 - AutoAssociate 1 - Device attempts Association until success Note: This bit is used only for Non-Beacon systems. End Devices in a Beaconing system must always associate to a Coordinator 0 - Pin Wake will not poll the Coordinator for pending (indirect) Data 1 - Pin Wake will send Poll Request to Coordinator to extract any pending data [reserved]
3 - PollCoordOnPinWake 4-7
A2 (Coordinator Association) Command <Networking {Association}> The A2 command is used to set and read association options of the Coordinator. Use the table below to determine Coordinator behavior in relation to the A2 parameter. AT Command: ATA2 Parameter Range: 0 - 7 [bitfield] Default Parameter Value: 0 Related Commands: ID (PAN ID), NI (Node Identifier), CH (Channel), CE (Coordinator Enable), A1 (End Device Association), AS Active Scan), ED (Energy Scan) Minimum Firmware Version Required: v1.x80 Bit number 0 - ReassignPanID End Device Association Option 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. 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. 2 - AllowAssociate 3-7 0 - Coordinator will not allow any devices to associate to it. 1 - Coordinator will allow devices to associate to it. [reserved]
1 - ReassignChannel
Thebinaryequivalentofthedefaultvalue(0x06)is00000110.Bit0isthelastdigitofthesequence.
35
AC (Apply Changes) Command <AT Command Mode Options> The AC command AT Command: ATAC is used to explicitly apply changes to module Minimum Firmware Version Required: v1.xA0 parameter values. Applying changes means that the module is re-initialized based on changes made to its parameter values. Once changes are applied, the module immediately operates according to the new parameter values. This behavior is in contrast to issuing the WR (Write) command. The WR command saves parameter values to non-volatile memory, but the module still operates according to previously saved values until the module is re-booted or the CN (Exit AT Command Mode) command is issued. Refer to the AT Command - Queue Parameter Value API type for more information. AI (Association Indication) Command <Networking {Association}> The AI command is used to indicate occurrences of errors during the last association request. Use the table below to determine meaning of the returned values. AT Command: ATAI Parameter Range: 0 - 0x13 [read-only] Related Commands: AS (Active Scan), ID (PAN ID), CH (Channel), ED (Energy Scan), A1 (End Device Association), A2 (Coordinator Association), CE (Coordinator Enable) Minimum Firmware Version Required: v1.x80 Returned Value (Hex) 0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07 0x08 0x09 0x0A 0x0B 0x0C 0x0D 0x0E 0x0F 0x10 0x11 0x12 0x13 0xFF Association Indication Successful Completion - Coordinator successfully started or End Device association complete Active Scan Timeout Active Scan found no PANs Active Scan found PAN, but the Coordinator Allow Association bit is not set Active Scan found PAN, but Coordinator and End Device are not configured to support beacons Active Scan found PAN, but Coordinator ID (PAN ID) value does not match the ID of the End Device Active Scan found PAN, but Coordinator CH (Channel) value does not match the CH of the End Device Energy Scan Timeout Coordinator start request failed Coordinator could not start due to Invalid Parameter Coordinator Realignment is in progress Association Request not sent Association Request timed out - no reply was received Association Request had an Invalid Parameter Association Request Channel Access Failure - Request was not transmitted - CCA failure Remote Coordinator did not send an ACK after Association Request was sent Remote Coordinator did not reply to the Association Request, but an ACK was received after sending the request [reserved] Sync-Loss - Lost synchronization with a Beaconing Coordinator Disassociated - No longer associated to Coordinator RF Module is attempting to associate
36
AP (API Enable) Command <Serial Interfacing> The AP command is used to enable the RF module to operate using a framebased API instead of using the default Transparent (UART) mode. AT Command: ATAP Parameter Range:0 - 2 Parameter 0 1 2 Configuration Disabled (Transparent operation) API enabled API enabled (with escaped characters)
Default Parameter Value:0 Minimum Firmware Version Required: v1.x80
Refer to the API Operation section when API operation is enabled (AP = 1 or 2). AS (Active Scan) Command <Network {Association}> The AS command is used to send a Beacon Request to a Broadcast (0xFFFF) and Broadcast PAN (0xFFFF) on every channel. The parameter determines the amount of time the RF module will listen for Beacons on each channel. A PanDescriptor is created and returned for every Beacon received from the scan. Each PanDescriptor contains the following information: AT Command: ATAS Parameter Range: 0 - 6 Related Command: SD (Scan Duration), DL (Destination Low Address), DH (Destination High Address), ID (PAN ID), CH (Channel) Minimum Firmware Version Required: v1.x80
CoordAddress (SH + SL parameters)<CR> (NOTE: If MY on the coordinator is set less than 0xFFFF, the MY value is displayed) CoordPanID (ID parameter)<CR> CoordAddrMode <CR> 0x02 = 16-bit Short Address 0x03 = 64-bit Long Address Channel (CH parameter) <CR> SecurityUse<CR> ACLEntry<CR> SecurityFailure<CR> SuperFrameSpec<CR> (2 bytes): bit 15 - Association Permitted (MSB) bit 14 - PAN Coordinator bit 13 - Reserved bit 12 - Battery Life Extension bits 8-11 - Final CAP Slot bits 4-7 - Superframe Order bits 0-3 - Beacon Order GtsPermit<CR> RSSI<CR> (- RSSI is returned as -dBm) TimeStamp<CR> (3 bytes) <CR> (A carriage return <CR> is sent at the end of the AS command. The Active Scan is capable of returning up to 5 PanDescriptors in a scan. The actual scan time on each channel is measured as Time = [(2 ^ (SD Parameter)) * 15.36] ms. Total scan time is this time multiplied by the number of channels to be scanned (16 for the XBee, 12 for the XBee-PRO).
37
NOTE: Refer the scan table in the SD description to determine scan times. If using API Mode, no <CR>s are returned in the response. Refer to the API Mode Operation section. BD (Interface Data Rate) Command <Serial Interfacing> The BD command is used to set and read the serial interface data rate used between the RF module and host. This parameter determines the rate at which serial data is sent to the module from the host. Modified interface data rates do not take effect until the CN (Exit AT Command Mode) command is issued and the system returns the 'OK' response. When parameters 0-7 are sent to the module, the respective interface data rates are used (as shown in the table on the right). The RF data rate is not affected by the BD parameter. If the interface data rate is set higher than the RF data rate, a flow control configuration may need to be implemented. AT Command: ATBD Parameter Range:0 - 7 (standard rates) 0x80-0x3D090 (non-standard rates up to 250 Kbps) Parameter 0 1 2 3 4 5 6 7 Configuration (bps) 1200 2400 4800 9600 19200 38400 57600 115200
Default Parameter Value:3 Non-standard Interface Data Rates: Any value above 0x07 will be interpreted as an actual baud rate. When a value above 0x07 is sent, the closest interface data rate represented by the number is stored in the BD register. For example, a rate of 19200 bps can be set by sending the following command line "ATBD4B00". NOTE: When using Digis X-CTU Software, non-standard interface data rates can only be set and read using the X-CTU Terminal tab. Non-standard rates are not accessible through the Modem Configuration tab. When the BD command is sent with a non-standard interface data rate, the UART will adjust to accommodate the requested interface rate. In most cases, the clock resolution will cause the stored BD parameter to vary from the parameter that was sent (refer to the table below). Reading the BD command (send "ATBD" command without an associated parameter value) will return the value actually stored in the modules BD register. ParametersSentVersusParametersStored BD Parameter Sent (HEX) 0 4 7 12C 1C200 Interface Data Rate (bps) 1200 19,200 115,200* 300 115,200 BD Parameter Stored (HEX) 0 4 7 12B 1B207
* The 115,200 baud rate setting is actually at 111,111 baud (-3.5% target UART speed). CA (CCA Threshold) Command <RF Interfacing> CA command is used to set and read CCA (Clear Channel Assessment) thresholds. Prior to transmitting a packet, a CCA is performed to detect energy on the transmit channel. If the detected energy is above the CCA Threshold, the RF module will not transmit the packet. AT Command: ATCA Parameter Range: 0 - 0x50 [-dBm] Default Parameter Value: 0x2C (-44 decimal dBm) Minimum Firmware Version Required: v1.x80
38
CC (Command Sequence Character) Command <AT Command Mode Options> The CC command is used to set and read the ASCII character used between guard times of the AT Command Mode Sequence (GT + CC + GT). This sequence enters the RF module into AT Command Mode so that data entering the module from the host is recognized as commands instead of payload. AT Command: ATCC Parameter Range: 0 - 0xFF Default Parameter Value: 0x2B (ASCII +) Related Command: GT (Guard Times)
The AT Command Sequence is explained further in the AT Command Mode section. CE (Coordinator Enable) Command <Networking {Association} The CE command is used to set and read the behavior (End Device vs. Coordinator) of the RF module. AT Command: ATCE Parameter Range:0 - 1 Parameter 0 1 Default Parameter Value:0 Minimum Firmware Version Required: v1.x80 CH (Channel) Command <Networking {Addressing}> The CH command is used to set/read the operating channel on which RF connections are made between RF modules. The channel is one of three addressing options available to the module. The other options are the PAN ID (ID command) and destination addresses (DL & DH commands). AT Command: ATCH Parameter Range: 0x0B - 0x1A (XBee) 0x0C - 0x17 (XBee-PRO) Default Parameter Value: 0x0C (12 decimal) Related Commands: ID (PAN ID), DL (Destination Address Low, DH (Destination Address High) Configuration End Device Coordinator
In order for modules to communicate with each other, the modules must share the same channel number. Different channels can be used to prevent modules in one network from listening to transmissions of another. Adjacent channel rejection is 23 dB. The module uses channel numbers of the 802.15.4 standard. Center Frequency = 2.405 + (CH - 11d) * 5 MHz (d = decimal) Refer to the XBee/XBee-PRO Addressing section for more information. CN (Exit Command Mode) Command <AT Command Mode Options> The CN command is used to explicitly exit the RF module from AT Command Mode. CT (Command Mode Timeout) Command <AT Command Mode Options> The CT command is used to set and read the amount of inactive time that elapses before the RF module automatically exits from AT Command Mode and returns to Idle Mode. Use the CN (Exit Command Mode) command to exit AT Command Mode manually. AT Command: ATCT Parameter Range:2 - 0xFFFF [x 100 milliseconds] Default Parameter Value: 0x64 (100 decimal (which equals 10 decimal seconds)) Number of bytes returned: 2 Related Command: CN (Exit Command Mode) AT Command: ATCN
39
D0 - D4 (DIOn Configuration) Commands <I/O Settings> The D0, D1, D2, D3 and D4 commands are used to select/read the behavior of their respective AD/DIO lines (pins 20, 19, 18, 17 and 11 respectively). Options include: Analog-to-digital converter Digital input Digital output AT Commands: ATD0, ATD1, ATD2, ATD3, ATD4 Parameter Range:0 - 5 Parameter 0 1 2 3 4 5 Default Parameter Value:0 Minimum Firmware Version Required: 1.x.A0 D5 (DIO5 Configuration) Command <I/O Settings> The D5 command is used to select/read the behavior of the DIO5 line (pin 15). Options include: Associated Indicator (LED blinks when the module is associated) Analog-to-digital converter Digital input Digital output AT Command: ATD5 Parameter Range:0 - 5 Parameter 0 1 2 3 4 5 Default Parameter Value:1 Parameters 2-5 supported as of firmware version 1.xA0 D6 (DIO6 Configuration) Command <I/O Settings> The D6 command is used to select/read the behavior of the DIO6 line (pin 16). Options include: RTS flow control Analog-to-digital converter Digital input Digital output AT Command: ATD6 Parameter Range:0 - 5 Parameter 0 1 2 3 4 5 Default Parameter Value:0 Parameters 3-5 supported as of firmware version 1.xA0 Configuration Disabled RTS Flow Control n/a DI DO low DO high Configuration Disabled Associated Indicator ADC DI DO low DO high Configuration Disabled n/a ADC DI DO low DO high
40
D7 (DIO7 Configuration) Command <I/O Settings> The D7 command is used to select/read the behavior of the DIO7 line (pin 12). Options include: CTS flow control Analog-to-digital converter Digital input Digital output RS485 TX Enable AT Command: ATD7 Parameter Range:0 - 5 Parameter 0 1 2 3 4 5 6 7 Configuration Disabled CTS Flow Control n/a DI DO low DO high RS485 TX Enable Low RS485 TX Enable High
Default Parameter Value:1 D8 (DI8 Configuration) Command <I/O Settings> The D8 command is used to select/read the behavior of the DI8 line (pin 9). This command enables configuring the pin to function as a digital input. This line is also used with Pin Sleep. Parameters 3-7 supported as of firmware version 1.x.A0 AT Command: ATD8 Parameter Range:0 - 5 (1, 2, 4 & 5 n/a) Parameter 0 3 Default Parameter Value:0 Minimum Firmware Version Required: 1.xA0 DA (Force Disassociation) Command <(Special)> The DA command is used to immediately disassociate an End Device from a Coordinator and reattempt to associate. DB (Received Signal Strength) Command <Diagnostics> DB parameter is used to read the received signal strength (in dBm) of the last RF packet received. Reported values are accurate between -40 dBm and the RF module's receiver sensitivity. AT Command: ATDB AT Command: ATDA Minimum Firmware Version Required: v1.x80 Configuration Disabled DI
Parameter Range [read-only]: 0x17-0x5C (XBee), 0x24-0x64 (XBee-PRO)
Absolute values are reported. For example: 0x58 = -88 dBm (decimal). If no packets have been received (since last reset, power cycle or sleep event), 0 will be reported. DH (Destination Address High) Command <Networking {Addressing}> The DH command is used to set and read the upper 32 bits of the RF module's 64-bit destination address. When combined with the DL (Destination Address Low) parameter, it defines the destination address used for transmission. AT Command: ATDH Parameter Range: 0 - 0xFFFFFFFF Default Parameter Value: 0 Related Commands: DL (Destination Address Low), CH (Channel), ID (PAN VID), MY (Source Address)
An module will only communicate with other modules having the same channel (CH parameter), PAN ID (ID parameter) and destination address (DH + DL parameters).
To transmit using a 16-bit address, set the DH parameter to zero and the DL parameter less than 0xFFFF. 0x000000000000FFFF (DL concatenated to DH) is the broadcast address for the PAN.
41
Refer to the XBee/XBee-PRO Addressing section for more information. DL (Destination Address Low) Command <Networking {Addressing}> The DL command is used to set and read the lower 32 bits of the RF module's 64-bit destination address. When combined with the DH (Destination Address High) parameter, it defines the destination address used for transmission. AT Command: ATDL Parameter Range: 0 - 0xFFFFFFFF Default Parameter Value: 0 Related Commands: DH (Destination Address High), CH (Channel), ID (PAN VID), MY (Source Address)
A module will only communicate with other modules having the same channel (CH parameter), PAN ID (ID parameter) and destination address (DH + DL parameters).
To transmit using a 16-bit address, set the DH parameter to zero and the DL parameter less than 0xFFFF. 0x000000000000FFFF (DL concatenated to DH) is the broadcast address for the PAN. Refer to the XBee/XBee-PRO Addressing section for more information. DN (Destination Node) Command <Networking {Identification}> The DN command is used to resolve a NI (Node Identifier) string to a physical address. The following events occur upon successful command execution: AT Command: ATDN Parameter Range: 20-character ASCII String Minimum Firmware Version Required: v1.x80
1. DL and DH are set to the address of the module with the matching NI (Node Identifier). 2. OK is returned. 3. RF module automatically exits AT Command Mode. If there is no response from a modem within 200 msec or a parameter is not specified (left blank), the command is terminated and an ERROR message is returned. DP (Disassociation Cyclic Sleep Period) Command <Sleep Mode (Low Power)> NonBeacon Firmware AT Command: ATDP
Parameter Range: 1 - 0x68B0 [x 10 milliseconds] End Device - The DP command is used to set and read the time period of sleep for cyclic sleeping Default Parameter Value:0x3E8 remotes that are configured for Association but (1000 decimal) are not associated to a Coordinator. (i.e. If a Related Commands: SM (Sleep Mode), SP device is configured to associate, configured as a (Cyclic Sleep Period), ST (Time before Sleep) Cyclic Sleep remote, but does not find a CoordiMinimum Firmware Version Required: v1.x80 nator; it will sleep for DP time before reattempting association.) Maximum sleep period is 268 seconds (0x68B0). DP should be > 0 for NonBeacon systems. EA (ACK Failures) Command <Diagnostics> The EA command is used to reset and read the count of ACK (acknowledgement) failures. This parameter value increments when the module expires its transmission retries without receiving an ACK on a packet transmission. This count saturates at its maximum value. Set the parameter to 0 to reset count. AT Command: ATEA Parameter Range:0 - 0xFFFF Minimum Firmware Version Required: v1.x80
42
EC (CCA Failures) Command <Diagnostics> The EC command is used to read and reset the count of CCA (Clear Channel Assessment) failures. This parameter value increments when the RF module does not transmit a packet due to the detection of energy that is above the CCA threshold level (set with CA command). This count saturates at its maximum value. Set the EC parameter to 0 to reset count. ED (Energy Scan) Command <Networking {Association}> The ED command is used to send an Energy Detect Scan. This parameter determines the length of scan on each channel. The maximal energy on each channel is returned and each value is followed by a carriage return. An additional carriage return is sent at the end of the command. AT Command: ATED AT Command: ATEC Parameter Range:0 - 0xFFFF Related Command: CA (CCA Threshold) Minimum Firmware Version Required: v1.x80
Parameter Range:0 - 6
Related Command: SD (Scan Duration), SC (Scan Channel)
Minimum Firmware Version Required: v1.x80
The values returned represent the detected energy level in units of -dBm. The actual scan time on each channel is measured as Time = [(2 ^ ED PARAM) * 15.36] ms. Note: Total scan time is this time multiplied by the number of channels to be scanned. Also refer to the SD (Scan Duration) table. Use the SC (Scan Channel) command to choose which channels to scan. EE (AES Encryption Enable) Command <Networking {Security}> The EE command is used to set/read the parameter that disables/ enables 128-bit AES encryption. The XBee/XBee-PRO firmware uses the 802.15.4 Default Security protocol and uses AES encryption with a 128-bit key. AES encryption dictates that all modules in the network use the same key and the maximum RF packet size is 95 Bytes. AT Command: ATEE Parameter Range:0 - 1 Parameter 0 1 Default Parameter Value:0 Related Commands: KY (Encryption Key), AP (API Enable), MM (MAC Mode) Configuration Disabled Enabled
When encryption is enabled, the module will Minimum Firmware Version Required: v1.xA0 always use its 64-bit long address as the source address for RF packets. This does not affect how the MY (Source Address), DH (Destination Address High) and DL (Destination Address Low) parameters work If MM (MAC Mode) > 0 and AP (API Enable) parameter > 0: With encryption enabled and a 16-bit short address set, receiving modules will only be able to issue RX (Receive) 64-bit indicators. This is not an issue when MM = 0. If a module with a non-matching key detects RF data, but has an incorrect key: When encryption is enabled, non-encrypted RF packets received will be rejected and will not be sent out the UART. Transparent Operation --> All RF packets are sent encrypted if the key is set. API Operation --> Receive frames use an option bit to indicate that the packet was encrypted. FP (Force Poll) Command <Networking (Association)> The FP command is used to request indirect messages being held by a Coordinator. AT Command: ATFP Minimum Firmware Version Required: v1.x80
43
FR (Software Reset) Command <Special> The FR command is used to force a software reset on the RF module. The reset simulates powering off and then on again the module. GT (Guard Times) Command <AT Command Mode Options> GT Command is used to set the DI (data in from host) time-ofsilence that surrounds the AT command sequence character (CC Command) of the AT Command Mode sequence (GT + CC + GT). The DI time-of-silence is used to prevent inadvertent entrance into AT Command Mode. AT Command: ATGT Parameter Range:2 - 0x0CE4 [x 1 millisecond] Default Parameter Value:0x3E8 (1000 decimal) Related Command: CC (Command Sequence Character) AT Command: ATFR Minimum Firmware Version Required: v1.x80
Refer to the Command Mode section for more information regarding the AT Command Mode Sequence. HV (Hardware Version) Command <Diagnostics> The HV command is used to read the hardware version of the RF module.
AT Command: ATHV Parameter Range:0 - 0xFFFF [Read-only] Minimum Firmware Version Required: v1.x80
IA (I/O Input Address) Command <I/O Settings {I/O Line Passing}> The IA command is used to bind a module output to a specific address. Outputs will only change if received from this address. The IA command can be used to set/read both 16 and 64-bit addresses. Setting all bytes to 0xFF will not allow the reception of any I/O packet to change outputs. Setting the IA address to 0xFFFF will cause the module to accept all I/O packets. IC (DIO Change Detect) Command <I/O Settings> 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. AT Command: ATIC Parameter Range:0 - 0xFF [bitfield] Default Parameter Value:0 (disabled) Minimum Firmware Version Required: 1.xA0 AT Command: ATIA Parameter Range:0 - 0xFFFFFFFFFFFFFFFF Default Parameter Value:0xFFFFFFFFFFFFFFFF (will not allow any received I/O packet to change outputs) Minimum Firmware Version Required: v1.xA0
Refer to the ADC and Digital I/O Line Support sections of the RF Module Operations chapter for more information. ID (Pan ID) Command <Networking {Addressing}> The ID command is used to set and read the PAN (Personal Area Network) ID of the RF module. Only modules with matching PAN IDs can communicate with each other. Unique PAN IDs enable control of which RF packets are received by a module. AT Command: ATID Parameter Range: 0 - 0xFFFF Default Parameter Value:0x3332 (13106 decimal)
Setting the ID parameter to 0xFFFF indicates a global transmission for all PANs. It does not indicate a global receive.
44
IO (Digital Output Level) Command <I/O Settings> The IO command is used to set digital output levels. This allows DIO lines setup as outputs to be changed through Command Mode. AT Command: ATIO Parameter Range: 8-bit bitmap (where each bit represents the level of an I/O line that is setup as an output.) Minimum Firmware Version Required: v1.xA0 IR (Sample Rate) Command <I/O Settings> The IR command is used to set/ read the sample rate. When set, the module will sample all enabled DIO/ADC lines at a specified interval. This command allows periodic reads of the ADC and DIO lines in a non-Sleep Mode setup. A sample rate which requires transmissions at a rate greater than once every 20ms is not recommended. AT Command: ATIR Parameter Range: 0 - 0xFFFF [x 1 msec] (cannot guarantee 1 ms timing when IT=1) Default Parameter Value:0 Related Command: IT (Samples before TX) Minimum Firmware Version Required: v1.xA0
Example: When IR = 0x14, the sample rate is 20 ms (or 50 Hz). IS (Force Sample) Command <I/O Settings> The IS command is used to force a read of all enabled DIO/ADC lines. The data is returned through the UART. When operating in Transparent Mode (AP=0), the data is retuned in the following format: AT Command: ATIS Parameter Range: 1 - 0xFF Default Parameter Value:1 Minimum Firmware Version Required: v1.xA0
All bytes are converted to ASCII: number of samples<CR> channel mask<CR> DIO data<CR> (If DIO lines are enabled<CR> ADC channel Data<cr> <-This will repeat for every enabled ADC channel<CR> <CR> (end of data noted by extra <CR>) When operating in API mode (AP > 0), the command will immediately return an OK response. The data will follow in the normal API format for DIO data. IT (Samples before TX) Command <I/O Settings> The IT command is used to set/ read the number of DIO and ADC samples to collect before transmitting data. AT Command: ATIT Parameter Range: 1 - 0xFF
Default Parameter Value:1 One ADC sample is considered complete when all Minimum Firmware Version Required: v1.xA0 enabled ADC channels have been read. The module can buffer up to 93 Bytes of sample data. Since the module uses a 10-bit A/D converter, each sample uses two Bytes. This leads to a maximum buffer size of 46 samples or IT=0x2E. When Sleep Modes are enabled and IR (Sample Rate) is set, the module will remain awake until IT samples have been collected.
45
IU (I/O Output Enable) Command <I/O Settings> The IU command is used to disable/enable I/O UART output. When enabled (IU = 1), received I/O line data packets are sent out the UART. The data is sent using an API frame regardless of the current AP parameter value. AT Command: ATIU Parameter Range:0 - 1 Parameter 0 Configuration Disabled Received I/O line data packets will be NOT sent out UART. Enabled Received I/O line data will be sent out UART
Default Parameter Value:1 Minimum Firmware Version Required: 1.xA0 KY (AES Encryption Key) Command <Networking {Security}> The KY command is used to set the 128-bit AES (Advanced Encryption Standard) key for encrypting/decrypting data. Once set, the key cannot be read out of the module by any means. AT Command: ATKY Parameter Range:0 - (any 16-Byte value) Default Parameter Value:0 Related Command: EE (Encryption Enable)
Minimum Firmware Version Required: v1.xA0 The entire payload of the packet is encrypted using the key and the CRC is computed across the ciphertext. When encryption is enabled, each packet carries an additional 16 Bytes to convey the random CBC Initialization Vector (IV) to the receiver(s). The KY value may be 0 or any 128-bit value. Any other value, including entering KY by itself with no parameters, is invalid. All ATKY entries (valid or not) are received with a returned 'OK'. A module with the wrong key (or no key) will receive encrypted data, but the data driven out the serial port will be meaningless. A module with a key and encryption enabled will receive data sent from a module without a key and the correct unencrypted data output will be sent out the serial port. Because CBC mode is utilized, repetitive data appears differently in different transmissions due to the randomly-generated IV. When queried, the system will return an OK message and the value of the key will not be returned. M0 (PWM0 Output Level) Command <I/O Settings> The M0 command is used to set/ read the output level of the PWM0 line (pin 6). Before setting the line as an output: 1. Enable PWM0 output (P0 = 2) 2. Apply settings (use CN or AC) The PWM period is 64 sec and there are 0x03FF (1023 decimal) steps within this period. When M0 = 0 (0% PWM), 0x01FF (50% PWM), 0x03FF (100% PWM), etc. M1 (PWM1 Output Level) Command <I/O Settings> The M1 command is used to set/ read the output level of the PWM1 line (pin 7). Before setting the line as an output: 1. Enable PWM1 output (P1 = 2) 2. Apply settings (use CN or AC) AT Command: ATM1 Parameter Range:0 - 0x03FF Default Parameter Value:0 Related Commands: P1 (PWM1 Enable), AC (Apply Changes), CN (Exit Command Mode) Minimum Firmware Version Required: v1.xA0 AT Command: ATM0 Parameter Range:0 - 0x03FF [steps] Default Parameter Value:0 Related Commands: P0 (PWM0 Enable), AC (Apply Changes), CN (Exit Command Mode) Minimum Firmware Version Required: v1.xA0
46
MM (MAC Mode) Command <Networking {Addressing}> The MM command is used to set and read the MAC Mode value. The MM command disables/enables the use of a Digi header contained in the 802.15.4 RF packet. By default (MM = 0), Digi Mode is enabled and the module adds an extra header to the data portion of the 802.15.4 packet. This enables the following features: ND and DN command support Duplicate packet detection when using ACKs "RR command "DIO/AIO sampling support AT Command: ATMM Parameter Range:0 - 3 Parameter 0 1 2 3 Configuration Digi Mode (802.15.4 + Digi header) 802.15.4 (no ACKs) 802.15.4 (with ACKs) Digi Mode (no ACKs)
Default Parameter Value:0 Related Commands: ND (Node Discover), DN (Destination Node)
The MM command allows users to turn off the use Minimum Firmware Version Required: v1.x80 of the extra header. Modes 1 and 2 are strict 802.15.4 modes. If the Digi header is disabled, ND and DN parameters are also disabled. Note: When MM=0 or 3, application and CCA failure retries are not supported. MY (16-bit Source Address) Command <Networking {Addressing}> The MY command is used to set and read the 16-bit source address of the RF module. By setting MY to 0xFFFF, the reception of RF packets having a 16-bit address is disabled. The 64-bit address is the modules serial number and is always enabled. NB (Parity) Command <Serial Interfacing> The NB command is used to select/read the parity settings of the RF module for UART communications. Note: the module does not actually calculate and check the parity; it only interfaces with devices at the configured parity and stop bit settings. AT Command: ATNB Parameter Range: 0 - 4 Parameter 0 1 2 3 4 Default Parameter Value: 0 Number of bytes returned: 1 Configuration 8-bit (no parity or 7-bit (any parity) 8-bit even 8-bit odd 8-bit mark 8-bit space AT Command: ATMY Parameter Range: 0 - 0xFFFF Default Parameter Value: 0 Related Commands: DH (Destination Address High), DL (Destination Address Low), CH (Channel), ID (PAN ID)
47
ND (Node Discover) Command <Networking {Identification}> The ND command is used to discover and report all modules on its current operating channel (CH parameter) and PAN ID (ID parameter). ND also accepts an NI (Node Identifier) value as a parameter. In this case, only a module matching the supplied identifier will respond. AT Command: ATND Range: optional 20-character NI value Related Commands: CH (Channel), ID (Pan ID), MY (Source Address), SH (Serial Number High), SL (Serial Number Low), NI (Node Identifier), NT (Node Discover Time)
Minimum Firmware Version Required: v1.x80 ND uses a 64-bit long address when sending and responding to an ND request. The ND command causes a module to transmit a globally addressed ND command packet. The amount of time allowed for responses is determined by the NT (Node Discover Time) parameter. In AT Command mode, command completion is designated by a carriage return (0x0D). Since two carriage returns end a command response, the application will receive three carriage returns at the end of the command. If no responses are received, the application should only receive one carriage return. When in API mode, the application should receive a frame (with no data) and status (set to OK) at the end of the command. When the ND command packet is received, the remote sets up a random time delay (up to 2.2 sec) before replying as follows: Node Discover Response (AT command mode format - Transparent operation): MY (Source Address) value<CR> SH (Serial Number High) value<CR> SL (Serial Number Low) value<CR> DB (Received Signal Strength) value<CR> NI (Node Identifier) value<CR> <CR> (This is part of the response and not the end of command indicator.) Node Discover Response (API format - data is binary (except for NI)): 2 bytes for MY (Source Address) value 4 bytes for SH (Serial Number High) value 4 bytes for SL (Serial Number Low) value 1 byte for DB (Received Signal Strength) value NULL-terminated string for NI (Node Identifier) value (max 20 bytes w/out NULL terminator) NI (Node Identifier) Command <Networking {Identification}> The NI command is used to set and read a string for identifying a particular node. Rules: Register only accepts printable ASCII data. A string can not start with a space. A carriage return ends command Command will automatically end when maximum bytes for the string have been entered. This string is returned as part of the ND (Node Discover) command. This identifier is also used with the DN (Destination Node) command. NO (Node Discover Options) Command <Networking {Identification}> The NO command is used to suppress/include a self-response to Node Discover commands. When NO=1 a module doing a Node Discover will include a response entry for itself. AT Command: ATNO Parameter Range: "0-1 Related Commands: ND (Node Discover), DN (Destination Node) Minimum Firmware Version Required: v1.xC5 AT Command: ATNI Parameter Range: 20-character ASCII string Related Commands: ND (Node Discover), DN (Destination Node) Minimum Firmware Version Required: v1.x80
48
NT (Node Discover Time) Command <Networking {Identification}> The NT command is used to set the amount of time a base node will wait for responses from other nodes when using the ND (Node Discover) command. The NT value is transmitted with the ND command. AT Command: ATNT Parameter Range: 0x01 - 0xFC [x 100 msec] Default: 0x19 (2.5 decimal seconds)
Related Commands: ND (Node Discover) Remote nodes will set up a random hold-off time Minimum Firmware Version Required: 1.xA0 based on this time. The remotes will adjust this time down by 250 ms to give each node the ability to respond before the base ends the command. Once the ND command has ended, any response received on the base will be discarded. P0 (PWM0 Configuration) Command <I/O Setting {I/O Line Passing}> The P0 command is used to select/read the function for PWM0 (Pulse Width Modulation output 0). This command enables the option of translating incoming data to a PWM so that the output can be translated back into analog form. With the IA (I/O Input Address) parameter correctly set, AD0 values can automatically be passed to PWM0. AT Command: ATP0 The second character in the command is the number zero (0), not the letter O. Parameter Range: 0 - 2 Parameter 0 1 2 Default Parameter Value: 1 P1 (PWM1 Configuration) Command <I/O Setting {I/O Line Passing}> The P1 command is used to select/read the function for PWM1 (Pulse Width Modulation output 1). This command enables the option of translating incoming data to a PWM so that the output can be translated back into analog form. With the IA (I/O Input Address) parameter correctly set, AD1 values can automatically be passed to PWM1. AT Command: ATP1 Parameter Range: 0 - 2 Parameter 0 1 2 Default Parameter Value: 0 Minimum Firmware Version Required: v1.xA0 Configuration Disabled RSSI PWM1 Output Configuration Disabled RSSI PWM0 Output
PL (Power Level) Command <RF Interfacing> The PL command is used to select and read the power level at which the RF module transmits conducted power. When operating in Europe, XBee-PRO 802.15.4 modules must operate at or below a transmit power output level of 10dBm. Customers have 2 choices for transmitting at or below 10dBm: Order the standard XBeePRO module and change the PL command to "0" (10dBm), AT Command: ATPL Parameter Range: 0 - 4 Parameter 0 1 2 3 4 XBee -10 dBm -6 dBm -4 dBm -2 dBm 0 dBm XBee-PRO 10 dBm 12 dBm 14 dBm 16 dBm 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
Default Parameter Value: 4
Order the International variant of the XBee-PRO module, which has a maximum transmit output power of 10dBm.
49
PR (Pull-up Resistor) Command <Serial Interfacing> The PR command is used to set and read the bit field that is used to configure internal the pull-up resistor status for I/O lines. 1 specifies the pull-up resistor is enabled. 0 specifies no pull up. bit bit bit bit bit bit bit bit 0 1 2 3 4 5 6 7 AD4/DIO4 (pin 11) AD3/DIO3 (pin 17) AD2/DIO2 (pin 18) AD1/DIO1 (pin 19) AD0/DIO0 (pin 20) AD6/DIO6 (pin 16) DI8 (pin 9) DIN/CONFIG (pin 3) AT Command: ATPR Parameter Range: 0 - 0xFF Default Parameter Value: 0xFF (all pull-up resistors are enabled) Minimum Firmware Version Required: v1.x80
For example: Sending the command ATPR 6F will turn bits 0, 1, 2, 3, 5 and 6 ON; and bits 4 & 7 will be turned OFF. (The binary equivalent of 0x6F is 01101111. Note that bit 0 is the last digit in the bitfield. PT (PWM Output Timeout) Command <I/O Settings {I/O Line Passing}> The PT command is used to set/read the 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. RE (Restore Defaults) Command <(Special)> The RE command is used to restore AT Command: ATRE all configurable parameters to their factory default settings. The RE command does not write restored values to non-volatile (persistent) memory. Issue the WR (Write) command subsequent to issuing the RE command to save restored parameter values to non-volatile memory. RN (Random Delay Slots) Command <Networking & Security> The RN command is used to set and read the minimum value of the back-off exponent in the CSMA-CA algorithm. The CSMA-CA algorithm was engineered for collision avoidance (random delays are inserted to prevent data loss caused by data collisions). AT Command: ATRN Parameter Range: 0 - 3 [exponent] Default Parameter Value: 0 AT Command: ATPT Parameter Range: 0 - 0xFF [x 100 msec] Default Parameter Value: 0xFF Minimum Firmware Version Required: 1.xA0
If RN = 0, collision avoidance is disabled during the first iteration of the algorithm (802.15.4 macMinBE). CSMA-CA stands for "Carrier Sense Multiple Access - Collision Avoidance". Unlike CSMA-CD (reacts to network transmissions after collisions have been detected), CSMA-CA acts to prevent data collisions before they occur. As soon as a module receives a packet that is to be transmitted, it checks if the channel is clear (no other module is transmitting). If the channel is clear, the packet is sent over-the-air. If the channel is not clear, the module waits for a randomly selected period of time, then checks again to see if the channel is clear. After a time, the process ends and the data is lost.
50
RO (Packetization Timeout) Command <Serial Interfacing> RO command is used to set and read the number of character times of intercharacter delay required before transmission. AT Command: ATRO Parameter Range:0 - 0xFF [x character times]
RF transmission commences when data is Default Parameter Value: 3 detected in the DI (data in from host) buffer and RO character times of silence are detected on the UART receive lines (after receiving at least 1 byte).
RF transmission will also commence after 100 Bytes (maximum packet size) are received in the DI buffer. Set the RO parameter to '0' to transmit characters as they arrive instead of buffering them into one RF packet. RP (RSSI PWM Timer) Command <I/O Settings {I/O Line Passing}> The RP comAT Command: ATRP mand is used to enable PWM (Pulse Width ModuParameter Range:0 - 0xFF lation) output on the RF module. The output is [x 100 msec] calibrated to show the level a received RF signal is Default Parameter Value: 0x28 (40 decimal) above the sensitivity level of the module. The PWM pulses vary from 24 to 100%. Zero percent means PWM output is inactive. One to 24% percent means the received RF signal is at or below the published sensitivity level of the module. The following table shows levels above sensitivity and PWM values. The total period of the PWM output is 64 s. Because there are 445 steps in the PWM output, the minimum step size is 144 ns. PWMPercentages dB above Sensitivity 10 20 30 PWM percentage (high period / total period) 41% 58% 75%
A non-zero value defines the time that the PWM output will be active with the RSSI value of the last received RF packet. After the set time when no RF packets are received, the PWM output will be set low (0 percent PWM) until another RF packet is received. The PWM output will also be set low at power-up until the first RF packet is received. A parameter value of 0xFF permanently enables the PWM output and it will always reflect the value of the last received RF packet. RR (XBee Retries) Command <Networking {Addressing}> The RR command is used set/read the maximum number of retries the module will execute in addition to the 3 retries provided by the 802.15.4 MAC. For each XBee retry, the 802.15.4 MAC can execute up to 3 retries. AT Command: ATRR Parameter Range: 0 - 6 Default: 0 Minimum Firmware Version Required: 1.xA0
This values does not need to be set on all modules for retries to work. If retries are enabled, the transmitting module will set a bit in the Digi RF Packet header which requests the receiving module to send an ACK (acknowledgement). If the transmitting module does not receive an ACK within 200 msec, it will re-send the packet within a random period up to 48 msec. Each XBee retry can potentially result in the MAC sending the packet 4 times (1 try plus 3 retries). Note that retries are not attempted for packets that are purged when transmitting with a Cyclic Sleep Coordinator.
51
SC (Scan Channels) Command <Networking {Association}> The SC command is used to set and read the list of channels to scan for all Active and Energy Scans as a bit field. This affects scans initiated in command mode [AS (Active Scan) and ED (Energy Scan) commands] and during End Device Association and Coordinator startup. AT Command: ATSC Parameter Range: 1-0xFFFF [Bitfield] (bits 0, 14, 15 are not allowed when using the XBee-PRO) Default Parameter Value: 0x1FFE (all XBeePRO channels) Related Commands: ED (Energy Scan), SD (Scan Duration) Minimum Firmware Version Required: v1.x80 bit bit bit bit 0 1 2 3 0x0B 0x0C 0x0D 0x0E bit bit bit bit 4 5 6 7 0x0F 0x10 0x11 0x12 bit bit bit bit 8 - 0x13 9 - 0x14 10 - 0x15 11 - 0x16 bit bit bit bit 12 13 14 15 0x17 0x18 0x19 0x1A
SD (Scan Duration) Command <Networking {Association}> The SD command is used to set and read the exponent value that determines the duration (in time) of a scan. End Device (Duration of Active Scan during Association) - In a Beacon system, set SD = BE of the Coordinator. SD must be set at least to the highest BE parameter of any Beaconing Coordinator with which an End Device or Coordinator wish to discover. AT Command: ATSD Parameter Range: 0 - 0x0F Default Parameter Value: 4 Related Commands: ED (Energy Scan), SC (Scan Channel) Minimum Firmware Version Required: v1.x80
Coordinator - If the ReassignPANID option is set on the Coordinator [refer to A2 parameter], the SD parameter determines the length of time the Coordinator will scan channels to locate existing PANs. If the 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 RF Module can scan up to 16 channels (SC = 0xFFFF). The XBee PRO RF Module can scan up to 12 channels (SC = 0x1FFE). Examples:Valuesbelowshowresultsfora12channelscan If SD = 0, time = 0.18 sec SD = 2, time = 0.74 sec SD = 4, time = 2.95 sec SD = 6, time = 11.80 sec SD = 8, time = 47.19 sec SD = 10, time = 3.15 min SD = 12, time = 12.58 min SD = 14, time = 50.33 min
SH (Serial Number High) Command <Diagnostics> The SH command is used to read the high 32 bits of the RF module's unique IEEE 64-bit address. The module serial number is set at the factory and is read-only. SL (Serial Number Low) Command <Diagnostics> The SL command is used to read the low 32 bits of the RF module's unique IEEE 64-bit address. The module serial number is set at the factory and is read-only. AT Command: ATSL Parameter Range: 0 - 0xFFFFFFFF [read-only] Related Commands: SH (Serial Number High), MY (Source Address) AT Command: ATSH Parameter Range: 0 - 0xFFFFFFFF [read-only] Related Commands: SL (Serial Number Low), MY (Source Address)
52
SM (Sleep Mode) Command <Sleep Mode (Low Power)> The SM command is used to set and read Sleep Mode settings. By default, Sleep Modes are disabled (SM = 0) and the RF module remains in Idle/ Receive Mode. When in this state, the module is constantly ready to respond to either serial or RF activity. * The Sleep Coordinator option (SM=6) only exists for backwards compatibility with firmware version 1.x06 only. In all other cases, use the CE command to enable a Coordinator. SO (Sleep Mode Command) 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. SP (Cyclic Sleep Period) Command <Sleep Mode (Low Power)> The SP command is used to set and read the duration of time in which a remote RF module sleeps. After the cyclic sleep period is over, the module wakes and checks for data. If data is not present, the module goes back to sleep. The maximum sleep period is 268 seconds (SP = 0x68B0). The SP parameter is only valid if the module is configured to operate in Cyclic Sleep (SM = 4-6). Coordinator and End Device SP values should always be equal. To send Direct Messages, set SP = 0. NonBeacon Firmware 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). AT Command: ATSP Parameter Range: NonBeacon Firmware: 0-0x68B0 [x 10 milliseconds] AT Command: ATSO Parameter Range: 0-4 AT Command: ATSM Parameter Range: 0 - 6 Parameter 0 1 2 3 4 5 6 Configuration Disabled Pin Hibernate Pin Doze (reserved) Cyclic Sleep Remote Cyclic Sleep Remote (with Pin Wake-up) Sleep Coordinator*
Default Parameter Value: 0
Default Parameter Value: Related Commands: SM (Sleep Mode), ST (Time before Sleep), DP (Disassociation Cyclic Sleep Period, BE (Beacon Order)
Default Parameter Value: Related Commands: SM (Sleep Mode), ST (Time before Sleep), DP (Disassociation Cyclic Sleep Period, BE (Beacon Order)
53
ST (Time before Sleep) Command <Sleep Mode (Low Power)> The ST command is used to set and read the period of inactivity (no serial or RF data is sent or received) before activating Sleep Mode. 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). AT Command: ATST Parameter Range: NonBeacon Firmware: 1 - 0xFFFF [x 1 millisecond]
Default Parameter Value: Related Commands: SM (Sleep Mode), ST (Time before Sleep)
Coordinator and End Device ST values must be equal.
54
T0 - T7 ((D0-D7) Output Timeout) Command <I/O Settings {I/O Line Passing}> The T0, T1, AT Commands: ATT0 - ATT7 T2, T3, T4, T5, T6 and T7 commands are used to Parameter Range:0 - 0xFF [x 100 msec] set/read output timeout values for the lines that Default Parameter Value:0xFF correspond with the D0 - D7 parameters. When output is set (due to I/O line passing) to a nonMinimum Firmware Version Required: v1.xA0 default level, a timer is started which when expired, will set the output to its default level. The timer is reset when a valid I/O packet is received. The Tn parameter defines the permissible amount of time to stay in a non-default (active) state. If Tn = 0, Output Timeout is disabled (output levels are held indefinitely). VL (Firmware Version - Verbose) <Diagnostics> The VL command is used to read detailed version information about the RF module. The information includes: application build date; MAC, PHY and bootloader versions; and build dates. This command was removed from firmware 1xC9 and later versions. VR (Firmware Version) Command <Diagnostics> The VR command is used to read which firmware version is stored in the module. AT Command: ATVL Parameter Range:0 - 0xFF [x 100 milliseconds] Default Parameter Value: 0x28 (40 decimal) Minimum Firmware Version Required: v1.x80 - v1.xC8
AT Command: ATVR
Parameter Range: 0 - 0xFFFF [read only] XBee version numbers will have four significant digits. The reported number will show three or four numbers and is stated in hexadecimal notation. A version can be reported as "ABC" or "ABCD". Digits ABC are the main release number and D is the revision number from the main release. "D" is not required and if it is not present, a zero is assumed for D. "B" is a variant designator. The following variants exist: "0" = Non-Beacon Enabled 802.15.4 Code "1" = Beacon Enabled 802.15.4 Code WR (Write) Command <(Special)> The WR command is used to write AT Command: ATWR configurable parameters to the RF module's nonvolatile memory. Parameter values remain in the module's memory until overwritten by subsequent use of the WR Command. If changes are made without writing them to non-volatile memory, the module reverts back to previously saved parameters the next time the module is powered-on. NOTE: Once the WR command is sent to the module, no additional characters should be sent until after the OK/r response is received.
55
API Operation
By default, XBee/XBee-PRO RF Modules act as a serial line replacement (Transparent Operation) - all UART data received through the DI pin is queued up for RF transmission. When the module receives an RF packet, the data is sent out the DO pin with no additional information. Inherent to Transparent Operation are the following behaviors: If module parameter registers are to be set or queried, a special operation is required for transitioning the module into Command Mode. In point-to-multipoint systems, the application must send extra information so that the receiving module(s) can distinguish between data coming from different remotes. As an alternative to the default Transparent Operation, API (Application Programming Interface) Operations are available. API operation requires that communication with the module be done through a structured interface (data is communicated in frames in a defined order). The API specifies how commands, command responses and module status messages are sent and received from the module using a UART Data Frame.
API Frame Specifications

Two API modes are supported and both can be enabled using the AP (API Enable) command. Use the following AP parameter values to configure the module to operate in a particular mode: AP = 0 (default): Transparent Operation (UART Serial line replacement) API modes are disabled. AP = 1: API Operation AP = 2: API Operation (with escaped characters) Any data received prior to the start delimiter is silently discarded. If the frame is not received correctly or if the checksum fails, the data is silently discarded. API Operation (AP parameter = 1) When this API mode is enabled (AP = 1), the UART data frame structure is defined as follows: Figure301. UARTDataFrameStructure:
Start Delimiter (Byte 1) Length (Bytes 2-3) Frame Data (Bytes 4-n) Checksum (Byte n + 1)
0x7E
MSB
LSB
API-specific Structure
1 Byte
MSB=MostSignificantByte,LSB=LeastSignificantByte API Operation - with Escape Characters (AP parameter = 2) When this API mode is enabled (AP = 2), the UART data frame structure is defined as follows: Figure302. UARTDataFrameStructurewithescapecontrolcharacters:
Start Delimiter (Byte 1) Length (Bytes 2-3) Frame Data (Bytes 4-n) Checksum (Byte n + 1)
0x7E
MSB
LSB
1 Byte
Characters Escaped If Needed
MSB=MostSignificantByte,LSB=LeastSignificantByte Escape characters. When sending or receiving a UART data frame, specific data values must be escaped (flagged) so they do not interfere with the UART or UART data frame operation. To escape an interfering data byte, insert 0x7D and follow it with the byte to be escaped XORd with 0x20.
56
Data bytes that need to be escaped: 0x7E Frame Delimiter 0x7D Escape 0x11 XON 0x13 XOFF Example - Raw UART Data Frame (before escaping interfering bytes): 0x7E 0x00 0x02 0x23 0x11 0xCB 0x11 needs to be escaped which results in the following frame: 0x7E 0x00 0x02 0x23 0x7D 0x31 0xCB Note: In the above example, the length of the raw data (excluding the checksum) is 0x0002 and the checksum of the non-escaped data (excluding frame delimiter and length) is calculated as: 0xFF - (0x23 + 0x11) = (0xFF - 0x34) = 0xCB. Checksum To test data integrity, a checksum is calculated and verified on non-escaped data. To calculate: Not including frame delimiters and length, add all bytes keeping only the lowest 8 bits of the result and subtract from 0xFF. To verify: Add all bytes (include checksum, but not the delimiter and length). If the checksum is correct, the sum will equal 0xFF.
API Types
Frame data of the UART data frame forms an API-specific structure as follows:
Start Delimiter (Byte 1)
Figure303. UARTDataFrame&APIspecificStructure: Length Frame Data (Bytes 2-3) (Bytes 4- n)
Checksum (Byte n + 1)
0x7E
MSB
LSB
Identifier-specific Data
1 Byte
API Identifier
cmdID
cmdData
The cmdID frame (API-identifier) indicates which API messages will be contained in the cmdData frame (Identifier-specific data). Refer to the sections that follow for more information regarding the supported API types. Note that multi-byte values are sent big endian. Modem Status API Identifier: 0x8A RF module status messages are sent from the module in response to specific conditions. Figure304. ModemStatusFrames
Start Delimiter Length Frame Data Checksum
0 x7E
MSB
LSB
API -specific Structure
1 Byte
API Identifier
0x8 A
cmdData Status (Byte 5 )
0 1 2 3 4
Hardware reset W atchdog timer reset Associated Disassociated Synchronization Lost ( Beacon -enabled only ) 5 = Coordinator realignment 6 = Coordinator started
= = = = =
57
AT Command API Identifier Value: 0x08 The AT Command API type allows for module parameters to be queried or set. When using this command ID, new parameter values are applied immediately. This includes any register set with the AT Command - Queue Parameter Value (0x09) API type. Figure305. ATCommandFrames
0x7E
MSB
LSB
1 Byte
API Identifier
0x08
cmdData
Frame ID (Byte 5)
AT Command (Bytes 6-7)
Parameter Value (Byte(s) 8-n)
Identifies the UART data frame for the host to correlate with a subsequent ACK (acknowledgement). If set to 0, no response is sent.
Command Name - Two ASCII characters that identify the AT Command.
If present, indicates the requested parameter value to set the given register. If no characters present, register is queried.
Figure306. Example:APIframeswhenreadingtheDLparametervalueofthemodule.
Byte 1 Bytes 2-3 Byte 4 Byte 5 Bytes 6-7 Byte 8
0x7E
Start Delimiter
0x00
0x04
0x08
API Identifier
0x52 (R)
Frame ID**
0x44 (D) 0x4C (L)

AT Command
0x15
Checksum
Length*
*Length[Bytes]=APIIdentifier+FrameID+ATCommand **Rvaluewasarbitrarilyselected.
Figure307. Example:APIframeswhenmodifyingtheDLparametervalueofthemodule.
Byte 1 Bytes 2-3 Byte 4 Byte 5 Bytes 6-7 Bytes 8-11 Byte 12
0x7E
Start Delimiter
0x00
0x08
0x08
API Identifier
0x4D (M)
Frame ID**
0x44 (D) 0x4C (L)

AT Command
0x00000FFF
Parameter Value
0x0C
Checksum
Length*
*Length[Bytes]=APIIdentifier+FrameID+ATCommand+ParameterValue **Mvaluewasarbitrarilyselected.
AT Command - Queue Parameter Value API Identifier Value: 0x09 This API type allows module parameters to be queried or set. In contrast to the AT Command API type, new parameter values are queued and not applied until either the AT Command (0x08) API type or the AC (Apply Changes) command is issued. Register queries (reading parameter values) are returned immediately. Figure308. ATCommandFrames (NotethatframesareidenticaltotheATCommandAPItypeexceptfortheAPIidentifier.)
0x7E
MSB
LSB
1 Byte
API Identifier
0x09
cmdData
Frame ID (Byte 5)
Parameter Value (Byte(s) 8-n)
Identifies the UART data frame for the host to correlate with a subsequent ACK (acknowledgement). If set to 0, no response is requested.
If present, indicates the requested parameter value to set the given register. If no characters present, register is queried.
58
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 message. 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. Figure309. ATCommandResponseFrames.
0x7E
MSB
LSB
1 Byte
API Identifier
0x88
cmdData
Frame ID (Byte 5 )
Status (Byte 8)
Value (Byte(s) 9-n)
Identifies the UART data frame being reported . Note: If Frame ID = 0 in AT Command Mode, no AT Command Response will be given.
Command Name - Two ASCII characters that identify the AT Command .
0 1 2 3
= = = =
OK ERROR Invalid Command Invalid Parameter
The HEX (non -ASCII) value of the requested register
Figure310. ATCommandResponseFrames.
0x7E
MSB
LSB
1 Byte
API Identifier
0x88
cmdData
Frame ID (Byte 5 )
Status (Byte 8)
Value (Byte(s) 9-n)
Identifies the UART data frame being reported. Note: If Frame ID = 0 in AT Command Mode, no AT Command Response will be given.
0 1 2 3
= = = =
OK ERROR Invalid Command Invalid Parameter
The HEX (non-ASCII) value of the requested register
Remote AT Command Request API Identifier Value: 0x17 Allows for module parameter registers on a remote device to be queried or set Figure311. RemoteATCommandRequest
0x7E
MSB
LSB
1 Byte
API Identifier
0x17
cmdData
Frame ID (Byte 5)
16-bit Destination Network Address (bytes 14-15)
Command Name (bytes 17-18)
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.
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 (MY=FFFE or MY=FFFF).
Name of the command
64-bit Destination Address (bytes 6-13)
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.
Command Options (byte 16)
Command Data (byte 19-n)
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.
If present, indicates the requested parameter value to set the given register. If no characters present, the register is queried.
59
Remote Command Response API Identifier Value: 0x97 If a module receives a remote command response RF data frame in response to a Remote AT Command Request, the module will send a Remote AT Command Response message out the UART. Some commands may send back multiple frames--for example, Node Discover (ND) command.
Figure312. RemoteATCommandResponse.
Start Delimiter
Length
Frame Data
Checksum
0x7E
MSB
LSB
API- specific Structure
1 Byte
API Identifier
Identifier specific Data -
0x97
cmdData
Frame ID( Byte5)
64- bit Responder Address( bytes6-13)
16-
bit Responder Network Address ( bytes 14-15)
Command Name bytes ( 16-17)
Identifies the UART data frame being reported . Matches the Frame ID of the Remote Command Request the remote is responding. to
Indicates the64- bit address of the remote module that is responding to the Remote AT Command request
Set to the16- bit network address of the remote . .
Name of the command Two . ASCII characters that identify the AT command
Status( byte 18)
0 = OK 1 = Error 2 = Invalid Command 3 = Invalid Parameter 4 = No Response

Command Data byte 19-n) (
The value of the requested register .
TX (Transmit) Request: 64-bit address API Identifier Value: 0x00 A TX Request message will cause the module to send RF Data as an RF Packet. Figure313. TXPacket(64bitaddress)Frames
0x7E
MSB
LSB
1 Byte
API Identifier
0x00
cmdData
Frame ID (Byte 5)
Destination Address (Bytes 6-13)
Options (Byte 14)
RF Data (Byte(s) 15-n)
Identifies the UART data frame for the host to correlate with a subsequent ACK (acknowledgement). Setting Frame ID to 0' will disable response frame.
MSB first, LSB last. Broadcast = 0x000000000000FFFF
0x01 = Disable ACK 0x04 = Send packet with Broadcast Pan ID All other bits must be set to 0.
Up to 100 Bytes per packet
60
TX (Transmit) Request: 16-bit address API Identifier Value: 0x01 A TX Request message will cause the module to send RF Data as an RF Packet. Figure314. TXPacket(16bitaddress)Frames
0x7E
MSB
LSB
1 Byte
API Identifier
0x01
cmdData
Frame ID (Byte 5)
Destination Address (Bytes 6-7)
Options (Byte 8)
Identifies the UART data frame for the host to correlate with a subsequent ACK (acknowledgement). Setting Frame ID to 0' will disable response frame.
MSB first, LSB last. Broadcast = 0xFFFF
0x01 = Disable ACK 0x04 = Send packet with Broadcast Pan ID All other bits must be set to 0.
61
TX (Transmit) Status API Identifier Value: 0x89 When a TX Request is completed, the module sends a TX Status message. This message will indicate if the packet was transmitted successfully or if there was a failure. Figure315. TXStatusFrames
0x7E
MSB
LSB
1 Byte
API Identifier
0x89
cmdData
Frame ID (Byte 5)
Status (Byte 6)
Identifies UART data frame being reported. Note: If Frame ID = 0 in the TX Request, no AT Command Response will be given.
0 = Success 1 = No ACK (Acknowledgement) received 2 = CCA failure 3 = Purged
NOTES: STATUS = 1 occurs when all retries are expired and no ACK is received. If transmitter broadcasts (destination address = 0x000000000000FFFF), only STATUS = 0 or 2 will be returned. STATUS = 3 occurs when Coordinator times out of an indirect transmission. Timeout is defined as (2.5 x SP (Cyclic Sleep Period) parameter value). RX (Receive) Packet: 64-bit Address API Identifier Value: 0x80 When the module receives an RF packet, it is sent out the UART using this message type. Figure316. RXPacket(64bitaddress)Frames
0x7E
MSB
LSB
1 Byte
API Identifier
0x80
cmdData
Source Address (Bytes 5-12)
RSSI (Byte 13)
Options (Byte 14)
MSB (most significant byte) first, LSB (least significant) last
Received Signal Strength Indicator Hexadecimal equivalent of (-dBm) value. (For example: If RX signal strength = -40 dBm, 0x28 (40 decimal) is returned)
bit 0 [reserved] bit 1 = Address broadcast bit 2 = PAN broadcast bits 3-7 [reserved]
RX (Receive) Packet: 16-bit Address API Identifier Value: 0x81 When the module receives an RF packet, it is sent out the UART using this message type. Figure317. RXPacket(16bitaddress)Frames
0x7E
MSB
LSB
1 Byte
API Identifier
0x81
cmdData
Source Address (Bytes 5-6)
RSSI (Byte 7)
Options (Byte 8)
MSB (most significant byte) first, LSB (least significant) last
Received Signal Strength Indicator Hexadecimal equivalent of (-dBm) value. (For example: If RX signal strength = -40 dBm, 0x28 (40 decimal) is returned)
bit 0 [reserved] bit 1 = Address broadcast bit 2 = PAN broadcast bits 3-7 [reserved]
62
AppendixA:AgencyCertifications
United States (FCC)
XBee/XBee-PRO RF Modules comply with Part 15 of the FCC rules and regulations. Compliance with the labeling requirements, FCC notices and antenna usage guidelines is required. To fulfill FCC Certification requirements, the OEM must comply with the following regulations: 1. 2. The system integrator must ensure that the text on the external label provided with this device is placed on the outside of the final product [Figure A-01]. XBee/XBee-PRO RF Modules may only be used with antennas that have been tested and approved for use with this module [refer to the antenna tables in this section].

WARNING: The Original Equipment Manufacturer (OEM) must ensure that FCC labeling requirements are met. This includes a clearly visible label on the outside of the final product enclosure that displays the contents shown in the figure below. Figure401. RequiredFCCLabelforOEMproductscontainingtheXBee/XBeePRORFModule
Contains FCC ID: OUR-XBEE/OUR-XBEEPRO** The enclosed device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: (i.) this device may not cause harmful interference and (ii.) this device must accept any interference received, including interference that may cause undesired operation.
*TheFCCIDfortheXBeeisOURXBEE.TheFCCIDfortheXBeePROisOURXBEEPRO.
FCC Notices
IMPORTANT: The XBee/XBee-PRO OEM RF Module has been certified by the FCC for use with other products without any further certification (as per FCC section 2.1091). Modifications not expressly approved by Digi could void the user's authority to operate the equipment. IMPORTANT: OEMs must test final product to comply with unintentional radiators (FCC section 15.107 & 15.109) before declaring compliance of their final product to Part 15 of the FCC Rules. IMPORTANT: The RF module has been certified for remote and base radio applications. If the module will be used for portable applications, the device must undergo SAR testing. This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: Re-orient or relocate the receiving antenna, Increase the separation between the equipment and receiver, Connect equipment and receiver to outlets on different circuits, or Consult the dealer or an experienced radio/TV technician for help.
63
FCC-Approved Antennas (2.4 GHz)

XBee/XBee-PRO RF Modules can be installed using antennas and cables constructed with standard connectors (TypeN, SMA, TNC, etc.) if the installation is performed professionally and according to FCC guidelines. For installations not performed by a professional, non-standard connectors (RPSMA, RPTNC, etc) must be used. The modules are FCC-approved for fixed base station and mobile applications on channels 0x0B - 0x1A (XBee) and 0x0C - 0x17 (XBee-PRO). If the antenna is mounted at least 20cm (8 in.) from nearby persons, the application is considered a mobile application. Antennas not listed in the table must be tested to comply with FCC Section 15.203 (Unique Antenna Connectors) and Section 15.247 (Emissions). XBee OEM RF Modules (1 mW): XBee Modules have been tested and approved for use with all of the antennas listed in the tables below (Cable-loss IS NOT required). XBee-PRO OEM RF Modules (60 mW): XBee-PRO Modules have been tested and approved for use with the antennas listed in the tables below (Cable-loss IS required when using antennas listed in the second table. The antennas in the tables below have been approved for use with this module. Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas. AntennasapprovedforusewiththeXBee/XBeePRORFModules(Cablelossisnotrequired.) Part Number A24-HASM-450 A24-HABSM A24-HABUF-P5I A24-HASM-525 A24-QI Type (Description) Dipole (Half-wave articulated RPSMA - 4.5) Dipole (Articulated RPSMA) Dipole (Half-wave articulated bulkhead mount U.FL. w/ 5 pigtail) Dipole (Half-wave articulated RPSMA - 5.25") Monopole (Integrated whip) Gain 2.1 dBi 2.1 dBi 2.1 dBi 2.1 dBi 1.5 dBi Application* Fixed/Mobile Fixed Fixed Fixed/Mobile Fixed Min. Separation 20 cm 20 cm 20 cm 20 cm 20 cm
AntennasapprovedforusewiththeXBeeRFModules(Cablelossisrequired) Part Number Type (Description) Omni-Directional Class Antennas A24-Y6NF Yagi (6-element) A24-Y7NF A24-Y9NF A24-Y10NF A24-Y12NF A24-Y13NF A24-Y15NF A24-Y16NF A24-Y16RM Yagi (7-element) Yagi (9-element) Yagi (10-element) Yagi (12-element) Yagi (13-element) Yagi (15-element) Yagi (16-element) Yagi (16-element, RPSMA connector) Gain 8.8 dBi 9.0 dBi 10.0 dBi 11.0 dBi 12.0 dBi 12.0 dBi 12.5 dBi 13.5 dBi 13.5 dBi 15.0 dBi -1.5 dBi 2.1 dBi 3.0 dBi 5.0 dBi 8.0 dBi 9.5 dBi 10.0 dBi 12.0 dBi 15.0 dBi 7.2 dBi 7.2 dBi 8.5 dBi 8.5 dBi 13.0 dBi 14.0 dBi 15.0 dBi 16.0 dBi Application* Min. Separation Required Cable-loss Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed/Mobile Fixed/Mobile Fixed/Mobile Fixed/Mobile Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 20 cm 20 cm 20 cm 20 cm 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 1.5 dB 1.5 dB 6 dB 7 dB 8 dB 9 dB 0.2 dB 0.7 dB 2.7 dB 5.7 dB 1.7 dB 1.9 dB 2.9 dB 3.9 dB 4.9 dB 4.9 dB 5.4 dB 6.4 dB 6.4 dB 7.9 dB -
A24-Y18NF Yagi (18-element) Omni-Directional Class Antennas A24-C1 Surface Mount A24-F2NF A24-F3NF A24-F5NF A24-F8NF A24-F9NF A24-F10NF A24-F12NF A24-F15NF A24-W7NF Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Base station)
A24-M7NF Omni-directional (Mag-mount base station) Panel Class Antennas A24-P8SF Flat Panel A24-P8NF A24-P13NF A24-P14NF A24-P15NF A24-P16NF Flat Panel Flat Panel Flat Panel Flat Panel Flat Panel
64
AntennasapprovedforusewiththeXBee/XBeePRORFModules(Cablelossisrequired) Part Number A24-C1 A24-Y4NF A24-Y6NF A24-Y7NF A24-Y9NF A24-Y10NF A24-Y12NF A24-Y13NF A24-Y15NF A24-Y16NF A24-Y16RM A24-Y18NF A24-F2NF A24-F3NF A24-F5NF A24-F8NF A24-F9NF A24-F10NF A24-F12NF A24-F15NF A24-W7NF A24-M7NF A24-P8SF A24-P8NF A24-P13NF A24-P14NF A24-P15NF A24-P16NF A24-P19NF Type (Description) Surface Mount Yagi (4-element) Yagi (6-element) Yagi (7-element) Yagi (9-element) Yagi (10-element) Yagi (12-element) Yagi (13-element) Yagi (15-element) Yagi (16-element) Yagi (16-element, RPSMA connector) Yagi (18-element) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Fiberglass base station) Omni-directional (Base station) Omni-directional (Mag-mount base station) Flat Panel Flat Panel Flat Panel Flat Panel Flat Panel Flat Panel Flat Panel Gain -1.5 dBi 6.0 dBi 8.8 dBi 9.0 dBi 10.0 dBi 11.0 dBi 12.0 dBi 12.0 dBi 12.5 dBi 13.5 dBi 13.5 dBi 15.0 dBi 2.1 dBi 3.0 dBi 5.0 dBi 8.0 dBi 9.5 dBi 10.0 dBi 12.0 dBi 15.0 dBi 7.2 dBi 7.2 dBi 8.5 dBi 8.5 dBi 13.0 dBi 14.0 dBi 15.0 dBi 16.0 dBi 19.0 dBi Application* Min. Separation Required Cable-loss Fixed/Mobile 20 cm Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed/Mobile Fixed/Mobile Fixed/Mobile Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed Fixed 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 20 cm 20 cm 20 cm 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 2m 8.1 dB 10.9 dB 11.1 dB 12.1 dB 13.1 dB 14.1 dB 14.1 dB 14.6 dB 15.6 dB 15.6 dB 17.1 dB 4.2 dB 5.1 dB 7.1 dB 10.1 dB 11.6 dB 12.1 dB 14.1 dB 17.1 dB 9.3 dB 9.3 dB 8.6 dB 8.6 dB 13.1 dB 14.1 dB 15.1 dB 16.1 dB 19.1 dB
*IfusingtheRFmoduleinaportableapplication(ForexampleIfthemoduleisusedinahandhelddeviceandtheantennaisless than20cmfromthehumanbodywhenthedeviceisoperation):TheintegratorisresponsibleforpassingadditionalSAR(Specific AbsorptionRate)testingbasedonFCCrules2.1091andFCCGuidelinesforHumanExposuretoRadioFrequencyElectromagnetic Fields,OETBulletinandSupplementC.ThetestingresultswillbesubmittedtotheFCCforapprovalpriortosellingtheintegrated unit.TherequiredSARtestingmeasuresemissionsfromthemoduleandhowtheyaffecttheperson. RF Exposure WARNING: To satisfy FCC RF exposure requirements for mobile transmitting devices, a separation distance of 20 cm or more should be maintained between the antenna of this device and persons during device operation. To ensure compliance, operations at closer than this distance is not recommended. The antenna used for this transmitter must not be co-located in conjunction with any other antenna or transmitter. The preceding statement must be included as a CAUTION statement in OEM product manuals in order to alert users of FCC RF Exposure compliance.
65
Europe (ETSI)
The XBee/XBee-PRO RF Module has been certified for use in several European countries. For a complete list, refer to www.maxstream.net. If the XBee/XBee-PRO RF Modules are incorporated into a product, the manufacturer must ensure compliance of the final product to the European harmonized EMC and low-voltage/safety standards. A Declaration of Conformity must be issued for each of these standards and kept on file as described in Annex II of the R&TTE Directive. Furthermore, the manufacturer must maintain a copy of the XBee/XBee-PRO user manual documentation and ensure the final product does not exceed the specified power ratings, antenna specifications, and/or installation requirements as specified in the user manual. If any of these specifications are exceeded in the final product, a submission must be made to a notified body for compliance testing to all required standards.

The 'CE' marking must be affixed to a visible location on the OEM product. Figure402. CELabelingRequirements
The CE mark shall consist of the initials "CE" taking the following form: If the CE marking is reduced or enlarged, the proportions given in the above graduated drawing must be respected. The CE marking must have a height of at least 5mm except where this is not possible on account of the nature of the apparatus. The CE marking must be affixed visibly, legibly, and indelibly.
Restrictions
Power Output: "Power Output: The power output of the XBee-PRO RF Modules must not exceed 10 dBm. The power level is set using the PL command. France: France imposes restrictions on the 2.4 GHz band. Go to www.art-telecom.Fr or contact MaxStream for more information. Norway: Norway prohibits operation near Ny-Alesund in Svalbard. More information can be found at the Norway Posts and Telecommunications site (www.npt.no).
Declarations of Conformity
MaxStream has issued Declarations of Conformity for the XBee/XBee-PRO RF Modules concerning emissions, EMC and safety. Files are located in the 'documentation' folder of the MaxStream CD. Important Note MaxStream does not list the entire set of standards that must be met for each country. MaxStream customers assume full responsibility for learning and meeting the required guidelines for each country in their distribution market. For more information relating to European compliance of an OEM product incorporating the XBee/XBee-PRO RF Module, contact MaxStream, or refer to the following web sites: CEPT ERC 70-03E - Technical Requirements, European restrictions and general requirements: Available at www.ero.dk/. R&TTE Directive - Equipment requirements, placement on market: Available at www.ero.dk/.
66
Approved Antennas
When integrating high-gain antennas, European regulations stipulate EIRP power maximums. Use the following guidelines to determine which antennas to design into an application. XBee-PRO OEM RF Module The following antenna types have been tested and approved for use with the XBee Module: Antenna Type: Yagi RF module was tested and approved with 15 dBi antenna gain with 1 dB cable-loss (EIRP Maximum of 14 dBm). Any Yagi type antenna with 14 dBi gain or less can be used with no cable-loss. Antenna Type: Omni-directional RF module was tested and approved with 15 dBi antenna gain with 1 dB cable-loss (EIRP Maximum of 14 dBm). Any Omni-directional type antenna with 14 dBi gain or less can be used with no cable-loss. Antenna Type: Flat Panel RF module was tested and approved with 19 dBi antenna gain with 4.8 dB cable-loss (EIRP Maximum of 14.2 dBm). Any Flat Panel type antenna with 14.2 dBi gain or less can be used with no cable-loss. XBee-PRO OEM RF Module (@ 10 dBm Transmit Power, PL parameter value must equal 0, or use International variant) The following antennas have been tested and approved for use with the embedded XBee-PRO RF Module: Dipole (2.1 dBi, Omni-directional, Articulated RPSMA, Digi part number A24-HABSM) Chip Antenna (-1.5 dBi) Attached Monopole Whip (1.5 dBi) The RF modem encasement was designed to accommodate the RPSMA antenna option.
Canada (IC)
Labeling Requirements
Labeling requirements for Industry Canada are similar to those of the FCC. A clearly visible label on the outside of the final product enclosure must display the following text: Contains Model XBee Radio, IC: 4214A-XBEE Contains Model XBee-PRO Radio, IC: 4214A-XBEEPRO The integrator is responsible for its product to comply with IC ICES-003 & FCC Part 15, Sub. B Unintentional Radiators. ICES-003 is the same as FCC Part 15 Sub. B and Industry Canada accepts FCC test report or CISPR 22 test report for compliance with ICES-003.
Japan
In order to gain approval for use in Japan, the XBee-PRO RF Module must contain firmware that limits its transmit power output to 10 dBm. For a list of module part numbers approved for use in Japan, contact MaxStream [call 1-801-7659885 or send e-mail to sales@maxstream.net].
Labeling Requirements
A clearly visible label on the outside of the final product enclosure must display the following text: ID: 005NYCA0378
67
AppendixB.AdditionalInformation
1-Year Warranty
XBee/XBee-PRO RF Modules from Digi Intenational, Inc. (the "Product") are warranted against defects in materials and workmanship under normal use, for a period of 1-year from the date of purchase. In the event of a product failure due to materials or workmanship, Digi will repair or replace the defective product. For warranty service, return the defective product to Digi, shipping prepaid, for prompt repair or replacement. The foregoing sets forth the full extent of Digi's warranties regarding the Product. Repair or replacement at Digi's option is the exclusive remedy. THIS WARRANTY IS GIVEN IN LIEU OF ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, AND DIGI SPECIFICALLY DISCLAIMS ALL WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL DIGI, ITS SUPPLIERS OR LICENSORS BE LIABLE FOR DAMAGES IN EXCESS OF THE PURCHASE PRICE OF THE PRODUCT, FOR ANY LOSS OF USE, LOSS OF TIME, INCONVENIENCE, COMMERCIAL LOSS, LOST PROFITS OR SAVINGS, OR OTHER INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PRODUCT, TO THE FULL EXTENT SUCH MAY BE DISCLAIMED BY LAW. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES. THEREFORE, THE FOREGOING EXCLUSIONS MAY NOT APPLY IN ALL CASES. This warranty provides specific legal rights. Other rights which vary from state to state may also apply.
Ordering Information
FigureC01.DivisionsoftheXBee/XBeePRORFModulePartNumbers
A
1 2 3 4 5
1
MaxStream Product Family XB24 = XBee 2.4 GHz XBP24 = XBee-PRO 2.4 GHz Reserved for internal use Insert the letterA Antenna C U W Option = Chip Antenna = U.FL RF Connector = Integrated Whip Antenna
Rating I = Protocol 001 = 002 =
Industrial (-40 to 85 C 802.15.4 ZigBee
5 2
For example: XBP24-AWI-001 = XBee-PRO OEM RF Module, 2.4 GHz, attached whip antenna, Industrial temperature rating, IEEE 802.15.4 standard If operating in Japan, XBee-PRO RF Modules must contain firmware that limits transmit power output to 10 dBm. For a list of module part numbers approved for use in Japan, contact Digi [call 1-801-765-9885 or send e-mail to sales@maxstream.net].
68
Contact Digi
Free and unlimited technical support is included with every Digi Radio Modem sold. For the best in wireless data solutions and support, please use the following resources: Technical Support: Phone Live Chat Online Support (866) 765-9885 toll-free U.S.A. & Canada (801) 765-9885 Worldwide www.digi.com http://www.digi.com/support/eservice/eservicelogin.jsp
Digi office hours are 8:00 am - 5:00 pm [U.S.Mountain Time]
69

Xbee /Xbee-Pro Oem RF Modules: Product Manual - 802.15.4 Protocol

Uploaded by

Copyright:

Available Formats

Xbee /Xbee-Pro Oem RF Modules: Product Manual - 802.15.4 Protocol

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Xbee /Xbee-Pro Oem RF Modules: Product Manual - 802.15.4 Protocol

Uploaded by

Copyright:

Available Formats

XBee/XBee-PRO OEM RF Modules

XBee/XBee-PRO OEM RF Modules RF Module Operation RF Module Configuration Appendices

Product Manual v1.xCx - 802.15.4 Protocol

IEEE 802.15.4 OEM RF Modules by Digi International

2008 Digi International, Inc. All rights reserved

Phone:(801)7659885 LiveChat:www.digi.com OnlineSupport:http://www.digi.com/supporteservice/eservicelogin.jsp

OEM Labeling Requirements

Transmit/Receive Modes Command Mode

3. RF Module Configuration Programming the RF Module Programming Examples 25 26 26 26 26 26 25

Typical 0.5 0.5 0.4 0.4 0.05 1.1

Unit k V mV LSB LSB LSB LSB LSB LSB

VREFH 3.516 1.0 1.0 1.0 1.0 5.0 2.5

2.08V < VDDAD < 3.6V

Total Unadjusted Error10

UART Data Flow

To implement API operations, refer to API sections [p56].

Refer to the D6 (DIO6 Configuration) command description for more information.

ADC and Digital I/O Line Support

I/O Data Format

Total number of samples

Bit set to 1 if channel is active

DIO Pin Change Detect

Sample Rate (Interval)

I/O Line Passing

NonBeacon (w/ Coordinator)

Pin/Host-controlled / De-assert (low) Sleep_RQ NonBeacon systems only / Lowest Power

Cyclic Sleep (SM = 4)

< 50 A when sleeping

Cyclic Sleep (SM = 5)

< 50 A when sleeping

Remote Configuration Commands

Sending a Remote Command

Applying Changes on Remote

Remote Command Responses

Command Reference Tables

20-character ASCII string

0-1 0 = End Device 1 = Coordinator

0x1FFE (all XBeePRO Channels)

Networking {Association} Networking {Association}

Networking {Security} Networking {Security}

0x24 - 0x50 [-dBm]

0x2C (-44d dBm)

Sleep (Low Power)

Sleep Mode. Set/Read Sleep Mode configurations.

Sleep (Low Power)

Sleep (Low Power)

Sleep (Low Power)

Sleep (Low Power)

IU (v1.xA0*) IT (v1.xA0*) IS (v1.xA0*) IO (v1.xA0*) IC (v1.xA0*) IR (v1.xA0*) IA (v1.xA0*) T0 - T7 (v1.xA0*)

1 1 0 (disabled) 0 0xFFFFFFF FFFFFFFFF 0xFF

P1 (v1.xA0*) M0 (v1.xA0*) M1 (v1.xA0*) PT (v1.xA0*)

Default Parameter Value:0 Minimum Firmware Version Required: v1.x80

Parameter Range [read-only]: 0x17-0x5C (XBee), 0x24-0x64 (XBee-PRO)

Related Command: SD (Scan Duration), SC (Scan Channel)

Minimum Firmware Version Required: v1.x80

Default Parameter Value:0 Related Commands: ND (Node Discover), DN (Destination Node)

Default Parameter Value: 4

Default Parameter Value: 0

Coordinator and End Device ST values must be equal.

IU (v1.xA0) IT (v1.xA0) IS (v1.xA0) IO (v1.xA0) IC (v1.xA0) IR (v1.xA0) IA (v1.xA0) T0 - T7 (v1.xA0)

P1 (v1.xA0) M0 (v1.xA0) M1 (v1.xA0) PT (v1.xA0)