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

1 xbee / xbee -PROSXR adioFrequency(RF)ModuleUserGuideRevision history asis, withoutwarrantyofanykind,expressedorimpl ied,including,butnotlimitedto, (s)and/ortheprogram(s) ,gotothefollowingwebsite: , (P2MP)51 Repeater/directedbroadcast51 DigiMeshnetworking52 SerialcommunicationUART dataflow56 Serialdata56 SPIsignals57 Signaldescription57 Slavemodecharacteristics58 Fullduplexoperation58 Configurationconsiderations59 SPIandAPImode59 SPIparameters59 Serialportselection60 Serialreceivebuffer60 Serialtransmitbuffer60 UART flowcontrol60 CTSflowcontrol61 RTSflowcontrol61 ATcommandsSpecialcommands62AC(ApplyChang es)62FR(SoftwareReset)62RE(RestoreDefaul ts)62WR(Write)63 MAC/PHYcommands63AF(AvailableFrequencies )63CM(ChannelMask)64MF(MinimumFrequencie s)64HP(PreambleID)65ID(NetworkID)65MT (BroadcastMulti-Transmits)65BR(RFDataRat e)66PL(TXPowerLevel)66RR(UnicastMacRetri es)67 Diagnosticcommands-MACstatisticsandtimeo uts68BC(BytesTransmitted)68DB(LastPacket RSSI)68ER(ReceiveCountError)68GD(GoodPac ketsReceived)69EA(MACACKF ailureCount)69 xbee / xbee -PROSXRFM oduleUserGuide6TR(TransmissionFailureCou nt)69UA (UnicastsAttemptedCount)70%H(MACU nicastOneHopTime)

2 70%8(MACB roadcastOneHopTime)70 Networkcommands71CE(Routing/MessagingMod e)71BH(BroadcastHops)71NH(NetworkHops)72 MR(MeshUnicastRetries)72NN(NetworkDelayS lots)72 Addressingcommands73SH(SerialNumberHigh) 73SL(SerialNumberLow)73DH(DestinationAdd ressHigh)73DL(DestinationAddressLow)74TO (TransmitOptions)74NI(NodeIdentifier)75N T(NetworkDiscoveryBack-off)75NO (NetworkDiscoveryOptions)76CI(ClusterID) 76 Diagnostic-addressingcommands77N?(Networ kDiscoveryTimeout)77 Addressingdiscovery/configurationcommand s77AG(AggregatorSupport)77DN(DiscoverNod e)78ND(NetworkDiscover)78 FindNeighbors(FN)79 Securitycommands80EE(EncryptionEnable)80 KY(AESE ncryptionKey)81 Serialinterfacingcommands81BD(InterfaceD ataRate)81NB(Parity)83SB(StopBits)83RO(P acketizationTimeout)83FT(FlowControlThre shold)84AP(APIE nable)84AO(APIO ptions)85I/Osettingscommands85D0(DIO0/AD 0)85D1(DIO1/AD1)86D2(DIO2/AD2)87D3(DIO3/ AD3)87D4(DIO4)88D5(DIO5/ASSOCIATED_INDIC ATOR)88D6(DIO6/RTS)89D7(DIO7/CTS)90D8(DI O8/SLEEP_REQUEST)90 xbee / xbee -PROSXRFM oduleUserGuide7D9(DIO9/ON_SLEEP)91P0(DIO 10/RSSI/PWM0 Configuration)92P1(DIO11/PWM1 Configuration)92P2(DIO12 Configuration)93P3(DIO13/DOUT)93P4(DIO14 /DIN)94P5(DIO15/SPI_MISO)94P6(DIO16/SPI_ MOSI)95P7(DIO17/SPI_SSEL)96P8(DIO18/SPI_ SCLK)96P9(DIO19/SPI_ATTN)97PD(PullDirect ion)97PR(Pull-up/DownResistorEnable)98M0 (PWM0 DutyCycle)99M1(PWM1 DutyCycle)99LT(AssociateLEDB linkTime)99RP (RSSIPWMT imer)

3 100I/Osamplingcommands100AV(AnalogVoltag eReference)100IC(DIOC hangeDetect)101IF(SleepSampleRate)102IR( SampleRate)102TP(BoardTemperature)102%V( SupplyVoltage)103I/Olinepassing103IU(I/O OutputEnable)103IU(SendI/OSampletoSerial Port)103IA(I/OInputAddress)103T0(D0 Timeout)104T1(D1 Timeout)104T2(D2 Timeout)104T3(D3 Timeout)104T4(D4 Timeout)105T5(D5 Timeout)105T6(D6 Timeout)105T7(D7 Timeout)106T8(D8 Timeout)106T9(D9 Timeout)106Q0(P0 Timeout)106Q1(P1 Timeout)107Q2(P2 Timeout)107Q3(P3 Timeout)107Q4(P4 Timeout)107PT(PWMO utputTimeout)108 Sleepcommands108SM(SleepMode)108SO(Sleep Options)109SN(NumberofCyclesBetweenON_SL EEP)110 xbee / xbee -PROSXRFM oduleUserGuide8SP(SleepTime)111ST(WakeTi me)111WH(WakeHostDelay)111 Diagnostic-sleepstatus/timingcommands112 SS(SleepStatus)112OS(OperatingSleepTime) 113OW(OperatingWakeTime)113MS(MissedSync Messages)113SQ(MissedSleepSyncCount)114 Commandmodeoptions114CC(CommandSequenceC haracter)114CT(CommandmodeTimeout)114GT( GuardTimes)115 Firmwareversion/informationcommands115VR (FirmwareVersion)115HV(HardwareVersion)1 15HS(HardwareSeries)116DD(DeviceTypeIden tifier)116NP(MaximumPacketPayloadBytes)1 16CK(ConfigurationCRC)

4 116 OperateinAPImodeAPImodeoverview118 APIframespecifications118 Calculateandverifychecksums120 EscapedcharactersinAPIframes121 APIframes121 APIframeexchanges122 CodetosupportfutureAPIframes124 LegacyTXRequestframe-0x00125 ATCommandframe-0x08127 ATCommand-QueueParameterValueframe-0x091 29 TransmitRequestframe-0x10131 ExplicitAddressingCommandframe-0x11134 RemoteATCommandRequestframe-0x17140 ModemStatusframe-0x8A143 TransmitStatusframe-0x8B144 RouteInformationPacket-0x8D146 AggregateAddressingUpdateframe-0x8E150 LegacyRXIndicatorframe-0x80153 ATCommandResponseframe-0x88156 LegacyTXStatusframe-0x89158 RXIndicatorframe-0x90159 ExplicitRxIndicatorframe-0x91161 NodeIdentificationIndicatorframe-0x95164 RemoteCommandResponseframe-0x97169 xbee / xbee -PROSXRFM oduleUserGuide9 WorkwithnetworkeddevicesNetworkcommissio ninganddiagnostics172 Configuredevices172 Configureadeviceremotely172 Sendaremotecommand172 Applychangesonremotedevices173 Remotecommandresponse173 Establishandmaintainnetworklinks173 Buildaggregateroutes173 Examples174 Replacenodes174 Testlinksinanetwork175 Testlinksbetweenadjacentdevices176 Example177 RSSI indicators178 Discoverdevices178 Tracerouteoption179 NACK messages180 TheCommissioningPushbutton180 AssociateLED183 MonitorI/OlinesPinconfigurations185 QueriedSampling185 Queriedsampling186 PeriodicI/Osampling188 DetectdigitalI/Ochanges188I/Olinepassing Configurationexample190 GeneralPurposeFlashMemoryAboutGeneralPur poseFlashMemory193 AccessGeneralPurposeFlashMemory193 GeneralPurposeFlashMemorycommands195 UpdatethefirmwareOver-the-Airfirmwareupd ates204 Distributethenewapplication204 Example204 Verifythenewapplication205 xbee / xbee -PROSXRFM oduleUserGuide10 Installtheapplication205 Importantconsiderations206 CertificationsFCC(UnitedStates)207 OEMlabelingrequirements207 FCCnotices208 FCCantennacertifications208 xbee -PROSX RF Moduleantennaoptions(30dBmmaximumRFpower )

5 210 XBeeSXantennaoptions(13dBmmaximumRFpower )217 IndustryCanada(IC)225 Labelingrequirements225 Transmittersfordetachableantennas225 Detachableantennas226 ACMA(Australia)226 Powerrequirements226 PCBdesignandmanufacturingRecommendedfoot printandkeepout227 Designnotes229 Hostboarddesign229 Improveantennaperformance230 RFpadversion230 Recommendedsolderreflowcycle232 Fluxandcleaning233 Rework233 xbee / xbee -PROSXRFM oduleUserGuide11 xbee / xbee -PROSXRFM oduleUserGuideTheXBee/ xbee -PROSXRFM oduleisanembeddedradiofrequency(RF) ,lowoperatingcurrent, sfrequencyhoppingtechnologyoffersadvance dinterferenceimmunity, (SPI)oruniversalasynchronousreceiver/tra nsmitter(UART),aswellasdigital,analog,an dpulsewidthmodulation(PWM) :n0x900 XItsupportsthefollowinghardware:nXBee/XB ee-PROSXRFM oduleRegulatoryapprovalsThefollowingtabl eprovidesthedevice' :MCQ-XBPSXC anadaIC:1846A-XBPSXP owerrequirementsXBee/ xbee -PROSXRFM oduleUserGuide12 CountryApprovalAustraliaRCMP owerrequirementsThefollowingtableprovide sthedevice' @ @ @ ANetworkingspecificationsThefollowingtab leprovidesthedevice' (GFSK)SpreadingtechnologyFrequencyHoppin gSpreadSpectrum(FHSS)Performancespecific ationsXBee/ xbee -PROSXRFM oduleUserGuide13 SpecificationValueSupportednetworktopolo gies(softwareselectable)Peer-to-peer(mas ter/slaverelationshipnotrequired),point- to-point/point-to-multipoint,meshEncrypt ionOptional256-bitAdvancedEncryptionStan dard(AES)cipherblockchaining(CBC) (softwareselectable)Lowdatarate10kb/sMid dledatarate110kb/sHighdatarate250kb/sTra nsmitpower(softwareselectable)Upto13dBmU pto30dBm1 MaximumdatathroughputHighdatarate120 ,seePL(TXPowerLevel) (9mi)Upto105km(65mi) ( )Upto18km(11mi)

6 3 ReceiversensitivityLowdatarate-113dBmMid dledatarate-106dBmHighdatarate-103dBmRec eiverIFselectivityLowdatarate 250kHz40dBLowdatarate 500kHz50dBMiddledatarate 250kHz30dBMiddledatarate 500kHz40dBHighdatarate 500kHz30dBHighdatarate 1000kHz45dBReceiverRFselectivityBelow900 MHzandabove930 MHz>50dB1 Thedevicehopson50channelsselectedusingth eCMcommand, ,seeCM(ChannelMask) (9mi) datarate(softwareselectable)1200-921600b audSPIclockrateUpto6Mb/sGeneralspecifica tionsThefollowingtableprovidesthedevice' ( )Weight3gRestrictionofHazardousSubstance s(RoHS)CompliantManufacturingISO9001 unbalancedMaximuminputRFlevelatantennapo rt6dBmOperatingtemperature-40 Cto85 CDigitalI/O13I/Olines,5outputlinesAnalog -to-digitalconverter(ADC)410-bitanalogin putsPulsewidthmodulator(PWM)2outputsXBee / xbee -PROSXRFM oduleUserGuide16 , ; [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 [Reserved]--Donotconnect19[Reserved]--Do notconnect20[Reserved]--Donotconnect21[R eserved]--Donotconnect22 GND--Ground23[Reserved]--Donotconnect24 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).

7 xbee / xbee -PROSXRFM oduleUserGuide21 GettingstartedwiththeXBee/ xbee - (6ft). (SMT)socketdevelopmentboard1 XBIB-U-SSSX developmentboardwithonboardXBee-PROSX RFpadmodule2 XBIB-XBP9XR-0 StandardUSBcable1N/AMiniUSBcable2N/A12 VDCpowersupply2 , : (andnotbefore), (XCTU)isamulti-platformprogramthatenable sdeveloperstointeractwithDigiradiofreque ncy(RF) ,configure, , ,goto: , , , , ,thePCautomaticallyinstallsdrivers, :ID:2015NI:LOCAL_DEVICEAP:APIenabled[1] :ID:2015NI:REMOTE_DEVICEAP:APIdisabled[0 ] , ; , ' (the"localdevice") [0], , (6ft)apartwhentransmittingtoprotectthede vice' ,theotherdevice(REMOTE_XBEE) , , (bysettingAPto1). :RSSI willdecreaseasyougetfartheraway,andevent uallyyouwillseethepercentageofsuccessful packetsdropbelow100%, (withtheXBeeSXinstalled) (SENDER) (XBeeSX)XBeeB(XBeePROSX)XBeeC(XBeePROSX) EffectNISENDERRECEIVERBRIDGED efinesthenodeidentifier, [0]Lowest[0]Lowest[0] (XBeeSX)XBeeB(XBeePROSX)XBeeC(XBeePROSX) EffectDH000 Definesthedestinationaddress(highpart) (lowpart) 000000000000 FFFF (hexadecimal)=5(decimal)x100ms= , ,movingthetwodevicesoutofrangeofeachothe r, :selecttheSENDER deviceintheRadioModulessection, "Hello!

8 ". , , ,createsabridgebetweentheothertwonodes, ATmode. , , , , : ,changetheaddress,exitCommandmode, , 'saddressAllreceivedRFdataAPIframesindic atethesourceaddressAdvancedaddressingsup portAPItransmitandreceiveframescanexpose addressingfieldsincludingsourceanddestin ationendpoints,clusterIDandprofileIDAdva ncednetworkingdiagnosticsAPIframescanpro videindicationofIOsamplesfromremotedevic es, ,NACK, :nSendsRFdatatomultipledestinationsnSend sremoteconfigurationcommandstomanagedevi cesinthenetworknReceivesRFdatapacketsfro mmultipledevices,andtheapplicationneedst oknowwhichdevicesentwhichpacketAPImodeis requiredwhen:nReceivingI/Osamplesfromrem otedevicesnUsingSPIfortheserialportIfthe conditionslistedabovedonotapply, , , ,thatdatamustmeetthefollowingcriteria:nN etworkIDmatch[ID(NetworkID)onpage65]nPre ambleIDmatch[HP(PreambleID)onpage65]nAdd ressmatch[SH(SerialNumberHigh)onpage73an dSL(SerialNumberLow)onpage73]Transmitmod eWhenthedevicereceivesserialdataandisrea dytopacketizeit, (s) , , , , , , , ,wherethedeviceenterssleepmodeuponpintra nsition,andcyclicsleep, , , "AT" ,youmustissuethefollowingsequence:GT+CC( +++)+ (theguardtime)followedbythestring+++(wit houtEnterorReturn)andanotherfullsecondof silence, +++ , , (defaultis10seconds)passeswithoutanyuser input, ,seeCC(CommandSequenceCharacter)onpage11 4,CT(CommandmodeTimeout)onpage114andGT(G uardTimes) ,theBRparameter=3(9600b/s).

9 (serialbreak) ' , , sregister, 'sdestinationaddress(Low) , , , , ,ifyousendtheBDcommandtochangethebaudrat e, (ApplyChanges) (ExitCommandMode) (CommandModeTimeout), :nAsynchronous(SM=1,4,5).nSynchronous(SM =7,8).InDigiMeshnetworks, , , , , , ,butdoesnotobservesynchronizationdatarou tingrules;itroutesdataatanytime,regardle ssofthenetwork' ,adeviceinNormalnoderelayssyncmessagesth atsleep-compatiblenodesgenerate, , (pin10).WhenyouassertSLEEP_RQ(high), (low), , , ,(ON/SLEEP)(high) ,(ON/SLEEP)(low) ,theCTSpinasserts(low)whenthedevicewakes andcanreceiveserialdata,andde-asserts(hi gh) (SM=4)thatallowsyoutowakeadeviceprematur elybyassertingtheSLEEP_RQpin(pin10).Inth ismode,youcanwakethedeviceafterthesleepp eriodexpires, , , , ,wakesinunisonwithothernodes,exchangesda taandsyncmessages, , ,thenetwork , (ON/SLEEP enabled)onacyclicsleepnode, , ,unsynchronized,sleepingdevicepollsforas ynchronizedmessageandthensleepsfortheper iodthattheSPcommandspecifies, , (SM=4orSM=5),itstartsasleeptimer(timeunt ilsleep).

10 NIfthedevicereceivesanydataseriallyorbyR Flink, ,youcanusetheCE(Routing/MessagingMode) (P2MP) (ifavailable) , , ,aTxStatusmessageisgeneratedforapurgedda tapacketwithastatusof0x75(INDIRECT_MESSA GE_UNREQUESTED). , ,CTSisde-asserted(ifhardwareflowcontroli senabled). ,directedbroadcasts,repeaterpackets, ,configureitasanindirectmessagingpollerw iththeCEcommandandsetitsDH: ,thedevicesendsaP2 :DLofapollingdevice, , , , , , , , , ,duetoRFinterference, , , , (sleepoptions) , commandtoconfigurenodesasnon-coordinator s,andifthenon-coordinatorsgosixormoresle epcycleswithouthearingasync, , ,setthepreferredsleepcoordinatorbit(bit0 ) , , , , , , , : (presumablybecausethesleepcoordinatorhas beendisabled).Dependingontheplatformando therconfigurableoptions, , :thenetworkconsidersanodeusingnewersleep parameters(SPandST) :Ifthepreviousfactorsdonotresolvetheprio rity, (pin33) , sSPand/orSTtovaluesdifferentfromthosetha tthenetworkisusing, ,adeviceusesthesleepandwakeparametersitg etsfromthesleepsyncmessage, :NH,NN, ,werecommendconfiguringtheNH,NN, , , , , , ,selecttheappropriatevaluesfortheNH(Netw orkHops)andNN(NetworkDelaySlots) , , (SMPT).