Home

XBee DigiMesh 2.4 RF Modules User Guide

1. XBee DigiMesh 2 4 User Guide 124 XBee DigiMesh 2 4 API frames Status 5 0x00 Hardware reset 0x01 Watchdog timer reset 0x0B Network woke up 0x0C Network went to sleep Example When a device powers up it returns the following API frame Frame fields Offset Example Transmit Status frame 0x8B Description When a Transmit Request completes the device sends a Transmit Status message This message indicates if the Transmit Request was successful or if it failed Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame Byte fields s Description Frame type 0x8B Frame ID 5 Identifies the data frame for the host to correlate with a subsequent ACK If set to 0 in Command mode the device does not send a response Reserved 6 7 Reserved Transmit The number of application transmission retries that occur Retry Count XBee DigiMesh 2 4 User Guide 125 XBee DigiMesh 2 4 API frames Frame Byte fields s Description Delivery 0x00 Success Status 0x01 MAC ACK failure 0x15 Invalid destination endpoint 0x21 Network ACK failure 0x25 Route not found Discovery 0x00 No discovery overhead Status 0x02 Route discovery Example Inthe following example the destination device reports that a unicast data transmission was successful using a frame ID of 0x47 Frame Fields Offset Example Start delimiter
2. eee 129 Receive Packet 0x90 cco e eee ns 132 Explicit Rx Indicator frame 0x91 e cece eee cece ec eeeeeeeeeeeeeeeees 133 Data Sample Rx Indicator frame 0x92 lle eee cece cece eee cece cece cece onanan 135 Node Identification Indicator frame 0x95 2 lee eee cece cece cece cece ececeeeeeeees 138 Remote Command Response frame 0X97 e ananena anann 141 XBee DigiMesh 2 4 certifications XBee DigiMesh 2 4 agency certifications United States e cece eee eee ee 143 United States FCC 2 2 00 ooo ccc cnc 143 OEM labeling requirements o cece c cece cece cnc cnn 143 AAA PR Aa i Se ALE Bon eee Joa Baa ne oh 144 RF exposure statement 2202 naaa BALA Do PIA NADYA GNG MA SIKA KIN KNA UA NGANGA LK GG 144 XBee DigiMesh 2 4 FCC approved antennas 2 4 GHZ e eee ee 145 XBee DigiMesh 2 4 agency certifications Australia C Tick 0000000 0c eee eee eee 152 XBee DigiMesh 2 4 User Guide 9 Labeling requirements 0 00000000 coco cece ccc ccc nas 152 XBee DigiMesh 2 4 agency certifications Brazil Ag ncia Nacional de Telecomunicac es Anatel 153 XBee DigiMesh 2 4 agency certifications Industry Canada IC 154 Labeling requirements 000020 nene 154 XBee DigiMesh 2 4 agency certifications European Telecommunications Standards Institute ETSI ao ha ae A O a a ear ee eet 154 OEM labeling requirements e cece cece ccc
3. 00 0000000 cece cece cee eee eeeeees 24 XBee DigiMesh 2 4 ADC timing and performance characteristics 000000 02222 e eee eee eee eee eee 25 XBee DigiMesh 2 4 User Guide 3 XBee DigiMesh 2 4 modes Transparent and API operating modes ooo cocos 26 Transparent operating mode iiiiiiii teen 26 API operating mode nos 26 Comparing Transparent and API modes 00n noa0on non enenonnnnnnn 2T XBee DigiMesh 2 4 additional modes 1 1 0 2 22 222 eee ee eee eee ec eee ccc cece cece cece raaraa 29 Gomimand mode 2222 Satan yaa tia ede et es dd A e sabes Aes 29 VG ade a Dia eee ia et ee Ne AA Ba A 29 Receiveimode anag s tetas AE Paa Saad AD na ba E eter et 29 Sleep modes 34 a fees ates TSA D Nah Sou eee ne A 29 Transmit mode nn 30 Enter Command mode 22 02 2200 a citada E JANG GG tii iaa ia 30 Troubleshooting voca ic 30 Send AT commands cnn 31 Responding to AT commands eee 31 Exit Command Mode 2 eee 31 XBee DigiMesh 2 4 serial communication XBee serial interface conca aoe ede 33 UART data flow 33 EA NN TA PAANAN AA AA a eae 34 XBee DigiMesh 2 4 serial buffers eee cece cece eee eeeeeeeeeeeeeeees 34 XBee DigiMesh 2 4 serial buffer issues 34 Seral HOw COMO AP Vices ee EAR 35 CTS NOW COMTO test d ant oh elton E dido Efe golo tite ad e ala Ne eee poli idea 35 RES flow Control cn cnk oscars thes hs Soules etd ae ara Oa lei EEE oGsbeetewa ice Soecvelsseebeess 35 Work
4. SL lt CR gt NI lt CR gt Variable length PARENT NETWORK ADDRESS lt CR gt 2 Bytes always xFFFE DEVICE_TYPE lt CR gt 1 Byte Coord 1 Router 2 End Device STATUS lt CR gt 1 Byte Reserved PROFILE_ID lt CR gt 2 Bytes MANUFACTURER_ID lt CR gt 2 Bytes DIGI DEVICE TYPE lt CR gt 4 Bytes Optionally included based on NO settings RSSI OF LAST HOP lt DR gt 1 Byte Optionally included based on NO settings lt CR gt If you send the FN command in Command mode after NT 100 ms overhead time the command ends by returning a carriage return represented by lt CR gt If you send the FN command through a local API frame each response returns as a separate AT Command Response 0x88 or Remote Command Response 0x97 frame respectively The data consists of the bytes in the previous list without the carriage return delimiters The NI string ends in a 0x00 null character Parameter range N A Default N A FR Software Reset Reset the device The device responds immediately with an OK and performs a reset 100 ms later Parameter range N A Default N A FT Flow Control Threshold Set or read the flow control threshold XBee DigiMesh 2 4 User Guide 89 GD Good Packets Received De assert CTS and or send XOFF when FT bytes are in the UART receive buffer Re assert CTS when less than FT 16 bytes are in the UART receive buffer Parameter range 0x11 Oxee Bytes Default OxBE GD
5. Start Length Frame Frame Data Checksum epe ee The length field has a two byte value that specifies the number of bytes in the frame data field It does not delimiter TE include the checksum field XBee DigiMesh 2 4 API frames The device sends multi byte values in big endian format The devices support the following API frames API frame names API ID AT Command 0x08 AT Command Queue Parameter Value 0x09 Transmit Request 0x10 Explicit Addressing Command Frame 0x11 Remote Command Request 0x17 AT Command Response 0x88 Modem Status 0x8A Transmit Status 0x8B Receive Packet AO 0 0x90 Explicit Rx Indicator AO 1 0x91 Node Identification Indicator 40 0 0x95 XBee DigiMesh 2 4 User Guide 112 XBee DigiMesh 2 4 API frames API frame names API ID Remote Command Response 0x97 Route Information Packet 0x8D Aggregate Addressing Update Ox8E I O Data Sample Rx Indicator 0x92 API frame exchanges AT commands The following image shows the API frame exchange that takes place at the UART when you send an AT command request to read or set a device parameter To disable the response set the frame ID to 0 in the request AT command request Ox08 or 0x09 A AT command request 0x88 RF data The following image shows the API exchanges that take place at the UART when a device sends RF data to another device The device sends the Transmit Status frame at the end of a data transmission unles
6. Test links between adjacent devices 1 Transmit data to the loopback cluster ID 2 The remote device receives data on 0x12 and data endpoint OxE8 on the loopbach cluster ID and data endpoint a remote device Device 1 Device Mesh Network 4 Source receives loopback transmission 3 Remote transmits the received packet and sends received packet out the UART back to the sender The configuration steps for sending data to the loopback cluster ID depend on what mode the device is in For details on setting the mode see AP API Enable on page 73 The following sections list the steps based on the device s mode Transparent operating mode configuration AP 0 To send data to the loopback cluster ID on the data endpoint of a remote device 1 Set the CI command to 0x12 2 Set the SE and DE commands to OxE8 the default value 3 Set the DH and DL commands to the address of the remote device After you exit Command mode the device transmits any serial characters it received to the remote device which returns those characters to the sending device API operating mode configuration AP 1 or AP 2 Send an Explicit Addressing Command frame 0x11 using 0x12 as the cluster ID and 0xE8 as both the source and destination endpoint The remote device echoes back the data packets it receives to the sending device Test links between adjacent devices It often helps to test the quality of a link between two adjacen
7. Default 0x64 10 seconds XBee DigiMesh 2 4 User Guide 78 DO DIOO ADO The DIO0 ADO pin configuration pin 20 Parameter range Parameter Description 0x0 0x1 0x2 0x3 0x4 0x5 Default 0x1 Disabled Commissioning Pushbutton ADC Digital Input Digital output low Digital output high D1 DIO1 AD1 The DIO1 AD1 pin configuration pin 19 Parameter range Parameter Description 0x0 0x1 0x2 0x3 0x4 0x5 Default 0x0 Disabled N A ADC Digital input Digital output low Digital output high XBee DigiMesh 2 4 User Guide DO DIOO ADO 79 D2 DIO2 AD2 The DIO2 AD2 pin configuration pin 18 Parameter range Parameter Description 0x0 0x1 0x2 0x3 0x4 0x5 Default 0x0 Disabled N A ADC Digital input Digital output low Digital output high D3 DIO3 AD3 The DIO3 AD3 pin configuration pin 17 Parameter range Parameter Description 0x0 0x1 0x2 0x3 0x4 0x5 Default 0x0 Disabled N A ADC Digital input Digital output low Digital output high XBee DigiMesh 2 4 User Guide D2 DIO2 AD2 80 D4 DIO4 AD4 The DIO4 ADA4 pin configuration pin 11 Parameter range Parameter Description 0x0 0x1 0x2 0x3 0x4 0x5 Default 0x0 Disabled N A ADC Digital input Digital output low Digital output high D5 DIO5 AD5 ASSOCIATED_IND
8. The CCA parameter is measured in units of dBm Setting the parameter to 0x00 disables CCA otherwise the valid range is 0x24 0x50 Parameter range 0x0 0x50 dBm XBee DigiMesh 2 4 User Guide 75 CB Commissioning Pushbutton Default 0x0 CCA disabled Example If you set the ATCA parameter to 60 0x3C the device does not transmit if it detects a signal greater than 60 dBm on the channel ETSI compliance Europe Use the following settings for ETSI compliance Radio Hex value Sets to level XBee 58 dBm XBee PRO 0x43 67 dBm CB Commissioning Pushbutton Use CB to simulate commissioning pushbutton presses in software Set the parameter value to the number of button presses that you want to simulate For example send ATCB1 command to perform the action of pressing the commissioning pushbutton once Parameter range 0 4 Default N A CC Command Sequence Character The character value you use to enter Command mode Use CC to set or read the character The default value 0x2B is the ASCII code for the plus character You must enter it three times within the guard time to enter Command mode from Idle mode Parameter range 0x0 Oxff Recommended 0x20 0x7F ASCII Default 0x2b XBee DigiMesh 2 4 User Guide 76 CE Routing Messaging Mode CE Routing Messaging Mode The routing and messaging network type of the device End devices do not propagate broadcasts and will not become in
9. A device receives this frame when e adevice s AO O e it transmits a node identification message to identify itself The data portion of this frame is similar to a network discovery response see ND Network Discover on page 95 Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame fields Byte Description s Frame type 4 0x95 64 bit source 5 12 The sender s 64 bit address address Reserved 13 Reserved 14 Receive options 15 0x01 Packet acknowledged 0x02 Packet was a broadcast packet 0x40 Point multipoint packet 0x80 Directed broadcast packet OxCO DigiMesh packet Reserved 16 Reserved 17 64 bit address 18 Indicates the 64 bit address of the remote device that transmitted the Node 25 Identification Indicator frame XBee DigiMesh 2 4 User Guide 138 NI string Reserved Device type Source event Digi Profile ID Digi Manufacturer ID Digi DD value optional RSSI optional Example XBee DigiMesh 2 4 API frames 26 Node identifier string on the remote device The NI string is terminated with a 27 NULL byte 0x00 28 Reserved 29 30 0 Coordinator 1 Normal Mode 2 End Device For more options see NO Network Discovery Options on page 97 31 1 Frame sent by node identification pushbutton event See DO DIOO ADO on page 79 32 Set to Digis application pr
10. A24 Omni directional 9 5 dBi 0 2 dB FONF fiberglass base station A24 Omni directional 10 0 dBi 0 7 dB FIONF fiberglass base station A24 Omni directional 12 0 dBi 2 7 dB F12NF fiberglass base station A24 Omni directional 15 0 dBi 5 7 AB FI5NF fiberglass base station A24 Omni directional 7 2 dBi W7NF base station A24 Omni directional 7 2 dBi M7NF mag mount base station Panel class antennas 1 5 dB A24 Flat panel 8 5 dBi P8SF A24 Flat panel 8 5 dBi 1 5 dB P8NF dr you are using the RF module in a portable application or if the module is used in a handheld device and the antenna is less than 20 cm from the human body when the device is in operation The integrator may be responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C See the note under FCC notices for more information The testing results will be submitted to the FCC for approval prior to selling the integrated unit The required SAR testing measures emissions from the module and how they affect the person XBee DigiMesh 2 4 User Guide 148 XBee DigiMesh 2 4 agency certifications United States Required Part Minimum Cable Number Type Description Gain Application Separation Loss A24 Flat panel 13 0 dBi Fixed 6 dB P13NF A24 Flat panel 14 0 dBi Fixed 2m 7 dB P14NF A24 i
11. EN nanamn haaa Yas md ede desta le be lt a ia 89 ER Software Reset can 89 FT Flow Control Threshold 0 00 c ee nn 89 GD Good Packets Received 90 GT Guard TIMES 3a ap ab DNA ede radio obkl bled dica aaa 90 HV Hardware Version 2 2 22 eee c cece cece ccc cece cceeeecceeeecceceseceeeseceeesteeeseeeeeeeees 90 IC DIO Change Detect ipinin eNEAN EEA EAE SAN UKSE Er ESEESE 91 ID Network ID naana aoaaa aoaaa aa aaa nn a anana 91 XBee DigiMesh 2 4 User Guide 7 IF Sleep Sample Rate 92 IR Sample Rate ccoo 92 IS Force Sample 200 2 eee eee eee ec cee cece eee c cece cece cece cece eee ee cece ee eeetteeeeeeeeees 92 KY AES Encryption Key eterno 93 LT Associate LED Blink Time 20 0 a 93 MO PWMO Duty Cycle 222222 scecoch cess cscs kag DL NANG veces PAGKA BBW AT voce cana 93 1 PWM1 Duty Cycle l a c cece eee aaao cece eee aa ea ranana nannaa 93 R Mesh Unicast Retries ee 94 S Missed Sync Messages 94 T Broadcast Multi Transmits ooo 94 N Network Discovery Timeout teen 95 NB Parity cnc 95 ND Network Discover corno 95 NH Network Hops 0000000 c cece cece nn 96 NI Node Identifier 2 2 2 2 o cece eee eee cee cece cece ccc eecececececeeececeeeesceeseeseeeeees 96 N Network Delay Slots 96 O Network Discovery Options 97 P Maximum Packet Payload Bytes 97 T Network Discover
12. Good Packets Received Read the number of RF packets with valid MAC headers that the device receives successfully on the RF interface When the value reaches OxFFFF it stays there Parameter range N A Default N A GT Guard Times Set the required period of silence before and after the command sequence characters of the Command mode sequence GT CC GT The period of silence prevents inadvertently entering Command mode Parameter range 0x2 Oxce4 x 1 ms Default 0x3e8 one second HV Hardware Version Read the device s hardware version number Parameter range O OXFFFF read only Default Set in the factory XBee DigiMesh 2 4 User Guide 90 IC DIO Change Detect IC DIO Change Detect Set or read the digital I O pins to monitor them for changes in the 1 O state IC works with the individual pin configuration commands DO D9 PO P2 If a pin is enabled as a digital I O you can use the IC command to force an immediate I O sample transmission when the DIO state changes The data transmission contains only DIO data IC is a bitmask you can use to enable or disable edge detection on individual channels Set unused bits to 0 Bit 0 10 11 12 1 O pin DIOO DIO1 DIO2 DIO3 DIO4 DIO5 DIO6 DIO7 DIO8 DIO9 DIO10 DIO11 DIO12 Parameter range 0x0 Oxffff Default 0x0 ID Network ID Set or read the user network identifier Devices must have the
13. Length Frame type Frame ID Reserved Transmit retry count Delivery status Discovery status Checksum XBee DigiMesh 2 4 User Guide 126 XBee DigiMesh 2 4 API frames Route Information Packet 0x8D Description If you enable NACK or the Trace Route option on a DigiMesh unicast transmission a device can output this frame for the transmission Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame Byte Description fields s Frame type 4 0x8D Source 5 0x11 NACK event 0x12 Trace route Length The number of bytes that follow excluding the checksum If the length increases new items have been added to the end of the list for future revisions Timestamp 7 10 System timer value on the node generating the Route Information Packet The timestamp is in microseconds Only use this value for relative time measurements because the time stamp count restarts about every hour ACK 11 The number MAC ACK timeouts that occur timeout count Reserved 12 Reserved 13 Destination 14 The address of the final destination node of this network based transmission address 21 Source 22 Address of the source node of this network based transmission address 29 Responder 30 Address of the node that generates this Route Information packet after it sends or address 37 attempts to send the packet to the n
14. Parameter range N A Default N A XBee DigiMesh 2 4 User Guide 105 ST Wake Time ST Wake Time Sets or reads the wake time of the device For devices in asynchronous sleep ST defines the amount of time that a device stays awake after it receives RF or serial data For devices in synchronous sleep the minimum wake time is a function of MT SP NH NN and platform dependent values If you increase SP NH NN or MT the ST value raises automatically The maximum value is an hour 0x36ee80 ms Parameter range Ox1 0x36ee80 x 1 ms Default 0x7DO 2 seconds TR Transmission Failure Count Reads the number of unicast transmissions where retries expire without receiving an ACK when RR gt 0 When the value reaches Oxffff it stays there Parameter range N A Default N A UA Unicasts Attempted Count The number of unicast transmissions expecting an acknowledgment when RR gt 0 This count increments whenever a MAC unicast transmission occurs that requests an ACK Once the number reaches OxFFFF it does not count further events You can reset the counter to any 16 bit value by appending a hexadecimal parameter to the command Parameter range O OXFFFF Default 0 XBee DigiMesh 2 4 User Guide 106 VL Version Long VL Version Long Shows detailed version information including the application build date and time Parameter range N A Default N A VR Firmware Version Reads the firmware version o
15. configuration Button and sync presses status Action 1 Configured for Wakes the module for 30 seconds or until the synchronized network goes to synchronous sleep sleep Queues a Node Identification broadcast transmission that it sends at the beginning of the next network wake cycle All devices that receive this transmission blink their Associate LED rapidly for one second All devices in API operating mode that receive this transmission send a Node Identification Indicator frame 0x95 out their UART 2 Not configured No effect for synchronous sleep 2 Configured for Causes a node configured with sleeping router nomination enabled to synchronous immediately nominate itself as the network sleep coordinator For more sleep information see SO Sleep Options on page 104 4 Any Sends an ATRE command to restore device parameters to default values Use the Commissioning Pushbutton Use the CB command to simulate button presses in software Send ATCB with a parameter set to the number of button presses to perform For example if you send ATCB1 the device performs the action s associated with a single button press The Node Identification Indicator 0x95 frame is similar to the Remote Command Response 0x97 frame it contains the device s address node identifier string NI command and other relevant data All devices in API operating mode that receive the Node Identification Indicator frame send it out the
16. go to http www digi com products xbee rf solutions xctu software xctu XBee DigiMesh 2 4 User Guide 32 XBee DigiMesh 2 4 serial communication XBee serial interface The XBee devices provide a serial interface to an RF link The XBee device converts serial data to RF data and sends that data to any device in an RF network The device can communicate through its serial port with any logic and voltage compatible universal asynchronous receiver transmitter UART or through a level translator to any serial device UART data flow The XBee device s UART performs tasks such as checking timing and parity which is required for data communications You can connect devices that have a UART interface directly to the pins of the XBee devices as the following diagram shows In the diagram active low signals have a horizontal line over the signal name CMOS Logic CMOS Logic bii ida kau DIN CU in DIN in DOUT Seer out KINITA out baa PERS eana XBEE XBEE Module Module XBee DigiMesh 2 4 User Guide 33 XBee DigiMesh 2 4 serial buffers Serial data A device sends data to the device s UART through pin 3 DIN as an asynchronous serial signal When the device is not transmitting data the signal idles high For serial communication to occur you must configure the UART of both devices with compatible settings for the baud rate parity start bits stop bits and data bits Each data byte consists of a start bit lo
17. 0 375 a Q pi S 3 S 0 013 XBee hardware dimensions XBee 210 SHORTER THAN XBee PRO XBee hardware side view Mounting considerations We design the through hole module to mount into a receptacle so that you do not have to solder the module when you mount it to a board The development kits may contain RS 232 and USB interface boards that use two 20 pin receptacles to receive modules The following illustration shows the module mounting into the receptacle on the RS 232 interface board XBee DigiMesh 2 4 User Guide 18 Hardware diagram Century Interconnect and Samtec manufacture the 2 x 10 pin 2 mm spacing receptacles on Digi development boards Several other manufacturers provide comparable mounting solutions we currently use the following receptacles e Through hole single row receptacles Samtec P N MMS 110 01 L SV or equivalent e Surface mount double row receptacles Century Interconnect P N CPRMSL20 D 0 1 or equivalent e Surface mount single row receptacles Samtec P N SMM 110 02 SM S Note We recommend that you print an outline of the module on the board to indicate the correct orientation for mounting the module Hardware diagram The following diagram shows a simplified view of XBee XBee PRO DigiMesh 2 4 hardware DIO Ato D PWM interface Amplifier section 1 on XBee PRO modules Antenna Switch Switch control XBee and XBee PRO DigiMesh 2 4 pin signals The following table
18. 3 If there is an ERROR the module does not exit Command mode Parameter range 20 byte ASCII string Default N A EA MAC ACK Failure Count The number of unicast transmissions that time out awaiting a MAC ACK This can be up to RR 1 timeouts per unicast when RR gt 0 This count increments whenever a MAC ACK timeout occurs on a MAC level unicast When the number reaches OxFFFF the firmware does not count further events To reset the count to any 16 bit value append a hexadecimal parameter to the command ED Energy Detect Starts an energy detect scan This parameter is the time in milliseconds to scan all channels The device loops through all the channels until the time elapses It returns the maximal energy on each channel a comma follows each value and the list ends with a carriage return The values returned reflect the energy level that ED detects in dBm units Parameter range 0 0x3A98 Default N A EE Encryption Enable Enable or disable 128 bit Advanced Encryption Standard AES encryption Set this command parameter the same on all devices in a network Parameter range Parameter Description 0x0 Disabled 0x1 Enabled XBee DigiMesh 2 4 User Guide 88 Find Neighbors FN Default 0x0 Find Neighbors FN Discovers and reports all devices found within immediate RF range FN reports the following information for each device it discovers MY lt CR gt always xFFFE SH lt CR gt
19. 64 bit extended address The 64 bit source address is always enabled SL is read only and it is also the serial number of the node Parameter range 0 0xFFFFFFFF Default Set in the factory SM Sleep Mode Set or read the sleep mode of the device Normal mode is always awake Pin sleep modes allow you to wake the device with the SLEEP REQUEST line Asynchronous cyclic mode sleeps for SP time and briefly wakes checking for activity Sleep Support mode is always awake but can effectively communicate with SM8 nodes Synchronized Cyclic Sleep nodes sleep for SP and wake for ST time Synchronous modes are not compatible with asynchronous modes XBee DigiMesh 2 4 User Guide 102 SN Number of Cycles Between ON_SLEEP Parameter range Parameter Description 0x0 Normal The user did not enable a sleep mode 0x1 Asynchronous Pin Sleep In this mode the SLEEP RQ line controls the sleep wake state of the device 0x2 N A 0x3 N A 0x4 Asynchronous Cyclic Sleep In this mode the device periodically sleeps and wakes based on the SP and ST commands 0x5 Asynchronous Cyclic Sleep Pin Wake When you assert the SLEEP_REQUEST pin the device enters a cyclic sleep mode similar to Asynchronous Cyclic Sleep When you de assert the SLEEP_REQUEST pin the device immediately wakes up The device does not sleep when you de assert the SLEEP_REQUEST pin 0x6 N A 0x7 Sleep Support 0x8 Synchronized Cyclic Sleep Default 0x0 SN Number of Cycl
20. Asynchronous Cyclic Sleep Mode This mode allows the device to sleep for a specified time and wake for a short time to poll e Asynchronous Cyclic Sleep with Pin Wake Up mode In this mode you can wake the device up prematurely using the Sleep_RQ pin e Synchronous Sleep Support mode A node in this mode synchronizes itself with a sleeping network but does not sleep itself At any time the node responds to new nodes that attempt to join the sleeping network using a sync message e Synchronous Cyclic Sleep mode A node in synchronous cyclic sleep mode sleeps for a programmed time wakes in unison with other nodes exchanges data and sync messages and then returns to sleep Transmit mode When the device receives serial data and is ready to packetize it it exits Idle mode and attempts to transmit the serial data Enter Command mode To get a device to switch into this mode you must issue the string When the device sees a full second of silence in the data stream followed by the string without Enter or Return and another full second of silence it knows to stop sending data through and start accepting commands locally Do not press Return or Enter after typing because it will interrupt the guard time silence and prevent you from entering Command mode Once you send the Command mode sequence the device sends OK out the UART pin The device may delay sending the OK if it has not transmitted all of the serial data it recei
21. FCC for approval prior to selling the integrated unit The required SAR testing measures emissions from the module and how they affect the person XBee DigiMesh 2 4 User Guide 151 XBee DigiMesh 2 4 agency certifications Australia C Tick Required Part Minimum Cable Number Type Description Gain Application Separation Loss A24 Flat panel 13 0 Fixed 2m 13 1 dB P13NF dBi A24 Flat panel 14 0 Fixed 2m 14 1 dB P14NF dBi A24 Flat panel 15 0 Fixed 2m 15 1 dB P15NF dBi A24 Flat panel 16 0 Fixed 2m 16 1 dB P16NF dBi A24 Flat panel 19 0 Fixed 2m 19 1 dB P19NF dBi XBee DigiMesh 2 4 agency certifications Australia C Tick These products comply with requirements to be used in end products in Australia All products with EMC and radio communications must have a registered C Tick mark Registration to use the compliance mark will only be accepted from Australian manufacturers or importers or their agent in Australia Labeling requirements In order to place a C Tick mark on an end product a company must comply with 1 or 2 below 1 Have a company presence in Australia 2 Have a company distributor or agent in Australia that will sponsor importing the end product Contact Digi for questions about locating a contact in Australia dr you are using the RF module in a portable application or if the module is used in a handheld device and the antenna is less than 20 cm from the human body when the device
22. ND command may send back multiple frames Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame fields Byte s Description Frame type 0x97 Frame ID 5 12 This is the same value that is passed in to the request 64 bit source remote address 13 14 The address of the remote device returning this response Reserved 15 Reserved AT commands 16 17 The name of the command Command status 18 25 0 OK 1 ERROR 2 Invalid Command 3 Invalid Parameter Command data 26 27 The value of the required register XBee DigiMesh 2 4 User Guide 141 Example XBee DigiMesh 2 4 API frames If a device sends a remote command to a remote device with 64 bit address 0x0013A20040522BAA to query the SL command and if the frame ID 0x55 the response would look like the following example Frame fields Start delimiter Length Frame type Frame ID 64 bit source remote address Reserved AT commands Command status Command data Checksum XBee DigiMesh 2 4 User Guide Offset Example o Ox7E 0x00 0x13 0x97 0x55 0x00 le 0x13 OxA2 ls 0x00 a 0x40 0x52 0x2B OXAA MN OxFF OxFE 0x53 0x4C 0x00 0x40 0x52 0x2B OXAA OxF4 142 XBee DigiMesh 2 4 certifications XBee DigiMesh 2 4 agency certifications United States United States FCC XBee and XBee PRO DigiMesh 2 4 RF Modules comply with Part 15 of the
23. Yagi 13 element 12 0 dBi Fixed 4 9 dB Y13NF A24 Yagi 15 element 12 5 dBi Fixed 5 4 dB YI5NF A24 Yagi 16 element 13 5 dBi Fixed 6 4 dB Y16NF A24 Yagi 16 element 13 5 dBi Fixed 6 4 dB Y16RM RPSMA connector A24 Yagi 18 element 15 0 dBi Fixed 7 9dB Y18NF Omni directional class antennas A24 Omni directional 2 1 dBi Fixed mobile F2NF fiberglass base station A24 Omni directional 3 0 dBi Fixed mobile F3NF fiberglass base station A24 Omni directional 5 0 dBi Fixed mobile F5NF fiberglass base station dr you are using the RF module in a portable application or if the module is used in a handheld device and the antenna is less than 20 cm from the human body when the device is in operation The integrator may be responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C See the note under FCC notices for more information The testing results will be submitted to the FCC for approval prior to selling the integrated unit The required SAR testing measures emissions from the module and how they affect the person XBee DigiMesh 2 4 User Guide 147 XBee DigiMesh 2 4 agency certifications United States Required Part Minimum Cable Number Type Description Gain Application Separation Loss A24 Omni directional 8 0 dBi F8NF fiberglass base station
24. and on the user is encouraged to try to correct the interference by one or more of the following measures e Re orient or relocate the receiving antenna e Increase the separation between the equipment and receiver e Connect equipment and receiver to outlets on different circuits e Consult the dealer or an experienced radio TV technician for help RF exposure statement If you are an integrating the XBee into another product you must include the following Caution statement in product manuals to alert users of FCC RF exposure compliance 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 XBee DigiMesh 2 4 User Guide 144 XBee DigiMesh 2 4 agency certifications United States XBee DigiMesh 2 4 FCC approved antennas 2 4 GHz You can install XBee and XBee PRO RF modules using antennas and cables constructed with standard connectors Type N SMA TNC and so forth if you perform the installation professionally and according to FCC guidelines If a non professional performs the installation you must use non standard connectors RPSMA RPTNC and so forth The modules are FCC a
25. from node to node until it reaches its final destination e Ad hoc network creation This is an automated process that creates an entire network of nodes on the fly without any human intervention e Self healing This process automatically figures out if one or more nodes on the network is missing and reconfigures the network to repair any broken routes With mesh networking the distance between two nodes does not matter as long as there are enough nodes in between to pass the message along When one node wants to communicate with another the network automatically calculates the best path XBee DigiMesh 2 4 User Guide 53 Routers and end devices A mesh network is also reliable and offers redundancy If a node can no longer operate for example because it has been removed from the network or because a barrier blocks its ability to communicate the rest of the nodes can still communicate with each other either directly or through intermediate nodes Note Mesh networks use more bandwidth for administration and therefore have less available for payloads They can also be more complex to configure and debug in some cases Routers and end devices You can use the CE command to configure devices in a DigiMesh network to act as routers or end devices All devices in a DigiMesh network act as routers by default Any devices that you configure as routers actively relay network unicast and broadcast traffic Network identifiers Yo
26. i i Flat panel 15 0 dBi Fixed 2m 8 dB P15NF A24 Flat panel 16 0 dBi Fixed 2m 9 dB P16NF High gain antenna summary The following antenna types have been tested and approved for use with the XBee module Antenna type YagiThe XBee RF Module was tested and approved with 15 dBi antenna gainand with 7 9 dB cable loss You can use any Yagi type antenna with 7 1 dBi gain or less with no cable loss Antenna type omni directionalThe XBee RF Module was tested and approved with 15 dBi antenna gain with 5 7 dB cable loss You can use any omni directional antenna with 9 3 dBi gain or less with no cable loss Antenna type flat panelThe XBee RF Module was tested and approved with 16 dBi antenna gain with 9 0 dB cable loss You can use any flat panel antenna with 7 0 dBi gain or less with no cable loss Antennas approved for use with the XBee PRO DigiMesh 2 4 RF Modules cable loss is required dr you are using the RF module in a portable application or if the module is used in a handheld device and the antenna is less than 20 cm from the human body when the device is in operation The integrator may be responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C See the note under FCC notices for more information The testing results will be submitted to the FCC for approval prior to selling the in
27. loss due to the soldered RF connector XBee DigiMesh 2 4 User Guide 12 XBee DigiMesh 2 4 technical specifications XBee DigiMesh 2 4 technical specifications The following tables provide the device s technical specifications XBee DigiMesh 2 4 performance specifications This table describes the performance specifications for the XBee XBee PRO 2 4 DigiMesh devices Specification XBee XBee PRO Indoor urban range Upto 100 ft 30 m Up to 300 ft 90 m standard or up to 200 ft 60 m international variant Outdoor RF line of Up to 300 ft 90 m Up to 1 mile 1 5 km with a 2 0 dB dipole sight range antenna Up to 6 miles 10 km with a high gain antenna Transmit power 1 mW 0 dBm 63 mW 18 dBm standard or 10 mW 10 dBm output for the international variant Serial interface data 1200 bps 250 kb s devices 1200 bps 250 kb s devices also support non rate software also support non standard baud standard baud rates selectable rates Receiver sensitivity 92 dBm 1 packet error rate 100 dBm 1 packet error rate XBee DigiMesh 2 4 power requirements The following table describes the power requirements for the XBee XBee PRO 2 4 DigiMesh devices Specification XBee XBee PRO Supply voltage 2 8 3 4 2 8 3 4 VDC VDC Transmit current 45mA 250 mA 3 3 V 150 mA for the international variant RPSMA device only 3 3 340 mA O 3 3 V 180 mA for the international variant V Idle
28. most cases we suggest that you do not modify these parameters from their default values Decreasing these parameters for small networks can improve battery life but take care to not make the values too small 2 Calculate the Sync Message Propagation Time SMPT This is the maximum amount of time it takes for a sleep synchronization message to propagate to every node in the network You can estimate this number with the following formula SMPT NN NH MT 1 18ms 3 Select the duty cycle you want 4 Choose the sleep period and wake time The wake time must be long enough to transmit the desired data as well as the sync message The ST parameter automatically adjusts upwards to its minimum value when you change other AT commands that affect it SP NN and NH Use a value larger than this minimum If a device misses successive sync messages it reduces its available transmit time to compensate for possible clock drift Budget a large enough ST time to allow for the device to miss a few sync messages and still have time for normal data transmissions XBee DigiMesh 2 4 User Guide 67 Start a sleeping DigiMesh network Start a sleeping DigiMesh network By default all new nodes operate in normal non sleep mode To start a sleeping network follow these steps 1 2 8 Enable the preferred sleep coordinator option on one of the nodes Set its SM to a sleep compatible mode 7 or 8 with its SP and ST set to a quick cycl
29. network can serve as a good sleep coordinator because it minimizes the number of hops a sync message takes to get across the network A sleep support node and or a node that is mains powered is a good candidate to be a sleep coordinator Use the preferred sleep coordinator bit with caution The advantages of using the option become weaknesses if you use it on a node that is not in the proper position or configuration You can also use the preferred sleep coordinator option when you set up a network for the first time When you start a network you can configure a node as a sleep coordinator so it will begin sending sleep messages After you set up the network disable the preferred sleep coordinator bit Resolution criteria and selection option There is an optional selection process with resolution criteria that can occur on a node if it loses contact with the network sleep coordinator By default this process is disabled Use the SO command to enable this process This process occurs automatically if a node loses contact with the previous sleep coordinator If you enable the process on any sleep compatible node then it is eligible to become the sleep coordinator for the network A sleep compatible node may become a sleep coordinator if it e Misses three or more sync messages e Is not configured as a non coordinator presumably because the sleep coordinator has been disabled Depending on the platform and other configurable o
30. placing devices configuring devices and network diagnostics Configuring devices You can configure modules locally using serial commands in Transparent or API mode or remotely using remote API commands Devices that are in API mode can send configuration commands to set or read the configuration settings of any device in the network Configure a device remotely When you integrate a module into another product or otherwise do not have access to the module s serial port you can use a device in API mode to remotely configure other devices To remotely configure devices use the following steps Send a remote command To send a remote command populate the Remote Command Request 0x17 frame with 1 The 64 bit address of the remote device 2 The correct command options value 3 Optionally the command and parameter data 4 If you want a command response set the Frame ID field to a non zero value XBee DigiMesh 2 4 User Guide 37 Establish and maintain network links The firmware only supports unicasts of remote commands You cannot broadcast remote commands XCTU has a Frames Generator tool that can assist you with building and sending a remote AT frame Apply changes on remote devices When you use remote commands to change the command parameter settings on a remote device you must apply the parameter changes or they do not take effect For example if you change the BD parameter the actual serial interface rate d
31. receive 50mA 55 MA 3 3 V current 3 3 V Power down lt 10 pA lt 10 pA current pin sleep XBee DigiMesh 2 4 User Guide 13 XBee DigiMesh 2 4 technical specifications Specification XBee XBee PRO Power down lt 50 pA current cyclic sleep XBee DigiMesh 2 4 User Guide 14 XBee DigiMesh 2 4 technical specifications XBee DigiMesh 2 4 general specifications The following table describes the general specifications for the devices Specification XBee XBee PRO Operating ISM 2 4 GHz ISM 2 4 GHz frequency band Dimensions 0 960 in x 1 087 in 2 438 cm x 2 761 cm 0 960 in x 1 297 in 2 438 cm x 3 294 cm Operating 40 to 85 C industrial 40 to 85 C industrial temperature Relative 0 to 95 non condensing 0 to 95 non condensing humidity Antenna 1 4 wave wire antenna embedded PCB antenna 1 4 wave wire antenna RPSMA RF options RPSMA RF connector U FL RF connector connector U FL RF connector XBee DigiMesh 2 4 network and security specifications The following describes the network and security specifications for the XBee XBee PRO 2 4 DigiMesh devices Specification XBee XBee PRO Supported network Mesh point to point point to Mesh point to point point to topologies multipoint peer to peer multipoint peer to peer Number of channels 16 direct sequence channels 12 direct sequence channels software selectable Addressing options PAN ID channel and 64 bit PAN ID channel and 64 b
32. same network identifier to communicate with each other You can use the WR command to write ID changes to non volatile memory XBee DigiMesh 2 4 User Guide 91 IF Sleep Sample Rate Parameter range 0x0 Oxffff Default Ox7 fff IF Sleep Sample Rate Set or read the number of sleep cycles that must elapse between periodic IO samples This allows the firmware to take IO samples only during some wake cycles During those cycles the firmware takes IO samples at the rate specified by IR Parameter range Ox1 Oxff Default Ox1 IR Sample Rate Set or read the I O sample rate to enable periodic sampling When set this parameter causes the device to sample all enabled DIO and ADC at a specified interval To enable periodic sampling you must set IR to a non zero value and enable the analog or digital I O functionality of at least one device pin Refer to DO DIOO ADO on page 79 D9 DIO9 ON_ SLEEP on page 83 and PO DIO10 RSSI PWMO Configuration on page 83 P2 DIO12 Configuration on page 84 Parameter range 0x0 Oxffff ms Default 0x0 IS Force Sample Forces a read of all enabled digital and analog input lines Parameter range N A Default N A XBee DigiMesh 2 4 User Guide 92 KY AES Encryption Key KY AES Encryption Key Sets the 16 byte network security key value that the device uses for encryption and decryption This command is write only If you attempt to read KY the device return
33. 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 and 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 is used for portable applications the following applies e For XBee modules where the antenna gain is less than 13 8 dBi no additional SAR testing is required The 20 cm separation distance is not required for antenna gain less than 13 8 dBi e For XBee modules where the antenna gain is greater than 13 8 dBi and for all XBee PRO modules 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
34. the XBee PRO in Japan you must order the International version The International XBee PRO RF Modules are limited to a transmit power output of 10 dBm Labeling requirements A clearly visible label on the outside of the final product enclosure must display the following text R201WW07215214 XBee R201WW08215111 XBee PRO XBee DigiMesh 2 4 User Guide 157
35. 0 Disabled 0x1 ON SLEEP output 0x2 N A 0x3 Digital input 0x4 Digital output low 0x5 Digital output high Default 0x1 PO DIO10 RSSI PWMO Configuration The DIO10 RSSI PWMO pin configuration pin 6 Parameter range Parameter Description 0x0 Disabled 0x1 RSSI PWMO output XBee DigiMesh 2 4 User Guide 83 P1 DIO11 PWM1 Configuration 0x2 PWMO output 0x3 Digital input 0x4 Digital output low 0x5 Digital output high Default 0x1 P1 DIO11 PWM1 Configuration The DIO11 PWM1 pin configuration pin 7 Parameter range Parameter Description 0x0 Disabled 0x1 N A 0x2 PWM1 output 0x3 Digital input 0x4 Digital output low 0x5 Digital output high Default 0x0 P2 DIO12 Configuration The DIO12 pin configuration pin 4 Parameter range Parameter Description 0x0 Disabled 0x1 N A 0x2 N A 0x3 Digital input 0x4 Digital output low 0x5 Digital output high XBee DigiMesh 2 4 User Guide 84 DB Last Packet RSSI Default 0x0 DB Last Packet RSSI This command reports the received signal strength of the last RF data packet that a device receives The DB command only indicates the signal strength of the last hop It does not provide an accurate quality measurement for a multihop link The command measures RSSI in dBm For example if DB returns 0x60 then the RSSI of the last packet received was 96 dBm Parameter range N A Default N A DD Device Type
36. 0x88 Description A device sends this frame in response to an AT Command frame Some commands send back multiple frames for example the ND command Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame Byte Description fields s Frame 0x88 type Frame ID 5 Identifies the data frame for the host to correlate with a subsequent ACK If set to 0 in Command mode the device does not send a response XBee DigiMesh 2 4 User Guide 123 XBee DigiMesh 2 4 API frames AT 6 7 Command name two ASCII characters that identify the command Command Command 0 OK Status 1 ERROR 2 Invalid command 3 Invalid parameter Value The register data in binary format If the host sets the register the device does not return this field Example If you change the BD parameter on a local device with a frame ID of 0x01 and the parameter is valid the user receives the following response Frame fields Offset Example Start delimiter Length Frame type Frame ID AT command Command status Command data Checksum Modem Status frame 0x8A Description Devices send the status messages in this frame in response to specific conditions Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame fields Byte s Description Frame type
37. 22 en 107 WR Write LL 107 WH Wake Host Delay 0 000020 0000000000 aa daaa eaaa aa oaaao nananana 107 H MAC Unicast One Hop Time eee cee ee eee arannana nannan 108 8 MAC Broadcast One Hop Time 1 2 0 eee ee cece na 108 Operate in API mode API mode overview 2202222ce e 109 API frame specifications 2 2 222 266 2200 JA SING ba ANAN adele iaa 109 Calculate and verify checksums 1 0 0 2 eee e en 111 Escaped characters in API frames eee 111 XBee DigiMesh 2 4 API frames o 2 222 222 cc cece cece ee cece cece cnn cnn nn 112 API frame exchanges 0 e cece cece cece eee cceccececccceceeeeeeees 113 Code to support future API frames eee 114 AT Command frame 0X08 0 02202 eee cece cece cece nn 115 AT Command Queue Parameter Value frame 0x09 e eee cece cece eee e ees 116 Transmit Request frame 0x10 ooo eee 117 Explicit Addressing Command frame Ox11 oo cece eee c cece eee c cece ccc eeeeeeeeeeees 119 Remote AT Command Request frame 0X17 e ecco eee cece cece eee eee cece eee eeees 121 AT Command Response frame 0x88 2222222 e cece cece c cee ce cece cece drana nannan 123 Modem Status frame 0x8A eee 124 Transmit Status frame 0x8B cece cece cece cece cece eeeeeeeeees 125 Route Information Packet 0x8D e cece cece cece cececceceeeeeeees 127 Aggregate Addressing Update frame OX8E
38. 6 CE Routing Messaging Mode occ nn 77 CH Operating Channel aaa aaa aaa aaa aaa 77 Cl Cluster ID x 2 22 Mess eye ele weed oir oie naa eaten ges aes AN rou afk T7 CK Configuration CRC 2 2 2 2 22222 eee N CN Exit Command mode 78 CT Command mode Timeout ns 78 DO DIQO ADO O O ED AA aera NA Na T9 Di DIOU AD1 St iD eae Lk se ee daanan NA KI D2 DIO2 AD2 LL ns 80 AN AA 80 DA DIO4 AD4 LL 81 D5 DIO5 AD5 ASSOCIATED INDICATOR elec eee 81 DG6i DIOG IRIS see rerev eas SIRAAN SANA hee Se NA sao She ada aces 82 D7 DIO7 CTS LL eee 82 D8 DIO8 SLEEP REQUEST lt 2 22 2 feta otto tata da 82 D9 DIO9 ON SLEEP ea 83 PO DIO10 RSSI PWMO Configuration 20 222 e cece eee e orr aa raoran 83 P1 DIO11 PWM1 Configuration 0 00000 eee terre erre 84 P2 DIO12 Configuration eee 84 DB Last Packet RSS Mio soe ect elt NONA ta 85 DD Device Type Identifier e cece cece cette nn 85 DE Destination Endpoint 0022222 e cece c cece cee cece nn 86 DH Destination Address High 20 0 00222 c cece cece e cece cece eee e eee ceeeeeeeeeeees 86 DL Destination Address Low 2 2 2 a 86 DM DigiMesh Options coccoccoccoicn SKNLA PA ka NGARAN LALA 87 DN Discover Node 1 2 2 0 0 2 cece cece cece cece cece eee rene 87 EA MAC ACK Failure Count 88 ED Energy Detect nene 88 EE Encryption Enable eee 88 Find Neighbors
39. DIGI XBee DigiMesh 2 4 Radio Frequency RF Module User Guide XBee DigiMesh 2 4 User Guide Publication number Revision Date Description 90000991 10 27 2015 Revised the document as part of moving to online help Trademarks and copyright Digi Digi International and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide All other trademarks mentioned in this document are the property of their respective owners 2015 Digi International Inc All rights reserved Disclaimers Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International Digi provides this document as is without warranty of any kind expressed or implied including but not limited to the implied warranties of fitness or merchantability for a particular purpose Digi may make improvements and or changes in this manual or in the product s and or the program s described in this manual at any time Warranty To view the product s warranty information go to the following website http www digi com howtobuy terms Customer support Telephone 8 00 am 5 00 pm U S Central Time Toll free US and Canada 866 912 3444 Worldwide 1 952 912 3456 Online www digi com support eservice Mail Digi International Inc 11001 Bren Road East Minnetonka MN 55434 USA XBee DigiMesh 2 4 User Guide 2 Contents Ab
40. FCC test report or CISPR 22 test report for compliance with ICES 003 XBee DigiMesh 2 4 agency certifications European Telecommunications Standards Institute ETSI The XBee PRO RF Module is certified for use in several European countries for a complete list go to www digi com XBee DigiMesh 2 4 User Guide 154 XBee DigiMesh 2 4 agency certifications European Telecommunications Standards Institute ETS If the 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 Il of the R amp TTE Directive Furthermore the manufacturer must maintain a copy of the 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 OEM labeling requirements The CE marking must be affixed to a visible location on the OEM product 15 Simm mini The CE mark shall consist of the initials CE taking the following form e Ifthe CE marking is reduced or enlarged the proportions given in the above graduated d
41. FCC rules and regulations If you are integrating the XBee into another product you must comply with the labeling requirements FCC notices and antenna usage guidelines To fulfill FCC certification requirements the OEM must comply with the following regulations e 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 e XBee PRO RF modules may only be used with antennas that have been tested and approved for use with this module refer to XBee DigiMesh 2 4 FCC approved antennas 2 4 GHz on page 145 OEM labeling requirements As an Original Equipment Manufacturer OEM you must include a clearly visible label on the outside of the final product enclosure that displays the following content 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 1The FCC ID for the XBee is OUR XBEE The FCC ID for the XBee PRO is OUR XBEEPRO XBee DigiMesh 2 4 User Guide 143 XBee DigiMesh 2 4 agency certifications United States FCC notices IMPORTANT The XBee PRO OEM RF Module has been certified by the FCC for use with other products without any further certification as per FCC
42. ICATOR The DIO5 AD5 ASSOCIATED_INDICATOR pin configuration pin 15 Parameter range Parameter Description 0x0 0x1 0x2 0x3 0x4 0x5 Default 0x1 Disabled Associate LED indicator blinks when associated ADC Digital input Digital output low Digital output high XBee DigiMesh 2 4 User Guide D4 DIO4 AD4 81 D6 DIOG RTS The DIO6 RTS pin configuration pin 16 Parameter range Parameter Description 0x0 0x1 0x2 0x3 0x4 0x5 Default 0x0 Disabled RTS flow control N A Digital input Digital output low Digital output high D7 DIO7 CTS The DIO7 CTS pin configuration pin 12 Parameter range Parameter Description 0x0 0x1 0x2 0x3 0x4 0x5 0x6 0x7 Default 0x1 Disabled CTS flow control N A Digital input Digital output low Digital output high RS 485 Tx enable low Tx 0 V on transmit high when idle RS 485 Tx enable high high Tx high on transmit 0 V when idle D8 DIO8 SLEEP_REQUEST The DIO8 SLEEP_REQUEST pin configuration pin 9 XBee DigiMesh 2 4 User Guide D6 DIO6 RTS 82 D9 DIO9 ON_SLEEP Parameter range Parameter Description 0x0 Disabled 0x1 Sleep request 0x2 N A 0x3 Digital input 0x4 Digital output low 0x5 Digital output high Default 0x1 D9 DIO9 ON SLEEP The DIO9 ON SLEEP pin configuration pin 13 Parameter range Parameter Description 0x
43. Identifier The Digi device type identifier value This command reads the device type value Use this value to differentiate between multiple devices Product values include 16 bit Description 0x0000 Unspecified 0x0001 XBee 802 15 4 Series 1 0x0002 XBee ZNet 2 5 0x0003 XBee ZB Zigbee 2007 0x0004 XBee DigiMesh 900 900 MHz 0x0005 XBee DigiMesh 2 4 2 4 GHz 0x0006 XBee 868 point to multi point 868 MHz for EU market 0x0007 XBee point to multi point 900 MHz 0x0008 XTend DigiMesh 900 MHz 0x0009 XBee 802 11 Wi fi XBee DigiMesh 2 4 User Guide 85 DE Destination Endpoint 16 bit Description 0x000A XBee ZB on S2C surface mount 0x000B XBee DigiMesh 900 S3B 0x000C XBee DigiMesh 868 0x000E XLR PRO Parameter range 0x0 Oxffffffff Default 0x50000 DE Destination Endpoint Sets or reads the application layer destination ID value Use this value as the destination endpoint for all data transmissions The default value 0xE8 is the Digi data endpoint Parameter range 0 0xFF Default OxE8 DH Destination Address High Set or read the upper 32 bits of the 64 bit destination address When you combine DH with DL it defines the destination address that the device uses for transmission 0x000000000000FFFF is the broadcast address Parameter range 0x0 Oxffffffff Default 0x0 DL Destination Address Low Set or read the lower 32 bits of the 64 bit destination addre
44. L registers in the network after you replace a device You can also update the DH and DL registers of nodes in the network To update only the routing table information without affecting the DH and DL registers then use the process in Example two To update the DH and DL registers of the network use example three Example three You were using a device with serial number 0x0013A2004052c507 as a network aggregator You replace the aggregator with a device with serial number 0x0013A200f5E4D3B2 Send the AG0013A2004052C507 command on the new device This causes all devices which had a DH and DL register setting of 0x0013A2004052C507 to update their DH and DL register setting to the MAC address of the sending device 0x0013A200F5E4D3B2 Test links in a network For a network installation to be successful you must determine where to place individual devices in order to establish reliable links throughout a network To measure the performance of a network you can send unicast data through the network from one device to another to determine the success rate of several transmissions To simplify link testing the devices support a loopback cluster ID 0x12 on the data endpoint 0xE8 The cluster ID on the data endpoint sends any data transmitted to it back to the sender The following figure demonstrates how you can use the loopback cluster ID and data endpoint to measure the link quality in a mesh network XBee DigiMesh 2 4 User Guide 40
45. MAC Broadcast One Hop Time The MAC broadcast one hop time timeout in milliseconds If you change the MAC parameters it can change this value Parameter range This is a read only parameter Default n a XBee DigiMesh 2 4 User Guide 108 Operate in API mode API mode overview As an alternative to Transparent operating mode you can use API operating mode API mode requires that your application communicates data with the device using software frames in a particular order The API specifies how to send commands receive command responses and device status messages from the device using UART data frames We may add new frame types to future versions of firmware so build the ability to filter out additional API frames with unknown frame types into your software interface API frame specifications The firmware supports two API operating modes with escaped characters and without escaped characters Use the AP command to enable either mode To configure a device to one of these modes set the following AP parameter values 1 AP 0 Transparent operating mode UART serial line replacement with API modes disabled 2 AP 1 API operation 3 AP 2 API operation with escaped characters The API data frame structure differs depending on what mode you choose API operation AP parameter 1 When you enable this mode the following diagram illustrates the data frame structure Ox7E MSB LSB API specific 1Byte Structur
46. REF analog to digital converter reference range pa VREF reference supply current mode 5 Vibe Analog input voltage Maximum electrical operating range not valid conversion range 2Maximum electrical operating range not valid conversion range 3Maximum electrical operating range not valid conversion range 4Maximum electrical operating range not valid conversion range 5 i E E Analog input must be between VREFL and VREER for valid conversion Values greater than VREFH will convert to 3FF XBee DigiMesh 2 4 User Guide 24 XBee DigiMesh 2 4 ADC timing and performance characteristics XBee DigiMesh 2 4 ADC timing and performance characteristics The following table displays the ADC timing and performance characteristics Symbols Parameter Condition Min Typical Max Units NG Source impedance at input kQ RES Ideal resolution 1 LSB Ed a o 3 516 mV DNL Differential non linearity Po sos Jao LSB mo maron us noi Ess Zero scale error A LSB Fes Full scale error EP LSB E Input leakage error NS LSB Eru Total unadjusted error o E LSB Tall Accuracy numbers are based on processor and system being in WAIT state very little activity and no IO switching and that adequate low pass filtering is present on analog input pins filter with 0 01 uF to 0 1 uF capacitor between analog input and Voert Failure to observe these guidelines may result in system or microcontroller noise causing accuracy errors which will var
47. ackets that device A sent 2 Success The number of packets that were successfully acknowledged 2 Retries The number of MAC retries used to transfer all the packets Result 0x00 the command was successful 0x03 invalid parameter used The maximum number of MAC retries allowed 1 maxRSSI The strongest RSSI reading observed during the test 1 minRSSI The weakest RSSI reading observed during the test hb 1 avgRSSI The average RSSI reading observed during the test Example Suppose that you want to test the link between device A SH SL 0x0013a20040521234 and device B SH SL 0x0013a2004052abcd by transmitting 1000 40 byte packets XBee DigiMesh 2 4 User Guide 42 Test links between adjacent devices e Send the following API packet to the serial interface of the device that will output the results device C e Device C can be the same as device A or B Inthe following example packet whitespace marks fields bold text is the payload portion of the packet 7E 0020 11 01 0013A20040521234 FFFE E6 E6 0014 C105 00 00 0013A2004052ABCD 0028 03E8 EB XBee C may return the following packet TE 0027 91 0013A20040521234 FFFE E6 E6 0094 C105 00 0013A2004052ABCD 0028 03E8 03E7 0064 00 0A 50 53 52 9F This means e 999 out of 1000 packets were successful e The XBee made 100 retries e RR 10 e maxRSSI 80 dBm e minRSSI 83 dBm e avgRSSI 82 dBm If the result field does not equal zero an error has occurred Ignore the o
48. age 127 Trace route example Suppose that you successfully unicast a data packet with trace route enabled from device A to device E through devices B C and D The following sequence would occur e After the data packet makes a successful MAC transmission from device A to device B device A outputs a Route Information Packet frame indicating that the transmission of the data packet from device A to device E was successful in forwarding one hop from device A to device B e After the data packet makes a successful MAC transmission from device B to device C device B transmits a Route Information Packet frame to device A When device A receives the Route Information packet it outputs it over its serial interface e After the data packet makes a successful MAC transmission from device C to device D device C transmits a Rout Information Packet frame to device A through device B When device A receives the Route Information packet it outputs it over its serial interface e After the data packet makes a successful MAC transmission from device D to device E device D transmits a Route Information Packet frame to device A through device C and device B When device A receives the Route Information packet it outputs it over its serial interface The following figure shows a trace route example XBee DigiMesh 2 4 User Guide 45 Test links between adjacent devices epi 000 API Console Tx Frames 1 E oe ars om ma Ga E
49. ages cece ee eee ee cece enna e ee ee eee e eee eeeeeneeaeeees 63 Become a sleep coordinator 64 Preferred sleep coordinator option 00 65 Resolution criteria and selection option 222 eee 65 Commissioning Pushbutton option 22222222022 66 Auto early wake up sleep option 67 Select sleep parameters 67 Start a sleeping DigiMesh network 68 Adding a new node to an existing network 2mmm eee ence cece eee nneeeeeeeees 68 Change sleep parameters liiii een 69 Rejoin nodes that lose sync 70 XBee DigiMesh 2 4 diagnostics eee T1 AAA 71 ATA Rs Bes ae oe et ees oe Eee eee 71 Missed sync messages command eee TI Sleep status API messages 71 XBee DigiMesh 2 4 AT commands 1S XBee Sensor Sample 0 02222 e cece e eee cece e cece cece cece cece cece cece eee eeeeeeeeeeeeeees 72 AC Apply Changes l nene T2 AG Aggregator Support 72 AO APLOPUIONS ias en ads ocr candid A utes NAA Anna aasa ss 73 AP API Enable oct dicas dessins 73 BC Bytes Transmitted e 74 BDABaudiRate uscar ett ents a a Re Re GOA fe Oe ua 74 BH Broadcast Hops ooo e cece eee e eee eeeeeccesceecececcseseeeeees 15 XBee DigiMesh 2 4 User Guide 6 CANECA Threshold 22 252 25 22 of nayan hand ANON fend LU nal nk dase Ate Na aag Naa NAGANA TIDORA Se ses 75 CB Commissioning Pushbutton occ cnc 76 CC Command Sequence Character eee 7
50. as never been synchronized sends a message requesting sync information at the beginning of its wake cycle Synchronized nodes which receive one of these messages respond with a synchronization packet If you use the SO command to configure nodes as non coordinators e Ifthe non coordinators go six or more sleep cycles without hearing a sync they send a message requesting sync at the beginning of their wake period The following diagram illustrates the synchronization behavior of sleep compatible modules XBee DigiMesh 2 4 User Guide 63 Become a sleep coordinator Is Node In Deployment Mode Is Sleep Coordinator L Yes i KI n eze Ever Been Sync ed y y A Pr 4 Coord Rapid Sync Disabled Bes Sleep Node Become a sleep coordinator In DigiMesh 2 4 networks a node can become a sleep coordinator in one of four ways XBee DigiMesh 2 4 User Guide 64 Become a sleep coordinator Preferred sleep coordinator option You can specify that a node always act as a sleep coordinator To do this set the preferred sleep coordinator bit bit 0 in the SO command to 1 A node with the sleep coordinator bit set always sends a sync message at the beginning of a wake cycle For this reason do not set this bit on more than one node in the network Although it is not necessary to specify a preferred sleep coordinator doing so improves network performance A node that is centrally located in the
51. ble provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame Byte Description fields s Frame type 4 0x90 Frame ID 5 Identifies the data frame for the host to correlate with a subsequent ACK If set to O in Command mode the device does not send a response 64 bit 6 12 The sender s 64 bit address MSB first LSB last source address Reserved 13 Reserved 14 Receive 15 Bit field 0x01 Packet acknowledged 0x02 Packet was a broadcast packet options Ignore all other bits Received 16 The RF data that the device receives data 21 Example In the following example a device with a 64 bit address of 0x0013A200 40522BAA sends a unicast data transmission to a remote device with payload RxData If AO 0 on the receiving device it sends the following frame out its UART Frame fields Offset Example Start delimiter Ox7E Length MSB 1 0x00 LSB 2 0x12 XBee DigiMesh 2 4 User Guide 132 XBee DigiMesh 2 4 API frames Frame fields Offset Example 0x90 Frame ID 0x00 64 bit source address MSB5 0x13 le OxA2 0x00 EM 0x40 9 0x52 0x2B OxAA Reserved OxFF OxFE Receive options 0x01 Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x11 Explicit Rx Indicator frame 0x91 Description When AO 1 and the device receives an RF frame it sends it out the UART using this message type Format The following table provi
52. ce endpoint 14 OxE0 Destination endpoint 15 OxE0 Cluster ID 16 0x22 17 Ox11 Profile ID 18 OxC1 19 0x05 Receive options 20 0x02 Received data 21 0x52 22 0x78 23 0x44 24 0x61 25 0x74 26 0x61 Checksum 27 0x56 Data Sample Rx Indicator frame 0x92 Description When you enable periodic O sampling or digital 1 0 change detection on a remote device the UART of the device that receives the sample data sends this frame out XBee DigiMesh 2 4 User Guide 135 XBee DigiMesh 2 4 API frames Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame Byte Description fields s Frame 4 0x92 type 64 bit 5 12 The sender s 64 bit address source address Reserved 13 Reserved 14 Receive 15 Bit field options 0x01 Packet acknowledged 0x02 Packet is a broadcast packet Ignore all other bits Number 16 The number of sample sets included in the payload Always set to 1 of samples Digital 17 Bitmask field that indicates which digital IO lines on the 17 0x1C remote have sampling channel 18 enabled if any mask Analog 19 Bitmask field that indicates which analog IO lines on the remote have sampling enabled channel if any mask Digital 20 Ifthe sample set includes any digital IO lines Digital channel mask gt 0 these two bytes samples 21 contain samples for all enabled digital IO lines DIO lines that do n
53. cece cc ccc cece cece cece arraroan 155 Restrictions stc soon eU ada toes tale te ck Gobet cloro iu ELENA GHANA NA 155 Declarations of conformity 0022 22 e eee e cece cece cc cece cecececccceeeeees 156 Approved antennas 0 e cece cece cece E cece E Ea aaran annann 156 XBee DigiMesh 2 4 agency certifications Japan Telec c cece eee 157 Labeling requirements eee 157 XBee DigiMesh 2 4 User Guide 10 About the XBee DigiMesh 2 4 RF Module XBee DigiMesh 2 4 overview The XBee and XBee PRO DigiMesh 2 4 RF modules support the unique needs of low cost low power wireless sensor networks The devices require minimal power and provide reliable data delivery between remote devices The devices operate within the ISM 2 4 MHz frequency band You can build networks of up to 32 nodes using these devices For larger networks of up to 1 000 or more nodes we offer RF optimization services to assist with proper network configuration Contact Digi Technical Support for more details XBee DigiMesh 2 4 manufacturing standards We manufacture and certify the XBee DigiMesh 2 4 devices to certain industry standards These standards enable you to understand what the devices can do and where you can use them The Federal Communications Commission FCC approves the devices for use in the United States For details see XBee DigiMesh 2 4 agency certifications United States on page 143 If a system co
54. contents of the frame For details on frame structure see API frame specifications on page 109 Frame fields Byte Description s Frame type 4 0x11 Frame ID 5 Identifies the data frame for the host to correlate with a subsequent ACK If set to 0 in Command mode the device does not send a response 64 bit 6 13 MSB first LSB last Set to the 64 bit address of the destination device Broadcast Destination 0x00 00000 00000 FFF Address Reserved MSB first LSB last Set to OxFFFE for Broadcast TX or if you do not know the network address Source Source Endpoint for the transmission Endpoint ble e E XBee DigiMesh 2 4 User Guide 119 Destination Endpoint Cluster ID Profile ID Broadcast Radius Transmission Options Data Payload Example XBee DigiMesh 2 4 API frames 17 Destination Endpoint for the transmission 18 The Cluster ID that the host uses in the transmission 19 20 The Profile ID that the host uses in the transmission 21 21 Sets the maximum number of hops a broadcast transmission can traverse If set to 22 0 the transmission radius set to the network maximum hops value 23 0x01 Disable ACK 0x02 Do not attempt route discovery Set all other bits to 0 24n Upto 72 bytes per packet Sent to the destination device The following example sends a data transmission to a device with e 64 bit address 0x0013A20001238400 e Source endpoint 0xA0 e Destinatio
55. d 0x08 frame for API type e The AC command The device immediately returns the register queries parameter value readings Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame Byte Description fields s Frame 4 0x09 type Frame ID 5 Identifies the data frame for the host to correlate with a subsequent ACK If set to 0 in Command mode the device does not send a response AT 6 7 Command name two ASCII characters that identify the AT command command Parameter 8 n If present indicates the requested parameter value to set the given register If no value characters are present queries the register Example The following example sends a command to change the baud rate BD to 115200 baud but does not apply the changes immediately The device continues to operate at the previous baud rate until you apply the changes Inthis example you could send the parameter as a zero padded 2 byte or 4 byte value Frame fields Offset Example Start delimiter Length Frame type Frame ID XBee DigiMesh 2 4 User Guide 116 XBee DigiMesh 2 4 API frames Frame fields Offset Example AT command Parameter value BD7 115200 baud Checksum Transmit Request frame 0x10 Description This frame causes the device to send data as an RF packet to a specific destination e For broadcast transmissions set the 64 bit de
56. ddressing Update frame 0X8E Description The following steps generate this frame XBee DigiMesh 2 4 User Guide 129 XBee DigiMesh 2 4 API frames 1 Send an AG command to a node in API operating mode 2 The node outputs the Aggregate Addressing Update 0x8E frame 3 The node updates its DH and DL registers Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame Byte Description fields s Frame 4 Ox8E type Format Reserved to indicate the format of the additional packet information that Digi may add to ID future firmware revisions Currently this field returns 0x00 New 6 13 The address that the device will set DH and DL to address Old 14 The previous address of DH and DL address 21 Example In the following example a device with destination address DH DL of 0x0013A2004052AAAA updates its destination address to 0x0013A2004052BBBB Frame fields Offset Example Start delimiter Ox7E Length 0x00 0x12 Frame type a 0x8E Format ID 0x00 XBee DigiMesh 2 4 User Guide 130 XBee DigiMesh 2 4 API frames Frame fields Offset Example MSB 5 0x00 New address Old address 13 0x00 Checksum XBee DigiMesh 2 4 User Guide 131 XBee DigiMesh 2 4 API frames Receive Packet 0x90 Description When a device receives an RF frame it sends this frame out the UART Format The following ta
57. des the contents of the frame For details on frame structure see API frame specifications on page 109 Frame fields Byte s Description Frame type 64 bit source address The sender s 64 bit address XBee DigiMesh 2 4 User Guide 133 XBee DigiMesh 2 4 API frames Reserved 13 14 Reserved Source endpoint 15 Endpoint of the source that initiates transmission Destination endpoint 16 Endpoint of the destination that the message is addressed to Cluster ID 17 18 The Cluster ID that the frame is addressed to Profile ID 19 20 The Profile ID that the fame is addressed to Receive options 21 Bit field 0x01 Packet acknowledged 0x02 Packet is a broadcast packet Ignore all other bits Received data 22 27 Received RF data Example Inthe following example a device with a 64 bit address of 0x0013A200 40522BAA sends a broadcast data transmission to a remote device with payload RxData If a device sends the transmission e With source and destination endpoints of OxE0 e Cluster ID 0x2211 e Profile ID 0xC105 If AO 1 on the receiving device it sends the following frame out its UART Frame fields Offset Example o Ox7E 0x00 0x18 Frame type 0x91 Start delimiter Length XBee DigiMesh 2 4 User Guide 134 XBee DigiMesh 2 4 API frames Frame fields Offset Example 64 bit source address MSB 4 0x00 5 0x13 OxA2 T 0x00 0x40 0x52 10 0x2B LSB 11 OxAA Reserved OXFF OxFE Sour
58. device received a sync message Parameter range N A Default N A MT Broadcast Multi Transmits Set or read the number of additional MAC level broadcast transmissions All broadcast packets are transmitted MT 1 times to ensure they are received Parameter range 0x0 Oxf Default 0x3 XBee DigiMesh 2 4 User Guide 94 N Network Discovery Timeout N Network Discovery Timeout The maximum response time in milliseconds for network discovery responses ND and discover node DN responses The timeout is based on the network discovery back off time NT and the network propagation time Parameter range Read only Default 0x3D6A NB Parity Set or read the parity settings for UART communications Parameter range Parameter Description 0x0 No parity 0x1 Even parity 0x2 Odd parity 0x3 Mark parity forced high 0x4 Space parity forced low Default 0x0 ND Network Discover Discovers and reports all of the devices it finds on a network If you send ND through a local API frame each network node returns a separate AT Command Response 0x88 or Remote Command Response 0x97 frame respectively Parameter range N A Default N A XBee DigiMesh 2 4 User Guide 95 NH Network Hops NH Network Hops Sets or reads the maximum number of hops across the network This parameter limits the number of hops You can use this parameter to calculate the maximum network traversal time You must set thi
59. e MSB Mos Signicane XBee DigiMesh 2 4 User Guide 109 API mode overview The firmware silently discards any data it receives prior to the start delimiter If the device does not receive the frame correctly or if the checksum fails the device replies with a status frame 0x8A indicating the nature of the failure API operation with escaped characters AP parameter 2 API mode 2 is rarely necessary to use API mode 1 is fully capable of transmitting all characters including those that can be escaped If you think you need to use API mode 2 contact Digi Support so we can discuss your application For details read the following article http knowledge digi com articles Knowledge Base Article Escaped Characters and API Mode 2 When you enable this mode the following diagram illustrates the data frame structure Ox7E MSB LSB API specific 1Byte Structure Characters Escaped Needed MSB Most Significant Byte LSB Least significant Byte The following paragraphs explain what the fields within the API frame mean Start delimiter The first byte of a frame consists of a special sequence of bits that indicate the beginning of a data frame Its value is always 0x7E This allows an application to easily detect a new incoming frame Length The length field specifies the total number of bytes included in the frame s data field Its two byte value excludes the start delimiter the length and the checksum Frame data Th
60. e XBee devices in the network You must first update the configuration to establish a new destination and transmit data You cannot identify the source of received data as it does not include the sender s address Received data does not include transmission details or the reasons for success or failure This mode does not offer the advanced features of API mode including advanced networking diagnostics and firmware upgrades XBee DigiMesh 2 4 User Guide Transparent and API operating modes API operating mode Disadvantages e The interface is more complex data is structured in packets with a specific format e This mode is more difficult to support transmissions are structured in packets that need to be parsed to get data or created to transmit data e Sent data and received data are not identical received packets include some control data and extra information 28 XBee DigiMesh 2 4 additional modes XBee DigiMesh 2 4 additional modes In addition to the serial communication modes several modes apply to how devices communicate with each other Command mode Command mode is a state in which the firmware interprets incoming characters as commands Command mode allows you to modify the device s firmware using parameters you can set using AT commands When you want to read or set any setting of the device you have to send it an AT command Every AT command starts with the letters AT foll
61. e sleep coordinator or other nodes that have synchronized with the network If the synchronized node is asleep you can wake it by pressing the Commissioning Pushbutton once Wait a sleep cycle for the new node to sync itself Verify that the node syncs with the network The associate LED blinks when the device is awake and synchronized Continue this process until you deploy all of the nodes Adding a new node to an existing network To add a new node to the network the node must receive a sync message from a node already in the network On power up an unsynchronized sleep compatible node periodically sends a broadcast XBee DigiMesh 2 4 User Guide 68 Change sleep parameters requesting a sync message and then sleeps for its SP period Any node in the network that receives this message responds with a sync Because the network can be asleep for extended periods of time and cannot respond to requests for sync messages there are methods that can be used to sync a new node while the network is asleep 1 Power the new node on within range of a sleep support node Sleep support nodes are always awake and able to respond to sync requests promptly 2 You can wake a sleeping cyclic sleep node in the network using the Commissioning Pushbutton 3 Place the new node in range of the existing cyclic sleep node 4 Wake the existing node by holding down the Commissioning Pushbutton for two seconds or until the node wakes The existing nod
62. e stays awake for 30 seconds and responds to sync requests while it is awake If you do not use one of these two methods you must wait for the network to wake up before adding the new node Place the new node in range of the network with a sleep wake cycle that is shorter than the wake period of the network The new node periodically sends sync requests until the network wakes up and it receives a sync message Change sleep parameters To change the sleep and wake cycle of the network select any node in the network and change the SP and or ST of the node to values different than those the network currently uses If you use a preferred sleep coordinator or if you know which node acts as the sleep coordinator we suggest that you use this node to make changes to network settings If you do not know the network sleep coordinator you can use any node that does not have the non sleep coordinator sleep option bit set For details on the bit see SO Sleep Options on page 104 When you make changes to a node s sleep parameters that node becomes the network s sleep coordinator unless it has the non sleep coordinator option selected It sends a sync message with the new sleep settings to the entire network at the beginning of the next wake cycle The network immediately begins using the new sleep parameters after it sends this sync Changing sleep parameters increases the chances that nodes will lose sync If a node does not rec
63. e the command send a response that includes their addressing information node identifier string and other relevant information For more information on the node identifier string see NI Node Identifier on page 96 ND is useful for generating a list of all device addresses in a network When a device receives the network discovery command it waits a random time before sending its own response You can use the NT command to set the maximum time delay on the device that you use to send the ND command e The device that sends the ND includes its NT setting in the transmission to provide a delay window for all devices in the network e On large networks you may need to increase NT to improve the reliability of network discovery e The default NT value is 0x82 13 seconds Discover devices within RF range e You can use the FN command to discover the devices that are immediate neighbors within RF range of a particular device e FN is useful in determining network topology and determining possible routes You can send FN locally on a device in Command mode or you can use a local AT Command 0x08 frame To use FN remotely send the target node a Remote AT Command frame 0x17 using FN as the name of the AT command The device you use to send FN transmits a broadcast to all of its immediate neighbors All of the devices that receive this broadcast send an RF packet to the device that transmitted the FN command If you sent FN remotely
64. e time The purpose of a quick cycle time is to allow the network to send commands quickly through the network during commissioning Power on the new nodes within range of the sleep coordinator The nodes quickly receive a sync message and synchronize themselves to the short cycle SP and ST Configure the new nodes in the sleep mode you want and as cyclic sleeping nodes or sleep support nodes Set the SP and ST values on the sleep coordinator to the values you want for the network Wait a sleep cycle for the sleeping nodes to sync themselves to the new SP and ST values Disable the preferred sleep coordinator option bit on the sleep coordinator unless you want a preferred sleep coordinator Deploy the nodes to their positions Alternatively prior to deploying the network you can use the WR command to set up nodes with their sleep pre configured and written to flash If this is the case you can use the Commissioning Pushbutton and associate LED to aid in deployment 1 2 If you are going to use a preferred sleep coordinator in the network deploy it first If there will not be a preferred sleep coordinator select a node for deployment power it on and press the Commissioning Pushbutton twice This causes the node to begin emitting sync messages Verify that the first node is emitting sync messages by watching its associate LED A slow blink indicates that the node is acting as a sleep coordinator Power on nodes in range of th
65. ed circuit board PCB components Keep power and ground traces thicker than signal traces and make sure that they are able to comfortably support the maximum current specifications There are no other special PCB design considerations to integrate XBee devices with the exception of antennas XBee DigiMesh 2 4 User Guide 21 Design notes Power supply design A poor power supply can lead to poor radio performance especially if you do not keep the supply voltage within tolerance or if it is excessively noisy To help reduce noise place a 1 0 UF and 8 2 pF capacitor as near as possible to pin 1 on the PCB If you are using a switching regulator for the power supply switch the frequencies above 500 kHz Limit the power supply ripple to a maximum 100 mV peak to peak Antenna performance Antenna location is important for optimal performance The following suggestions help you achieve optimal antenna performance Point the antenna up vertically up right Antennas radiate and receive the best signal perpendicular to the direction they point so a vertical antenna s omnidirectional radiation pattern is strongest across the horizon Position the antennas away from metal objects whenever possible Metal objects between the transmitter and receiver can block the radiation path or reduce the transmission distance Objects that are often overlooked include e metal poles e metal studs e structure beams e concrete which is usually reinforced wit
66. eive the sync message with the new sleep settings it continues to operate on its old settings To minimize the risk of a node losing sync and to facilitate the re syncing of a node that does lose sync take the following precautions XBee DigiMesh 2 4 User Guide 69 Rejoin nodes that lose sync 1 Whenever possible avoid changing sleep parameters 2 Enable the missed sync early wake up sleep option in the SO command This command tells a node to wake up progressively earlier based on the number of cycles it goes without receiving a sync This increases the probability that the un synced node will be awake when the network wakes up and sends the sync message Using this sleep option increases reliability but may decrease battery life Nodes using this sleep option that miss sync messages increase their wake time and decrease their sleep time during cycles where they miss the sync message This increases power consumption When changing between two sets of sleep settings choose settings so that the wake periods of the two sleep settings occur at the same time In other words try to satisfy the following equation SP1 ST1 N SP2 ST2 where SP1 ST1 and SP2 ST2 are the desired sleep settings and N is an integer Rejoin nodes that lose sync DigiMesh networks get their robustness from routing redundancies which may be available We recommend architecting the network with redundant mesh nodes to increase robustness If a scenar
67. er Parameter range Parameter Description 0x0 Lowest Ox1 Low 0x2 Medium 0x3 High 0x4 Highest XBee DigiMesh 2 4 User Guide 98 These parameters equate to the following settings for the XBee RF module Setting Power level 0 7 dBm 1 1 7 dBm 2 0 77 dBm 3 0 62 dBm 4 11 42 dBm 0 10 dBm 1 12 dBm 2 14 dBm 3 16 dBm 4 18 dBm Default 0x4 XBee DigiMesh 2 4 User Guide PL TX Power Level 99 PR Pull up Resistor Enable PR Pull up Resistor Enable The bit field that configures the internal pull up resistor status for the I O lines If you set PR to 1 it enables the pull up resistor 0 specifies no internal pull up The following table defines the bit field map Bit 1 0 line O DIO4 AD4 1 DIO3 AD3 2 DIO2 AD2 3 DIO1 AD1 4 DIOO ADO 5 DIO6 RTS 6 DIO8 Sleep Request 10 11 12 13 14 DIO14 DIN Config DIO5 AD6 Associate DIO9 On nSleep DIO12 DIO10 RSSI PWMO DIO11 PWM1 DIO7 CTS DOUT pin 2 Parameter range 0x0 Ox7fff bit field Default Ox1fff RE Restore Defaults Restore device parameters to factory defaults Parameter range N A XBee DigiMesh 2 4 User Guide 100 RO Packetization Timeout Default N A RO Packetization Timeout Set or read the number of character times of inter character silence required before transmission begins Set RO to 0 to transmit characters as they arrive instead of buffering them int
68. er ncia a sistemas operando em car ter prim rio The XBee PRO RF modules with 802 15 4 firmware models noted in conformity information below comply with Brazil ANATEL standards in Resolution No 506 The following information is required in the user manual for the product containing the radio and on the product containing the radio in Portuguese XBee DigiMesh 2 4 User Guide 153 XBee DigiMesh 2 4 agency certifications Industry Canada IC Brazilian conformity Anatel DIGI models XBP24 ASI 001 XBP24 AUI 001 XBP24 AWI 001 XBP24 API 001 XBP24 DMUIT 250 XBP24 DMWIT 250 XBP24 DMSIT 250 XBP24 DMPIT 250 ANATEL Ag ncia Nacional de Telecomunica es 0378 15 1209 01 07899029305318 Este equipamento opera em car ter secund rio isto n o tem direito a prote o contra interfer ncia prejudicial mesmo de esta es do mesmo tipo e n o pode causar interfer ncia a sistemas operando em car ter prim rio XBee DigiMesh 2 4 agency certifications Industry Canada IC Labeling requirements IC requires you to place a clearly visible label on the outside of the final product enclosure displaying 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 amp FCC Part 15 Sub B Unintentional Radiators ICES 003 is the same as FCC Part 15 Sub B and Industry Canada accepts
69. er API frame types that are not being used reak XBee DigiMesh 2 4 User Guide 114 XBee DigiMesh 2 4 API frames AT Command frame 0x08 Description Use this frame to query or set device parameters on the local device This API command applies changes after running the command Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame Byte Description fields s Frame 4 0x08 type Frame ID 5 Identifies the data frame for the host to correlate with a subsequent ACK If set to O in Command mode the device does not send a response AT 6 7 Command name two ASCII characters that identify the AT command command Parameter 8 n If present indicates the requested parameter value to set the given register If no value characters are present queries the register Example The following example illustrates an AT Command frame when you modify the device s NH parameter value Frame fields Offset Example Start delimiter Length Frame type Frame ID AT command Parameter value optional Checksum XBee DigiMesh 2 4 User Guide 115 XBee DigiMesh 2 4 API frames AT Command Queue Parameter Value frame 0x09 Description This frame allows you to query or set device parameters In contrast to the AT Command 0x08 frame this frame queues new parameter values and does not apply them until you issue either e The AT Comman
70. er Synchronous Cyclic Sleep mode A device in Synchronous Cyclic Sleep mode sleeps for a programmed time wakes in unison with other nodes exchanges data and sync messages and then returns to sleep While asleep it cannot receive RF messages or read commands from the UART port XBee DigiMesh 2 4 User Guide 61 The sleep timer Generally the network s sleep coordinator specifies the sleep and wake times based on its SP and ST settings The device only uses these parameters at startup until the device synchronizes with the network When a device has synchronized with the network you can query its sleep and wake times with the OS and OW commands respectively If D9 1 On SLEEP enabled on a cyclic sleep node the On SLEEP line asserts when the device is awake and de asserts when the device is asleep If D7 1 the device de asserts CTS while asleep A newly powered unsynchronized sleeping device polls for a synchronized message and then sleeps for the period that the SP command specifies repeating this cycle until it synchronizes by receiving a sync message Once it receives a sync message the device synchronizes itself with the network Configure all nodes in a synchronous sleep network to operate in either Synchronous Sleep Support mode or Synchronous Cyclic Sleep mode Asynchronous sleeping nodes are not compatible with synchronous sleep nodes The sleep timer In Asynchronous Cyclic Sleep Mode and Asynchronous Cyc
71. es Between ON_SLEEP Set or read the number of sleep periods value This command controls the number of sleep periods that must elapse between assertions of the ON_SLEEP line during the wake time of Asynchronous Cyclic Sleep This allows external circuitry to sleep longer than the SP time During cycles when ON_SLEEP is de asserted the device wakes up and checks for any serial or RF data If it receives any such data then it asserts the ON_SLEEP line and the device wakes up fully Otherwise the device returns to sleep after checking This command does not work with synchronous sleep devices Parameter range Ox1 Oxffff Default Ox1 XBee DigiMesh 2 4 User Guide 103 SO Sleep Options Example Set to 1 to set ON SLEEP high after each SP time default If SN 3 the ON_SLEEP line asserts only every third wakeup SN 9 every 9th wakeup and so forth SO Sleep Options Set or read the sleep options bit field of a device This command is a bitmask You can set or clear any of the available sleep option bits You cannot set bit 0 and bit 1 at the same time Parameter range 0x0 Oxffff For synchronous sleep devices the following sleep options are defined Bit Option Preferred sleep coordinator Non sleep coordinator Enable API sleep status messages Disable early wake up Enable node type equality Disable lone coordinator sync repeat For asynchronous sleep devices the following sleep options are defined Bit Opti
72. es with an RPSMA female plug while the antenna is an RPSMA male jack The U FL connection allows for connectivity to an external antenna U FLis a small antenna connection for use with a pigtail connector A pigtail is a short typically 4 6 in cable that either terminates into an external antenna port such as an RPSMA N or TNC connection or an antenna You would attach the RPSMA connector to a bulkhead These options allow you to mount the device away from the edge of the enclosure in your product and centrally locate the radio U FLis fragile and is not designed for multiple insertions without a specialized tool to separate the pigtail without damaging the connector for more information see http www digikey com product detail en U FL LP V N 2 HR5017 ND 513034 The other available antenna options are printed circuit board PCB and wire antennas We form the PCB antenna directly on the device with conductive traces A PCB antenna performs about the same as a wire antenna An integrated wire antenna consists of a small wire about 80 mm sticking up perpendicular to the PCB It uses a 1 4 wave wire that we solder directly to the PCB of the OEM device All Digi devices with antenna connectors have less than 0 1 dB loss we do not consider one to be better than the other in terms of reliability or insertion loss RF device specifications such as 110 dBm receiver sensitivity 3 OdBm TX power and so forth already include any insertion
73. etwork driving the analog pin Reducing the impedance of the network reduces this error Total unadjusted error is the difference between the transition voltage to the current code and the ideal straight line transfer function This measure of error includes inherent quantization error 1 2 LSB and circuit error differential integral zero scale and full scale error The specified value of Ey assumes zero EL no leakage or zero real source impedance XBee DigiMesh 2 4 User Guide 25 XBee DigiMesh 2 4 modes Transparent and API operating modes The firmware operates in several different modes Two top level modes establish how the device communicates with other devices through its serial interface Transparent operating mode and API operating mode Transparent operating mode Devices operate in this mode by default We also call this mode AT operating mode The device acts as a serial line replacement when it is in Transparent operating mode The device queues all UART data it receives through the DIN pin for RF transmission When a device receives RF data it sends the data out through the DOUT pin You can set the configuration parameters using the AT Command interface API operating mode API operating mode is an alternative to Transparent mode API mode is a frame based protocol that allows you to direct data on a packet basis It can be particularly useful in large networks where you need to control the route a data packet
74. ext hop the Receiver node Receiver 38 Address of the node that the device sends or attempts to send the data packet address 45 XBee DigiMesh 2 4 User Guide 127 XBee DigiMesh 2 4 API frames Example The following example represents a possible Route Information Packet A device receives the packet when it performs a trace route on a transmission from one device serial number 0x0013a2004052AAAA to another serial number 0x0013a2004052DDDD This particular frame indicates that the network successfully forwards the transmission from one device serial number 0x0013a2004052BBBB to another serial number 0x0013a2004052CCCC Destination address MSB 13 0x00 0x13 Ha 5 OxA2 16 0x00 17 0x40 18 0x52 m Co OxAA LSB 20 OxAA Frame fields Offset Example Start delimiter lo Ox7E Length 0x00 0x2A Frame type 0x8D Source event 0x12 Length MN 0x2B Timestamp 0x9C 0x93 EN 0x81 Ox7F ACK timeout count 0x00 Reserved 0x00 Reserved RE 0x00 pusa i3 Po EM EM EM EM EM 19820 XBee DigiMesh 2 4 User Guide 128 XBee DigiMesh 2 4 API frames Frame fields Offset Example Source address MSB 21 0x00 22 0x13 23 OxA2 24 0x00 25 0x40 26 0x52 27 OxDD LSB 28 OxDD Responder address MSB 29 0x00 30 0x13 31 OxA2 32 0x00 33 0x40 34 0x52 35 OxBB LSB 36 OxBB Receiver address MSB 37 0x00 38 0x13 Ww 9 OxA2 40 0x00 41 0x40 42 0x52 43 OxCC LSB 44 OxCC Checksum 45 OxCE Aggregate A
75. four times The extra transmissions become automatic retries without acknowledgments This results in all nodes repeating the transmission four times as well In order to avoid RF packet collisions the network inserts a random delay before each router relays the broadcast message You can change this random delay time with the NN parameter Sending frequent broadcast transmissions can quickly reduce the available network bandwidth Use broadcast transmissions sparingly The broadcast address is a 64 bit address with the lowest 16 bits set to 1 The upper bits are set to 0 To send a broadcast transmission e Set DH to0 e Set DLto OxFFFF In API operating mode this would set the destination address to 0x000000000000FFFF Routing A device within a mesh network determines reliable routes using a routing algorithm and table The routing algorithm uses a reactive method derived from Ad hoc On demand Distance Vector AODV The firmware uses an associative routing table to map a destination node address with its next hop A device XBee DigiMesh 2 4 User Guide 55 Routing sends a message to the next hop address and the message either reaches its destination or forwards to an intermediate router that routes the message on to its destination If a device broadcasts a message with a broadcast address to all neighbors then all routers that receive the message rebroadcast the message MT 1 times Eventually the message reaches t
76. g shows the following throughput performance in a robust operating environment with low interference Configuration Data throughput 1 hop encryption disabled 27 0 kb s XBee DigiMesh 2 4 User Guide 56 Transmission timeouts Configuration Data throughput 3 hop encryption disabled 10 9 kb s 6 hop encryption disabled 5 78 kb s 1 hop encryption enabled 20 5 kb s 3 hop encryption enabled 9 81 kb s 6 hop encryption enabled 4 70 kb s We performed data throughput measurements with the serial interface rate set to 115200 b s and measured the time to send 100 000 bytes from the source to the destination During the test there were no route discoveries or failures Transmission timeouts When a device in API operating mode receives a Transmit Request 0x10 frame or a device in Transparent operating mode has an RO timeout occur the time required to route the data to its destination depends on e Anumber of configured parameters e Whether the transmission is a unicast or a broadcast e Ifthe route to the destination address is known Timeouts or timing information is provided for the following transmission types Transmitting a broadcast e Transmitting a unicast with a known route Transmitting a unicast with an unknown route e Transmitting a unicast with a broken route The timeouts in this documentation are theoretical timeouts and are not precisely accurate Your application should pad the calculated maximum ti
77. h metal rods If you place the device inside a metal enclosure use an external antenna Common objects that have metal enclosures include e vehicles e elevators e ventilation ducts e refrigerators e microwave ovens e batteries e tall electrolytic capacitors Do not place XBee devices with the chip or integrated PCB antenna inside a metal enclosure Do not place any ground planes or metal objects above or below the antenna For the best results mount the device at the edge of the host PCB Ensure that the ground power and signal planes are vacant immediately below the antenna section We recommend that you allow a keepout area which the following drawing shows XBee DigiMesh 2 4 User Guide 22 Design notes 1 2 3 4 5 5 7 B Minimum Keepout Area All PCB Layers le 83 8mm gt A A 3388Thou y 3 o E E N 5 No metal in keepout on all layers in o o 2 B B 3 eja E 3 XBee m E PRO oe S NO N N Pl XBee form factor E ae XBee PRO farm factar Recommended Keepout Area All PCB Layers D je 111 8mm k 4488Thou No metal in keepout on all layers 3 E E o E E wo E o m ml in gt Preferred edge of PCB ef When possible keep XBee close F DE to edge of board CO T mi E m 2 P E a s2 XBee mb PRO os 5 So o Ts me Ng N G G The antenna performance improves
78. he entire network Packet tracking prevents a node from resending a broadcast message more than MT 1 times Route discovery Route discovery is a process that occurs when 1 The source node does not have a route to the requested destination 2 Aroute fails A route fails when the source node uses up its network retries without receiving an ACK Route discovery begins by the source node broadcasting a route request RREQ We call any router that receives the RREQ and is not the ultimate destination an intermediate node Intermediate nodes may either drop or forward a RREQ depending on whether the new RREQ has a better route back to the source node If so the source node saves updates and broadcasts the information from the RREQ When the ultimate destination receives the RREQ it unicasts a route reply RREP back to the source node along the path of the RREQ It does this regardless of route quality and regardless of how many times it has seen an RREQ before This allows the source node to receive multiple route replies The source node selects the route with the best round trip route quality which it uses for the queued packet and for subsequent packets with the same destination address Throughput Throughput in a DigiMesh network varies due to a number of variables including e The number of hops If you enable or disable encryption e Sleeping end devices e Failures and route discoveries Our empirical testin
79. he far right of the sum will equal OxFF Escaped characters in API frames When you send or receive an API frame you must escape flag specific data values so they do not interfere with data frame sequencing In API operating mode with escaped characters you must escape the following data bytes e Ox7E start delimiter e 0x7D escape character e 0x11 XON e 0x13 XOFF API operating mode with escaped characters guarantees that all the 0x7E bytes a device receives are start delimiters this character cannot be part of any of the other frame fields length data or checksum since you must escape it To escape a character 1 Insert 0x7D the escape character 2 Append it with the byte you want to escape XORed with 0x20 In API operating mode with escaped characters the length field does not include any escape characters in the frame and the firmware calculates the checksum with non escaped data XBee DigiMesh 2 4 User Guide 111 XBee DigiMesh 2 4 API frames Example escape an API frame To express the following API non escaped frame in API operating mode with escaped characters Start Length Frame Frame Data Checksum delimiter r oo for ir ox 00 23 2 00 40 ao x4 2e Fr Fe o2 ae 49 60 You must escape the 0x13 byte 1 Insert a 0x7D 2 XOR byte 0x13 with 0x20 13 20 33 The following figure shows the resulting frame Note that the length and checksum are the same as the non escaped frame
80. ically To send a unicast message use XBees in Transparent Mode AP 0 Set the DH and DL registers of these devices to the media access control MAC address of the aggregator node that they need to transmit to XBee DigiMesh 2 4 User Guide 38 Establish and maintain network links Rather than setting every device s DH and DL registers individually use the AG command to set the DH and DL registers for all of the nodes in the DigiMesh network to the MAC address of the aggregator node When you deploy a DigiMesh network issue the AG command on the aggregator node you want to use This causes all of the nodes in the network to build routes to the aggregator node Optionally you can use the command to update the DH and DL registers to match the MAC address of the aggregator node The AG command requires a 64 bit parameter The parameter indicates the current value of the DH and DL registers on a device Replace the current parameter value with the 64 bit address of the node that sends the AG broadcast If you do not want to update the DH and DL registers of the device that receives the AG broadcast then you can use the invalid address OxFFFE If you update the DH or DL address of devices in API mode they output an Aggregate Addressing Update OX8E API frame for a description of the frame see Aggregate Addressing Update frame OX8E on page 129 All devices that receive an AG broadcast update their routing table information to bu
81. ild a route to the sending device whether or not they update their DH and DL address The devices use this routing information for future DigiMesh unicast transmissions Examples Example one In a scenario where you deploy a network and then you want to update the DH and DL registers of all the devices in the network so that they use the MAC address of the aggregator node which has the MAC address 0x0013A2004052C507 you could use the following technique 1 Deploy all devices in the network with the default DH DL of OxFFFF 2 Send an ATAGFFFF command on the aggregator node All the nodes in the network that receive the AG broadcast set their DH to 0x0013A200 and their DL to 0x4052C507 These nodes automatically build a route to the aggregator node Example two If you want all of the nodes in the network to build routes to an aggregator node with a MAC address of 0x0013A2004052C507 without affecting the DH and DL registers of any nodes in the network 1 Send the ATAGFFFE command should on the aggregator node This sends an AG broadcast to all of the nodes in the network XBee DigiMesh 2 4 User Guide 39 Test links in a network 2 All ofthe nodes update their internal routing table information to contain a route to the aggregator node 3 None of the nodes update their DH and DL registers because none of the registers are set the OxFFFE address Replace nodes You can use the AG command to update the routing table and DH D
82. imate the timeout in the following manner knownRouteUnicast 2 NH MR unicastOneHopTime Transmit a unicast with an unknown route If the transmitting device does not know the route to the destination it begins by sending a route discovery If the route discovery is successful then the transmitting device transmits data You can estimate the timeout associated with the entire operation as follows unknownRouteUnicast BroadcastTxTime NH unicastOneHopTime knownRouteUnicast Transmit a unicast with a broken route If the route to a destination node changes after route discovery completes an XBee node begins by attempting to send the data along the previous route After it fails it initiates route discovery and when route discovery finishes transmits the data along the new route You can estimate the timeout associated with the entire operation as follows brokenRouteUnicast BroadcastTxTime NH unicastOneHopTime 2 knownRouteUnicast XBee DigiMesh 2 4 User Guide 58 DigiMesh sleep modes XBee DigiMesh 2 4 sleep modes Anumber of low power modes exist to enable devices to operate for extended periods of time on battery power Use the SM command to enable these sleep modes The sleep modes are characterized as either e Asynchronous SM 1 4 5 e Synchronous SM 7 8 In DigiMesh networks a device functions in one of three roles 1 Asleep coordinator 2 Apotential coordinator 3 Anon coordinator The difference bet
83. initions and the associated LED functions The following diagram shows how the hardware can support these features XBee DigiMesh 2 4 User Guide 46 Test links between adjacent devices Push button Associate LED To support the Commissioning Pushbutton and its associated LED functions connect a pushbutton and an LED to device pins 20 and 15 respectively Definitions To enable the Commissioning Pushbutton functionality on pin 20 set the DO command to 1 The functionality is enabled by default You must perform multiple button presses within two seconds The following table provides the pushbutton definitions Sleep configuration Button and sync presses status Action 1 Not configured Immediately sends a Node Identification broadcast transmission for sleep All devices that receive this transmission blink their Associate LED rapidly for one second All devices in API operating mode that receive this transmission send a Node Identification Indicator frame 0x95 out their UART 1 Configured for Wakes the device for 30 seconds asynchronous Immediately sends a Node Identification broadcast transmission sleep All devices that receive this transmission blink their Associate LED rapidly for one second All devices in API operating mode that receive this transmission send a Node Identification Indicator frame 0x95 out their UART XBee DigiMesh 2 4 User Guide 47 Test links between adjacent devices Sleep
84. io exists where the only route connecting a subnet to the rest of the network depends on a single node and that node fails or the wireless link fails due to changing environmental conditions a catastrophic failure condition then multiple subnets may arise using the same wake and sleep intervals When this occurs the first task is to repair replace and strengthen the weak link with new and or redundant devices to fix the problem and prevent it from occurring in the future When you use the default DigiMesh sleep parameters separated subnets do not drift out of phase with each other Subnets can drift out of phase with each other if you configure the network in one of the following ways e If you disable the non sleep coordinator bit in the SO command on multiple devices in the network they are eligible for the network to nominate them as a sleep coordinator For more details see SO Sleep Options on page 104 e If the devices in the network do not use the auto early wake up sleep option If anetwork has multiple subnets that drift out of phase with each other get the subnets back in phase with the following steps 1 Place a sleep support node in range of both subnets 2 Select a node in the subnet that you want the other subnet to sync with 3 Use this node to slightly change the sleep cycle settings of the network for example increment ST XBee DigiMesh 2 4 User Guide 70 XBee DigiMesh 2 4 diagnostics 4 Wait for the
85. ir UART as a Node Identification Indicator frame If you enable the Commissioning Pushbutton during sleep it increases the sleeping current draw especially in Asynchronous pin sleep SM1 mode When asleep hold down the Commissioning Pushbutton for up to two seconds to wake the device from sleep then issue the two or four button presses XBee DigiMesh 2 4 User Guide 48 Monitor I O lines Monitor I O lines Devices support both analog input and digital IO line modes on several configurable pins Queried sampling The following table provides typical parameters for the pin configuration commands Pin command parameter Description 0 1 5 6 9 Unmonitored digital input Reserved for pin specific alternate functionality Analog input A D pins or PWM output PWM pins Digital input monitored Digital output low Digital output high Alternate functionality where applicable The following table provides the pin configurations when you set the configuration command for a particular pin XBee pin names CD DIO12 PWMO RSSI DIO10 PWM1 DIO11 DTR SLEEP RQ DIO8 AD4 DIO4 CTS DIO7 ON SLEEP DIO9 ASSOC AD5 DIO5 RTS DIO6 AD3 DIO3 AD2 DIO2 AD1 DIO1 ADO DIOO Commissioning Pushbutton 20 XBee pin number Configuration command E U U TU U U gt 00 Re o N ta N U q ka m o Co m au J og O iw U par wm D q J o ER Re ER E Re N 4 Ww O to U
86. is field contains the information that a device receives or will transmit The structure of frame data depends on the purpose of the API frame Ox7E MSB LSB API specific 1 Byte Structure Characters Escaped Needed MSB Most Significant Byte LSB Least significant Byte e Frame type is the API frame type identifier It determines the type of API frame and indicates how the Data field organizes the information e Data contains the data itself This information and its order depend on the what type of frame that the Frame type field defines The cmdID byte API identifier indicates which API messages the cmdData bytes Identifier specific data will contain XBee DigiMesh 2 4 User Guide 110 API mode overview Checksum The value OxFF minus the 8 bit sum of bytes from offset 3 to this byte Checksum is the last byte of the frame and helps test data integrity The device does not process frames sent through the serial interface with incorrect checksums and ignores their data Calculate and verify checksums To calculate the checksum of an API frame 1 Add all bytes of the packet excluding the start delimiter 0x7E and the length the second and third bytes 2 Keep only the lowest 8 bits from the result 3 Subtract this quantity from OXFF To verify the checksum of an API frame 1 Add all bytes including the checksum do not include the delimiter and length 2 Ifthe checksum is correct the last two digits on t
87. is in operation The integrator may be responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C See the note under FCC notices for more information The testing results will be submitted to the FCC for approval prior to selling the integrated unit The required SAR testing measures emissions from the module and how they affect the person XBee DigiMesh 2 4 User Guide 152 XBee DigiMesh 2 4 agency certifications Brazil Ag ncia Nacional de Telecomunica es Anatel XBee DigiMesh 2 4 agency certifications Brazil Ag ncia Nacional de Telecomunica es Anatel The XBee RF modules with DigiMesh firmware models noted in conformity information below comply with Brazil ANATEL standards in Resolution No 506 The following information is required in the user manual for the product containing the radio and on the product containing the radio in Portuguese Brazilian conformity Anatel DIGI model XB24 AS1 001 XB24 AUI 001 XB24 AWI 001 XB24 API 001 XB24 DMUIT 250 XB24 DMWIT 250 XB24 DMSIT 250 XB24 DMPIT 250 O ANATEL Ag ncia Nacional de Telecomunica es 0369 15 1209 01 078990293 0529 5 Este equipamento opera em car ter secund rio isto n o tem direito a prote o contra interfer ncia prejudicial mesmo de esta es do mesmo tipo e n o pode causar interf
88. it addresses addresses Encryption 128 bit Advanced Encryption 128 bit AES Standard AES XBee DigiMesh 2 4 agency approvals This table describes the agency approvals for the XBee 2 4 DigiMesh devices Specification XBee XBee PRO United States FCC Part OUR XBEE OUR XBEEPRO 15 247 XBee DigiMesh 2 4 User Guide 15 XBee DigiMesh 2 4 technical specifications Specification XBee XBee PRO Industry Canada IC 4214A XBEE 4214A XBEEPRO Europe CE ETSI ETSI maximum 10 dBm transmit power output RoHS Lead free and RoHS Lead free and RoHS compliant compliant Japan R201WW07215214 R201WW08215111 maximum 10 dBm transmit power output Brazil ANATEL 0369 15 1209 ANATEL 0378 15 1209 See XBee DigiMesh 2 4 certifications on page 143 for region specific certification requirements XBee DigiMesh 2 4 User Guide 16 XBee DigiMesh 2 4 hardware Mechanical drawings The following figures show the mechanical drawings for the devices The second drawing shows the RPSMA device The drawings do not show antenna options All dimensions are in inches XBee PRO side view XBee PRO oe side view pe Simm 0 0201 x kpa 20 508 P 179mm 79mm 0 160 1 I 1 4 06mm i FI 1 1 i 0 079 2 00mm 0 960 24 38mm 0 299 D saka E 0 F AS 6 Sare Shield Bottom Side 1 297 32 94mm 0 284 7 22mm 1 0 866 22 00mm XBee DigiMesh 2 4 User Guide 17 Mounting considerations mM o
89. kaa GIO Frame details p im fame Roseta A o 12 04 55 821 17 Transmit Request 7E 00 2A 8D 12 27 3F OF ES 5B 00 00 00 OO 13 AZ 1 12 04 55891 42 Route Information 88 40 AD 15 64 00 13 AZ 08 48 AD 13 85 00 13 A2 6 120455901 7 Taik aes 00 40 AD 13 85 00 13 A2 00 40 AD 15 64 6E Start delimiter E 7E Length 27 39 8D Route Information 12 Trace Route Timestamp 3F 9F E8 5B 1067444315 ACK timeout count es e Send frames Name B Transmit Request Enable Unicast Trace Route messages Transmit Request There is no guarantee that Route Information Packet frames will arrive in the same order as the route taken by the unicast packet On a weak route it is also possible for the transmission of Route Information Packet frames to fail before arriving at the unicast originator NACK messages Transmit Request 0x10 frames contain a negative acknowledge character NACK API option If you use this option then when a MAC acknowledgment failure occurs on one of the hops to the destination device the device generates a Route Information Packet 0x8D frame and sends it to the originator of the unicast This information is useful because it allows you to identify and repair marginal links The Commissioning Pushbutton Devices support a set of commissioning and LED functions to help you deploy and commission modules These functions include the Commissioning Pushbutton def
90. lic Sleep with Pin Wake Up modes SM 4 or SM 5 if the device receives serial or RF data it starts a sleep timer time until sleep If the device receives any data serially or by RF link the timer resets Set the duration of the timer using the ST command When the sleep timer expires the device returns to sleep Coordinating sleep modes in the DigiMesh network In a sleeping network one node acts as the sleep coordinator During normal operations at the beginning of a wake cycle the sleep coordinator sends a sync message as a broadcast to all nodes in the network This message contains synchronization information and the wake and sleep times for the current cycle All cyclic sleep nodes that receive a sync message remain awake for the wake time and then sleep for the specified sleep period The sleep coordinator sends one sync message at the beginning of each cycle with the current wake and sleep times All router nodes that receive this sync message relay the message to the rest of the network If the sleep coordinator does not hear a rebroadcast of the sync message by one of its immediate neighbors then it re sends the message one additional time XBee DigiMesh 2 4 User Guide 62 DigiMesh synchronization messages If you change the SP or ST parameters the network does not apply the new settings until the beginning of the next wake time Asleeping router network is robust enough that an individual node can go several cycle
91. meouts by a few hundred milliseconds When you use API operating mode use Transmit Status 0x8B frames as the primary method to determine if a transmission is complete Unicast one hop time unicastOneHopTime is a building block of many of the following calculations It represents the amount of time it takes to send a unicast transmission between two adjacent nodes The time depends on the MAC retry setting that you set in the RR parameter DigiMesh networks assume that the average number of MAC level retries across a multi hop wireless link will be three or less The following table defines the retires and the associated time XBee DigiMesh 2 4 User Guide 57 Transmission timeouts RR mac retries Unicast one hop time 0 unicastOneHopTime 5 ms 1 unicastOneHopTime 24 ms 2 unicastOneHopTime 40 ms 3 unicastOneHopTime 63 ms Transmit a broadcast All of the routers in a network must relay a broadcast transmission The maximum delay occurs when the sender and receiver are on the opposite ends of the network The NH NN and MT parameters define the maximum broadcast delay as follows BroadcastTxTime NN NH MT 1 18ms Transmit a unicast with a known route When a device knows a route to a destination node the transmission time is largely a function of the number of hops and retries The timeout associated with a unicast assumes that the maximum number of hops is necessary as specified by the NH command You can est
92. n a device Parameter range O OXFFFFFFFF read only Default Set in the factory WR Write Writes parameter values to non volatile memory so that parameter modifications persist through subsequent resets Once you issue WR do not send any additional characters to the device until after you receive the OK r response Parameter range N A Default N A WH Wake Host Delay Sets or reads the wake host timer value You can use WH to give a sleeping host processor sufficient time to power up after the device asserts the ON_SLEEP line If you set WH to a non zero value this timer specifies a time in milliseconds that the device allows after waking from sleep before sending data out the UART or transmitting an I O sample If the device receives serial characters the WH timer stops immediately XBee DigiMesh 2 4 User Guide 107 H MAC Unicast One Hop Time When in synchronous sleep the device shortens its sleep period by the WH value to ensure that it is prepared to communicate when the network wakes up When in this sleep mode the device always stay awake for the WH time plus the amount of time it takes to transmit a one hop unicast to another node Parameter range 0x0 Oxffff x 1 ms Default 0x0 H MAC Unicast One Hop Time The MAC unicast one hop time timeout in milliseconds If you change the MAC parameters it can change this value Parameter range This parameter is read only Default n a 8
93. n endpoint 0xA1 e Cluster ID 0x1554 e Profile ID 0xC105 e Payload TxData Frame fields Start delimiter Length Frame ID XBee DigiMesh 2 4 User Guide Offset Example 120 Frame fields 64 bit destination address Reserved Source endpoint Destination endpoint Cluster ID Profile ID Broadcast radius Transmit options Data payload Checksum Remote AT Command Request frame 0x17 Description Offset Example MSB 5 0x00 0x13 OxA2 0x00 0x01 10 0x23 11 0x84 LSB12 0x00 15 16 17 18 19 20 21 22 23 24 25 26 27 o o o o o o o o o o o o o o o o x x x x x x x x x x x x x x x x m N o gt E N ul o o o O GI ka gt gt nm nm ta D ka A Co E o o Ci E Bs q H o m T 28 29 o x O O XBee DigiMesh 2 4 API frames Used to query or set device parameters on a remote device For parameter changes on the remote device to take effect you must apply changes either by setting the apply changes options bit or by sending an XBee DigiMesh 2 4 User Guide 121 XBee DigiMesh 2 4 API frames AC command to the remote Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame fields Byte Description s Frame type 4 0x17 ae Frame ID Identifies the data frame for the host to correlate with a subsequent ACK If set to 0 in Command mode the device does no
94. nly sleep coordinator nodes honor Commissioning Pushbutton nomination requests Changing sleep parameters You can use any sleep compatible node in the network that does not have the non coordinator sleep option set to make changes to the network s sleep and wake times If you change a node s SP and or ST to values different from those that the network is using the node becomes the sleep coordinator The node begins sending sync messages with the new sleep parameters at the beginning of the next wake cycle For normal operations a device uses the sleep and wake parameters it gets from the sleep sync message not the ones specified in its SP and ST parameters It does not update the SP and ST parameters with the values of the sync message Use the OS and OW commands to query the current network sleep and wake times used by the node Changing network parameters can cause a node to become a sleep coordinator and change the sleep settings of the network The following commands can cause this to occur NH NN and MR For most applications we recommend configuring the NH NN and MR network parameters during initial deployment only The default values of NH and NN are optimized to work for most deployments Sleep guard times To compensate for variations in the timekeeping hardware of the various devices in a sleeping router network the network allocates sleep guard times at the beginning and end of the wake time The size of the sleep g
95. ntains XBee PRO DigiMesh 2 4 RF Modules the system inherits Digi s certifications The devices are certified to operate in the industrial scientific and medical ISM 2 4 GHz frequency band We manufacture the devices under International Organization for Standardization ISO 9001 2000 registered standards We optimize the devices for use in the United States and Canada For a complete list of agency approvals see XBee DigiMesh 2 4 certifications on page 143 XBee DigiMesh 2 4 part numbers The part numbers for these devices are available at the following link XBee DigiMesh 2 4 User Guide 11 Antenna options www digi com products xbee rf solutions modules xbee digimesh 2 4 partnumbers Antenna options Digi devices come in a variety of antenna options The options that allow you to connect an external antenna are reverse polarity standard subminiature assembly RPSMA and U FL Typically you make connections with either a dipole antenna with a U FL connection or a U FL to RPSMA antenna adapter cable RPSMA is the more traditional antenna connector however if the device is going to be inside of an enclosure you would need to locate the device near the edge of the enclosure to allow the connector to pass through an available bulkhead The RPSMA connector uses the same body as a regular SMA connector but changes the gender of the center conductor The female RPSMA actually has a male center conductor We equip the XBee devic
96. o one RF packet Parameter range 0x0 Oxff x character times Default 0x3 RP RSSI PWM Timer The PWM timer expiration in 0 1 seconds RP sets the duration of PWM signal output on the RSSI pin The signal duty cycle updates with each received packet and shuts off when the timer expires When RP OxFF the output is always on Parameter range 0x0 Oxff x 100 ms Default 0x28 four seconds RR Unicast Retries Set or read the maximum number of MAC level packet delivery attempts for unicasts If RR is non zero the packets a device sends request an acknowledgment and can be present up to RR times if the device does not receive any acknowledgments Parameter range 0x0 Oxfretries Default OxA XBee DigiMesh 2 4 User Guide 101 SE Source Endpoint SE Source Endpoint Sets or reads the application layer source endpoint value Use this value as the source endpoint for all data transmissions The default value 0xE8 data endpoint is the Digi data endpoint Parameter range 0 0xFF Default OxE8 SH Serial Number High Reads the high 32 bits of the device s unique IEEE 64 bit extended address The 64 bit source address is always enabled This value is read only and it never changes Parameter range 0 0xFFFFFFFF Default Set in the factory SL Serial Number Low The lower 32 bits of the unique IEEE 64 bit Extended Address assigned to this device Reads the low 32 bits of the device s unique IEEE
97. oes not change on the remote device until you apply the changes You can apply the changes using remote commands in one of three ways 1 Set the apply changes option bit in the API frame 2 Send an AC command to the remote device 3 Send the WR and FR commands to the remote device to save the changes and reset the device Respond to remote command requests If a local device sends a command request to a remote device and the API frame ID is non zero the remote device sends a remote command response transmission back to the local device When the local device receives a remote command response transmission it sends a remote command response API frame out its UART The remote command response indicates 1 The status of the command which is either success or the reason for failure 2 Inthe case of acommand query it includes the register value The device that sends a remote command does not receive a remote command response frame if 1 It could not reach the destination device 2 You set the frame ID to 0 in the remote command request Establish and maintain network links Build aggregate routes In many networks many or all of the nodes have to transmit data to a central aggregator node In a new DigiMesh network the overhead of these nodes discovering routes to the aggregator node is extensive and taxes the network To eliminate this overhead you can use the AG command to build routes to the aggregator node automat
98. ofile ID 33 34 Set to Digis Manufacturer ID 35 36 Reports the DD value of the responding device To enable this field use the NO 39 command 40 Received signal strength indicator To enable this field use the NO command If you press the commissioning pushbutton on a remote device with 64 bit address 0x0013a200407402ac and a default NI string the sending device receives the following node identification indicator Ox7e 0025 9500 13a2 0040 7402 acff fec2 fffe 0013 a200 4074 2ac 2000 fffe 0101 c105 101e 000c 0000 2e33 Frame fields Start delimiter Length Frame type XBee DigiMesh 2 4 User Guide Offset Example 139 XBee DigiMesh 2 4 API frames Frame fields Offset Example 64 bit source address MSB4 0x00 0x13 le OxA2 0x00 E 0x40 o 0x74 0x02 OXAC Reserved o OxFF ES OxFE Receive options 0xC2 Reserved OxFF OxFE 64 bit address 0x00 0x13 OxA2 0x00 0x40 0x74 0x02 ES OXAC NI string 0x20 0x00 Reserved OxFF OxFE Device type 0x01 Source event 0x01 Digi Profile ID OxC1 0x05 XBee DigiMesh 2 4 User Guide 140 XBee DigiMesh 2 4 API frames Frame fields Offset Example Digi Manufacturer ID Digi DD value optional RSSI optional Checksum Remote Command Response frame 0x97 Description If a device receives this frame in response to a Remote Command Request 0x17 frame the device sends an AT Command Response 0x88 frame out the UART Some commands such as the
99. on Always wake for ST time Default 0x2 SP Sleep Time Set or read the device s sleep time This command defines the amount of time the device sleeps per cycle Parameter range 0x1 0x15f900 x 10 ms XBee DigiMesh 2 4 User Guide 104 SQ Missed Sleep Sync Count Default OxC8 SQ Missed Sleep Sync Count Counts the number of sleep cycles in which the device does not receive a sleep sync Set the value to 0 to reset this value When the value reaches OXFFFF it does not increment anymore Parameter range N A Default N A SS Sleep Status Queries a number of Boolean values that describe the device s status Bit Description 0 This bit is true when the network is in its wake state 1 This bit is true if the node currently acts as a network sleep coordinator 2 This bit is true if the node ever receives a valid sync message after it powers on 3 This bit is true if the node receives a sync message in the current wake cycle 4 This bit is true if you alter the sleep settings on the module so that the node nominates itself and sends a sync message with the new settings at the beginning of the next wake cycle 5 This bit is true if you request that the node nominate itself as the sleep coordinator using the commissioning pushbutton or the CB2 command 6 This bit is true if the node is currently in deployment mode All Reserved All non documented bits can be any value you can ignore them other bits
100. onse frame when ND is issued 0x04 Append the RSSI of the last hop for DigiMesh networks to ND or FN responses or API node identification frames NP Maximum Packet Payload Bytes Reads the maximum number of payload bytes that you can send in a unicast RF transmission based on the device s current configuration Parameter range 0 0xFFFF NT Network Discovery Back off Sets or reads the network discovery back off parameter for a device This sets the maximum value for the random delay that the device uses to send network discovery responses The ND DN and FN commands use NT Parameter range 0x20 0x2ee0 x100 ms XBee DigiMesh 2 4 User Guide 97 OS Operating Sleep Time Default 0x82 13 seconds OS Operating Sleep Time Reads the current network sleep time that the device is synchronized to in units of 10 milliseconds If the device has not been synchronized then OS returns the value of SP If the device synchronizes with a sleeping router network OS is different from SP Parameter range N A Default N A OW Operating Wake Time Reads the current network wake time that a device is synchronized to in 1 ms units If the device has not been synchronized then OW returns the value of ST If the device synchronizes with a sleeping router network OS is different from ST Parameter range N A Default N A PL TX Power Level Sets or reads the power level at which the device transmits conducted pow
101. ot have sampling if enabled return 0 Bits in these two bytes map the same as they do in the Digital channel included mask field Analog 22 Ifthe sample set includes any analog IO lines Analog channel mask gt 0 each enabled sample 23 analog input returns a 2 byte value indicating the A D measurement of that input Analog samples are ordered sequentially from ADO DIOO to AD3 DIO3 XBee DigiMesh 2 4 User Guide 136 XBee DigiMesh 2 4 API frames Example In the following example the device receives an I O sample from a device with a 64 bit serial number of 0x0013A20040522BAA The configuration of the transmitting device is to take a digital sample of a number of digital I O lines and an analog sample of AD1 It read the digital lines to be 0x0014 and the analog sample value is 0x0225 The complete example frame is 7EQ 1492 0013 A200 4052 2BAA FFFE 0101 001C 0200 1402 25F9 Frame fields Offset Example Start delimiter Ox7E Length MSB 1 0x00 0x14 Frame specific data 64 bit source address 0x00 0x13 e OxA2 0x00 a 0x40 EJ 0x52 0x2B OXAA Reserved Oxfffe 0x84 Receive options 0x01 Number of samples 0x01 Digital channel mask 0x00 0x1C Analog channel mask 0x02 Digital samples if included 0x00 0x14 XBee DigiMesh 2 4 User Guide 137 XBee DigiMesh 2 4 API frames Frame fields Offset Example Analog sample 0x02 0x25 Checksum OxF5 Node Identification Indicator frame 0x95 Description
102. out the XBee DigiMesh 2 4 RF Module XBee DigiMesh 2 4 overview 2 2 2 2 eee 11 XBee DigiMesh 2 4 manufacturing standards 0 0000002 c cece cece cece cece cece cee eeeeees 11 XBee DigiMesh 2 4 part numbers _ 22 22 22 eee eee ee eee cece cece cece eee eeceeeeeeeeees 11 Antenna Options escitas et ee nga EPAL naa Mods ese eis alt str god 12 XBee DigiMesh 2 4 technical specifications c eee c cece cece ecceceeeeeee 13 XBee DigiMesh 2 4 performance specifications e cece cece c cece cece eee 13 XBee DigiMesh 2 4 power requirements eee eee 13 XBee DigiMesh 2 4 general specifications 0 2 22 cece en 15 XBee DigiMesh 2 4 network and security specifications 0 00 0022 e eee 15 XBee DigiMesh 2 4 agency approvals 2 22 15 XBee DigiMesh 2 4 hardware Mechanical drawings 2 cece cece cece cece eee eee eee tee cece cence erre 17 Mounting considerations eee 18 Hardware diagram eterna 19 XBee and XBee PRO DigiMesh 2 4 pin signals eee 19 Recommended pin connections ocn 21 Design notes nn Al Board layout seo sus dakha Asa de nG Lat Na Ga na NUNAL POT a baa 21 Power supply design 22 Antenna performance cece cece cece eee eee tener 22 XBee DigiMesh 2 4 DC characteristics 2 0 0 0 0000000 c ccc c cece cece ccc ce ccc ccc cece cece cece ee eeeeeeeees 24 XBee DigiMesh 2 4 ADC operating characteristics
103. owed by the two characters that identify the command that is being issued and then by some optional configuration values For more details see Enter Command mode on the next page Idle mode When not receiving or transmitting data the device is in Idle mode During Idle mode the device listens for valid data on both the RF and serial ports Receive mode If a destination node receives a valid RF packet the destination node transfers the data to its serial transmit buffer For the serial interface to report receive data on the RF network that data must meet the following criteria e ID match e Channel match e Address match Sleep modes Sleep modes allows the device to enter states of low power consumption when not in use The device is almost completely off during sleep and is incapable of sending or receiving data until it wakes up XBee devices support both pin sleep where the module enters sleep mode upon pin transition and cyclic sleep where the module sleeps for a fixed time While asleep nodes cannot receive RF messages or read commands from the UART port The sleep modes are e Normal mode Normal mode is the default for a newly powered on node In this mode a node does not sleep Normal mode nodes should be mains powered e Asynchronous Pin Sleep mode This mode allows the device to sleep and wake according to the state of the Sleep RQ pin pin 9 XBee DigiMesh 2 4 User Guide 29 Enter Command mode e
104. owledgment scheme for every data packet that a device sends XBee DigiMesh 2 4 User Guide 54 Routing the receiving device must send an acknowledgment back to the transmitting device to let the sender know that the data packet arrives at the receiver If the transmitting device does not receive an acknowledgment then it re sends the packet It sends the packet a finite number of times before the system times out The MR Mesh Network Retries parameter determines the number of mesh network retries The sender device transmits RF data packets up to MR 1 times across the network route and the receiver transmits ACKs when it receives the packet If the sender does not receive a network ACK within the time it takes for a packet to traverse the network twice the sender retransmits the packet If a device sends a unicast that uses both MAC and NWK retries and acknowledgments e Use MAC retries and acknowledgments for transmissions between adjacent devices in the route e Use NWK retries and acknowledgments across the entire route To send unicast messages set the DH and DL on the transmitting device to match the corresponding SH and SL parameter values on the receiving device Broadcast addressing All of the routers in a network receive and repeat broadcast transmissions Broadcast transmissions do not use ACKs so the sending device sends the broadcast multiple times By default the sending device sends a broadcast transmission
105. passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C See the note under FCC notices for more information The testing results will be submitted to the FCC for approval prior to selling the integrated unit The required SAR testing measures emissions from the module and how they affect the person XBee DigiMesh 2 4 User Guide 145 XBee DigiMesh 2 4 agency certifications United States Part Minimum Number Type Description Gain Application Separation A24 Dipole half wave articulated 2 1 dBi Fixed 20 cm HABUF bulkhead mount U FL with 5 P5I pigtail A24 Dipole half wave articulated 2 1 dBi Fixed mobile 20 cm HASM RPSMA 5 25 525 A24 QI Monopole integrated whip 1 5 dBi 20 cm maa ide Fhedmobie T 29000430 Integrated PCB Antenna 0 5 dBi Fixed mobile 20 cm Antennas approved for use with the XBee RF Modules cable loss is shown if required Required Part Minimum Cable Number Type Description Gain Application Separation Loss Yagi class antennas A24 Yagi 4 element Y4NF A24 Yagi 6 element 1 7 dB Y6NF A24 Yagi 7 element 1 9 dB Y7NF dr you are using the RF module in a portable application or if the module is used in a handheld device and the antenna is less than 20 cm from the human body when the device is in operation The integrator may be
106. ples at the IR rate until the ST time expires and the device can resume sleeping XBee DigiMesh 2 4 User Guide 51 Monitor I O lines Detect digital I O changes You can configure devices to transmit a data sample immediately whenever a monitored digital I O pin changes state The IC command is a bitmask that you use to set which digital I O lines to monitor for a state change If you set one or more bits in IC the device transmits an I O sample as soon it observes a state change in one of the monitored digital I O lines The figure below shows how edge detection can work with periodic sampling In the figure the grey dashed lines with a dot on top represent samples taken from the monitored DIO line The top graph shows only IR samples the bottom graph shows a combination of IR samples and IC change detect In the top graph the humps indicate that the sample was not taken at that exact moment and needed to wait for the next IR sample period Monitored digital IO line IO sample transmissions IR gt 0 IC 0 IO sample transmissions IR gt O IC gt 0 XBee DigiMesh 2 4 User Guide 52 DigiMesh networking Mesh networking A mesh network is a topology in which each node in the network is connected to other nodes around it Each node cooperates in the transmission of information Mesh networking provides three important benefits e Routing With this technique the message is propagated along a path by hopping
107. pproved for fixed base station and mobile applications on channels 0x0B Ox1A XBee and 0x0C 0x17 XBee PRO If you mount the antenna at least 20 cm 8 in from nearby persons the FCC considers the application to be a mobile application You must test antennas that are not in the table to comply with FCC Section 15 203 Unique Antenna Connectors and Section 15 247 Emissions XBee RF Modules 1 mW XBee modules are tested and approved for use with the antennas listed in the first and second tables below XBee PRO RF Modules 63 mW XBee PRO modules are tested and approved for use with the antennas listed in the first and third tables below The antennas in the following tables are approved for use with the XBee XBee PRO DigiMesh 2 4 RF module We do not carry all of these antenna variants Contact Digi Sales for the available antennas Antennas approved for use with the XBee XBee PRO RF Modules cable loss is not required Part Minimum Number Type Description Gain Application Separation A24 Dipole half wave articulated Fixed mobile 20 cm HASM RPSMA 4 5 450 29000095 Dipole half wave articulated Fixed mobile 20 cm RPSMA 4 5 A24 Dipole articulated RPSMA Fixed 20 cm HABSM lf you are using the RF module in a portable application or if the module is used in a handheld device and the antenna is less than 20 cm from the human body when the device is in operation The integrator may be responsible for
108. ptions such a node eventually uses the selection process after a number of sleep cycles without a sync A node that uses the selection process begins acting as the new network sleep coordinator It is possible for multiple nodes to declare themselves as the sleep coordinator If this occurs the firmware uses the following resolution criteria to identify the sleep coordinator from among the nodes using the selection process XBee DigiMesh 2 4 User Guide 65 Become a sleep coordinator 1 Newer sleep parameters the network considers a node using newer sleep parameters SP and ST as higher priority to a node using older sleep parameters 2 Preferred sleep coordinator a node acting as a preferred sleep coordinator is higher priority to other nodes 3 Sleep support node sleep support nodes are higher priority to cyclic sleep nodes You can modify this behavior using the SO parameter 4 Serial number If the previous factors do not resolve the priority the network considers the node with the higher serial number to be higher priority Commissioning Pushbutton option Use the Commissioning Pushbutton to select a device to act as the sleep coordinator If you enable the commissioning pushbutton functionality you can immediately select a device as a sleep coordinator by pressing the Commissioning Pushbutton twice or by issuing the CB2 command The device you select in this manner is still subject to the resolution criteria process O
109. ransmit buffer out the UART Use the D6 and D7 commands to enable RTS and CTS flow control CTS flow control If you send the D7 command to enable CTS flow control when the serial receive buffer fills with the number of bytes specified by the FT parameter the device de asserts CTS sets it high to signal the host device to stop sending serial data The device re asserts CTS when less than FT 16 bytes are in the UART receive buffer for more information see FT Flow Control Threshold on page 89 RTS flow control If you send the D6 command to enable RTS flow control the device does not send data in the serial transmit buffer out the DOUT pin as long as RTS is de asserted set high Do not de assert RTS for long XBee DigiMesh 2 4 User Guide 35 Serial flow control periods of time or the serial transmit buffer will fill If the device receives an RF data packet and the serial transmit buffer does not have enough space for all of the data bytes it discards the entire RF data packet XBee DigiMesh 2 4 User Guide 36 Work with networked devices Network commissioning and diagnostics We callthe process of discovering and configuring devices in a network for operation network commissioning Devices include several device discovery and configuration features In addition to configuring devices you must develop a strategy to place devices to ensure reliable routes To accommodate these requirements modules include features to aid in
110. rawing must be respected e 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 e The CE marking must be affixed visibly legibly and indelibly Restrictions The power output of the XBee PRO RF Modules must not exceed 10 dBm The power level is set using the PL command The International Variant of this product is internally limited to 10 dBm XBee DigiMesh 2 4 User Guide 155 XBee DigiMesh 2 4 agency certifications European Telecommunications Standards Institute ETSI France imposes restrictions on the 2 4 GHz band Go to www art telecom Fr or contact Digi for more information Declarations of conformity Digi has issued Declarations of Conformity for the XBee PRO RF Modules concerning emissions EMC and safety Note Digi does not list the entire set of standards that must be met for each country Digi 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 PRO RF Module contact Digi or refer to the following web sites e CEPT ERC 70 03 technical requirements European restrictions and general requirements available at www ero dk e RETTE Directive equipment requirements and market placement available at www ero dk Approved antennas When you integrate high gain antennas Eu
111. responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C See the note under FCC notices for more information The testing results will be submitted to the FCC for approval prior to selling the integrated unit The required SAR testing measures emissions from the module and how they affect the person 21 you are using the RF module in a portable application or if the module is used in a handheld device and the antenna is less than 20 cm from the human body when the device is in operation The integrator may be responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C See the note under FCC notices for more information The testing results will be submitted to the FCC for approval prior to selling the integrated unit The required SAR testing measures emissions from the module and how they affect the person XBee DigiMesh 2 4 User Guide 146 XBee DigiMesh 2 4 agency certifications United States Required Part Minimum Cable Number Type Description Gain Application Separation Loss A24 Yagi 9 element 10 0 dBi Fixed 2 9 dB Y9NF A24 Yagi 10 element 11 0 dBi Fixed 3 9 dB YIONF A24 Yagi 12 element 12 0 dBi Fixed 4 9 dB Y12NF A24
112. ropean regulations stipulate the EIRP power maximums Use the following guidelines to determine which antennas to use when you design an application The following antenna types are tested and approved for use with the XBee 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 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 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 The embedded XBee PRO was tested and approved for use with the following antennas Note At 10 dBm transmit power the PL parameter value must equal 0 or you must use the international variant XBee DigiMesh 2 4 User Guide 156 XBee DigiMesh 2 4 agency certifications Japan Telec Dipole 2 1 dBi omni directional articulated RPSMA Digi part number A24 HABSM Chip antenna 1 5 dBi Attached monopole whip 1 5 dBi Integrated PCB antenna 0 5 dBi The RF modem encasement was designed to accommodate the RPSMA antenna option XBee DigiMesh 2 4 agency certifications Japan Telec In order to use
113. s an OK status Set this command parameter the same on all devices in a network Parameter range 128 bit value Default N A LT Associate LED Blink Time The Associate LED blink time If you use the D5 command to enable the Associate LED functionality DIO5 Associate pin this value determines the on and off blink times for the LED If LT 0 the XBee uses the default blink rate 500 ms for a sleep coordinator 250 ms otherwise For all other LT values the firmware measures LT in 10 ms increments Parameter range 0x14 Oxff x 10 ms Default 0x0 MO PWMO Duty Cycle The duty cycle of the PWMO line Use the PO command to configure the line as a PWM output Parameter range 0x0 Ox3ff Default 0x0 M1 PWM1 Duty Cycle The duty cycle of the PWM1 line Use the P1 command to configure the line as a PWM Parameter range 0x0 Ox3ff XBee DigiMesh 2 4 User Guide 93 MR Mesh Unicast Retries Default 0x0 MR Mesh Unicast Retries Set or read the maximum number of network packet delivery attempts If MR is non zero the packets a module sends request a network acknowledgment and can be resent up to MR 1 times if the module does not receive an acknowledgment Changing this value dramatically changes how long a route request takes We recommend that you set this value to 1 Parameter range 0x0 0x7 mesh unicast retries Default 0x1 MS Missed Sync Messages Reads the number of sleep or wake cycles since the
114. s parameter to the same value on all nodes in the network Parameter range 0x1 0x20 hops Default Ox7 NI Node Identifier Stores the node identifier string for a device This can be up to 20 ASCII characters The string only accepts printable ASCII data in Command mode The string cannot start with a space Use a carriage return or comma to end the command The command automatically ends when you enter the maximum bytes for the string Use the ND command to return this string to easily identify devices The DN command also uses this identifier Parameter range 0x20 up to 20 byte ASCII string Default A space character NN Network Delay Slots Set or read the maximum random number of network delay slots before rebroadcasting a network packet One network delay slot is approximately 13 ms Parameter range 0x1 Oxa network delay slots XBee DigiMesh 2 4 User Guide 96 NO Network Discovery Options Default 0x3 NO Network Discovery Options Set or read the network discovery options value for the ND command on a particular device The options bit field value changes the behavior of the ND command and or changes e What optional values the device returns when it receives an ND command or API Node Identification Indicator 0x95 frame Parameter range 0x0 0x7 bit field Default 0x0 Options 0x01 Append the DD value to ND responses or API node identification frames 0x02 Local device sends ND resp
115. s the most recently set sleep settings Normal mode Set SM to 0 to enter Normal mode When you power on a device it defaults to Normal mode If a device is in this mode it does not sleep Use mains power for devices in Normal mode A device in Normal mode synchronizes to a sleeping network but does not observe synchronization data routing rules it routes data at any time regardless of the network s wake state When synchronized a device in Normal node relays sync messages that sleep compatible nodes generate but will not generate sync messages itself Once a device in Normal node synchronizes with a sleeping network you can put it into a sleep compatible sleep mode at any time Asynchronous Pin Sleep mode Set SM to 1 to enter Asynchronous Pin Sleep mode Pin sleep allows the device to sleep and wake according to the state of the Sleep RQ pin pin 9 When you assert Sleep RQ high the device finishes any transmit or receive operations and enters a low power state When you de assert Sleep RQ low the device wakes from pin sleep Asynchronous Cyclic Sleep mode Set SM to 4 to enter Asynchronous Cyclic Sleep mode Cyclic sleep allows the device to sleep for a specific time and wake for a short time to poll If the device receives serial or RF data while awake it extends the time before it returns to sleep by the specific amount the ST command provides Otherwise it enters sleep mode immediately XBee DigiMesh 2 4 U
116. s without receiving a sync message due to RF interference for example As a node misses sync messages the time available for transmitting messages during the wake time reduces to maintain synchronization accuracy By default a device reduces its active sleep time progressively as it misses sync messages DigiMesh synchronization messages Asleep coordinator regularly sends sync messages to keep the network in sync Unsynchronized nodes also send messages requesting sync information Sleep compatible nodes use deployment mode when they first power up and the sync message has not been relayed A sleep coordinator in deployment mode rapidly sends sync messages until it receives a relay of one of those messages Deployment mode e Allows you to effectively deploy a network e Allows asleep coordinator that resets to rapidly re synchronize with the rest of the network If anode exits deployment mode and then receives a sync message from a sleep coordinator that is in deployment mode it rejects the sync message and sends a corrective sync to the sleep coordinator Use the SO sleep options command to disable deployment mode Asleep coordinator that is not in deployment mode sends a sync message at the beginning of the wake cycle The sleep coordinator listens for a neighboring node to relay the sync If it does not hear the relay the sleep coordinator sends the sync one additional time Anode that is not a sleep coordinator and h
117. s you set the frame ID to 0 in the transmit request If the packet cannot be delivered to the destination the Transmit Status frame indicates the cause of failure Use the AP command to choose the type of data frame you want to receive either a Receive Packet frame 0x90 or an Explicit Rx Indicator frame 0x91 XBee DigiMesh 2 4 User Guide 113 XBee DigiMesh 2 4 API frames Transmit request 0x10 or 0x11 RF data and ACK a nano Transmit status 0x88 Remote AT commands darnos The following image shows the API frame exchanges that take place at the UART when you send a remote AT command If the remote device does not receive the remote command it does not send a Remote Command Response frame out the UART Remote AT command 0x17 ma wo Remote AT command response 0x97 Code to support future API frames If your software application supports the API you should make provisions that allow for new API frames in future firmware releases For example you can include the following section of code on a host microprocessor that handles serial API frames that are sent out the device s DOUT pin void XBee_HandleRxAPIFrame _apiFrameUnion xpapiFrame switch papiFrame gt api_id case RX_RF_DATA_FRAME process received RF data frame break case RX IO SAMPLE FRAME process IO sample frame break case NODE IDENTIFICATION FRAME process node identification frame break default oe any oth
118. se the PR command to enable the pullup resistors for each digital input XBee DigiMesh 2 4 User Guide 49 Monitor I O lines If you send the IS command from Command mode then the device returns a carriage return delimited list containing the following fields Field Name Description 1 Sample Number of sample sets in the packet Always set to 1 sets 2 Digital Indicates which digital IO lines have sampling enabled Each bit corresponds to one channel digital 1O line on the device mask bit O ADO DIOO bit 1 AD1 DIO1 bit 2 AD2 DIO2 bit 3 AD3 DIO3 bit 4 DIO4 bit 5 ASSOC DIO5 bit 6 RTS DIO6 bit 7 CTS GPIO7 bit 8 DTR SLEEP RQ DIO8 bit 9 ON SLEEP DIO9 bit 10 RSSI DIO10 bit 11 PWM DIO11 bit 12 CD DIO12 For example a digital channel mask of 0x002F means DIO0 1 2 3 and 5 are enabled as digital 10 1 Analog Indicates which lines have analog inputs enabled for sampling Each bit in the analog channel channel mask corresponds to one analog input channel mask bit 0 ADO DIOO bit 1 AD1 DIO1 bit 2 AD2 DIO2 bit 3 AD3 DIO3 bit 4 AD4 DIO4 bit 5 ASSOC AD5 DIO5 XBee DigiMesh 2 4 User Guide 50 Monitor I O lines Field Name Description Variable Sampled If you enable any digital IO lines the first two bytes of the data set indicate the state data set of all enabled digital 10 Only digital channels that you enable in the Digital channel mask b
119. sed sync messages command Use the MS command to query the number of cycles that elapse since the device receives a sync message Sleep status API messages When you use the SO command to enable a device that is in API operating mode it outputs modem status frames immediately after it wakes up and prior to going to sleep XBee DigiMesh 2 4 User Guide 71 XBee DigiMesh 2 4 AT commands 1S XBee Sensor Sample Forces a device sensor to take a sample You can only send 1S to a device sensor using a Remote Command Request 0x17 frame Parameter range N A Default N A AC Apply Changes Immediately applies new settings without exiting Command mode Parameter range N A Default N A AG Aggregator Support The AG command sends a broadcast through the network that has the following effects on nodes that receive the broadcast e The receiving node establishes a DigiMesh route back to the originating node if there is space in the routing table XBee DigiMesh 2 4 User Guide 72 AO API Options e The DH and DL of the receiving node update to the address of the originating node if the AG parameter matches the current DH DL of the receiving node e API enabled XBees with updated DH and DL send an Aggregate Addressing Update frame 0x8E out the UART The AG command is only available on products that support DigiMesh Parameter range Any 64 bit number Default N A AO API Options The serial frame type that comm
120. ser Guide 60 Asynchronous Cyclic Sleep with Pin Wake Up mode Assert the ON SLEEP pin high to wake the device De assert ON SLEEP low to put the device to sleep If you enable use the D7 command to enable hardware flow control the CTS pin asserts low when the device wakes and can receive serial data and de asserts high when the device sleeps Asynchronous Cyclic Sleep with Pin Wake Up mode Set SM to 5 to enter Asynchronous Cyclic Sleep with Pin Wake Up mode This mode is a slight variation on Asynchronous Cyclic Sleep mode SM 4 that allows you to wake a device prematurely by asserting the Sleep_RQ pin pin 9 In this mode you can wake the device after the sleep period expires or if a high to low transition occurs on the Sleep_RQ pin Synchronous Sleep Support mode Set SM to 7 to enter Synchronous Sleep Support mode A device in Synchronous Sleep Support mode synchronizes itself with a sleeping network but does not sleep itself At any time the node responds to new nodes that attempt to join the sleeping network with a sync message Asleep support node only transmits normal data when the other nodes in the sleeping network are awake Sleep support nodes are especially useful when e You use them as preferred sleep coordinator nodes e As aids in adding new nodes to a sleeping network Because sleep support nodes do not sleep they should be mains powered Synchronous Cyclic Sleep mode Set SM to 8 to ent
121. shows the pin signals and their descriptions XBee DigiMesh 2 4 User Guide 19 Hardware diagram PIN 1 pa PIN 20 o Dict E INE PIN 10 PIN 11 Pin Pin Name Direction Description 2 DOUT Output UART data out 3 DIN CONFIG UART data in a piora Digital 70 12 5 RESET Input open Device reset The reset pulse must be at least 100 us Drive this line as an open drain collector The device drives this line low when a reset occurs Never drive this line high 6 PWMO RSSI D1010 Either PWM output O RX signal strength indicator Digital I O 7 PNM DIO11 PWM output 1 Digital I O 11 9 DTR SLEEP_RQ Either Pin sleep control line or Digital 1 0 8 DIO8 11 AD4 DIO4 Analog input 4 or Digital I O 4 12 CTS DIO7 Either Clear to send flow control or Digital I O 7 13 ON SLEEP Output Device Status Indicator or Digital 1 0 9 14 VREF You must connect this line if you want to use analog I O sampling Must be between 2 6 V and Vcc Associate Either Associated indicator Digital I O 5 DIO5 AD5 16 RTS DIO6 Either Request to send flow control Digital I O 6 17 AD3 DIO3 Either Analog input 3 or Digital I O 3 18 AD2 DIO2 Either Analog input 2 or Digital I O 2 19 AD1 DIO1 Either Analog input 1 or Digital I O 1 XBee DigiMesh 2 4 User Guide 20 Design notes Pin Pin Name Direction Description ADO DIOO Either Analog input 0 Digital I O 0 or Commissioning Button Commissioning B
122. sparent mode in a network The following table provides a comparison of the two modes Transparent operating mode When to use e The conditions for using API mode do not apply Advantages e Provides a simple interface that makes it easy to get started with XBee devices e It is easy for an application to support what you send is exactly what other modules get and vice versa e Works very well for two way communication between XBee devices XBee DigiMesh 2 4 User Guide API operating mode When to use The device sends wireless data to multiple destinations The device configures remote XBee devices in the network The device receives wireless data packets from multiple XBee devices and the application needs to identify which devices send each packet The device receives I O samples from remote XBee devices Advantages You can set or read the configuration of remote XBee devices in the network You can transmit data to one or multiple destinations this is much faster than transparent mode where the configuration must be updated to establish a new destination Received data includes the sender s address Received data includes transmission details and reasons for success or failure This mode has several advanced features such as advanced networking diagnostics and firmware upgrades 27 Transparent operating mode Disadvantages You cannot set or read the configuration of remot
123. ss Reserved Broadcast Radius Transmit Options RF Data Checksum XBee DigiMesh 2 4 User Guide Offset Example o Ox7E 0x00 0x16 0x10 0x01 0x00 6 0x13 OxA2 ls 0x00 9 0x40 Ox0A 0x01 0x27 OXFF OxFE 0x00 0x00 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 0x13 118 XBee DigiMesh 2 4 API frames If you enable escaping AP 2 the frame should look like 0x7E 0x00 0x16 0x10 0x01 0x00 0x7D 0x33 O xA2 0x00 0x40 0x0A 0x01 0x27 OxFF xFE 0x00 0x00 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 0x7D 0x33 Explicit Addressing Command frame 0x11 Description This frame is similar to Transmit Request 0x10 but it also requires you to specify the application layer addressing fields endpoints cluster ID and profile ID This frame causes the device to send data as an RF packet to a specific destination using specific source and destination endpoints cluster ID and profile ID Set the 64 bit destination as follows e For broadcast transmission 0x000000000000FFFF e For unicast transmission the address of the destination node you want for unicast transmissions Set the reserved field to OxFFFE Set the broadcast radius from 0 up to NH to OXFF If the broadcast radius exceeds the value of NH then the devices use the value of NH as the radius Only broadcast transmissions use this parameter Use the NP command to read the maximum number of payload bytes Format The following table provides the
124. ss When you combine DL with DH it defines XBee DigiMesh 2 4 User Guide 86 DM DigiMesh Options the destination address that the device uses for transmission 0x000000000000FFFF is the broadcast address Parameter range 0x0 Oxffffffff Default Oxffff DM DigiMesh Options A bit field mask that you can use to enable or disable DigiMesh features Bit 0 Disable aggregator updates When enabled the device does not issue or respond to AG requests 1 Disable Trace Route and NACK responses When enabled the device does not generate or respond to Trace Route or NACK requests Parameter range 0 0x03 bit field Default 0 DN Discover Node Resolves an NI string to a physical address case sensitive The following events occur after DN discovers the destination node if you have AT firmware 1 The device sets DL and DH to the extended 64 bit address of the device with the matching NI string 2 The receiving device returns OK or ERROR 3 The device exits Command mode to allow for immediate communication If you have API firmware 1 The receiving device returns the OxFFFE and 64 bit extended addresses in a Remote Command Response 0x97 frame 2 If there is no response from a module within NT 100 milliseconds or you do not specify a parameter by leaving it blank the command terminates the receiving device returns an XBee DigiMesh 2 4 User Guide 87 EA MAC ACK Failure Count ERROR message
125. stination address to 0x000000000000FFFF e For unicast transmissions set the 64 bit address field to the address of the desired destination node e Set the reserved field to OxFFFE Format The following table provides the contents of the frame For details on frame structure see API frame specifications on page 109 Frame fields Byte Description s Frame type 4 0x10 EN Frame ID Identifies the data frame for the host to correlate with a subsequent ACK If set to 0 in Command mode the device does not send a response 64 bit 6 13 MSB first LSB last Set to the 64 bit address of the destination device Broadcast Destination 0x00 00000 00000 FFF Address Reserved 14 MSB first LSB last Set to OxFFFE for Broadcast TX or if you do not know the 15 network address Broadcast 16 Sets the maximum number of hops a broadcast transmission can occur If set to 0 Radius the broadcast radius is set to the maximum hops value Transmit 17 0x01 Disable ACK Options 0x02 Disable network address discovery Set all other bits to 0 RF Data Up to 72 bytes per packet Sent to the destination device XBee DigiMesh 2 4 User Guide 117 Example XBee DigiMesh 2 4 API frames The example shows how to send a transmission to a device if you disable escaping AP 1 with destination address 0x0013A200 40014011 and payload TxData0A Frame Fields Start Delimiter Length Frame Type Frame ID 64 bit Destination Addre
126. subnet s next wake cycle During this cycle the node you select to change the sleep cycle parameters sends the new settings to the entire subnet it is in range of including the sleep support node that is in range of the other subnet 5 Wait for the out of sync subnet to wake up and send a sync When the sleep support node receives this sync it rejects it and sends a sync to the subnet with the new sleep settings 6 The subnets will now be in sync You can remove the sleep support node 7 If you want you can change the sleep cycle settings back to what they were If you only need to replace a few nodes you can use this method 1 Reset the out of sync node and set its sleep mode to Synchronous Cyclic Sleep mode SM 8 2 Set a short sleep cycle 3 Place the node in range of a sleep support node or wake a sleeping node with the Commissioning Pushbutton 4 The out of sync node receives a sync from the node that is synchronized to the network It then syncs to the network sleep settings XBee DigiMesh 2 4 diagnostics The following diagnostics are useful in applications that manage a sleeping router network Query sleep cycle Use the OS and OW commands to query the current operational sleep and wake times that a device uses Sleep status Use the SS command to query useful information regarding the sleep status of the device Use this command to query if the node is currently acting as a network sleep coordinator Mis
127. t modules in a network You can use the Test Link Request Cluster ID to send a number of test packets between any two devices in a network To clarify the example we refer to device A and device B in this section To perform a link test XBee DigiMesh 2 4 User Guide 41 Test links between adjacent devices 1 Use device Ato send an Explicit Addressing Command 0x11 frame to device B 2 Address the frame to the Test Link Request Cluster ID 0x0014 on device B s destination endpoint OxE6 3 Include a 12 byte payload in the Explicit Addressing Command frame with the following format Number of Bytes Field Name Description 8 Destination The address the device uses to test its link address 2 Payload size The size of the test packet Use the NP command to query the maximum payload size for the device 2 The number of packets to send This must be a number between 1 and 4000 4 Device B should transmit test link packets 5 When device B completes transmitting the test link packets it sends the following data packet to device A s Test Link Result Cluster 0x0094 on endpoint 0xE6 6 If device A is in API mode then it outputs the following information as an API Explicit RX Indicator 0x91 frame Number of Bytes Field Name Description 8 Destination address The address the device used to test its link 2 Payload size The size of the test packet device A sent to test the link 2 Iterations The number of p
128. t send a response 64 bit 6 13 MSB first LSB last Set to the 64 bit address of the destination device Broadcast Destination 0x00 00000 00000 FFF Address Reserved 14 MSB first LSB last Set to OxFFFE for Broadcast TX or if you do not know the 15 network address Remote 16 0x02 Apply changes on remote If you do not set this you must set the Command AC command for changes to take effect Set all other bits to 0 Options AT Command 17 The name of the command 18 Command 19 If present indicates the parameter value you request for a given register If no Parameter characters are present it queries the register Example The following example sends a remote command to e Change the broadcast hops register on a remote device to 1 broadcasts go to 1 hop neighbors only e Apply changes so the new configuration value takes effect immediately In this example the 64 bit address of the remote module is 0x0013A200 40401122 Frame fields Offset Example Ox7E MSB 1 0x00 LSB2 0x10 0x17 Start delimiter Length XBee DigiMesh 2 4 User Guide 122 XBee DigiMesh 2 4 API frames Frame fields Offset Example D Frame ID 0x01 64 bit destination address MSB 5 0x00 ES mses e 0x13 OxA2 ES 0x00 o 0x40 0x40 0x11 0x22 Reserved OxFF E OxFE Remote command options 15 0x02 apply changes AT command 0x42 B 0x48 H Command parameter 0x01 Checksum OxF5 AT Command Response frame
129. t value by appending a hexadecimal parameter to the command Parameter range O to OxFFFF Default 0 BD Baud Rate Set or read the serial interface baud rate for communication between the serial port of the device and the host To request non standard baud rates with values above 0x80 you can use the Serial Console toolbar in XCTU to configure the serial connection if the console is connected or click the Connect button if the console is not yet connected When you send non standard baud rates to a device it stores the closes interface data rate represented by the number in the BD register Read the BD command by sending ATBD without a parameter value and the device returns the value stored in the BD register Parameter range Parameter Description 0x0 1200 b s XBee DigiMesh 2 4 User Guide 74 BH Broadcast Hops Parameter Description Ox1 2400 b s 0x2 4800 b s 0x3 9600 b s 0x4 19200 b s 0x5 38400 b s 0x6 57600 b s 0x7 115200 b s 0x39 to 0xF4240 if the host supports it Default 0x3 9600 b s BH Broadcast Hops The maximum transmission hops for broadcast data transmissions Set the value to 0 for the maximum number of hops If you set BH greater than NH then the device uses the value of NH Parameter range 0x0 0x20 Default 0x0 CA CCA Threshold Set or read the Clear Channel Assessment CCA threshold If the device detects energy above the CCA threshold it will not transmit
130. ta it does not transmit the data in the serial receive buffer until the device stops receiving RF data 2 For mesh networking firmware if the device transmits an RF data packet the device may need to discover the destination address or establish a route to the destination After transmitting the data the device may need to retransmit the data if it does not receive an acknowledgment or if the transmission is a broadcast These issues could delay the processing of data in the serial receive buffer Serial transmit buffer If the serial transmit buffer becomes full enough that all of the data in a received RF packet will not fit in the serial transmit buffer it drops the entire RF data packet Cases in which the serial transmit buffer may become full resulting in dropped RF packets 1 Ifthe RF data rate is set higher than the interface data rate of the device the device may receive data faster than it can send the data to the host Even occasional transmissions from a large number of devices can quickly accumulate and overflow the transmit buffer 2 Ifthe host does not allow the device to transmit data out from the serial transmit buffer due to being held off by hardware flow control Serial flow control The RTS and CTS device pins provide RTS and or CTS flow control CTS flow control signals the host to stop sending serial data to the device RTS flow control lets the host signal the device so it will not send the data in the serial t
131. takes or when you need to know which node a data packet is from The device communicates UART data in packets also known as API frames This mode allows for structured communications with serial devices It is helpful in managing larger networks and is more appropriate for performing tasks such as collecting data from multiple locations or controlling multiple devices remotely There are two types of API operating modes one with escaped characters and another without escaped characters e Without escaped characters This mode eliminates escaping character sequences This makes it simpler to create code and libraries but runs a minor risk of lost frames or errors due to the possibility that payload data can be confused with frame structure We do not recommend this mode for noisy radio environments and where payload data may include XBee DigiMesh 2 4 User Guide 26 Transparent and API operating modes special characters specifically Ox7E 0x7D 0x11 and 0x13 e With escaped characters API escaped operating mode AP 2 works similarly to API mode The only difference is that when working in API escaped mode the software must escape any payload bytes that match API frame specific data such as the start of frame byte 0x7E Comparing Transparent and API modes XBee devices can use their serial connections in two ways Transparent operating mode or API operating mode You can use a mixture of devices running API mode and tran
132. tegrated unit The required SAR testing measures emissions from the module and how they affect the person XBee DigiMesh 2 4 User Guide 149 XBee DigiMesh 2 4 agency certifications United States Required Part Minimum Cable Number Type Description Gain Application Separation Loss Yagi class antennas A24 Yagi 4 element 6 0 8 1 dB Y4NF A24 Yagi 6 element 8 8 10 9 dB Y6NF dBi A24 Yagi 7 element 9 0 11 1 dB Y7NF dBi A24 Yagi 9 element 12 1 dB YONF dBi A24 Yagi 10 element 11 0 13 1 dB YIONF A24 Yagi 12 element 12 0 14 1 dB Y12NF A24 Yagi 13 element 12 0 14 1 dB Y13NF dBi A24 Yagi 15 element 12 5 14 6 dB Y15NF A24 Yagi 16 element 15 6 dB Y16NF A24 Yagi 16 element RPSMA 15 6 dB YI6RM connector A24 Yagi 18 element 17 1 dB Y18NF Omni directional class antennas dr you are using the RF module in a portable application or if the module is used in a handheld device and the antenna is less than 20 cm from the human body when the device is in operation The integrator may be responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C See the note under FCC notices for more information The testing results will be submitted to the FCC for approval prior to selling the integrated unit The required SAR testing measures emissions from
133. termediate nodes on a route Parameter range Parameter Description 0x0 Standard router 0x1 N A 0x2 End Device Default 0x0 CH Operating Channel Set or read the operating channel number devices use to transmit and receive data to each other The devices use 802 15 4 channel numbers Parameter range Oxb Oxla Default Oxc CI Cluster ID Sets or reads the default cluster identifier value that the device uses for serial data transmissions If you set this value to 0x12 the destination node echoes any transmitted packet back to the source device Parameter range 0x0 Oxffff Default 0x11 Transparent data cluster ID CK Configuration CRC Reads the cyclic redundancy check CRC of the current AT command configuration settings XBee DigiMesh 2 4 User Guide 77 CN Exit Command mode This command allows you to detect an unexpected configuration change on a device Use the code that the device returns to determine if a node has the configuration you want After a firmware update this command may return a different value Parameter range O OXFFFFFFFF Default N A CN Exit Command mode Makes the device exit Command mode Parameter range N A Default N A CT Command mode Timeout Set or read the Command mode timeout parameter If a device does not receive any valid commands within this time period it returns to Idle mode from Command mode Parameter range 0x2 0x1770 100 ms
134. the module and how they affect the person XBee DigiMesh 2 4 User Guide 150 Part Number Type Description A24 F2NF A24 F3NF A24 FONF A24 F8NF A24 FONF A24 F1ONF A24 F12NF A24 F15NF A24 W7NF A24 M7NF 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 Panel class antennas A24 P8SF A24 P8NF Flat panel Flat panel XBee DigiMesh 2 4 agency certifications United States Required Minimum Cable Gain Application Separation Loss o i 8 6 dB 8 6 dB dr you are using the RF module in a portable application or if the module is used in a handheld device and the antenna is less than 20 cm from the human body when the device is in operation The integrator may be responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C See the note under FCC notices for more information The testing results will be submitted to the
135. the target devices respond directly to the device that sent the FN command The device that sends FN outputs a response packet in the same format as an AT Command Response 0x88 frame Trace route option In many networks it is useful to determine the route that a DigiMesh unicast takes to its destination particularly when you set up a network or want to diagnose problems within a network Because of the large number of Route Information Packet frames that a unicast with trace route enabled can generate we suggest you only use the trace route option for occasional diagnostic purposes and not for normal operations XBee DigiMesh 2 4 User Guide 44 Test links between adjacent devices The Transmit Request 0x10 frame contains a trace route option which transmits routing information packets to the originator of the unicast using the intermediate nodes When a device sends a unicast with the trace route option enabled the unicast transmits to its destination devices which forward the unicast to its eventual destination The destination device transmits a Route Information Packet 0x8D frame back along the route to the unicast originator The Route Information Packet frame contains Addressing information for the unicast e e Addressing information for the intermediate hop e RSSI information e Other link quality information For a full description of the Route Information Packet frame see Route Information Packet 0x8D on p
136. ther fields in the packet If the success field equals zero ignore the RSSI fields RSSI indicators The received signal strength indicator RSSI measures the amount of power present ina radio signal It is an approximate value for signal strength received on an antenna You can use the DB command to measure the RSSI on a device DB returns the RSSI value measured in dBm of the last packet the device received This number can be misleading in DigiMesh networks The DB value only indicates the received signal strength of the last hop If a transmission spans multiple hops the DB value provides no indication of the overall transmission path or the quality of the worst link it only indicates the quality of the last link To determine the DB value in hardware 1 Enable the RSSI pulse width modulation PWM functionality using the PO command 2 Use the RSSI PWM module pin pin 6 When the device receives data it sets the RSSI PWM to a value based on the RSSI of the packet it receives This value only indicates the quality of the last hop You could connect this pin to an LED to indicate if the link is stable or not XBee DigiMesh 2 4 User Guide 43 Test links between adjacent devices Discover devices Discover all the devices on a network You can use the ND command to discover all devices on a network When you send the ND command 1 The device sends a broadcast ND command through the network 2 All devices that receiv
137. tworking Mesh networking occ teen eee 53 Routers and end devices iiiii nen 54 Network Identihiers asec saint li Ng 8 YS Ya na das Da dente lb eal see steele 54 Operating channels 54 Unicast addressing sacucaisslscss ias Pate ee nd NG BA O AN O deacon desta a ag a 54 Broadcast addressing eterno 55 eH AA 55 ROUTE CISCOVETY AAA 56 ThroUg put tios UNAN ta Taano cee Foie hee he Udo 56 Transmission timeouts 0200 22 eee 57 Unicast one hop time 2 20 2222 2 2 2 0 vacncesesenel doce edeenencagebaeiensdsdadedseccse R KATERE SENS Ea 57 Transmita broadcast eeno ee eet Se E ERE il Ai E 58 Transmit a unicast with a known route eee eee ee eee cece cece cece cece cece eee eeeeeees 58 Transmit a unicast with an unknown route 000 0 0222 e eee e cece e cece eee cece cece eeeeees 58 Transmit a unicast with a broken route nn 58 XBee DigiMesh 2 4 User Guide 5 DigiMesh sleep modes XBee DigiMesh 2 4 sleep modes 59 Asynchronous modes eee 59 Synchronous modes 2 222222 eee eee 59 Normalmente 60 Asynchronous Pin Sleep mode 2 222222 ee 60 Asynchronous Cyclic Sleep mode occ 60 Asynchronous Cyclic Sleep with Pin Wake Up mode 2 220220 2 0 0 61 Synchronous Sleep Support mode eee 61 Synchronous Cyclic Sleep mode ooo 61 The sleep timer 2 0 0 ee 62 Coordinating sleep modes in the DigiMesh network iii 62 DigiMesh synchronization mess
138. u define DigiMesh networks with a unique network identifier Use the ID command to set this identifier For devices to communicate you must configure them with the same network identifier The ID command directs the devices to talk to each other by establishing that they are all part of the same network The ID parameter allows multiple DigiMesh networks to co exist on the same physical channel Operating channels The XBee Digi Mesh 2 4 operates over the 2 4 GHz band using direct sequence spread spectrum DSSS modulation DSSS modulation allows the device to operate over a channel or frequency that you specify The 2 4 GHz frequency band defines 16 operating channels XBee devices support all 16 channels and XBee PRO devices support 12 of the 16 channels Use the CH command to select the operating channel on a device CH tells the device the frequency to use to communicate For devices to communicate the CH and ID commands must be equal on all devices in the network A device will e Only receive data from other devices within the same network with the same ID value and using the same channel with the same CH value e Only be able to transmit data to other devices within the same network with the same ID value and using the same channel with the same CH value Unicast addressing When devices transmit using DigiMesh unicast the network uses retries and acknowledgments ACKs for reliable data delivery In a retry and ackn
139. uard time varies based on the sleep and wake times you select and the number of sleep cycles that elapse since receiving the last sync message The sleep guard time guarantees that a destination XBee DigiMesh 2 4 User Guide 66 Select sleep parameters module will be awake when the source device sends a transmission As a node misses more and more consecutive sync messages the sleep guard time increases in duration and decreases the available transmission time Auto early wake up sleep option If you have nodes that are missing sync messages and could be going out of sync with the rest of the network enabling an early wake gives the device a better chance to hear the sync messages that are being broadcast Similar to the sleep guard time the auto early wake up option decreases the sleep period based on the number of sync messages a node misses This option comes at the expense of battery life Use the SO command to disable auto early wake up sleep Select sleep parameters Choosing proper sleep parameters is vital to creating a robust sleep enabled network with a desirable battery life To select sleep parameters that will be good for most applications follow these steps 1 Choose NN and NH Based on the placement of the nodes in your network select the appropriate values for the Network Hops NH and Network Delay Slots NN parameters We optimize the default values of NH and NN to work for the majority of deployments In
140. unicates RF packets received Use AO to enable different API output frames Parameter range Parameter Description 0x0 API Rx Indicator 0x90 this is for standard data frames 0x1 API Explicit Rx Indicator 0x91 this is for Explicit Addressing data frames Default 0x0 AP API Enable The API mode setting The device can format the RF packets it receives into API frames and send them out the serial port When you enable API you must format the serial data as API frames because Transparent operating mode is disabled Parameter range Parameter Description 0x0 Transparent Mode All UART input and output is raw data and the device uses the RO parameter to delineate packets Ox1 API Mode Without Escapes The device packetizes all UART input and output data in API format without escape sequences XBee DigiMesh 2 4 User Guide 73 BC Bytes Transmitted Parameter Description 0x2 API Mode With Escapes The device is in API mode and inserts escaped sequences to allow for control characters The device passes 0x11 0x13 Ox7d and 0x7e as data Default 0x0 Bytes returned 1 BC Bytes Transmitted The number of RF bytes transmitted The firmware counts every byte of every packet including MAC PHY headers and trailers The purpose of this count is to estimate battery life by tracking time spent performing transmissions This number rolls over to zero from OxFFFF You can reset the counter to any 16 bi
141. utton Notes The table specifies signal direction with respect to the device The device includes a 50 kQ pull up resistor attached to RESET You can configure several of the input pull ups using the PR command Leave any unused pins disconnected Recommended pin connections The only required pin connections for two way communication are VCC GND DOUT and DIN To support serial firmware updates you must connect VCC GND DOUT DIN RTS and DTR Do not connect any pins that are not in use Use the PR command to pull all inputs on the radio high with internal pull up resistors Unused outputs do not require any specific treatment You can connect other pins to external circuitry for convenience of operation including the Associate LED pin pin 15 and the Commissioning Button pin pin 20 The Associate LED pin flashes differently depending on the state of the module and a pushbutton attached to pin 20 can enable various deployment and troubleshooting functions without you sending UART commands For analog sampling attach the VREF pin pin 14 to a voltage reference Design notes The XBee devices do not require any external circuitry or specific connections for proper operation However there are some general design guidelines that we recommend to build and troubleshoot a robust design Board layout We design XBee devices to be self sufficient and have minimal sensitivity to nearby processors crystals or other print
142. ved Once the device is in Command mode it listens for user input for some time and is able to receive AT commands on the UART If 10 seconds go by without any user input the device drops out of Command mode and returns to Transparent operating mode You can customize the guard times and timeout in the device s configuration settings For information on how to do this see CC Command Sequence Character on page 76 CT Command mode Timeout on page 78 and GT Guard Times on page 90 Troubleshooting Failure to enter Command mode is commonly due to baud rate mismatch Ensure that the baud rate of the connection matches the baud rate of the device By default the BD parameter 3 9600 b s XBee DigiMesh 2 4 User Guide 30 Send AT commands Send AT commands Use the syntax in the following figure to send AT commands AT 4 ASCII 7 Space Pi Parameter Carriage Prefix Command Optional Optional HEX Return Example ATDL 1F lt CR gt To read a parameter value stored in the device s register omit the parameter field The preceding example would change the device s destination address Low to Ox1F To store the new value to non volatile long term memory send the WR Write command This allows parameter values that you modify to persist in the device s registry after a reset Otherwise the device restores parameters to the previous values after a reset Responding to AT commands When you send a command to the de
143. vice the device parses and runs the command If the command runs successfully the device returns an OK message If the command errors the device returns an ERROR message Exit Command Mode 1 Send the CN Exit Command Mode command followed by a carriage return or 2 Ifthe device does not receive any valid AT commands within the time specified by the CT Command Mode Timeout command it returns to Idle mode XBee DigiMesh 2 4 User Guide 31 Configure the XBee DigiMesh 2 4 Software libraries One way to communicate with the XBee device is by using a software library There are two primary libraries available for use with the devices e XBee Java library e XBee ANSI C library The XBee Java Library is a Java API The package includes the XBee library its source code and a collection of samples that help you develop Java applications to communicate with your XBee devices The XBee ANSI C Library project is a collection of portable ANSI C code for communicating with the devices in API mode Configure the device using XCTU XBee Configuration and Test Utility XCTU is a multi platform program that enables developers to interact with Digi radio frequency RF devices through a graphical interface The application includes built in tools that make it easy to set up configure and test Digi RF devices For full support of the XTC RF Module you must use XCTU version 6 3 0 or higher For instructions on downloading and using XCTU
144. w 8 data bits least significant bit first and a stop bit high The following diagram illustrates the serial bit pattern of data passing through the device Least Significant Bit first idl hi h 1 I I LI I I I PA UART Signal Signal O VDC Voltage Start Bit low Stop Bit high Time er XBee DigiMesh 2 4 serial buffers The XBee devices maintain buffers to collect serial and RF data that they receive The serial receive buffer collects incoming serial characters and holds them until the device can process them The serial transmit buffer collects the data it receives via the RF link until it transmits that data out the serial port The following figure shows the process of device buffers collecting received serial data Serial Receiver Transmitter Buffer RF Switch Processor Antenna Port XBee DigiMesh 2 4 serial buffer issues There are potential overflow and dropped packet issues which the following section describes Serial receive buffer Under certain conditions the device may not be able to process data in the serial receive buffer immediately If a host sends large amounts of serial data to the device the device may require CTS flow XBee DigiMesh 2 4 User Guide 34 Serial flow control control to avoid overflowing the serial receive buffer Cases in which the serial receive buffer may become full and possibly overflow 1 If the device receives a continuous stream of RF da
145. ween a potential coordinator and a non coordinator is that a non coordinator node has its SO parameter set so that it will not participate in coordinator election and thus cannot ever be a sleep coordinator Asynchronous modes e Do not use asynchronous sleep modes in a synchronous sleeping network and vice versa e Use the asynchronous sleep modes to control the sleep state on a device by device basis e Do not use devices operating in Asynchronous sleep mode to route data e We strongly encourage you to set asynchronous sleeping devices as end devices using the CE command This prevents the node from attempting to route data Synchronous modes Synchronous sleep makes it possible for all nodes in the network to synchronize their sleep and wake times All synchronized cyclic sleep nodes enter and exit a low power state at the same time This forms a XBee DigiMesh 2 4 User Guide 59 Normal mode cyclic sleeping network e Adevice acting as a sleep coordinator sends a special RF packet called a sync message to synchronize nodes e To make a device in the network a coordinator a node uses several resolution criteria e The sleep coordinator sends one sync message at the beginning of each wake period The coordinator sends the sync message as a broadcast and every node in the network repeats it e You can change the sleep and wake times for the entire network locally by changing the settings on an individual device The network use
146. with a larger keepout area H H Notes 1 Non metal enclosures are recommended For metal enclosures an external antenna should be used 2 Metal chassis or mounting structures in the keepout area should be at least 1 inchi2 54 cm from antenna 3 Maximize distance between antenna and metal objects that might be mounted in keepout area 4 These keepout area guidelines do not apply for Wire Whip antennas or external RF connectors Wire J Whip antennas radiate best over the center of a ground plane K K REV ECO DESCRIPTION OF CHANGE BY CKD APPR DATE TITLE APPROVALS DATE DESIGNED Keepout Area for DRAWN Embedded PCB Antenna L CHECKED ENGINEER PART NO REV Digi International Inc 1 2 3 4 All rights reserved DO NOT SCALE DRAWING SHEET 1 of 1 XBee DigiMesh 2 4 User Guide 23 XBee DigiMesh 2 4 DC characteristics XBee DigiMesh 2 4 DC characteristics The following table displays the DC characteristics VCC 2 8 3 4 VDC Symbols Parameter Condition Min Typical Max Units Vi Input low voltage All digital inputs LAT Input high voltage All digital inputs Mai Output low voltage loi 2 mA VCC gt 3 0 V Naia Output high voltage or 2 mA VCC gt 3 0 V Ning Input leakage ViN VCC or GND all inputs per current pin XBee DigiMesh 2 4 ADC operating characteristics The following table displays the ADC timing and performance characteristics Symbols Parameter Condition Min Typical Max Units VREFH V
147. with networked devices Network commissioning and diagnostics 2222 ne 37 Configuring devices scenes es os ose A So A ac sac 37 Configure a device remotely ooo eee 37 Send a remote command eek susedi ar E uNe eee eee ee enna cece NEUSE NER 37 Apply changes on remote devices 38 XBee DigiMesh 2 4 User Guide 4 Respond to remote command requests 38 Establish and maintain network links e cece eee ceeeececeeeeeeeeeee 38 Build aggregate routes 38 Examples e tcs a ba al da Le A te tt ose te Ate ead 39 Replace nodes 21 2 0 ieee cee ccccccc cs 40 Test links ina network c cece af cece cece cece cece ean EG orai 40 Transparent operating mode configuration AP 0 iii 4l API operating mode configuration AP 1 or AP 2 e cece eeeeee 41 Test links between adjacent devices 41 A A es ee ey ee ponte eee eases Rees Aa nected 42 AN a OFS ri tr fe fee eae os nk See Suede ee See ee 43 Discover devices 44 Traceroute Opticos conri bo 44 NACK MESSAGES etch ad APA AAP 46 The Commissioning Pushbutton 0000 022222 e eee cece cece cece cece cece cece cece ee ceeeeeeeees 46 Monitor I O lines 0 2 22 eco cee eee eee e cece cece ce ceeeecceeececeeeseceeeeeceeecteeesteeeeeeees 49 Queried sampling eee 49 Periodic I O sampling 222 2822 la bats sedssdude el iE rE SSES EL ES eee tie ue Ns Ayala alaala 51 Detect digital I O changes cnc 52 DigiMesh ne
148. y Back off eee 97 S Operating Sleep Time 98 OW Operating Wake Time 2 2 0 cc ccc cece cence eee ene eee eee e ence ee eee enneceeeeeeenneeeeees 98 PL TX Power Level 0 2 2 2 cece ccc eee ccc eee ccc eee ccc eee ceeeeeeeeeesceeeeseceecseeeeeteeeeseesees 98 PR Pull up Resistor Enable e eee e eee c cece aiani naan nr rrna 100 RE kaan DEUR kaser q be ce paa a I ce eet o dle 100 O Packetization Timeout _ 2 222 eee cece cee eee eee ccc DALALDALA LLALLA DA a aoaaa 101 P RSSI PWM Timer nn cnn 101 R Unicast Retries eee 101 et ENDON 02222222 a2 aa nie rosas e OA DONG ieee id o SE aa 102 H Serial Number High 0 000000222 aaa 102 SL ro Number LOW c cece cece nro 102 NENE AL ve ck nate satelite nos elon sade leis eae ale hide eid as Seine eee bebe detente es 102 N Number of Cycles Between ON SLEEP 103 O Sleep Options uu 2220002022 Pe ees ne es oa eee Asad Bue e rats Sarees ae 104 sp See IME oo oe ses at EAEI AA 104 Q Missed Sleep Sync Count e cece diaaa naaraana rnanan 105 igan SECS Aa Sic ae cere tea ak MAT AA AS Na Soh ate ees 105 ST Wake Time a 106 R Transmission Failure Count aaao 2 0 2 eee cece eee cece cece cece LLALA LALALA DaDa a anan anan 106 A Unicasts Attempted Count 106 VL Version Long 211005 ag LY LTD Nan ee correu LE NG ra tii eie aiaa 107 XBee DigiMesh 2 4 User Guide 8 VR Firmware Version 2 22
149. y based on board layout and the type and magnitude of the activity Data transmission and reception during data conversion may cause some degradation of these specifications depending on the number and timing of packets It is advisable to test the ADCs in your installation if best accuracy is required 2RAS is the real portion of the impedance of the network driving the analog input pin Values greater than this amount may not fully charge the input circuitry of the ATD resulting in accuracy error 3The resolution is the ideal step size or 1LSB Voce p 1024 Differential non linearity is the difference between the current code width and the ideal code width 1LSB The current code width is the difference in the transition voltages to and from the current code Integral non linearity is the difference between the transition voltage to the current code and the adjusted ideal transition e for the current code The adjusted ideal transition voltage is Current Code 1 2 1 Ve ee yt Eco Ver E 678ro a error is the difference between the transition to the first a code and the ideal transition to that code The Ideal transition voltage to a given code is Code 1 2 1 V TEull scale error is the difference between the transition to the sa VI code and the ideal transition to that code The ideal transition voltage to a given code is Code 1 2 1 V 8Input leakage error is error due to input leakage across the reek RE of the impedance of the n
150. ytes have any meaning in the sample set If do not enable any digital IO on the device it omits these two bytes Following the digital IO data if there is any each enabled analog channel returns two bytes The data starts with AINO and continues sequentially for each enabled analog input channel up to AIN5 If you issue the IS command using an API frame then the device returns an AT Command Response 0x88 frame with the IO data included in the command data portion of the packet Example Sample AT response Ox01 r_ 1 sample set Ox0COC r Digital Inputs DIO 2 3 10 11 enabled 0x03 r Analog Inputs A D 0 1 enabled 0x04081r Digital input states DIO 3 10 high DIO 2 11 low 0x03D0 r Analog input ADIO 0 0x3D0 0x01241r Analog input ADIO 1 0x120 Periodic I O sampling Periodic sampling allows a device to take an I O sample and transmit it to a remote module at a periodic rate You set the periodic sample rate with the IR command e Todisable periodic sampling set IR to 0 e For all other IR values the firmware samples data when IR milliseconds elapse and the sample transmits to a remote device The DH and DL commands determine the destination address of the O samples Only devices with API operating mode enabled will send I O data samples out their UART Devices that are not in API operating mode discard the I O data samples they receive A device with sleep enabled transmits periodic O sam

XBee DigiMesh 2.4 RF Modules User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents