XBee/XBee-PRO S2C Zigbee RF Module - Digi

Transcription

XBee /XBee-PRO S2C Zigbee RF ModuleUser Guide

Revision history—90002002Revision DateDescriptionACMay 2019Removed Brazilian certification information for certain devices.ADJune 2019Added FCC publication 996369 related information.AEOctober2019Enhancement to the network watchdog, fixes for a number of customerreported issues.AFNovember2019Added Brazilian ANATEL certification information.AGJanuary2020Added IFETEL certifications.Trademarks and copyrightDigi, Digi International, and the Digi logo are trademarks or registered trademarks in the UnitedStates and other countries worldwide. All other trademarks mentioned in this document are theproperty of their respective owners. 2020 Digi International Inc. All rights reserved.DisclaimersInformation in this document is subject to change without notice and does not represent acommitment on the part of Digi International. Digi provides this document “as is,” without warranty ofany kind, expressed or implied, including, but not limited to, the implied warranties of fitness ormerchantability for a particular purpose. Digi may make improvements and/or changes in this manualor in the product(s) and/or the program(s) described in this manual at any time.WarrantyTo view product warranty information, go to the following website:www.digi.com/howtobuy/termsCustomer supportGather support information: Before contacting Digi technical support for help, gather the followinginformation:Product name and modelProduct serial number (s)Firmware versionOperating system/browser (if applicable)Logs (from time of reported issue)Trace (if possible)XBee/XBee-PRO S2C Zigbee RF Module2

Description of issueSteps to reproduceContact Digi technical support: Digi offers multiple technical support plans and service packages.Contact us at 1 952.912.3444 or visit us at www.digi.com/support.FeedbackTo provide feedback on this document, email your comments totechcomm@digi.comInclude the document title and part number (XBee/XBee-PRO S2C Zigbee RF Module, 90002002 AG)in the subject line of your email.XBee/XBee-PRO S2C Zigbee RF Module3

ContentsXBee/XBee-PRO S2C Zigbee RF ModuleNote on product namingApplicable firmware and hardwareFirmware release notes151515Technical specificationsPerformance specificationsPower requirementsGeneral specificationsNetworking and security specificationsCommunication interface specificationsRegulatory conformity summarySerial communication specificationsUART pin assignmentsSPI pin assignmentsGPIO specificationsHardware specifications for the programmable variant1717171818192121212122HardwareMechanical drawingsPin signals for the surface-mount modulePin signals for the through-hole moduleEM357 pin mappingsDesign notesPower supply designBoard layoutAntenna performanceRecommended pin connectionsDesign notes for PCB antenna devicesDesign notes for RF pad devicesModule operation for the programmable variant252629303131313232333437Programmable XBee SDKProgrammable connectionsXBee/XBee-PRO S2C Zigbee RF Module394

OperationSerial interfaceUART data flowSerial dataSPI communicationsSPI operationSerial port selectionSerial buffersSerial receive bufferSerial transmit bufferUART flow controlCTS flow controlRTS flow controlBreak controlSerial interface protocolsTransparent operating modeAPI operating modeCompare Transparent and API operationModesIdle modeTransmit modeReceive modeCommand modeSleep Zigbee networksAbout the Zigbee specificationDefinitionsZigbee node typesZigbee protocolZigbee stack layersZigbee networking conceptsDevice typesPAN IDOperating channelsZigbee application layers: in depthApplication Support Sublayer (APS)Application profilesZigbee coordinator operationForm a networkSecurity policyChannel selectionPAN ID selectionPersistent dataCoordinator startupPermit joiningReset the coordinatorLeave a networkReplace a coordinator (security disabled only)Example: start a coordinatorExample: replace a coordinator (security disabled)Router operationXBee/XBee-PRO S2C Zigbee RF 656566665

Discover Zigbee networksJoin a networkPersistent dataZigbee router joiningPermit joiningRouter network connectivityEnd device operationDiscover Zigbee networksJoin a networkEnd device capacityPersistent dataOrphan scansEnd device joiningParent connectivityReset the end deviceLeave a networkExample: join a networkZigbee channel scanningManage multiple Zigbee networksFilter PAN IDConfigure security keysPrevent unwanted devices from joiningApplication messaging 67677Transmission, addressing, and routingAddressing64-bit device addresses16-bit device addressesApplication layer addressingData transmissionBroadcast transmissionsUnicast transmissionsAddress resolutionAddress tableGroup tableBinding transmissionsAddress resolutionBinding tableMulticast transmissionsAddress resolutionFragmentationData transmission examplesTransparent modeAPI modeAPI frameRF packet routingLink status transmissionAODV mesh routingMany-to-One routingHigh/Low RAM Concentrator modeSource routingEncrypted transmissionsMaximum RF payload sizeThroughputXBee/XBee-PRO S2C Zigbee RF 879090909595976

Latency timing specificationsZDO transmissionsSend a ZDO commandReceiving ZDO command and responsesTransmission timeoutsUnicast timeoutExtended timeoutTransmission examples98989899101101102102Zigbee securitySecurity modesZigbee security modelNetwork layer securityAPS layer securityTrust centerForming or joining a secure networkImplement security on the XBee/XBee-PRO Zigbee RF ModuleEnabling securitySetting the network security keySet the APS trust center link keyEnable APS encryptionUse a trust centerSecurity work commissioning and diagnosticsPlace devicesTest links in a network - loopback clusterRSSI indicatorsDevice discoveryNetwork discoveryZDO discoveryJoining AnnounceCommissioning pushbutton and associate LEDCommissioning pushbuttonAssociate LEDBindingEnd Device Bind reqExample of a End Device Bind reqGroup Table APIAdd Group commandView groupGet Group MembershipRemove GroupRemove All GroupsDefault responsesCommon status 121122125126127127Manage End DevicesEnd device operationParent operationXBee/XBee-PRO S2C Zigbee RF Module1301307

End Device poll timeoutsPacket buffer usageNon-Parent device operationEnd Device configurationPin sleepCyclic sleepRecommended sleep current measurementsAchieve the lowest sleep currentCompensate for switching timeInternal pin pull-upsTransmit RF dataReceiving RF dataI/O samplingWake end devices with the Commissioning PushbuttonParent verificationRejoiningRouter/Coordinator configurationRF packet buffering timeoutChild poll timeoutTransmission timeoutShort sleep periodsExtended sleep periodsSleep examplesExample 1: Configure a device to sleep for 20 seconds, but set SN such that the On/sleepline will remain de-asserted for up to 1 minuteExample 2: Configure an end device to sleep for 20 seconds, send 4 I/O samples in 2seconds, and return to sleepExample 3: configure a device for extended sleep: to sleep for 4 41141142142142143143143143143144144Analog and digital I/O linesConfigurable I/O pins and configuration commandsXBee ZB through-hole RF moduleI/O configurationI/O samplingQueried samplingPeriodic I/O samplingChange detection samplingRSSI PWMI/O examplesPWM1147147148149150151151151152152API OperationAPI frame formatAPI operation (AP parameter 1)API operation-with escaped characters (AP parameter 2)Data bytes that need to be escaped:LengthFrame dataCalculate and verify checksumsAPI examplesAPI serial exchangesAT commandsXBee/XBee-PRO S2C Zigbee RF Module1541541541551551551561571581588

Transmit and Receive RF dataRemote AT commandsSource routingDevice RegistrationSend ZDO commands with the APIExampleSend Zigbee cluster library (ZCL) commands with the APIExampleSend Public Profile Commands with the APIFrame specific dataExample159159160160160162163166168168171Frame descriptionsLocal AT Command Request - 0x08DescriptionFormatExamplesQueue Local AT Command Request - 0x09DescriptionExamplesTransmit Request - 0x10DescriptionTransmit options bit fieldExamplesExplicit Addressing Command Request - 0x11Description64-bit addressing16-bit addressingZigbee-specific addressing informationReserved endpointsReserved cluster IDsReserved profile IDsTransmit options bit fieldExamplesRemote AT Command Request - 0x17DescriptionFormatExamplesCreate Source Route - 0x21DescriptionFormatExamplesLocal AT Command Response - 0x88DescriptionExamplesModem Status - 0x8ADescriptionModem status codesExamplesExtended Transmit Status - 0x8BDescriptionExamplesReceive Packet - 0x90DescriptionXBee/XBee-PRO S2C Zigbee RF 941961961971981991992002022029

ExamplesExplicit Receive Indicator - 0x91DescriptionExamplesI/O Sample Indicator - 0x92DescriptionExamplesXBee Sensor Read Indicator - 0x94Node Identification Indicator - 0x95DescriptionExamplesRemote AT Command Response- 0x97DescriptionExamplesExtended Modem Status - 0x98DescriptionSecure Session status codesExamplesStatus code descriptionsOver-the-Air Firmware Update Status - 0xA0Route Record Indicator - 0xA1DescriptionExamplesMany-to-One Route Request Indicator - 3AT commandsNetwork commandsID (Extended PAN ID)SC (Scan Channels)SD (Scan Duration)ZS (Zigbee Stack Profile)NJ (Node Join Time)NW (Network Watchdog Timeout)JV (Coordinator Join Verification)JN (Join Notification)OP (Operating Extended PAN ID)OI (Operating 16-bit PAN ID)CH (Operating Channel)NC (Number of Remaining Children)CE (Coordinator Enable)DO (Miscellaneous Device Options)DC (Joining Device Controls)II (Initial 16-bit PAN ID)ED (Energy Detect)Addressing commandsSH (Serial Number High)SL (Serial Number Low)MY (16-bit Network Address)MP (16-bit Parent Network Address)DH (Destination Address High)DL (Destination Address Low)NI (Node Identifier)XBee/XBee-PRO S2C Zigbee RF 124124224224224224324324324324324410

NH (Maximum Unicast Hops)BH (Broadcast Hops)AR (Aggregate Routing Notification)DD (Device Type Identifier)NT (Node Discover Timeout)NO (Network Discovery Options)NP (Maximum Packet Payload Bytes)CR (Conflict Report)Zigbee addressing commandsSE (Source Endpoint)DE (Destination Endpoint)CI (Cluster ID)TO (Transmit Options)RF interfacing commandsPL (TX Power Level)PP (Power at PL4)PM (Power Mode)Security commandsEE (Encryption Enable)EO (Encryption Options)KY (Link Key)NK (Trust Center Network Key)Serial interfacing commandsBD (Interface Data Rate)NB (Parity)SB (Stop Bits)RO (Packetization Timeout)D6 (DIO6/RTS)D7 (DIO7/CTS)AP (API Enable)AO (API Options)Command mode optionsCT (Command Mode Timeout)GT (Guard Times)CC (Command Character)CN (Exit Command mode)Sleep commandsSP (Sleep Period)SN (Number of Cycles Between ON SLEEP)SM (Sleep Mode)ST (Time before Sleep)SO (Sleep Options)WH (Wake Host Delay)PO (Polling Rate)I/O settings commandsD0 (AD0/DIO0 Configuration)D1 (AD1/DIO1/PTI En Configuration)D2 (AD2/DIO2 Configuration)D3 (AD3/DIO3 Configuration)D4 (DIO4 Configuration)D5 (DIO5/Associate Configuration)D8 (DIO8/DTR/SLP RQ)D9 (DIO9/ON SLEEP)P0 (RSSI/PWM0 Configuration)P1 (DIO11/PWM1 Configuration)XBee/XBee-PRO S2C Zigbee RF 25926026026126126126211

P2 (DIO12 Configuration)P3 (DIO13/DOUT Configuration)P4 (DIO14/DIN)P5 (DIO15/SPI MISO)P6 (SPI MOSI Configuration)P7 (DIO17/SPI SSEL )P8 (DIO18/SPI SCLK)P9 (DIO19/SPI ATTN/PTI DATA)PR (Pull-up/Down Resistor Enable)PD (Pull Up/Down Direction)LT (Associate LED Blink Time)RP (RSSI PWM Timer)I/O sampling commandsIR (I/O Sample Rate)IC (Digital Change Detection)V (Voltage Supply Monitoring)Diagnostic commandsVR (Firmware Version)HV (Hardware Version)AI (Association Indication)%V (Voltage Supply Monitoring)DB (Received Signal Strength)TP (Temperature)VL (Version Long)Execution commandsAC (Apply Changes)AS (Active Scan)WR (Write)RE (Restore Defaults)FR (Software Reset)NR (Network Reset)SI (Sleep Immediately)CB (Commissioning Pushbutton)&X (Clear Binding and Group Tables)ND (Node Discovery)DN (Destination Node)DJ (Disable Joining)IS (Force 273274274274275276276Module supportConfigure the device using XCTUSoftware librariesCustomize XBee Zigbee firmwareXBee bootloaderSerial firmware updatesInvoke the XBee bootloaderSend a firmware imageWriting custom firmwareRegulatory complianceEnable GPIO 1 and 2Detect XBee versus XBee-PROSpecial instructions for using the JTAG interfaceXBee/XBee-PRO S2C Zigbee RF Module27827827827827927927928028028028128112

Regulatory informationUnited States (FCC)OEM labeling requirementsFCC noticesFCC-approved antennas (2.4 GHz)Associated antenna descriptionsRF exposureFCC publication 996369 related informationEurope (CE)Maximum power and frequency specificationsOEM labeling requirementsDeclarations of conformityAntennasISED (Innovation, Science and Economic Development Canada)Labeling requirementsFor XBee ZB surface-mount:For XBee-PRO ZB surface-mount:For XBee ZB through-hole:For XBee-PRO ZB through-hole:Transmitters for detachable antennasDetachable antennaFor XBee S2D SMT:RF ExposureAustralia (RCM)ANATEL (Brazil)South KoreaIFETEL (Mexico)OEM labeling ng from XBee through-ho

XBee-PRO ZigbeeS2C Indoor/urbanrange Upto60m(200ft) Upto90m(300 ft) OutdoorRFline-of-sight range Upto1200m(4000ft) Upto3200m(2 mi) Transmitpoweroutput (maximum) 6.3mW( 8dBm),boostmode 3.1mW( 5dBm),normalmodechannel26max poweris 3dBm 63mW( 18dBm) RFdatarate 250,000b/s Receiversensitivity -102dBm,boostmode-100dBm,normalmode-101dBm