XBee®/XBee-PRO SX RF Module User Guide

1 xbee / xbee -PROSXR adioFrequency(RF)ModuleUserGuideRevision history ,DigiInternational, asis, withoutwarrantyofanykind,expressedorimpl ied,including,butnotlimitedto, (s)and/ortheprogram(s) , :BeforecontactingDigitechnicalsupportfor help,gatherthefollowinginformation: Productnameandmodel Productserialnumber(s) Firmwareversion Operatingsystem/browser(ifapplicable) Logs(fromtimeofreportedissue) Trace(ifpossible) DescriptionofissueXBee / xbee -PROSXRFM oduleUserGuide2 / xbee -PROSXRFM oduleUserGuide,90001477K) / xbee -PROSXRFM oduleUserGuide3 ContentsXBee / xbee -PROSXRFM oduleUserGuideApplicablefirmwareandhardw are13 TechnicalspecificationsRegulatoryconform itysummary15 Powerrequirements15 Networkingspecifications15 Performancespecifications16 Generalspecifications17 GPIO specifications18 HardwareMechanicaldrawings20 Pinsignals21 Pinconnectionrecommendations23 GettingstartedwiththeXBee/ xbee -PROSXRFM oduleDevelopmentKitXBeeSXDevelopmentBoar d25 ConnectXBee-PROSX developmentboardstoaPC26 ConnecttheXBIB-U-SSdevelopmentboardtoaPC 27 ConfigurethedeviceusingXCTU27 Configurethedevicesforarangetest27 Performarangetest28 Meshnetworkdemonstration29 Softwarelibraries31 XBeeNetworkAssistant31 XBeeMultiProgrammer32 ModesTransparentandAPIoperatingmodes34 Transparentoperatingmode34 APIoperatingmode34 ComparingTransparentandAPImodes34 xbee / xbee -PROSXRFM oduleUserGuide4 xbee / xbee -PROSXRFM oduleUserGuide5 Modesofoperation35 Receivemode35 Transmitmode36 Sleepmode36

2 Commandmode36 SleepmodesAboutsleepmodes40 Asynchronousmodes40 Synchronousmodes40 Normalmode40 Asynchronouspinsleepmode41 Asynchronouscyclicsleepmode41 Asynchronouscyclicsleepwithpinwakeupmode 41 Synchronoussleepsupportmode41 Synchronouscyclicsleepmode42 Thesleeptimer42 Indirectmessagingandpolling42 Indirectmessaging42 Polling43 Sleepingrouters43 SleepcoordinatorsleepmodesintheDigiMeshn etwork43 Synchronizationmessages44 Becomeasleepcoordinator46 Preferredsleepcoordinatoroption46 Resolutioncriteriaandselectionoption46 CommissioningPushbuttonoption47 Auto-earlywake-upsleepoption48 Selectsleepparameters48 Startasleepingsynchronousnetwork48 Addanewnodetoanexistingnetwork49 Changesleepparameters50 Rejoinnodesthatlosesync50 Diagnostics51 Querysleepcycle51 Sleepstatus51 Missedsyncmessagescommand51 SleepstatusAPImessages51 NetworkingmethodsTheMACandPHYlayers5364- bitaddresses53 Makeaunicasttransmission54 Makeabroadcasttransmission54 Deliverymethods54 PointtoPoint/PointtoMultipoint(P2MP)54 Repeater/directedbroadcast55 DigiMeshnetworking55 xbee / xbee -PROSXRFM oduleUserGuide6 SerialcommunicationUART dataflow60 Serialdata60 SPIsignals60 Signaldescription61 Slavemodecharacteristics61 Fullduplexoperation62 Lowpoweroperation62 Configurationconsiderations63 SPIandAPImode63 SPIparameters63 Serialportselection63 Serialreceivebuffer64 Serialtransmitbuffer64 UART flowcontrol64 CTSflowcontrol64 RTSflowcontrol64 ATcommandsSpecialcommands67AC(ApplyChang es)67FR(SoftwareReset)67RE(RestoreDefaul ts)67WR(Write)67 MAC/PHYcommands68AF(AvailableFrequencies )68CM(ChannelMask)68MF(MinimumFrequencie s)69HP(PreambleID)70ID(NetworkID)70MT (BroadcastMulti-Transmits)70BR(RFDataRat e)70PL(TXPowerLevel)71RR(UnicastMacRetri es)72 Diagnosticcommands-MACstatisticsandtimeo uts72BC(BytesTransmitted)72DB(LastPacket RSSI)72ER(ReceiveCountError)73GD(GoodPac ketsReceived)73EA(MACACKF ailureCount)

3 73TR(TransmissionFailureCount)73UA(Unica stsAttemptedCount)74%H(MACU nicastOneHopTime)74%8(MACB roadcastOneHopTime)74 Networkcommands74CE(Routing/MessagingMod e)74BH(BroadcastHops)75NH(NetworkHops)75 MR(MeshUnicastRetries)75NN(NetworkDelayS lots)76 Addressingcommands76SH(SerialNumberHigh) 76 xbee / xbee -PROSXRFM oduleUserGuide7SL(SerialNumberLow)76DH(D estinationAddressHigh)77DL(DestinationAd dressLow)77TO(TransmitOptions)77NI(NodeI dentifier)78NT(NetworkDiscoveryBack-off) 78NO(NetworkDiscoveryOptions)78CI(Cluste rID)79 Diagnostic-addressingcommands79N?(Networ kDiscoveryTimeout)79 Addressingdiscovery/configurationcommand s80AG(AggregatorSupport)80DN(DiscoverNod e)80ND(NetworkDiscover)81FN(FindNeighbor s)81 Securitycommands82EE(EncryptionEnable)82 KY(AESE ncryptionKey)82KZ(RemoteATCommandPasswor d)83 Serialinterfacingcommands83BD(InterfaceD ataRate)83NB(Parity)85SB(StopBits)85RO(P acketizationTimeout)85FT(FlowControlThre shold)86AP(APIE nable)86AO(APIO ptions)86I/Osettingscommands87D0(DIO0/AD 0)87D1(DIO1/AD1)87D2(DIO2/AD2)88D3(DIO3/ AD3)88D4(DIO4)89D5(DIO5/ASSOCIATED_INDIC ATOR)89D6(DIO6/RTS)90D7(DIO7/CTS)90D8(DI O8/SLEEP_REQUEST)91D9(DIO9/ON_SLEEP)91P0 (DIO10/RSSI/PWM0 Configuration)92P1(DIO11/PWM1 Configuration)92P2(DIO12 Configuration)93P3(DIO13/DOUT)93P4(DIO14 /DIN)94P5(DIO15/SPI_MISO)94P6(SPI_MOSI)9 5P7(DIO17/SPI_SSEL)95P8(DIO18/SPI_SCLK)9 5P9(DIO19/SPI_ATTN)96PD(PullDirection)96 PR(Pull-up/DownResistorEnable)97M0(PWM0 DutyCycle)98M1(PWM1 DutyCycle)98LT(AssociatedLEDB linkTime)98RP(RSSIPWMT imer)

4 98I/Osamplingcommands99 xbee / xbee -PROSXRFM oduleUserGuide8AV(AnalogVoltageReference )99IC(DIOC hangeDetect)99IF(SleepSampleRate)100IR(S ampleRate)100IS(ImmediateSample)100TP(Bo ardTemperature)101%V(VoltageSupplyMonito ring)101I/Olinepassingcommands101IU(I/OO utputEnable)101IA(I/OInputAddress)102T0( D0 Timeout)102T1(D1 OutputTimeout)102T2(D2 OutputTimeout)103T3(D3 OutputTimeout)103T4(D4 OutputTimeout)103T5(D5 OutputTimeout)103T6(D6 OutputTimeout)103T7(D7 OutputTimeout)104T8(D8 Timeout)104T9(D9 Timeout)104Q0(P0 Timeout)104Q1(P1 Timeout)104Q2(P2 Timeout)105Q3(P3 Timeout)105Q4(P4 Timeout)105PT(PWMO utputTimeout)105 Sleepcommands106SM(SleepMode)106SO(Sleep Options)107SN(NumberofCyclesBetweenON_SL EEP)107SP(SleepTime)108ST(WakeTime)108WH (WakeHostDelay)108 Diagnostic-sleepstatus/timingcommands109 SS(SleepStatus)109OS(OperatingSleepTime) 109OW(OperatingWakeTime)109MS(MissedSync Messages)110SQ(MissedSleepSyncCount)110 Commandmodeoptions110CC(CommandSequenceC haracter)110CT(CommandModeTimeout)111GT( GuardTimes)111 Firmwareversion/informationcommands111VR (FirmwareVersion)111HV(HardwareVersion)1 11HS(HardwareSeries)111DD(DeviceTypeIden tifier)112NP(MaximumPacketPayloadBytes)1 12CK(ConfigurationCRC)112 OperateinAPImodeAPImodeoverview114 UsetheAPcommandtosettheoperationmode114 xbee / xbee -PROSXRFM oduleUserGuide9 APIframeformat114 APIoperation(APparameter=1)114 APIoperationwithescapedcharacters(APpara meter=2)

5 115 Lengthfield116 Framedata116 Calculateandverifychecksums116 APIframesAPIframeexchanges119 ATcommands119 TransmitandReceiveRFdata119 RemoteATcommands120 DeviceRegistration120 CodetosupportfutureAPIframes121 LegacyTXRequestframe-0x00122 ATCommandframe-0x08124 ATCommand-QueueParameterValueframe-0x091 26 TransmitRequestframe-0x10128 ExplicitAddressingCommandframe-0x11131 RemoteATCommandRequestframe-0x17134 SecureRemoteATCommandRequestframe-0x1813 6 ModemStatusframe-0x8A139 TransmitStatusframe-0x8B140 RouteInformationPacketframe-0x8D142 AggregateAddressingUpdateframe-0x8E145 LegacyRXIndicatorframe-0x80147 ATCommandResponseframe-0x88149 LegacyTXStatusframe-0x89151 RXIndicatorframe-0x90152 ExplicitRxIndicatorframe-0x91154 NodeIdentificationIndicatorframe-0x95156 RemoteCommandResponseframe-0x97159 WorkwithnetworkeddevicesNetworkcommissio ninganddiagnostics162 Localconfiguration162 Remoteconfiguration162 Sendaremotecommand162 Applychangesonremotedevices162 Remotecommandresponse162 SecureremoteATcommands163 HowsecureremoteATcommandsprotectthenetwo rk163 Passwordprotection163 Passwordrecovery163 Secureremotecommandcontrol164 Securityprotections164 Secureanetwork164 Softwaredowngrades165 Establishandmaintainnetworklinks165 Buildaggregateroutes165 DigiMeshroutingexamples166 Replacenodes166 xbee / xbee -PROSXRFM oduleUserGuide10 Testlinksinanetwork-loopbackcluster167 Testlinksbetweenadjacentdevices167 Example168 RSSI indicators169 Discoverallthedevicesonanetwork169 Tracerouteoption170 NACK messages171 TheCommissioningPushbutton171 AssociateLED173 MonitorI/OlinesPinconfigurations174 Queriedsampling175 PeriodicI/Osampling176 DetectdigitalI/Ochanges176I/Olinepassing Configurationexample178 GeneralPurposeFlashMemoryGeneralPurposeF lashMemory182 AccessGeneralPurposeFlashMemory182 GeneralPurposeFlashMemorycommands183 PLATFORM_INFO_REQUEST(0x00)183 PLATFORM_INFO(0x80)

6 183 ERASE(0x01)184 ERASE_RESPONSE(0x81)184 WRITE(0x02)andERASE_THEN_WRITE(0x03)185 WRITE_RESPONSE(0x82)andERASE_THEN_WRITE_ RESPONSE(0x83)186 READ(0x04)186 READ_RESPONSE(0x84)187 FIRMWARE_VERIFY(0x05)andFIRMWARE_VERIFY_ AND_INSTALL(0x06)187 FIRMWARE_VERIFY_RESPONSE(0x85)188 FIRMWARE_VERIFY_AND_INSTALL_RESPONSE(0x8 6)188 Updatethefirmwareover-the-airOver-the-ai rfirmwareupdates191 Distributethenewapplication191 Example191 Verifythenewapplication192 Installtheapplication192 Importantconsiderations192 RegulatoryinformationFCC(UnitedStates)19 4 OEMlabelingrequirements194 FCCnotices194 xbee / xbee -PROSXRFM oduleUserGuide11 RFexposurestatement196 FCCantennacertifications196 xbee -PROSX antennaoptions(30dBmmaximumRFpower)197 XBeeSXantennaoptions(13dBmmaximumRFpower )202 FCCpublication996369relatedinformation20 7 ISED(Innovation,ScienceandEconomicDevelo pmentCanada)209 Labelingrequirements209 Transmittersfordetachableantennas209 Detachableantennas209 ACMA(Australia)210 Powerrequirements210 RSM(NewZealand)210 Powerrequirements210 Brazil(Anatel)211 ANATELB razilforXBee-PROSX radioproducts(XBPSX)211 SXANATELB razilforXK9X-DMS-1 XBeeSXRFM oduleDevKit(XK9X-DMS-1)212 ANATELB razilforXBeeSXradioproducts(XBSX)213 IFETEL(Mexico)214 OEMlabelingrequirements214 PCBdesignandmanufacturingRecommendedfoot printandkeepout216 Designnotes218 Hostboarddesign218 Improveantennaperformance219 RFpadversion219 Recommendedsolderreflowcycle220 Fluxandcleaning221 Rework221 xbee / xbee -PROSXRFM oduleUserGuideTheXBee/ xbee -PROSXRFM oduleisanembeddedradiofrequency(RF) ,lowoperatingcurrent, sfrequencyhoppingtechnologyoffersadvance dinterferenceimmunity, (SPI)oruniversalasynchronousreceiver/tra nsmitter(UART),aswellasdigital,analog,an dpulsewidthmodulation(PWM)

7 / xbee -PROSXRFM oduleUserGuide12 xbee / xbee -PROSXRFM oduleUserGuideApplicablefirmwareandhardw areXBee / xbee -PROSXRFM oduleUserGuide13 ApplicablefirmwareandhardwareThismanuals upportsthefollowingfirmware:n0x900 XUSAandCanada, xbee / xbee -PROSXn0x920xAust ralia, xbee / xbee -PROSXn0x930 XBrazilXBee/ xbee -PROSXn0x960 XNewZealand, :nXBee/ xbee -PROSXRFM oduleTechnicalspecificationsRegulatoryco nformitysummary15 Powerrequirements15 Networkingspecifications15 Performancespecifications16 Generalspecifications17 GPIO specifications18 xbee / xbee -PROSXRFM oduleUserGuide14 TechnicalspecificationsRegulatoryconform itysummaryXBee , :MCQ-XBPSXFCCID:MCQ-XBSXC anadaIC:1846A-XBPSXIC:1846A-XBSXA ustraliaRCMRCMNewZealandR-NZBrazilANATEL :05774-16-01209 ANATEL:05776-16-01209 MexicoRCPDIXB19-2288 RCPDIXB19-1819 @ @ @ (GFSK)SpreadingtechnologyFrequencyHoppin gSpreadSpectrum(FHSS)Technicalspecificat ionsPerformancespecificationsXBee / xbee -PROSXRFM oduleUserGuide16 SpecificationValueSupportednetworktopolo gies(softwareselectable)Peer-to-peer(mas ter/slaverelationshipnotrequired),point- to-point/point-to-multipoint,meshEncrypt ionOptional256-bitAdvancedEncryptionStan dard(AES)cipherblockchaining(CBC) ,orientationoftransmitterandreceiver,hei ghtoftransmittingantenna,heightofreceivi ngantenna,weatherconditions,interference sourcesinthearea,andterrainbetweenreceiv erandtransmitter,includingindoorandoutdo orstructuressuchaswalls,trees,buildings, hills, (softwareselectable)Lowdatarate10kb/sMid dledatarate110kb/sHighdatarate250kb/sTra nsmitpower(softwareselectable)Upto13dBmU pto30dBm1 NewZealandspecificUpto13dBm,atthehighdat arate(BR2) ,seePL(TXPowerLevel).

8 2 Thedevicehopson50channelsselectedusingth eCMcommand, ,seeCM(ChannelMask).Technicalspecificati onsGeneralspecificationsXBee (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 audSPIclockrateUpto6 ( ) (9mi) / xbee -PROSXRFM oduleUserGuide18 SpecificationValueRestrictionofHazardous Substances(RoHS)CompliantManufacturingIS O9001 unbalancedMaximuminputRFlevelatantennapo rt6dBmOperatingtemperature-40 Cto85 CDigitalI/O13I/Olines,5outputlinesAnalog -to-digitalconverter(ADC)410-bitanalogin putsPulsewidthmodulator(PWM) * * AInputpull-upresistorvalue40k Inputpull-downresistorvalue40k * *VCCO utputsource/sinkcurrent1mATotaloutputcur rent(forGPIO pads)

9 20mAHardwareMechanicaldrawings20 Pinsignals21 xbee / xbee -PROSXRFM oduleUserGuide19 HardwareMechanicaldrawingsXBee / xbee -PROSXRFM oduleUserGuide20 , / xbee -PROSXRFM oduleUserGuide22 PinNameI/ODefaultstateFunction5 DIO12 ; [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]--Donotconnect24 DIO4 / xbee -PROSXRFM oduleUserGuide23 PinNameI/ODefaultstateFunction25 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).

10 GettingstartedwiththeXBee/ xbee -PROSXRFM oduleDevelopmentKitThissectionprovidesge ttingstartedinstructionsifyouhaveanXBee/ xbee -PROSXRFM oduledevelopmentkit:nUSAXK9X-DMS-0nAustr aliaXK9X-DMS-2nBrazilXK9X-DMS-1 / xbee -PROSXRFM oduleUserGuide24 GettingstartedwiththeXBee/ xbee -PROSXRFM oduleDevelopmentKitXBeeSXDevelopmentBoar dXBee / xbee -PROSXRFM oduleUserGuide25 XBeeSXDevelopmentBoardThefollowingfigure showstheXBeeSXdevelopmentboardwithonboar dXBee-PROSX LED indicatorsFrombottomtotop:Associated,Dat aIn,DataOut3 DIOpinLEDindicatorsFrombottomtotop:DIO4, DIO11, ! ' , ,thebuttonswitchpullsthedevice' pitchheadercorrespondstopins1through34 (6ft). (SMT)socketdevelopmentboard1 XBIB-U-SSSX developmentboardwithonboardXBee-PROSX RFpadmodule2 USA-XBIB-XBP9XR-0 Australia-XBIB-XB