XBee/XBee-PRO SX RF Module User Guide, Rev. B

1 xbee / xbee -PROSXR adioFrequency(RF)ModuleUserGuideRevision history 90001477 RevisionDateDescriptionAFebruary, , , ,DigiInternational, asis, / xbee -PROSXRFM oduleUserGuide2 ContentsXBee / xbee -PROSXRFM oduleUserGuideApplicablefirmwareandhardw are11 Regulatoryapprovals11 Powerrequirements11 Networkingspecifications12 Performancespecifications12 Generalspecifications13 HardwareMechanicaldrawings16 Pinsignals17 Pinconnectionrecommendations19 GettingstartedwiththeXBee/ xbee -PROSXRFM oduleDevelopmentKitXBeeSXDevelopmentBoar d21 ConnectXBee-PROSX developmentboardstoaPC21 ConnecttheXBIB-U_SSdevelopmentboardtoaPC 22 ConfigurethedeviceusingXCTU22 Configurethedevicesforarangetest22 Performarangetest23 Meshnetworkdemonstration24 ModesofoperationTransparentandAPIoperati ngmodes28 Transparentoperatingmode28 APIoperatingmode28 ComparingTransparentandAPImodes28 Modesofoperation29 Receivemode30 Transmitmode30 Sleepmodes30 Commandmode31

2 SleepmodesAboutsleepmodes34 Asynchronousmodes34 xbee / xbee -PROSXRFM oduleUserGuide3 xbee / xbee -PROSXRFM oduleUserGuide4 Synchronousmodes34 Normalmode34 Asynchronouspinsleepmode35 Asynchronouscyclicsleepmode35 Asynchronouscyclicsleepwithpinwakeupmode 35 Synchronoussleepsupportmode35 Synchronouscyclicsleepmode36 Thesleeptimer36 Indirectmessagingandpolling36 Indirectmessaging36 Polling37 Sleepingrouters37 SleepcoordinatorsleepmodesintheDigiMeshn etwork37 Synchronizationmessages38 Becomeasleepcoordinator40 Preferredsleepcoordinatoroption40 Resolutioncriteriaandselectionoption40 CommissioningPushbuttonoption41 Auto-earlywake-upsleepoption42 Selectsleepparameters42 Startasleepingsynchronousnetwork42 Addanewnodetoanexistingnetwork43 Changesleepparameters44 Rejoinnodesthatlosesync44 Diagnostics45 Querysleepcycle45 Sleepstatus45 Missedsyncmessagescommand46 SleepstatusAPImessages46 NetworkingmethodsTheMACandPHYlayers4864- bitaddresses48 Makeaunicasttransmission49 Makeabroadcasttransmission49 Deliverymethods49 PointtoPoint/PointtoMultipoint(P2MP)49 Repeater/directedbroadcast50 DigiMeshnetworking50 SerialcommunicationUART dataflow55 Serialdata55 SPIsignals55 Signaldescription56 Slavemodecharacteristics56 Fullduplexoperation57 Lowpoweroperation57 Configurationconsiderations58 SPIandAPImode58 SPIparameters58 Serialportselection58 xbee / xbee -PROSXRFM oduleUserGuide5 Serialreceivebuffer59 Serialtransmitbuffer59 UART flowcontrol59 CTSflowcontrol59 RTSflowcontrol59 ATcommandsSpecialcommands62AC(ApplyChang es)62FR(SoftwareReset)62RE(RestoreDefaul ts)62WR(Write)

3 62 MAC/PHYcommands62AF(AvailableFrequencies )63CM(ChannelMask)63MF(MinimumFrequencie s)64HP(PreambleID)64ID(NetworkID)64MT (BroadcastMulti-Transmits)65BR(RFDataRat e)65PL(TXPowerLevel)65RR(UnicastMacRetri es)66 Diagnosticcommands-MACstatisticsandtimeo uts67BC(BytesTransmitted)67DB(LastPacket RSSI)67ER(ReceiveCountError)67GD(GoodPac ketsReceived)67EA(MACACKF ailureCount)68TR(TransmissionFailureCoun t)68UA (UnicastsAttemptedCount)68%H(MACU nicastOneHopTime)68%8(MACB roadcastOneHopTime)69 Networkcommands69CE(Routing/MessagingMod e)69BH(BroadcastHops)69NH(NetworkHops)70 MR(MeshUnicastRetries)70NN(NetworkDelayS lots)70 Addressingcommands70SH(SerialNumberHigh) 70SL(SerialNumberLow)71DH(DestinationAdd ressHigh)71DL(DestinationAddressLow)71TO (TransmitOptions)71NI(NodeIdentifier)72N T(NetworkDiscoveryBack-off)72NO (NetworkDiscoveryOptions)73CI(ClusterID) 73 Diagnostic-addressingcommands74N?

4 (NetworkDiscoveryTimeout)74 Addressingdiscovery/configurationcommand s74AG(AggregatorSupport)74DN(DiscoverNod e)74ND(NetworkDiscover)75 xbee / xbee -PROSXRFM oduleUserGuide6FN(FindNeighbors)76 Securitycommands76EE(EncryptionEnable)76 KY(AESE ncryptionKey)77 Serialinterfacingcommands77BD(InterfaceD ataRate)77NB(Parity)78SB(StopBits)79RO(P acketizationTimeout)79FT(FlowControlThre shold)79AP(APIE nable)80AO(APIO ptions)80I/Osettingscommands81D0(DIO0/AD 0)81D1(DIO1/AD1)81D2(DIO2/AD2)82D3(DIO3/ AD3)82D4(DIO4)83D5(DIO5/ASSOCIATED_INDIC ATOR)83D6(DIO6/RTS)83D7(DIO7/CTS)84D8(DI O8/SLEEP_REQUEST)84D9(DIO9/ON_SLEEP)85P0 (DIO10/RSSI/PWM0 Configuration)85P1(DIO11/PWM1 Configuration)86P2(DIO12 Configuration)86P3(DIO13/DOUT)87P4(DIO14 /DIN)87P5(DIO15/SPI_MISO)88P6(DIO16/SPI_ MOSI)88P7(DIO17/SPI_SSEL)88P8(DIO18/SPI_ SCLK)89P9(DIO19/SPI_ATTN)89PD(PullUp/Dow nDirection)90PR(Pull-up/DownResistorEnab le)90M0(PWM0 DutyCycle)91M1(PWM1 DutyCycle)91LT(AssociateLEDB linkTime)91RP (RSSIPWMT imer)92I/Osamplingcommands92AV(AnalogVol tageReference)92IC(DIOC hangeDetect)92IF(SleepSampleRate)93IR(Sa mpleRate)93TP(BoardTemperature)94%V(Volt ageSupplyMonitoring)94I/Olinepassingcomm ands94IU(I/OOutputEnable)94IU(SendI/OSam pletoSerialPort)94IA(I/OInputAddress)94T 0(D0 Timeout)95T1(D1 OutputTimeout)95T2(D2 OutputTimeout)95T3(D3 OutputTimeout)95T4(D4 OutputTimeout)96 xbee / xbee -PROSXRFM oduleUserGuide7T5(D5 OutputTimeout)96T6(D6 OutputTimeout)96T7(D7 OutputTimeout)96T8(D8 Timeout)96T9(D9 Timeout)97Q0(P0 Timeout)97Q1(P1 Timeout)97Q2(P2 Timeout)97Q3(P3 Timeout)97Q4(P4 Timeout)98PT(PWMO utputTimeout)

5 98 Sleepcommands98SM(SleepMode)98SO(SleepOp tions)99SN(NumberofCyclesBetweenON_SLEEP )100SP(SleepTime)100ST(WakeTime)100WH(Wa keHostDelay)101 Diagnostic-sleepstatus/timingcommands101 SS(SleepStatus)101OS(OperatingSleepTime) 102OW(OperatingWakeTime)102MS(MissedSync Messages)102SQ(MissedSleepSyncCount)103 Commandmodeoptions103CC(CommandCharacter )103CT(CommandModeTimeout)103GT(GuardTim es)103 Firmwareversion/informationcommands104VR (FirmwareVersion)104HV(HardwareVersion)1 04HS(HardwareSeries)104DD(DeviceTypeIden tifier)104NP(MaximumPacketPayloadBytes)1 04CK(ConfigurationCRC)105 OperateinAPImodeAPImodeoverview107 APIframespecifications107 Calculateandverifychecksums109 EscapedcharactersinAPIframes110 APIframes110 APIframeexchanges111 CodetosupportfutureAPIframes112 LegacyTXRequestframe-0x00114 ATCommandframe-0x08116 ATCommand-QueueParameterValueframe-0x091 17 TransmitRequestframe-0x10119 ExplicitAddressingCommandframe-0x11121 RemoteATCommandRequestframe-0x17124 ModemStatusframe-0x8A126 TransmitStatusframe-0x8B127 RouteInformationPacketframe-0x8D129 AggregateAddressingUpdateframe-0x8E132 xbee / xbee -PROSXRFM oduleUserGuide8 LegacyRXIndicatorframe-0x80134 ATCommandResponseframe-0x88136 LegacyTXStatusframe-0x89138 RXIndicatorframe-0x90139 ExplicitRxIndicatorframe-0x91141 NodeIdentificationIndicatorframe-0x95143 RemoteCommandResponseframe-0x97146

6 WorkwithnetworkeddevicesNetworkcommissio ninganddiagnostics149 Localconfiguration149 Remoteconfiguration149 Sendaremotecommand149 Applychangesonremotedevices149 Remotecommandresponse149 Establishandmaintainnetworklinks150 Buildaggregateroutes150 DigiMeshroutingexamples150 Replacenodes151 Testlinksinanetwork151 Testlinksbetweenadjacentdevices152 Example153 RSSI indicators154 Discoverdevices154 Tracerouteoption155 NACK messages156 TheCommissioningPushbutton156 AssociateLED158 MonitorI/OlinesPinconfigurations159 Queriedsampling160 PeriodicI/Osampling161 DetectdigitalI/Ochanges161I/Olinepassing Configurationexample163 GeneralPurposeFlashMemoryAboutGeneralPur poseFlashMemory166 AccessGeneralPurposeFlashMemory166 GeneralPurposeFlashMemorycommands167 PLATFORM_INFO_REQUEST(0x00)167 PLATFORM_INFO(0x80)167 ERASE(0x01)168 ERASE_RESPONSE(0x81)168 WRITE(0x02)andERASE_THEN_WRITE(0x03)169 WRITE_RESPONSE(0x82)andERASE_THEN_WRITE_ RESPONSE(0x83).

7 170 READ(0x04)170 xbee / xbee -PROSXRFM oduleUserGuide9 READ_RESPONSE(0x84)171 FIRMWARE_VERIFY(0x05)andFIRMWARE_VERIFY_ AND_INSTALL(0x06)171 FIRMWARE_VERIFY_RESPONSE(0x85)172 FIRMWARE_VERIFY_AND_INSTALL_RESPONSE(0x8 6)172 UpdatethefirmwareOver-the-airfirmwareupd ates174 Distributethenewapplication174 Example174 Verifythenewapplication175 Installtheapplication175 Importantconsiderations175 CertificationsFCC(UnitedStates)177 OEMlabelingrequirements177 FCCnotices177 FCCantennacertifications178 xbee -PROSXRFM oduleantennaoptions(30dBmmaximumRFpower) 179 XBeeSXantennaoptions(13dBmmaximumRFpower )184 IndustryCanada(IC)190 Labelingrequirements190 Transmittersfordetachableantennas190 Detachableantennas190 ACMA(Australia)191 Powerrequirements191 RSM(NewZealand)191 Powerrequirements191 PCBdesignandmanufacturingRecommendedfoot printandkeepout193 Designnotes194 Hostboarddesign194 Improveantennaperformance195 RFpadversion195 Recommendedsolderreflowcycle196 Fluxandcleaning197 Rework197 xbee / xbee -PROSXRFM oduleUserGuideTheXBee/ xbee -PROSXRFM oduleisanembeddedradiofrequency(RF) ,lowoperatingcurrent, sfrequencyhoppingtechnologyoffersadvance dinterferenceimmunity, (SPI)oruniversalasynchronousreceiver/tra nsmitter(UART),aswellasdigital,analog,an dpulsewidthmodulation(PWM) / xbee -PROSXRFM oduleUserGuide10 xbee / xbee -PROSXRFM oduleUserGuideApplicablefirmwareandhardw areXBee / xbee -PROSXRFM oduleUserGuide11 ApplicablefirmwareandhardwareThismanuals upportsthefollowingfirmware.

8 N0x900 XUSAandCanada, xbee / xbee -PROSXn0x920xAust ralia, xbee / xbee -PROSXn0x930 XBrazilXBee/ xbee -PROSXn0x960 XNewZealand, :nXBee/ xbee -PROSXRFM oduleRegulatoryapprovalsThefollowingtabl eprovidesthedevice' , :MCQ-XBPSXFCCID:MCQ-XBSXC anadaIC:1846A-XBPSXIC:1846A-XBSXA ustraliaRCMRCMNewZealandR-NZPowerrequire mentsThefollowingtableprovidesthedevice' @ @ @ AXBee / xbee -PROSXRFM oduleUserGuideNetworkingspecificationsXB ee / xbee -PROSXRFM oduleUserGuide12 NetworkingspecificationsThefollowingtabl eprovidesthedevice' (GFSK)SpreadingtechnologyFrequencyHoppin gSpreadSpectrum(FHSS)Supportednetworktop ologies(softwareselectable)Peer-to-peer( master/slaverelationshipnotrequired),poi nt-to-point/point-to-multipoint,meshEncr yptionOptional256-bitAdvancedEncryptionS tandard(AES)cipherblockchaining(CBC) (softwareselectable)Lowdatarate10kb/sMid dledatarate110kb/sHighdatarate250kb/sTra nsmitpower(softwareselectable)Upto13dBmU pto30dBm1 NewZealandspecificUpto13dBm,atthehighdat arate(BR2) ,seePL(TXPowerLevel).

9 2 Thedevicehopson50channelsselectedusingth eCMcommand, ,seeCM(ChannelMask). xbee / xbee -PROSXRFM oduleUserGuideGeneralspecificationsXBee (9mi)Upto105km(65mi) ( )Upto18km(11mi)2 ReceiversensitivityLowdatarate-113dBmMid dledatarate-106dBmHighdatarate-103dBmRec eiverIFselectivityLowdatarate 250kHz40dBLowdatarate 500kHz50dBMiddledatarate 250kHz30dBMiddledatarate 500kHz40dBHighdatarate 500kHz30dBHighdatarate 1000kHz45dBReceiverRFselectivityBelow900 MHzandabove930 MHz>50dBUART datarate(softwareselectable)1200-921600b audSPIclockrateUpto6Mb/sGeneralspecifica tionsThefollowingtableprovidesthedevice' ( ) (9mi) / xbee -PROSXRFM oduleUserGuideGeneralspecificationsXBee / xbee -PROSXRFM oduleUserGuide14 SpecificationValueRestrictionofHazardous Substances(RoHS)CompliantManufacturingIS O9001 unbalancedMaximuminputRFlevelatantennapo rt6dBmOperatingtemperature-40 Cto85 CDigitalI/O13I/Olines,5outputlinesAnalog -to-digitalconverter(ADC)410-bitanalogin putsPulsewidthmodulator(PWM)2outputsHard wareMechanicaldrawings16 Pinsignals17 xbee / xbee -PROSXRFM oduleUserGuide15 HardwareMechanicaldrawingsXBee / xbee -PROSXRFM oduleUserGuide16 , / xbee -PROSXRFM oduleUserGuide18 PinNameI/ODefaultstateFunction4 DIN/CONFIG/DIO14I/OInputGPIO/UART datain5 DIO12.

10 [Reserved]--Donotconnect10 DIO8/DTR/SLEEP_RQI/OInputGPIO/PinSleepCo ntrolline(DTRonthedevelopmentboard)11 GND--Ground12DO19/SPI_ATTNOO utputGPO/SerialPeripheralInterface(SPI) AttentionorUARTDataPresentindicator13 GND--Ground14DO18/SPI_CLKI/O1 InputGPO/SPIclock15DO17/SPI_SSELI/O2 InputGPO/SPInotselect16DO16/SPI_MOSII/O3 InputGPO/SPIDataIn17DO15/SPI_MISOOO utputGPO/SPIDataOutTri-statedwhenSPI_SSE L ishigh18[Reserved]--Donotconnect19[Reser ved]--Donotconnect20[Reserved]--Donotcon nect21[Reserved]--Donotconnect22 GND--Ground23[Reserved] / xbee -PROSXRFM oduleUserGuide19 PinNameI/ODefaultstateFunction24 DIO4I/ODisabledGPIO25 DIO7/CTSI/OOutputGPIO/UARTC leartoSendFlowControl26 DIO9/ON/SLEEPI/ [Reserved]--Donotconnect35 GND--Ground36RF_PADI/O-RFconnectionforRF padvariant37[Reserved] ,GND, ,youshouldconnectVCC,GND,DOUT,DIN,RTS,an dSLEEP(DTR).