Home

XBee/XBee-PRO DigiMesh 2.4 User Guide

1. Frame Fields Offset Example Description RF Data 17 0x54 Data that is sent to the destination device 18 0x78 19 0x44 20 0x61 21 0x74 22 0x61 23 0x30 24 0x41 Checksum 25 0x13 OxFF the 8 bit sum of bytes from offset 3 to this byte Example The example above shows how to send a transmission to a module where escaping is disabled AP 1 with destination address 0x0013A200 40014011 payload TxData0A If escaping is enabled AP 2 the frame should look like x7E x0 x16 x1 x01 x00 Ox7D x33 OxA2 0x00 Ox40 Ox A 0x01 0x27 xFF xFE x Q x0Q x54 Qx78 x44 x61 0x74 0x61 0x30 0x41 Ox7D 0x33 The checksum is calculated on all non escaped bytes as OxFF sum of all bytes from API frame type through data payload Explicit addressing command frame Frame type 0x11 Allows application layer fields endpoint and cluster ID to be specified for a data transmission Similar to the Transmit Request but also requires application layer addressing fields to be specified endpoints cluster ID profile ID An Explicit Addressing Request API frame causes the module to send data as an RF packet to the specified destination using the specified source and destination endpoints cluster ID and profile ID The 64 bit destination address should be set to 0x000000000000FFFF for a broadcast transmission to all devices For unicast transmissions the 64 bit address field should be set to the address of the desired
2. Force Sample Forces a read of all enabled digital and analog input lines n a n a 1S XBee Sensor Sample Forces a sample to be taken on an XBee Sensor device This command can only be issued to an XBee Sensor device using an API remote command XBee XBee PRO DigiMesh 2 4 User Guide 66 Sleep Sleep AT Command Name and Description Parameter Range Default SM Sleep Mode Set read the sleep mode of the module 0 1 4 5 7 8 0 0 No sleep mode enabled 1 Pin sleep In this mode the sleep wake state of the module is controlled by the SLEEP_RQ line 4 Asynchronous cyclic sleep In this mode the module periodically sleeps and wakes based on the SP and ST commands 5 Asynchronous cyclic sleep with pin wake up When the SLEEP_REQUEST pin is asserted the module will enter a cyclic sleep mode similar to SM 4 When the SLEEP_REQUEST pin is de asserted the module will immediately wake up The module will not sleep when the SLEEP_REQUEST pin is de asserted 7 Sleep support mode 8 Synchronous cyclic sleep mode SO Sleep Options Set read the sleep options of the module This Any of the 0x02 command is a bitmask available sleep For synchronous sleep modules the following sleep options are option bits can defined be set or cleared bit 0 Preferred sleep coordinator BILD once cannot be set at bit 1 Non sleep coordinator the same time bit 2 Enable API sleep status messages bit 3 Disable
3. XBee XBee PRO DigiMesh 2 4 User Guide 45 XBee asynchronous sleep operation XBee asynchronous sleep operation DigiMesh wake timer In cyclic sleep mode SM 4 or SM 5 if serial or RF data is received the module starts a sleep timer time until sleep Any data received serially or by RF link resets the timer The timer duration can be set using the ST command The module returns to sleep when the sleep timer expires DigiMesh sleeping routers The Sleeping Router feature of DigiMesh 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 cyclic sleeping network Nodes synchronize by receiving a special RF packet called a sync message which is sent by a node acting as a sleep coordinator Anode in the network can become a sleep coordinator through a process called nomination The sleep coordinator sends one sync message at the beginning of each wake period The sync message is sent as a broadcast and repeated by every node in the network The sleep and wake times for the entire network can be changed by locally changing the settings on an individual node The network will use the most recently set sleep settings Coordinating sleep modes in the DigiMesh network One node in a sleeping network acts as the sleeping coordinator The process by which a node becomes a sleep coordinator is described later in this
4. 13 OxFE Source Endpoint 14 OxEO Endpoint of the source that initiated the transmission Destination Endpoint 15 OxEO Endpoint of the destination the message is addressed to Cluster ID 16 0x22 Cluster ID the packet was addressed to 17 0x11 Profile ID 18 0xC1 Profile ID the packet was addressed to 19 0x05 Receive Options 20 0x02 Bitfield XBee XBee PRO DigiMesh 2 4 User Guide 0x01 Packet acknowledged 0x02 Packet was a broadcast packet All other bits are reserved and should be ignored 89 XBee AP frame specifications Frame Fields Offset Example Description Received Data 21 0x52 Received RF data 22 0x78 23 0x44 24 0x61 25 0x74 26 0x61 Checksum 27 0x56 OxFF the 8 bit sum of bytes from offset 3 to this byte Example In the example above a device with a 64 bit address of 0x0013A200 40522BAA sends a broadcast data transmission to a remote device with payload RxData Suppose the transmission was sent with source and destination endpoints of OxE0 cluster ID 0x2211 and profile ID 0xC105 If AO 1 on the receiving device it would send the above frame out its UART Data sample Rx indicator Frame type 0x92 When you enable Periodic I O Sampling or Digital I O Change Detect on a remote node the UART of the modem receiving the sample data sends this message type out Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB
5. 4 18dBm RR Unicast Mac Retries Set Read the maximum number of 0 OxF OxA MAC level packet delivery attempts for unicasts If RR is non zero packets sent from the radio will request an acknowledgment and can be present up to RR times if no acknowledgments are received ED Energy Detect Start an Energy Detect Scan This 0 0x3A98 parameter is the time in milliseconds to scan all channels The Module will loop through all the channels until the time elapses The maximal energy on each channel is returned and each value is followed by a comma with the list ending with a carriage return The values returned reflect the detected energy level in units of dBm XBee XBee PRO DigiMesh 2 4 User Guide 55 Diagnostics AT Command BC Name and Description Bytes Transmitted The number of RF bytes transmitted This count is incremented for every PHY level byte transmitted The purpose of this count is to estimate battery life by tracking time spent doing transmissions This number rolls over to zero from OxFFFF The counter can be reset to any 16 bit value by appending a hexadecimal parameter to the command Parameter Range O to OxFFFF Diagnostics Default 0 DB Received Signal Strength This command reports the received signal strength of the last received RF data packet The DB command only indicates the signal strength of the last hop It does not provide an accurate quality measurement for a multihop li
6. 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 Figure A 01 XBee PRO RF Modules may only be used with antennas that have been tested and approved for use with this module refer to the antenna tables in this section OEM labeling requirements requirements are met This includes a clearly visible label on the outside of the final CAUTION The Original Equipment Manufacturer OEM must ensure that FCC labeling A product enclosure that displays the contents shown in the figure below Required FCC Label for OEM products containing the XBee PRO RF Module 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 The FCC ID for the XBee is OUR XBEE The FCC ID for the XBee PRO is OUR XBEEPRO 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 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 amp 15 109
7. 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 will be used for portable applications the following applies XBee XBee PRO DigiMesh 2 4 User Guide 98 United States FCC 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 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 and on the user is encouraged to try to correct the interference by one or more of the following measures Re orient or relocate the receiving antenna increase th
8. high 6 9 Alternate functionalities where applicable Setting the configuration command that corresponds to a particular pin will configure the pin Module Pin Names Module Pin Number Configuration Command CD DIO12 4 P2 PWMO RSSI DIO10 6 PO PWM1 DIO11 7 P1 DTR SLEEP_RQ DIO8 9 D8 AD4 DIO4 11 D4 CTS DIO7 12 D7 ON_SLEEP DIO9 13 D9 ASSOC AD5 DIO5 15 D5 RTS DIO6 16 D6 AD3 DIO3 17 D3 AD2 DIO2 18 D2 AD1 DIO1 19 D1 ADO DIOO Commissioning Button 20 DO XBee XBee PRO DigiMesh 2 4 User Guide 36 XBee XBee PRO DigiMesh 2 4 I O line monitoring See the command table for more information Use the PR command to enable the pullup resistors for each digital input 1 Sample Sets Number of sample sets in the packet Always set to 1 2 Digital Channel Mask Indicates which digital IO lines have sampling enabled Each bit corresponds to one digital IO line on the module bit 0 ADO DIOO bit 1 AD1 DI01 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 DIOO 1 2 3 and 5 are enabled as digital IO 1 Analog Channel Mask Indicates which lines have analog inputs enabled for sampling Each bit in the analog channel mask correspo
9. send the Write WR command This allows XBee XBee PRO DigiMesh 2 4 User Guide 25 Command mode modified parameter values to persist in the module s registry after a reset Otherwise parameters are restored to previously saved values after the module is reset Command response When a command is sent to the module the module will parse and execute the command Upon successful execution of a command the module returns an Ok message If execution of a command results in an error the module returns an ERROR message Applying command changes Any changes made to the configuration command registers through AT commands do not take effect until the changes are applied For example sending the BD command to change the baud rate will not change the actual baud rate until changes are applied Changes can be applied in one of the following ways Issue the Apply Changes AC command Exit AT Command Mode To Exit AT Command mode 1 Send the Exit Command Mode ATCN command followed by a carriage return OR 2 If no valid AT Commands are received within the time specified by Command Mode Timeout CT command the RF module automatically returns to Idle Mode For an example of programming the RF module using AT Commands and descriptions of each configurable parameter see XBee XBee PRO command reference tables on page 54 Sleep Mode Sleep modes allows the RF module to enter states of low power consumption when not in
10. 2 4 User Guide n a 69 AT command options AT command options AT Parameter Command Name and Description Range Default CC Command Character Set or read the character to be used between 0 0xFF 0x2B ASCII guard times of the AT Command Mode Sequence The AT Command character Mode Sequence causes the radio module to enter Command Mode from Idle Mode CT Command Mode Timeout Set Read the period of inactivity no valid 2 0x1770 0x64 commands received after which the RF module automatically exits x 100ms 10 seconds AT Command Mode and returns to Idle Mode CN Exit Command Mode Explicitly exit the module from AT Command Mode GT Guard Times Set required period of silence before and after the Oto OxFFFF 0x3E8 Command Sequence Characters of the AT Command Mode x ims 1 second Sequence GT CC GT The period of silence is used to prevent inadvertent entrance into AT Command Mode Firmware commands firmware version information AT Command Name and Description Parameter Range Default VL Version Long Shows detailed version information including application build date and time VR Firmware Version Read firmware version of the module O OXFFFFFFFF Firmware read only set HV Hardware Version Read hardware version of the module O OXFFFF Factory set read only DD Device Type Identifier Stores a device type value This value can 0O OxFFFFFFFF 0x50000 be u
11. Flat Panel 15 0 dBi Fixed 2m 15 1 dB A24 P16NF Flat Panel 16 0 dBi Fixed 2m 16 1 dB A24 P19NF Flat Panel 19 0 dBi Fixed 2m 19 1 dB If 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 20cm 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 A affect the person RF Exposure CAUTION 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 XBee PRO DigiMesh 2 4 User Guide 102 United States FCC The preceding statement must be included as a CAUTION statement in OEM product manuals in order to alert users of FCC RF Exposure compliance E
12. I O settings Default 0 D5 ADS5 DIOS ASSOCIATE Configuration pin 15 0 Disabled 1 Associated indicator 2 ADC 3 Digital input 4 Digital output low 5 Digital output high 0 1 2 3 4 5 D6 DIO6 RTS Configuration pin 16 0 Disabled 1 RTS flow control 2 N A 3 Digital input 4 Digital output low 5 Digital output high 0 1 3 4 5 D7 DIO7 Configuration pin 12 0 Disabled 1 CTS flow control 2 N A 3 Digital input 4 Digital output low 5 Digital output high 6 RS 485 Tx enable low TX Ov on transmit high when idle 7 RS 485 Tx enable high TX high on transmit OV when idle 0 1 2 3 4 5 6 7 D8 DIO8 SLEEP_REQUEST Configuration pin 9 0 Disabled 1 Sleep request 2 N A 3 Digital input 4 Digital output low 5 Digital output high XBee XBee PRO DigiMesh 2 4 User Guide 0 1 3 4 5 63 AT Command D9 Name and Description DIO9 ON Configuration pin 13 0 Disabled 1 ON output 2 N A 3 Digital input 4 Digital output low 5 Digital output high Parameter Range 0 1 3 4 5 I O settings Default 1 PO DIO10 RSSI PWMO Configuration pin 6 0 Disabled 1 RSSI PWMO output 2 PWMO output 3 Digital input 4 Digital output low 5 Digital output high 0 1 2 3 4 5 P1 DIO11 PWM1 Configuration pin 7 0 Disabled 1 N A 2 PWMO out
13. In most cases we suggest that these parameters not be modified from their default values Decreasing these parameters for small networks can improve battery life but care should be taken so that the values are not made too small XBee XBee PRO DigiMesh 2 4 User Guide 49 XBee asynchronous sleep operation 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 This number can be estimated with the following formula SMPT NN NH MT 1 18ms Select desired duty cycle The ratio of sleep time to wake time is the factor that has the greatest effect on the RF module s power consumption Battery life can be estimated based on the following factors sleep period wake time sleep current RX current TX current and battery capacity Choose sleep period and wake time The wake time needs to be long enough to transmit the desired data as well as the sync message The ST parameter will automatically adjust upwards to its minimum value when other AT commands are changed that will affect it SP NN and NH Use a value larger than this minimum If a module 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 a few sync messages to be missed and still have time for normal data transmissions Starting a sleeping DigiMesh net
14. MR is non zero packets sent will request a network acknowledgment and can be resent up to MR 1 times if no acknowledgments are received Name and Description Serial Number High Read high 32 bits of the RF module s unique IEEE 64 bit address 64 bit source address is always enabled This value is read only and it never changes Oto 7 Parameter Range 0 OxFFFFFFFF Default Factory SL Serial Number Low Read low 32 bits of the RF module s unique IEEE 64 bit address 64 bit source address is always enabled This is read only and it is also the serial number of the node 0 OxFFFFFFFF Factory DH Destination Address High Set Get the upper 32 bits of the 64 bit destination address When combined with DL it defines the destination address used for transmission XBee XBee PRO DigiMesh 2 4 User Guide 0 OxFFFFFFFF 57 AT Command DL Name and Description Destination Address Low Set Get the lower 32 bits of the 64 bit destination address When combined with DH DL defines the destination address used for transmission Parameter Range 0 OxFF x 100 ms Addressing Default 0x0000FF FF NI Node Identifier Stores a string identifier The string accepts only printable ASCII data in AT Command Mode the string can not start with a space A carriage return or comma ends the command Command will automatically end when maximum bytes for the string have been entered This
15. PRO DigiMesh 2 4 API operation on page 72 XBee XBee PRO DigiMesh 2 4 User Guide 23 Idle mode Idle mode When not receiving or transmitting data the RF module is in idle mode During Idle Mode the RF module is checking for valid RF data The module shifts into the other modes of operation under the following conditions Transmit Mode Serial data in the serial receive buffer is ready to be packetized Receive Mode Valid RF data is received through the antenna Command Mode Command Mode Sequence is issued Sleep Mode A device is configured for sleep Transmit mode The RF module will exit Idle Mode and attempt to transmit the data when serial data is received and is ready for packetization The destination address determines which node s will receive the data If Clear Channel Assessment is enabled see the ATCA command then an energy level reading will be performed on the channel to determine if the channel is available for transmission The detected energy on the channel is compared with the CA Clear Channel Assessment parameter value If the detected energy exceeds the CA parameter value the packet is not transmitted Note Customers in Europe who have the XBee DigiMesh 2 4 module must manage their CCA settings See the ATCA command for appropriate values If a route is not known the mesh firmware will perform route discovery to establish a route to the destination node If a module with a matching network addres
16. ST1 and SP2 ST2 are the desired sleep settings and N is an integer XBee XBee PRO DigiMesh 2 4 User Guide 51 XBee asynchronous sleep operation Rejoining nodes that have lost sync Mesh networks get their robustness from taking advantage of routing redundancies which may be available in a network It is recommended to architect the network with redundant mesh nodes to increase robustness If a scenario exists such that 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 catastrophic failure condition then multiple subnets may arise while 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 modules to fix the problem and prevent it from occurring in the future When the default DigiMesh sleep parameters are used separated subnets will not drift out of phase with each other Subnets can drift out of phase with each other if the network is configured in one of the following ways If multiple modules in the network have had the non sleep coordinator sleep option bit disabled and are thus eligible to be nominated as a sleep coordinator Ifthe modules in the network are not using the auto early wake up sleep option If a network has multiple subnets that have drifted out of phase with each other get the subnets back i
17. Standard Data Frames 0x90 for RF RX 1 Explicit Addressing Data Frames 0x91 for RF RX XBee XBee PRO DigiMesh 2 4 User Guide 61 I O settings I O settings AT Command Name and Description Parameter Range Default CB Commissioning Pushbutton This command canbe used to 0 4 n a simulate commissioning button presses in software The parameter value should be set to the number of button presses to be simulated For example sending the ATCB1 command will execute the action associated with one commissioning button press DO ADO DIOO COMMISSIONING Configuration pin 20 0 1 2 3 4 5 1 0 Disabled 1 Commissioning button 2 ADC 3 Digital input 4 Digital output low 5 Digital output high D1 AD1 DIO1 Configuration pin 19 0 2 3 4 5 0 0 Disabled 1 N A 2 ADC 3 Digital input 4 Digital output low 5 Digital output high D2 AD2 DIO2 Configuration pin 18 0 2 3 4 5 0 0 Disabled 1 N A 2 ADC 3 Digital input 4 Digital output low 5 Digital output high D3 AD3 DIO3 Configuration pin 17 0 2 3 4 5 0 0 Disabled 1 N A 2 ADC 3 Digital input 4 Digital output low 5 Digital output high XBee XBee PRO DigiMesh 2 4 User Guide 62 AT Command D4 Name and Description AD4 DIO4 Configuration pin 11 0 Disabled 1 N A 2 ADC 3 Digital input 4 Digital output low 5 Digital output high Parameter Range 0 2 3 4 5
18. Vn VCC or GND all inputs per 0 5 pA pin Symbol Parameter Condition Min Typical Max Units VREFH VREF analog to digital 2 08 VDDAD V converter reference range IREF VREF reference supply Enabled 200 pA current l Disabled or sleep mode lt 0 01 0 02 pA Vinpc Analog input voltage Vssap 0 3 Vssap 0 3 V XBee XBee PRO DigiMesh 2 4 User Guide 17 XBee XBee PRO DigiMesh 2 4 electrical characteristics Maximum electrical operating range not valid conversion range Symbol Parameter Condition Min Typical Max Units Ras Source impedance at input s 5 10 ko VAIN Analog input voltage VREFL VrerH V RES Ideal resolution 1 LSB 2 08V gt Vppan gt 3 6V 2 031 3 516 mV DNL Differential non linearity 0 5 1 0 LSB INL Integral non linearity 0 5 1 0 LSB Ezs Zero scale error 0 4 1 0 LSB Fes Full scale error 0 4 1 0 LSB Ei Input leakage error 0 05 5 0 LSB Etu Total unadjusted error 1 1 2 5 LSB 8 9 All 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 Vper Failure to observe these guidelines may result in system or microcontroller noise causing accuracy errors which will vary based on board layout and the type and magnitude of the activity Data transmiss
19. XBee Module Antenna type 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 Antenna type 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 Antenna type 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 XBee PRO RF module at 10 dBm Transmit Power PL parameter value must equal 0 or use international variant The following antennas have been tested and approved for use with the embedded XBee PRO RF Module Dipole 2 1 dBi Omni directional Articulated RPSMA Digi part number A24 HABSM Chip Antenna 1 5 dBi Attached Monopole Whip 1 5 dBi The RF modem encasement was designed to accommodate the RPSMA antenna option Canada IC Labeling requirements Labeling requirements for Industry Canada are similar to those of the FCC A clearly visible label on the outside of the final product enclosure must display 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
20. XBee XBee PRO DigiMesh 2 4 User Guide 56 Network AT Command CE Name and Description Node Type Set read the node networking type A module set as an end device will not propagate broadcasts and won t become and intermediate node on a route Parameter Range O Router 2 End Device Network Default 0 BH Broadcast Radius Set read the transmission radius for broadcast data transmissions Set to 0 for maximum radius If BH is set greater than NH then the value of NH is used 0 0x20 NH Network Hops Set or read the maximum number of hops expected to be seen in a network route This value doesn t limit the number of hops allowed but it is used to calculate timeouts waiting for network acknowledgments 1 to 0x20 DM DigiMesh Options Bitfield mask which can be used to enables or disable DigiMesh features Bit 0 Disable aggregator update When enabled the module will neither issue nor respond to AG requests 1 Disable Trace Route and NACK responses When enabled the module will neither generate nor respond to Trace Route or NACK requests 0 0x03 bitfield 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 13ms 1 to Ox0A MR Addressing AT Command SH Mesh Network Retries Set or read the maximum number of network packet delivery attempts If
21. able to respond to sync requests promptly 2 Asleeping cyclic sleep node in the network can be woken by the commissioning button Place the new node in range of the existing cyclic sleep node and wake the existing node by holding down the commissioning button for 2 seconds or until the node wakes The existing node stays awake for 30 seconds and will respond 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 The new node should be placed in range of the network with a sleep wake cycle that is shorter than the wake period of the network The new node will periodically send sync requests until the network wakes up and it receives a sync message Changing sleep parameters Changes to the sleep and wake cycle of the network can be made by selecting any node in the network and changing the SP and or ST of the node to values different than those the network is currently using If using a preferred sleep coordinator or if it is known which node is acting as the sleep coordinator it is suggested that this node be used to make changes to network settings If the network sleep coordinator is not known any node that does not have the non sleep coordinator sleep option bit set see the SO command can be used When changes are made to a node s sleep parameters that node will become the network s sleep coordinator unless it has the non sleep coordinator option
22. broadcast transmission to be sent at the beginning of the next network wake cycle All devices that receive this transmission will blink their Associate LEDs rapidly for 1 second All API devices that receive this transmission will send a Node Identification frame out their UART API ID 0x95 2 Not configured for No effect synchronous sleep XBee XBee PRO DigiMesh 2 4 User Guide 34 Button Presses 2 XBee network commissioning and diagnostics Sleep Configuration and Sync Status Action Configured for Causes a node which is configured with sleeping router nomination synchronous sleep enabled see the description of the ATSO sleep options command in the XBee module s Product Manual to immediately nominate itself as the network sleep coordinator Any Issues an ATRE to restore module parameters to default values Using the ATCB command button presses can be simulated in software Issue the ATCB with a parameter set to the number of button presses to execute for example sending ATCB1 will execute the action s associated with a single button press The node identification frame is similar to the node discovery response frame it contains the device s address node identifier string NI command and other relevant data All API devices that receive the node identification frame send it out their UART as an API Node Identification Indicator frame 0x95 Having the commissioning button enabled during sleep
23. command can be used to query the current operational sleep and wake times a module is currently using XBee XBee PRO DigiMesh 2 4 User Guide 52 XBee asynchronous sleep operation Sleep status The SS command can be used to query useful information regarding the sleep status of the module This command can be used to query if the node is currently acting as a network sleep coordinator as well as other useful diagnostics Missed sync messages command The MS command can be used to query the number of cycles that have elapsed since the module last received a sync message Sleep status API messages When enabled with the SO command a module configured in API mode will output modem status frames immediately after a module wakes up and just prior to a module going to sleep XBee XBee PRO DigiMesh 2 4 User Guide 53 XBee XBee PRO command reference tables Special AT Command Name and Description Parameter Range Default AC Apply Changes Immediately applies new settings without exiting command mode FR Software Reset Reset module Responds immediately with an OK then performs a reset 100ms later RE Restore Defaults Restore module parameters to factory defaults WR Write Write parameter values to non volatile memory so that parameter modifications persist through subsequent resets Note Once WR is issued no additional characters should be sent to the module until after the
24. cycle Bit 4 This bit will be true if the user has altered the sleep settings on the module so that the node will nominate itself and send a sync message with the new settings at the beginning of the next wake cycle Bit 5 This bit will be true if the user has requested that the node nominate itself as the sleep coordinator using the commissioning button or the CB2 command All other bits Reserved All non documented bits can be any value and should be ignored Bit 6 This bit will be true if the node is currently in deployment mode All other bits Reserved All non documented bits can be any value and should be ignored n a n a OS Operational Sleep Period Read the sleep period that the node is currently using This number will oftentimes be different from the SP parameter if the node has synchronized with a sleeping router network Units of 10mSec n a OW Operational Wake Period Read the wake time that the node is currently using This number will oftentimes be different from the ST parameter if the node has synchronized with a sleeping router network Units of 1 ms n a MS Number of Missed Syncs Read the number of wake cycles that have elapsed since the last sync message was received SQ Missed Sync Count Count of the number of syncs that have been missed This value can be reset by setting ATSQ to 0 When the value reaches OxFFFF it will not be incremented anymore XBee XBee PRO DigiMesh
25. dBi Fixed 2m 8 dB A24 P16NF Flat Panel 16 0 dBi Fixed 2m 9 dB XBee RF module high gain antenna summary The following antenna types have been tested and approved for use with the XBee Module Antenna Type Yagi RF Module was tested and approved with 15 dBi antenna gain with 7 9 dB cable loss Any Yagi type antenna with 7 1 dBi gain or less can be used with no cable loss Antenna Type Omni directional RF Module was tested and approved with 15 dBi antenna gain with 5 7 dB cable loss Any Omni directional antenna with 9 3 dBi gain or less can be used with no cable loss Antenna Type Flat Panel RF Module was tested and approved with 16 dBi antenna gain with 9 0 dB cable loss Any Flat Panel antenna with 7 0 dBi gain or less can be used with no cable loss Antennas approved for use with the XBee PRO DigiMesh 2 4 RF Modules cable loss is required Part Minimum Required Number Type Description Gain Application Separation Cable Loss Yagi Class Antennas A24 Y4NF Yagi 4 element 6 0 dBi Fixed 2m 8 1 dB A24 Y6NF Yagi 6 element 8 8 dBi Fixed 2m 10 9 dB A24 Y7NF Yagi 7 element 9 0 dBi Fixed 2m 11 1 dB A24 YONF Yagi 9 element 10 0 dBi Fixed 2m 12 1 dB A24 Y10NF Yagi 10 element 11 0 dBi Fixed 2m 13 1 dB A24 Y12NF Yagi 12 element 12 0 dBi Fixed 2m 14 1 dB A24 Y13NF Yagi 13 element 12 0 dBi Fixed 2m 14 1 dB A24 Y15NF Yagi 15 element 12 5 dBi Fixed 2m 14
26. discoveries or failures occurred XBee XBee PRO DigiMesh 2 4 User Guide 41 XBee DigiMesh 2 4 transmission timeouts When a node receives an API TX Request API configured modules or an RO timeout occurs modules configured for Transparent Mode the time required to route the data to its destination depends ona number of configured parameters whether the transmission is a unicast or a broadcast and if the route to the destination address is known Timeouts or timing information is provided for the following transmission types Transmitting a broadcast Transmitting a unicast with a known route Transmitting a unicast with an unknown route Transmitting a unicast with a broken route Note The timeouts in this section are theoretical timeouts and not precisely accurate The application should pad the calculated maximum timeouts by a few hundred milliseconds When using API mode Tx Status API packets should be the primary method of determining if a Unicast one hop time A building block of many of the calculations presented below is the unicastOneHopTime As its name indicates it represents the amount of time it takes to send a unicast transmission between two adjacent nodes It is largely dependent upon the mac retry setting RR DigiMesh networks assume that the average number of mac level retries across a multi hop wireless link will be three or less It is defined as follows RR mac retries Unicast One Hop Time
27. e AP 1 API Operation AP 2 API Operation with escaped characters XBee API operation AP parameter 1 When this API mode is enabled AP 1 the UART data frame structure is defined as follows UART data frame structure Start Delimiter Length Frame Data Checksum Byte 1 Bytes 2 3 Bytes 4 n Byte n 1 Ox7E se ise API specific Structure 1 Byte MSB Most Significant Byte LSB Least Significant Byte Any data received prior to the start delimiter is silently discarded If the frame is not received correctly or if the checksum fails the module will reply with a module status frame indicating the nature of the failure XBee API operation with escape characters AP parameter 2 When this API mode is enabled AP 2 the UART data frame structure is defined as follows XBee XBee PRO DigiMesh 2 4 User Guide 72 XBee API frame specifications UART Data Frame Structure with escape control characters Start Delimiter Length Frame Data Checksum Byte 1 Bytes 2 3 Bytes 4 n Byte n 1 Ox7E MSB LSB API specific Structure 1 Byte I Characters Escaped If Needed MSB Most Significant Byte LSB Least Significant Byte XBee escape characters When sending or receiving a UART data frame specific data values must be escaped flagged so they do not interfere with the data frame sequencing To escape an interfering data byte insert 0x7D and follow it with the b
28. endpoint OxE6 If the requesting radio is configured to operate in API mode then the following information will be output as an API Explicit RX Indicator Frame XBee XBee PRO DigiMesh 2 4 User Guide 31 XBee network commissioning and diagnostics Number of Bytes Field Name Description 8 Destination address The address with which the radio tested its link 2 Payload size The size of the test packet that was sent to test the link 2 Iterations The number of packets which were sent 2 Success The number of packets successfully acknowledged 2 Retries The total number of MAC retries used to transfer all the packets 1 Result 0x00 command was successful 0x03 invalid parameter used 1 RR 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 1 avgRSSI The average RSSI reading observed during the test Example Suppose that the link between radio A SH SL 0x0013a20040521234 and radio B SH SL 0x0013a2004052abcd is to be tested by transmitting 1000 40 byte packets The following API packet should be sent to the serial interface of the radio on which the results should be output radio C Radio C can be the same radio as radio A or B whitespace used to delineate fields bold text is the payload portion of the packet 7E 0020 11 01 0013A20040521234 FFFE E6 E6 0014 C105 00 00 0013A2004052ABCD 0
29. in 10ms increments 0 0x14 OxFF x 10ms RP RSSI PWM Timer Time RSSI signal will be output after last transmission When RP OxFF output will always be on XBee XBee PRO DigiMesh 2 4 User Guide O OxFF x 100ms 0x28 4 seconds 65 I O sampling AT Command IC Name and Description I O Digital Change Detection Set Read the digital I O pins to monitor for changes in the I O state IC works with the individual pin configuration commands DO D9 PO P2 If a pin is enabled as a digital input output the IC command can be used to force an immediate I O sample transmission when the DIO state changes IC is a bitmask that can be used to enable or disable edge detection on individual channels Unused bits should be set to 0 Bit I O pin 0 DIO10 1 DIO11 2 DIO12 Parameter Range 0 OxFFFF I O sampling Default 0 Sleep Sample Rate Set read the number of sleep cycles that must elapse between periodic I O samples This allows I O samples to be taken only during some wake cycles During those cycles I O samples are taken at the rate specified by IR 1 OXFF 10 Sample Rate Set Read the I O sample rate to enable periodic sampling For periodic sampling to be enabled IR must be set to a non zero value and at least one module pin must have analog or digital I O functionality enabled see DO D9 PO P2 commands The sample rate is measured in milliseconds O OxFFFF ms
30. or the Trace Route option is enabled Frame Fields Offset Example Description Start 0 Ox7E Delimiter Length MSB 1 0x00 Number of bytes between the length and the checksum LSB2 Ox2A Frame specific Data Frame Type 3 Ox8D Source Event 4 0x12 0x11 NACK 0x12 Trace Route Length 5 0x2B Number of bytes that follow excluding checksum If length increases then new items have been added to the end of the list for future revisions Timestamp MSB6 0x9C System timer value on the node generating the Route Information Packet The time stamp is returned in units of microseconds It can only be used for 7 0x93 relative time measurements because the time stamp counter restarts about 8 0x81 every hour LSB 9 Ox7F XBee XBee PRO DigiMesh 2 4 User Guide 84 XBee AP frame specifications Frame Fields Offset Example Description ACK Timeout 10 0x00 The number of MAC ACK timeouts that occurred Count Reserved 11 0x00 Reserved Reserved 12 0x00 Reserved Destination MSB 0x00 Address of the final destination node of this network level transmission Address 13 14 0x13 15 OxA2 16 0x00 17 0x40 18 0x52 19 OxAA LSB 20 OxAA Source MSB _ 0x00 Address of the source node of this network level transmission Address 21 22 0x13 23 OxA2 24 0x00 25 0x40 26 0x52 27 OxDD LSB 28 OxDD Responder MSB 0x00 A
31. selected and will send a sync message with the new sleep settings to the entire network at the beginning of the next wake cycle The network will immediately begin using the new sleep parameters after this sync is sent Changing sleep parameters increases the chances that nodes will lose sync If a node does not receive the sync message with the new sleep settings it will continue 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 the following precautions can be taken 1 Whenever possible avoid changing sleep parameters 2 Enable the missed sync early wake up sleep option SO This command is used to tell a node to wake up progressively earlier based on the number of cycles it has gone without receiving a sync This will increase the probability that the un synced node will be awake when the network wakes up and sends the sync message Note Using this sleep option increases reliability but may decrease battery life Nodes using this sleep option which miss sync messages will have an increased wake time and decreased sleep time during cycles in which the sync message is missed This will reduce battery conservation 3 When changing between two sets of sleep settings choose settings so that the wake periods of the two sleep settings will happen at the same time In other words try to satisfy the following equation SP1 ST1 N SP2 ST2 where SP1
32. sent up to MR 1 times across the network route and ACKs are transmitted by the receiving node upon receipt If a network ACK is not received within the time it would take for a packet to traverse the network twice a retransmission occurs When sending a DigiMesh Unicast that both MAC and NWK retries acknowledgments are used MAC retries acknowledgments are used for transmissions between adjacent nodes in the route NWK retries acknowledgments are used across the entire route To send Unicast messages set the DH and DL on the transmitting module to match the corresponding SH and SL parameter values on the receiving module Broadcast addressing Broadcast transmissions is received and repeated by all routers in the network Broadcast transmissions do not use ACKs Therefore the originating node will send the broadcast multiple times By default a broadcast transmission is sent four times Essentially 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 a random delay is inserted before each router relays the broadcast message See the NN parameter for details on changing this random delay time Sending frequent broadcast transmissions can quickly reduce the available network bandwidth and as such should be used sparingly The broadcast address is a 64 bit address with the lowest 16 bits set to 1 The upper bits are
33. set to 0 To send a broadcast transmission set DH to 0 and DL to OxFFFF In API mode the destination address would be set to 0x000000000000FFFF XBee XBee PRO DigiMesh 2 4 User Guide 40 Routing A module within a mesh network is able to determine reliable routes using a routing algorithm and table The routing algorithm uses a reactive method derived from Ad hoc On demand Distance Vector AODV An associative routing table is used to map a destination node address with its next hop By sending a message to the next hop address either the message will reach its destination or be forwarded to an intermediate router which will route the message on to its destination A message with a broadcast address is broadcast to all neighbors All routers receiving the message will rebroadcast the message MT 1 times and eventually the message will reach all corners of the network Packet tracking prevents a node from resending a broadcast message more than MT 1 times Route discovery If the source node doesn t have a route to the requested destination the packet is queued to await a route discovery RD process This process is also used when a route fails A route fails when the source node uses up its network retries without ever receiving an ACK This results in the source node initiating RD RD begins by the source node broadcasting a route request RREQ Any router that receives the RREQ that is not the ultimate destination is called an intermediate n
34. the length and the checksum LSB 2 0x12 Frame specific Data Frame Type 3 Ox8E Format ID 4 0x00 Byte reserved to indicate format of additional packet information which may be added in future firmware revisions In the current firmware revision 0x00 is returned in this field XBee XBee PRO DigiMesh 2 4 User Guide 86 XBee AP frame specifications Frame Fields Offset Example Description New Address MSB5 0x00 Address to which DH and DL are being set 6 0x13 7 OxA2 8 0x00 9 0x40 10 0x52 11 OxBB LSB 12 OxBB Old Address 13 0x00 Address to which DH and DL were previously set 14 0x13 15 OxA2 16 0x00 17 0x40 18 0x52 19 OxAA 20 OxAA Checksum 21 Ox2E OxFF the 8 bit sum of bytes from offset 3 to this byte Example In example above a radio which had a destination address DH DL of 0x0013A2004052AAAA updated its destination address to 0x0013A2004052BBBB Receive packet Frame type 0x90 When the module receives an RF packet it is sent out the UART using this message type Frame Fields Offset Example Description Start 0 Ox7E Delimiter Length MSB 1 0x00 Number of bytes between the length and the checksum LSB2 0x12 Frame specific Data Frame Type 3 0x90 XBee XBee PRO DigiMesh 2 4 User Guide 87 XBee AP frame specifications Frame Fields Offset Example Description F
35. through a process called nomination The sleep coordinator will send one sync message at the beginning of each wake period The sync message is sent as a broadcast and repeated by every node in the network The sleep and wake times for the entire network can be changed by locally changing the settings on an individual node The network will use the most recently set sleep settings DigiMesh sleep modes Normal mode SM 0 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 A normal mode module synchronizes to a sleeping network but will not observe synchronization data routing rules it will route data at any time regardless of the wake state of the network When synchronized a normal node will relay sync messages generated by sleep compatible nodes but will not generate sync messages Once a normal node has synchronized with a sleeping network it can be put into a sleep compatible sleep mode at any time Asynchronous pin sleep mode SM 1 Pin sleep allows the module to sleep and wake according to the state of the Sleep_RQ pin pin 9 Enable Pin sleep mode by setting the SM command to 1 When Sleep_RQ is asserted high the XBee XBee PRO DigiMesh 2 4 User Guide 44 DigiMesh sleep modes module will finish any transmit or receive operations and enter a low power state The module wakes from pin sleep when the Sleep_RQ pin is de asserted low Async
36. use XBee RF modules support both pin sleep sleep mode entered on pin transition and cyclic sleep module sleeps for a fixed time XBee XBee PRO DigiMesh 2 4 sleep modes on page 44discusses XBee sleep modes in detail XBee XBee PRO DigiMesh 2 4 User Guide 26 XBee XBee PRO DigiMesh 2 4 advanced application features XBee remote configuration commands A module in API mode has provisions to send configuration commands to remote devices using the Remote Command Request API frame see XBee XBee PRO DigiMesh 2 4 API operation on page 72 You can use this API frame to send commands to a remote module to read or set command parameters Sending a remote command To send a remote command the Remote Command Request frame should be populated with the 64 bit address of the remote device the correct command options value and the command and parameter data optional If a command response is desired the Frame ID should be set to a non zero value Only unicasts of remote commands are supported Remote commands cannot be broadcast Applying changes on remote devices When remote commands are used to change command parameter settings on a remote device parameter changes do not take effect until the changes are applied For example changing the BD parameter will not change the actual serial interface rate on the remote until the changes are applied Changes can be applied using remote commands in one of three ways Set the apply changes op
37. with variable sleep and wake times DigiMesh networking concepts Device configuration DigiMesh modules can be configured to act as routers or end devices with the CE command By default all modules in a DigiMesh network act as routers Modules configured as routers actively relay network unicast and broadcast traffic as described below XBee XBee PRO DigiMesh 2 4 User Guide 39 Network ID DigiMesh networks are defined with a unique network identifier This identifier is set with the ID command For modules to communicate they must be configured with the same network identifier The ID parameter allows multiple DigiMesh networks to co exist on the same physical channel Operating channel DigiMesh modules utilize direct sequence spread spectrum modulation and operate on a fixed channel There are 16 operating channels defined in the 2 4 GHz frequency band XBee modules support all 16 channels and XBee PRO modules support 12 of the 16 channels The operating channel on a module is selected using the CH command For modules to communicate the channel CH and network identifier ID must be equal on all modules in the network DigiMesh data transmission and routing Unicast addressing When transmitting while using DigiMesh Unicast communications reliable delivery of data is accomplished using retries and acknowledgments The number of mesh network retries is determined by the MR Mesh Network Retries parameter RF data packets are
38. 0 unicastOneHopTime 5 ms 1 unicastOneHopTime 24 ms 2 unicastOneHopTime 40 ms 3 unicastOneHopTime 63 ms Transmitting a broadcast A broadcast transmission must be relayed by all routers in the network The maximum delay would be 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 Transmitting a unicast with a known route When a route to a destination node is known the transmission time is largely a function of the number of hops and retries The timeout associated with a unicast assumes the maximum number of hops is necessary as specified by NH The timeout can be estimated in the following manner knownRouteUnicast 2 NH MR unicastOneHopT ime XBee XBee PRO DigiMesh 2 4 User Guide 42 Transmitting a Unicast with an unknown route If the route to the destination is not known the transmitting module will begin by sending a route discovery If the route discovery is successful and a route is found then the data is transmitted The timeout associated with the entire operation can be estimated as follows unknownRouteUnicast BroadcastTxTime NH unicastOneHopTime knownRouteUnicast Transmitting a Unicast with a broken route If the route to a destination node has changed since the last time a route discovery was completed a node will begin by attempting to send the data along the previous route Afte
39. 028 03E8 EB And the following is a possible packet that could be returned 7E 0027 91 0013A20040521234 FFFE E6 E6 0094 C105 00 0013A2004052ABCD 0028 03E8 03E7 0064 00 0A 50 53 52 9F 999 out of 1000 packets successful 100 retries used RR 10 maxRSSI 80dBm minRSSI 83dBm avgRSS 82dBm An error has occurred if the result field is not equal to zero ignore the other fields in the packet If the Success field is equal to zero then ignore the RSSI fields Trace routing In many applications it is useful to determine the route which a DigiMesh unicast takes to its destination This information is especially useful when setting up a network or diagnosing problems within a network The Trace Route API option of Tx Request Packets see the API section of this manual for a description of the API frames causes routing information packets to be transmitted to the originator of a DigiMesh unicast by the intermediate nodes When a unicast is sent with the Trace Route API option enabled the unicast is sent to its destination radios which forward the unicast to its eventual destination will transmit a Route Information RI packet back along the route to the unicast originator A full description of Route Information API packets can be found in the API section of this manual In general they contain addressing information for the unicast and the intermediate hop for which the trace route packet was generated RSSI information and other link quality in
40. 0HP device configuration XBee modules can be configured locally through serial commands AT or API or remotely through remote API commands API devices can send configuration commands to set or read the configuration settings of any device in the network XBee network link establishment and maintenance Building aggregate routes In many applications it is necessary for many or all of the nodes in the network to transmit data to a central aggregator node In a new DigiMesh network the overhead of these nodes discovering routes to the aggregator node can be extensive and taxing on the network To eliminate this overhead the AG command can be used to automatically build routes to an aggregate node in a DigiMesh network To send a unicast modules configured for transparent mode AP 0 must set their DH DL registers to the MAC address of the node to which they need to transmit to In networks of transparent mode modules which transmit to an aggregator node it is necessary to set every module s DH DL registers to the MAC address of the aggregator node This can be a tedious process The AG command can be used to set the DH DL registers of all the nodes in a DigiMesh network to that of the aggregator node in a simple and effective method Upon deploying a DigiMesh network the AG command can be issued on the desired aggregator node to cause all nodes in the network to build routes to the aggregator node The command can optionally be used to automatica
41. 1 0x00 Number of bytes between the length and the checksum LSB 2 0x14 Frame specific Data Frame Type 3 0x92 64 bit Source MSB 4 0x00 64 bit address of sender Address 5 0x13 6 OxA2 7 0x00 8 0x40 9 0x52 10 0x2B LSB 11 OxAA Reserved MSB 12 Oxfffe LSB 13 0x84 XBee XBee PRO DigiMesh 2 4 User Guide 90 XBee API frame specifications Frame Fields Offset Example Description Receive Options 14 0x01 Bitfield 0x01 Packet Acknowledged 0x02 Packet was a broadcast packet All other bits are reserved and should be ignored Number of 15 0x01 Number of sample sets included in the payload Always set to 1 samples Digital Channel 16 0x00 Bitmask field that indicates which digital IO lines on the 17 0x1C Mask remote have sampling enabled if any 17 0x1C Analog Channel 18 0x02 Bitmask field that indicates which analog IO lines on the remote Mask have sampling enabled if any Digital Samples 19 0x00 If the sample set includes any digital IO lines Digital Channel Mask gt if included 0 these two bytes contain samples for all enabled digital IO lines 20 0x14 DIO lines that do not have sampling enabled return 0 Bits in these 2 bytes map the same as they do in the Digital Channels Mask field Analog Sample 21 0x02 If the sample set includes any analog input lines Analog Channel Mask gt 0 each enabled analog input returns a 2 byte value 22 0x25 indicating the A D measurement of that inp
42. 2 If the host does not allow the module to transmit data out from the serial transmit buffer because of being held off by hardware flow control XBee serial flow control The RTS and CTS module pins provide RTS and or CTS flow control CTS flow control provides an indication to the host to stop sending serial data to the module RTS flow control allows the host to signal the module to not send data in the serial transmit buffer out the UART RTS and CTS flow control are enabled using the D and D7 commands XBee XBee PRO DigiMesh 2 4 User Guide 21 XBee serial interface protocols CTS flow control If you enable the CTS flow control is enabled D7 command when the serial receive buffer is filled with FT bytes the module de asserts CTS sets it high to signal to the host device to stop sending serial data CTS is re asserted when less than FT 16 bytes are in the UART receive buffer See command description for the FT command RTS flow control If you enable RTS flow control is enabled D6 command data in the serial transmit buffer will not be sent out the DOUT pin as long as RTS is de asserted set high Do not de assert RTS for long periods of time to avoid filling the serial transmit buffer If an RF data packet is received and the serial transmit buffer does not have enough space for all of the data bytes the entire RF data packet will be discarded XBee serial interface protocols The XBee modules support both transparent a
43. 30 Network discovery 30 Neighbor polling 30 XBee DigiMesh 2 4 RF Module XBee link reliability 30 Network link testing 30 Link testing between adjacent devices 31 Trace routing 32 NACK messages 33 Commissioning pushbutton and associate LED 34 Commissioning pushbutton 34 Associate LED 35 Diagnostics support 36 XBee XBee PRO DigiMesh 2 4 I O line monitoring 36 I O samples 36 Queried sampling 36 XBee periodic I O sampling 38 XBee digital I O change detection 38 XBee XBee PRO DigiMesh 2 4 networking DigiMesh feature set 39 DigiMesh networking concepts 39 Device configuration 39 Network ID 40 Operating channel 40 DigiMesh data transmission and routing 40 Unicast addressing 40 Broadcast addressing 40 Routing 41 Route discovery 41 Throughput 41 XBee DigiMesh 2 4 transmission timeouts 42 Unicast one hop time 42 XBee XBee PRO DigiMesh 2 4 User Guide Transmitting a broadcast 42 Transmitting a unicast with a known route 42 Transmitting a Unicast with an unknown route 43 Transmitting a Unicast with a broken route 43 XBee XBee PRO DigiMesh 2 4 sleep modes DigiMesh sleep modes 44 Normal mode SM 0 44 Asynchronous pin sleep mode SM 1 44 Asynchronous cyclic sleep mode SM 4 45 Asynchronous cyclic sleep with pin wake up mode SM 5 45 Synchronous sleep support mode SM 7 45 Synchronous cyclic sleep mode SM 8 45 XBee asynchronous sleep operation 46 DigiMesh wake timer 46 DigiMesh sleeping routers 46 Coordinating sleep modes in
44. 4 bit address of the destination device The Address 6 0x13 following address is also supported 7 OxA2 8 0x00 OxOO0000000000FFFF Broadcast address 9 0x40 10 0x40 11 0x11 LSB 12 0x22 Reserved 13 OxFF Set to OxFFFE 14 OxFE XBee XBee PRO DigiMesh 2 4 User Guide 81 XBee AP frame specifications Frame Fields Offset Example Description Remote Command 15 0x02 apply changes 0x02 Apply changes on remote If not set AC command Options must be sent before changes will take effect All other bits must be set to 0 AT Command 16 0x42 B Name of the command 17 0x48 H Command 18 0x01 If present indicates the requested parameter value to Parameter set the given register If no characters present the register is queried Checksum 18 OxF5 OxFF the 8 bit sum of bytes from offset 3 to this byte Example The above example sends a remote command to change the broadcast hops register on a remote device to 1 broadcasts go to 1 hop neighbors only and apply changes so the new configuration value immediately takes effect In this example the 64 bit address of the remote is 0x0013A200 40401122 AT command response Frame type 0x88 In response to an AT Command message the module sends an AT Command Response message Some commands send back multiple frames for example the Node Discover ND command Frame Fields Offset Example Description Start Delimiter 0
45. 6 dB A24 Y16NF Yagi 16 element 13 5 dBi Fixed 2m 15 6 dB A24 Y16RM Yagi 16 element RPSMA connector 13 5 dBi Fixed 2m 15 6 dB XBee XBee PRO DigiMesh 2 4 User Guide 101 United States FCC Part Minimum Required Number Type Description Gain Application Separation Cable Loss A24 Y18NF Yagi 18 element 15 0 dBi Fixed 2m 17 1 dB Omni directional Class Antennas A24 F2NF Omni directional Fiberglass base station 2 1 dBi Fixed Mobile 20cm 4 2 dB A24 F3NF Omni directional Fiberglass base station 3 0 dBi Fixed Mobile 20cm 5 1 dB A24 F5NF Omni directional Fiberglass base station 5 0 dBi Fixed Mobile 20cm 7 1 dB A24 F8NF Omni directional Fiberglass base station 8 0 dBi Fixed 2m 10 1 dB A24 FONF Omni directional Fiberglass base station 9 5 dBi Fixed 2m 11 6 dB A24 F10NF Omni directional Fiberglass base station 10 0 dBi Fixed 2m 12 1 dB A24 F12NF Omni directional Fiberglass base station 12 0 dBi Fixed 2m 14 1 dB A24 F15NF Omni directional Fiberglass base station 15 0 dBi Fixed 2m 17 1 dB A24 W7NF Omni directional Base station 7 2 dBi Fixed 2m 9 3 dB A24 M7NF Omni directional Mag mount base station 7 2 dBi Fixed 2m 9 3 dB Panel Class Antennas A24 P8SF Flat Panel 8 5 dBi Fixed 2m 8 6 dB A24 P8NF Flat Panel 8 5 dBi Fixed 2m 8 6 dB A24 P13NF Flat Panel 13 0 dBi Fixed 2m 13 1 dB A24 P14NF Flat Panel 14 0 dBi Fixed 2m 14 1 dB A24 P15NF
46. API frame This process is much faster than in transparent operation where the application must enter AT command mode change the address exit Command mode and then transmit data Each API transmission can return a transmit status frame indicating the success or reason for failure Received data frames indicate the sender s address All received RF data API frames indicate the source address Advanced addressing support API transmit and receive frames can expose addressing fields including source and destination endpoints cluster ID and profile ID Advanced networking diagnostics API frames can provide indication of IO samples from remote devices and node identification messages Remote Configuration Set read configuration commands can be sent to remote devices to configure them as needed using the API As a general rule we recommend API firmware when a device Sends RF data to multiple destinations Sends remote configuration commands to manage devices in the network Receives IO samples from remote devices Receives RF data packets from multiple devices and the application needs to know which device sent which packet If the conditions listed above do not apply for example a sensor node router or a simple application then AT firmware may be suitable You can use a mixture of devices running API and AT firmware in a network To learn about implementing API operations refer to XBee XBee
47. Digs XBee XBee PRO DigiMesh 2 4 RF Modules User Guide XBee XBee PRO DigiMesh 2 4 User Guide Part number N Revision Date Description A September 2008 Baseline release B March 2010 Updated to support XBee DigiMesh 2 4 firmware updates C February 2011 Updating hardware and software changes D July 2011 Update to Antenna Information E January 2012 Added new text and images F April 2013 Corrected errors G July 2013 Revised confusing voltage requirements H July 2013 Corrected receive options description on three API frame descriptions N A Revision is not used J December 2013 Added frames 8D and 8E frames to the API section K May 2014 Quality revision L July 2014 Corrected output power values from 100 mW to 63 mW Added CA changes and CA command to manual M December 2014 Added the table for reading 0x8D packet in the Route Information Packet added the max network size message in the General Information about the XBee XBee PRO DigiMesh 2 4 RF Module section updated the Data Sample Rx Indicator section updated the receive options description in the Data Sample Rx Indicator table N March 2015 Updated the warranty information Added Brazilian certifications Corrected DD command default Disclaimers Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International Digi prov
48. Name Direction Description 5 RESET Input Open Module reset Reset pulse must be at least 100 us This drain output must be driven as an open drain collector The module will drive this line low when a reset occurs This line should never be driven high 6 PWMO RSSI DIO10 Either PWM output 0 RX signal strength indicator Digital I O 7 PWM DIO11 Either PWM output 1 Digital I O 11 8 reserved Do not connect 9 DTR SLEEP_RQ DIO8 Either Pin sleep control line or Digital I O 8 10 GND Ground 11 AD4 DIO4 Either 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 Module Status Indicator or Digital I O 9 14 VREF This line must be connected if analog I O sampling is desired Must be between 2 6 V and Vcc 15 Associate DIO5 AD5 Either Associated indicator Digital I O 5 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 20 ADO DIOO Either Analog input 0 Digital I O 0 or Commissioning button Commissioning Button Signal direction is specified with respect to the module Module includes a 50 ka pull up resistor attached to RESET Several of the input pull ups can be configured using the PR command Unused pins should be left disconnected Recommended pin connections for
49. OK r response is received MAC PHY level AT Command Name and Description Parameter Range Default CH Channel Set Read the channel number used for OxOB Ox1A XBee Ox0C transmitting and receiving data between RF modules uses 0x0C 0x17 12d 802 15 4 protocol channel numbers XBee PRO ID Network ID Set or read the user network identifier Nodes 0x0000 to Ox7FFF Ox7 FFF must have the same network identifier to communicate Changes to ID can be written to non volatile memory using the WR command XBee XBee PRO DigiMesh 2 4 User Guide 54 MAC PHY level AT Command Name and Description Parameter Range Default MT Broadcast Multi Transmit Set Read the number of 0 0xF 3 additional MAC level broadcast transmissions All broadcast packets are transmitted MT 1 times to ensure it is received CA Clear Channel Assessment Threshold Set Read the 0 0x24 0x50 0 threshold at which transmissions will be held off For CCA example if the ATCA parameter was set to 60 0x3C the disabled radio will not transmit if a signal greater than 60dBm is detected on the channel For ETSI compliance Europe the following settings should be used Radio hex value sets to level XBee 0x3A 58 dBm XBee PRO 0x43 67 dBm PL Power Level Set Read the power level at which the RF XBee 4 module transmits conducted power 7dBm 1 1 7dBm 2 0 77dBm 3 0 62dBm 4 1 42dBm XBee Pro 0 10dBm 1 12dBm 2 14dBm 3 16dBm
50. Ox7E Length MSB 1 0x00 Number of bytes between the length and the checksum LSB 2 0x05 Frame specific Data Frame Type 3 0x88 Frame ID 4 0x01 Identifies the UART data frame being reported Note If Frame ID 0 in AT Command Mode no AT Command Response will be given AT Command 5 B 0x42 Command Name Two ASCII characters that identify the AT Command 6 D 0x44 Command 7 0x00 0 OK Status 1 ERROR 2 Invalid Command 3 Invalid Parameter Command Register data in binary format If the register was set then this field is not Data returned as in this example Checksum 8 OxFO OxFF the 8 bit sum of bytes from offset 3 to this byte XBee XBee PRO DigiMesh 2 4 User Guide 82 XBee AP frame specifications Example Suppose the BD parameter is changed on the local device with a frame ID of 0x01 If successful parameter was valid the above response would be received Modem status Frame type 0x8A RF module status messages are sent from the module in response to specific conditions Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB 1 0x00 Number of bytes between the length and the checksum LSB2 0x02 Frame specific Data Frame Type 3 Ox8A Status 4 0x00 0x00 Hardware reset 0x01 Watchdog timer reset 0x0B Network Woke Up 0x0C Network Went To Sleep Checksum 5 0x75 OxFF the 8 bit sum of bytes from offset 3 to this byte Example When an API device powers
51. XBee XBee PRO DigiMesh 2 4 The only required pin connections are VCC GND DOUT and DIN To support serial firmware updates VCC GND DOUT DIN RTS and DTR need to be connected All unused pins need to be left disconnected All inputs on the radio can be pulled high with internal pull up resistors using the PR software command No specific treatment is needed for unused outputs Other pins can be connected 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 will flash differently depending on the state of the module and a pushbutton attached to pin 20 can enable various deployment and troubleshooting functions without having to send UART commands XBee XBee PRO DigiMesh 2 4 User Guide 14 XBee DigiMesh 2 4 design notes For analog sampling attach the VRef pin pin 14 to a voltage reference Minimum pin connections on the XBee XBee PRO 2 4 DigiMesh VCC GND DOUT amp DIN Minimum connections on the XBee XBee PRO DigiMesh 2 4 for updating firmware VCC GND DOUT DIN RTS amp DTR XBee DigiMesh 2 4 design notes The XBee modules do not require any external circuitry or specific connections for proper operation However there are some general design guidelines that are recommended for troubleshooting and building a robust design XBee board layout XBee modules are designed to be self sufficient and have minimal se
52. ampling allows an XBee PRO module to take an I O sample and transmit it to a remote device at a periodic rate The periodic sample rate is set by the IR command If IR is set to 0 periodic sampling is disabled For all other values of IR data is disabled after IR milliseconds have elapsed and transmitted to a remote device The DH and DL commands determine the destination address of the IO samples Only devices with API mode enabled will send IO data samples out their UART Devices not in API mode will discard received IO data samples A module with sleep enabled transmits periodic I O samples at the IR rate until the ST time expires and the device can resume sleeping See XBee XBee PRO DigiMesh 2 4 sleep modes on page 44 for more information XBee digital I O change detection Modules can be configured to transmit a data sample immediately whenever a monitored digital I O pin changes state The IC command is a bitmask that is used to set which digital I O lines should be monitored for a state change If one or more bits in IC is set an I O sample is transmitted as soon as a state change is observed in one of the monitored digital I O lines The figure below shows how edge detection can work with periodic sampling Edge detection with periodic sampling Monitored Digital 1O Sample Transmissions j f IR gt 0 IC 0 H tR g t i ae i A Al 9 IO Sample Transmissions IR gt 0 IC gt 0 Pt IR t fe a g
53. ations of the XBee XBee PRO 2 4 DigiMesh Specification XBee XBee PRO Idle Receive current 50 mA 3 3 V 55 mA 3 3 V Power down current pin lt 10 pA lt 10 pA sleep Power down current cyclic lt 50 pA lt 50 pA sleep General Operating frequency band ISM 2 4 GHz ISM 2 4 GHz Dimensions 0 960 x 1 087 2 438 cm x 2 761 cm 0 960 x 1 297 2 438 cm x 3 294 cm Operating temperature 40 to 85 C Industrial 0 to 95 non condensing 40 to 85 C Industrial 0 to 95 non condensing Antenna options 1 4 wave wire antenna embedded PCB antenna RPSMA RF connector U FL RF connector 1 4 wave wire antenna RPSMA RF connector U FL RF connector Network and security Supported network topologies Mesh point to point point to multipoint peer to peer Mesh point to point point to multipoint peer to peer Number of Channels software selectable 16 direct sequence channels 12 direct sequence channels Addressing Options PAN ID channel and 64 bit addresses PAN ID channel and 64 bit addresses Encryption 128 bit AES 128 bit AES Agency approvals United States FCC Part OUR XBEE OUR XBEEPRO 15 247 Industry Canada IC 421 4A XBEE 4214A XBEEPRO Europe CE ETSI ETSI max 10dBm transmit power output RoHS Lead free and RoHS compliant Lead free and RoHS compliant Japan R201WW07215214 R201WW08215111 max 10
54. d 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 the FN command is issued in command mode after NT 100 ms overhead time the command ends by returning a lt CR gt If the FN command is sent through a local API frame each response is returned as a separate Local or Remote AT Command Response API packet respectively The data consists of the above listed bytes without the carriage return delimiters The NI string will end in a 0x00 null character Security AT Command Name and Description Parameter Range Default EE Security Enable Enables or disables 128 bit AES 0to1 0 encryption This command parameter should be set the same on all devices KY Security Key Sets the 16 byte network security key value 128 bit value n a This command is write only Attempts to read KY will return an OK status This command parameter should be set the same on all devices XBee XBee PRO DigiMesh 2 4 User Guide 60 Serial interfacing Serial interfacing AT Command Name and Description Parameter Range Default BD Baud rate Set or read serial interface rate speed for data 0 to 7 and 0x39 to 0x03 transfer between radio modem and host Values from 0 7 OxF4240 9600bps select preset standard rates Values at Ox7A and above sel
55. dBm transmit power output Australia C Tick C Tick Brazil ANATEL 0369 15 1209 ANATEL 0378 15 1209 Note See Agency certifications on page 98 for region specific certification requirements XBee XBee PRO DigiMesh 2 4 User Guide 10 Mechanical drawings of the XBee XBee PRO 2 4 DigiMesh Mechanical drawings of the XBee XBee PRO 2 4 DigiMesh The following figures show the mechanical drawings of the XBee PRO RF Modules The drawings do not show antenna options All dimensions are in inches XBee PRO XBee PRO top view side views ons e 0 89mm 0 031 0 110 o stmm SIN sD XIJ SPRO PIN 20 0 020 X 2 032 0 508 0 79mm 2 79mm __ 0 160 1 1 1 4 06mm i 1 1 i w t i A PIN 1 PIN 10 PIN 11 0 079 _ 2 00mm 0 960 i 24 38mm 0 299 ea 7 59mm 0 304 i 0 257 7 72mm Bamm Shield Bottom Side 0 284 7 22mm L 0 866 22 00mm XBee XBee PRO DigiMesh 2 4 User Guide 11 Mounting considerations for the XBee XBee PRO DigiMesh 2 4 Mechanical drawing for the RPSMA model XBee 210 SHORTER THAN XBee PRO 03 0 020 0 709 Mounting considerations for the XBee XBee PRO DigiMesh 2 4 The XBee XBee PRO DigiMesh 2 4 RF Module through hole is designed to be mounted into a receptacle Socket and does not require any soldering when mounting it to a board The development kits co
56. ddress of the node that generated this Route Information Packet after Address 29 sending or attempting to send the packet to the next hop the Receiver 30 0x13 REE 31 OxA2 32 0x00 33 0x40 34 0x52 35 OxBB LSB 36 OxBB XBee XBee PRO DigiMesh 2 4 User Guide 85 XBee API frame specifications Frame Fields Offset Example Description Receiver MSB 0x00 Address of the node to which the data packet was just sent or attempted to Address 37 be sent to 38 0x13 39 OxA2 40 0x00 41 0x40 42 0x52 43 OxCC LSB 44 OxCC Checksum 45 OxCE OxFF the 8 bit sum of bytes from offset 3 to this byte Example The example above represents a possible Route Information Frame that could be received when doing a trace route on a transmission from a radio with serial number 0x0013a2004052AAAA to a radio with serial number 0x0013a2004052DDDD This particular frame indicates that the transmission was successfully forwarded from the radio with serial number 0x0013a2004052BBBB to the radio with serial number 0x0013a2004052CCCC Aggregate addressing update Frame type 0x8E An Aggregate Addressing Update frame is output on an API enabled node when an address update frame generated by the AG command being issued on a node in the network causes the node to update its DH and DL registers Frame Fields Offset Example Description Start 0 Ox7E Delimiter Length MSB1 Ox00 Number of bytes between
57. des would have automatically built a route to the aggregator Example 2 To cause all nodes in the network to build routes to an aggregator node with a MAC address of 0x0013a2004052c507 without affecting the DH DL of any nodes in the network the ATAGFFFE command should be issued on the aggregator node This will cause an AG broadcast to be sent to all nodes in the network All of the nodes will update their internal routing table information to contain a route to the aggregator node None of the nodes will update their DH DL registers because none of the registers are set to an address of OxFFFE Node replacement The AG command can also be used to update the routing table and DH DL registers in the network after a module is replaced The DH DL registers of nodes in the network can also be updated To update only the routing table information without affecting the DH DL registers then the process of Example 2 above can be used To update the DH DL registers of the network then the method of Example 3 below can be used Example 3 The module with serial number 0x0013a2004052c507 was being used as a network aggregator It was replaced with a module with serial number 0x0013a200f5e4d3b2 The AG0013a2004052c507 command should be issued on the new module This will cause all modules which had a DH DL register setting of 0x0013a2004052c507 to update their DH DL register setting to the MAC address of the sending module 0x0013a200f5e4d3b2 XBee device
58. destination node The reserved field should be set to OxFFFE The broadcast radius can be set from 0 up to NH to OxFF If the broadcast radius exceeds the value of NH then the value of NH will be used as the radius This parameter is only used for broadcast transmissions The maximum number of payload bytes can be read with the NP command Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB 1 0x00 Number of bytes between the length and the checksum LSB 2 Ox1A Frame specific Data Frame Type 3 0x11 XBee XBee PRO DigiMesh 2 4 User Guide 79 XBee AP frame specifications Frame Fields Offset Example Description Frame ID 4 0x01 Identifies the UART data frame for the host to correlate with a subsequent ACK acknowledgment If set to 0 no response is sent 64 bit Destination MSB5 0x00 Set to the 64 bit address of the destination device The following Address address is also supported 6 0x13 7 OxA2 0x000000000000FFFF Broadcast address 8 0x00 9 0x01 10 0x23 11 0x84 LSB12 0x00 Reserved 13 OXxFF Set to OxFFFE 14 OxFE Source Endpoint 15 OxAO Source endpoint for the transmission Destination 16 OxA1 Destination endpoint for the Endpoint transmission Cluster ID 17 0x15 Cluster ID used in the transmission 18 0x54 Profile ID 19 OxC1 Profile ID used in the transmission 20 0x05 Broadcast Radius 21 0x00 Sets the maximum number of hops a b
59. document During normal operations at the beginning of a wake cycle the sleep coordinator will send 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 receiving a sync message will remain awake for the wake time and then sleep for the sleep period specified The sleep coordinator will send one sync message at the beginning of each cycle with the currently configured wake and sleep times All router nodes which receive this sync message will 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 will re send the message one additional time It should be noted that if SP or ST are changed the network will not apply the new settings until the beginning of the next wake time See Changing sleep parameters on page 51 for more information A sleeping router network is robust enough that an individual node can go several cycles without receiving a sync message due to RF interference for example As a node misses sync messages the time available for transmitting messages in the wake time is reduced to maintain synchronization accuracy By default a module will also reduce its active sleep time progressively as sync messages are missed DigiMesh synchronization messages Asleep coordinator will regularly send sync messa
60. e causar interfer ncia a sistemas operando em car ter prim rio XBee XBee PRO DigiMesh 2 4 User Guide 106
61. e remote After exiting command mode any received serial characters will be transmitted to the remote device and returned to the sender API configuration AP 1 or AP 2 Send an Explicit TX Request API frame 0x11 using 0x12 as the cluster ID and OxE8 as the source and destination endpoint Data packets received by the remote will be echoed back to the sender Link testing between adjacent devices It is often advantageous to test the quality of a link between two adjacent nodes in a network The Test Link Request Cluster ID can be used to send a number of test packets between any two nodes in a network A link test can be initiated using an Explicit TX Request frame The command frame should be addressed to the Test Link Request Cluster ID 0x0014 on destination endpoint OxE6 on the radio which should execute the test link The Explicit TX Request frame should contain a 12 byte payload with the following format Number of Bytes Field Name Description 8 Destination address The address with which the radio should test its link 2 Payload size The size of the test packet The maximum payload size for this radio can be queried with the NP command 2 Iterations The number of packets which should be sent This should be a number between 1 and 4000 After completing the transmissions of the test link packets the executing radio will send the following data packet to the requesting radio s Test Link Result Cluster 0x0094 on
62. e separation between the equipment and receiver connect equipment and receiver to outlets on different circuits or consult the dealer or an experienced radio TV technician for help FCC approved antennas 2 4 GHz XBee XBee PRO RF Modules can be installed using antennas and cables constructed with standard connectors Type N SMA TNC etc if the installation is performed professionally and according to FCC guidelines For installations not performed by a professional non standard connectors RPSMA RPTNC etc must be used The modules are FCC approved for fixed base station and mobile applications on channels OxOB 0x1A XBee and Ox0C 0x17 XBee PRO If the antenna is mounted at least 20cm 8 in from nearby persons the application is considered a mobile application Antennas not listed in the table must be tested to comply with FCC Section 15 203 Unique Antenna Connectors and Section 15 247 Emissions XBee RF Modules 1 mW XBee Modules have been 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 have been tested and approved for use with the antennas listed in the first and third tables below The antennas in the tables below have been approved for use with the XBee XBee PRO DigiMesh 2 4 RF module Digi does not carry all of these antenna variants Contact Digi Sales for available antennas Antennas approved for use with the XBee PRO RF M
63. early wake up bit 4 Enable node type equality bit 5 Disable lone coordinator sync repeat For asynchronous sleep modules the following sleep options are defined bit 8 Always wake for ST time SN Number of Sleep Periods Set read the number of sleep periods 1 OxFFFF 1 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 During cycles when the ON_SLEEP line is not asserted the module will wake up and check for any serial or RF data If any such data is received then the ON_SLEEP line will be asserted and the module will fully wake up Otherwise the module will return to sleep after checking This command does not work with synchronous sleep modules SP Sleep Period Set read the sleep period of the module This 1 1440000 OxC8 2 command defines the amount of time the module will sleep per x 10 ms seconds cycle XBee XBee PRO DigiMesh 2 4 User Guide 67 AT Command ST Name and Description Wake Time Set read the wake period of the module For asynchronous sleep modules this command defines the amount of time that the module will stay awake after receiving RF or serial data For synchronous sleep modules this command defines the amount of time that the module will stay awake when operating in cyclic sleep mode This value will be adjusted upwards automatically if it is too small to function properl
64. ect the actual baud rate providing the host supports it The values from 0 to 7 are interpreted as follows 0 1 200bps 1 2 400bps 2 4 800bps 3 9 600bps 4 19 200bps 5 38 400bps 6 57 600bps 7 111 111bps NB Parity Set or read parity settings for UART communications O to 4 0 No The values from 0 to 4 are parity interpreted as follows 0 No parity 3 Forced high parity 1 Even parity 4 Forced low parity 2 Odd parity RO Packetization Timeout Set Read number of character times 0 OxFF 3 of inter character silence required before packetization Set x character RO 0 to transmit characters as they arrive instead of times buffering them into one RF packet FT Flow Control Threshold Set or read flow control threshold 0x11 OxEE OxBE 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 AP API mode Set or read the API mode of the radio The 0 1 or 2 0 following settings are allowed 0 API mode is off All UART input and output is raw data and packets are delineated using the RO parameter 1 API mode is on All UART input and output data is packetized in the API format without escape sequences 2 API mode is on with escaped sequences inserted to allow for control characters XON XOFF escape and the 0x7e delimiter to be passed as data AO API Output Format Enables different API output frames 0 1 0 Options include 0
65. ed broadcast packet 0xC0 DigiMesh packet Reserved 15 OXxFF Reserved 16 OxFE XBee XBee PRO DigiMesh 2 4 User Guide 92 XBee AP frame specifications Frame Fields Offset Example Description 64 bit Address MSB 17 0x00 Indicates the 64 bit address of the remote module that transmitted the node identification frame 18 0x13 19 OxA2 20 0x00 21 0x40 22 0x74 23 0x02 LSB 24 OxAC NI String 25 0x20 Node identifier string on the remote device The NI string is terminated with a NULL byte 0x00 26 0x00 Reserved 27 OXFF Reserved 28 OxFE Frame Device Type 29 0x01 0 Coordinator specific Data 1 Normal Mode 2 End Device See the NO command description for more options Source Event 30 0x01 1 Frame sent by node identification pushbutton event See DO command description Digi Profile ID 31 OxC1 Set to Digi s application profile ID 32 0x05 Digi 33 0x10 Set to Digi s Manufacturer ID Manufacturer ID 34 Ox1E Digi DD Value 35 0x00 Reports the DD value of the responding module this field i can be enabled with the NO command optional 36 0x0C 37 0x00 38 0x00 RSSI optional 39 Ox2E RSSI this field can be enabled with the NO command Checksum 40 0x33 OxFF the 8 bit sum of bytes from offset 3 to this byte Example If the commissioning push button is pressed on a remote router device with 64 bit address 0x0013a200407402ac and default NI str
66. ep coordinator nodes and as aids in adding new nodes to a sleeping network Note Because sleep support nodes do not sleep they should be mains powered Synchronous cyclic sleep mode SM 8 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 While asleep it cannot receive RF messages or read commands from the UART port Generally sleep and wake times are specified by the SP and ST respectively of the network s sleep coordinator These parameters are only used at start up until the node is synchronized with the network When a module has synchronized with the network its sleep and wake times can be queried 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 module is awake and de assert when the module is asleep CTS is also de asserted while asleep D7 1 A newly powered unsynchronized sleeping node will poll for a synchronized message and then sleep for the period specified by SP repeating this cycle until it becomes synchronized by receiving a sync message Once a sync message is received the node synchronizes itself with the network Note 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
67. es sent out the DOUT pin pin 2 include RF received data frame Command response Event notifications such as reset sync status etc The API provides alternative means of configuring modules and routing data at the host application layer A host application can send data frames to the module that contain address and payload information instead of using command mode to modify addresses The module will send data frames XBee XBee PRO DigiMesh 2 4 User Guide 22 XBee serial interface protocols to the application containing status packets as well as source and payload information from received data packets The API operation option facilitates many operations such as the examples cited below Transmitting data to multiple destinations without entering Command Mode Receiving success failure status of each transmitted RF packet Identifying the source address of each received packet Comparing transparent and API operation The following table compares the advantages of transparent and API modes of operation Transparent Operation Features Simple interface All received serial data is transmitted unless the module is in command mode Easy to support It is easier for an application to support transparent operation and command mode API Operation Features Easy to manage data transmissions to multiple destinations Transmitting RF data to multiple remotes only requires changing the address in the
68. es to establish reliable links throughout the mesh network Network link testing A good way to measure the performance of a mesh network is to send unicast data through the network from one device to another to determine the success rate of many transmissions To simplify link testing the modules support a loopback cluster ID 0x12 on the data endpoint OxE8 Any data sent to this cluster ID on the data endpoint will be transmitted back to the sender This is shown in the figure below XBee XBee PRO DigiMesh 2 4 User Guide 30 XBee network commissioning and diagnostics Mesh network Demonstration of how the loopback cluster ID and data endpoint can be used to measure the link quality in a mesh network 2 The remote device receives data on the loopback cluster ID and data endpoint Mesh Network 1 Transmit data to the loopback cluster ID 0x12 and data endpoint OxE9 ona remote device Source Device Remote Device 3 Remote transmits the received 4 Source receives loopback P packet back to the sender transmission and sends received packet out the UART The configuration steps to send data to the loopback cluster ID depend on the AP setting AT configuration AP 0 To send data to the loopback cluster ID on the data endpoint of a remote device set the CI command value to 0x12 Set the SE and DE commands to OxE8 default value The DH and DL commands should be set to the address of th
69. ese features can be supported in hardware as shown below Push button 20 XBee 1 5 O mK Associate LED A pushbutton and an LED can be connected to module pins 20 and 15 respectively to support the commissioning pushbutton and associated LED functionalities Commissioning pushbutton The commissioning pushbutton definitions provide a variety of simple functions to aid in deploying devices in a network The commissioning button functionality on pin 20 is enabled by setting the DO command to 1 It is enabled by default Multiple button presses must be performed within two seconds Button Sleep Configuration and Presses Sync Status Action 1 Not configured for sleep Immediately sends a Node Identification broadcast transmission All devices that receive this transmission will blink their Associate LED rapidly for 1 second All API devices that receive this transmission will send a Node Identification frame out their UART API ID 0x95 1 Configured for Wakes the module for 30 seconds Immediately sends a Node asynchronous sleep Identification broadcast transmission All devices that receive this transmission will blink their Associate LED rapidly for 1 second All API devices that receive this transmission will send a Node Identification frame out their UART API ID 0x95 1 Configured for Wakes the module for 30 seconds or until the synchronized network goes synchronous sleep to sleep Queues a Node Identification
70. fault AT Command Mode sequence for transition to Command Mode No characters sent for one second Guard Times GT parameter 0x3E8 e Input three plus characters within one second Command Sequence Character CC parameter x2B e No characters sent for one second GT parameter 0x3E8 Once the AT command mode sequence has been issued the module sends an OK r out the UART pin The OK r characters can be delayed if the module has not finished transmitting received serial data When command mode has been entered the command mode timer is started CT command and the module is able to receive AT commands on the UART port All of the parameter values in the sequence can be modified to reflect user preferences Note Failure to enter AT Command Mode is most commonly due to baud rate mismatch When using XCTU ensure that the Baud Rate of the XCTU software tab matches the interface data rate of the RF module By default the BD parameter 3 9600 b s To send AT commands Send AT commands and parameters using the syntax shown below Syntax for sending AT commands AT ASCII Space Parameter Carriage Prefix Command Optional Optional HEX Return Example ATDL 1F lt CR gt Note To read a parameter value stored in the RF module s register omit the parameter field The preceding example would change the RF module Destination Address Low to 0x1F To store the new value to non volatile long term memory
71. fier string to a physical address case sensitive string The following events occur after the destination node is discovered lt AT Firmware gt 1 DL amp DH are set to the extended 64 bit address of the module with the matching NI Node Identifier string 2 OK or ERROR r is returned 3 Command Mode is exited to allow immediate communication lt API Firmware gt OxFFFE and 64 bit extended addresses are returned in an API Command Response frame If there is no response from a module within NT 100 milliseconds or a parameter is not specified left blank the command is terminated and an ERROR message is returned In the case of an ERROR Command Mode is not exited XBee XBee PRO DigiMesh 2 4 User Guide 59 Security AT Command Name and Description Parameter Range Default ND Network Discover Discovers and reports all RF modules found If the ND command is sent through a local API frame each response is returned as a separate Local or Remote AT Command Response API packet respectively FN Find Neighbors Discovers and reports all RF modules found within immediate RF range The following information is reported for each module discovered MY lt CR gt always OxFFFE SH lt CR gt SL lt CR gt NI lt CR gt Variable length PARENT_NETWORK ADDRESS lt CR gt 2 Bytes always OxFFFE DEVICE_TYPE lt CR gt 1 Byte 0 Coord 1 Router 2 End Device STATUS lt CR gt 1 Byte Reserve
72. fixed visibly legibly and indelibly Restrictions Power Output 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 France 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 XBee XBee PRO DigiMesh 2 4 User Guide 103 United States FCC 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 CEPT ERC 70 03E Technical Requirements European restrictions and general requirements Available at www ero dk R amp TTE Directive Equipment requirements placement on market Available at www ero dk Approved antennas When integrating high gain antennas European regulations stipulate EIRP power maximums Use the following guidelines to determine which antennas to design into an application XBee RF module The following antenna types have been tested and approved for use with the
73. formation Example Suppose that a data packet with trace route enabled was successfully unicast from radio A to radio E through radios B C and D The following sequence would occur XBee XBee PRO DigiMesh 2 4 User Guide 32 XBee network commissioning and diagnostics After the successful MAC transmission of the data packet from A to B A would output a RI Packet indicating that the transmission of the data packet from A to E was successfully for warded one hop from A to B After the successful MAC transmission of the data packet from B to C B would transmit a RI Packet to A A would output this RI packet out its serial interface upon reception After the successful MAC transmission of the data packet from C to D C would transmit a RI Packet to A through B A would output this RI packet out its serial interface upon reception After the successful MAC transmission of the data packet from D to E D would transmit a RI Packet to A through C and B A would output this RI packet out its serial interface upon reception It is important to note that Route Information packets are not guaranteed to arrive in the same order as the route taken by the unicast packet It is also possible for the transmission of Route Information packets on a weak route to fail before arriving at the unicast originator Because of the large number of Route Information packets which can be generated by a unicast with Trace Route enabled it is suggested that
74. g as the network sleep coordinator and is operating ms blink time properly 7 8 On fast blinking 250 ms The device is properly synchronized with the network blink time Off The device is in a low power mode On solid The device has not synchronized or has lost synchronization with the network XBee XBee PRO DigiMesh 2 4 User Guide 35 XBee XBee PRO DigiMesh 2 4 I O line monitoring Diagnostics support The Associate pin works with the commissioning pushbutton to provide additional diagnostic behaviors to aid in deploying and testing a network If the commissioning push button is pressed once the device transmits a broadcast node identification packet at the beginning of the next wake cycle if sleep compatible or immediately if not sleep compatible If the Associate LED functionality is enabled D5 command a device that receive this transmission will blink its Associate pin rapidly for one second XBee XBee PRO DigiMesh 2 4 I O line monitoring I O samples The XBee modules support both analog input and digital IO line modes on several configurable pins Queried sampling Parameters for the pin configuration commands typically include the following Pin Command Parameter Description 0 Unmonitored digital input 1 Reserved for pin specific alternate functionalities 2 Analog input A D pins or PWM output PWM pins 3 Digital input monitored 4 Digital output low 5 Digital output
75. ges to keep the network in sync Nodes which have not been synchronized or in some cases which have lost sync will also send messages requesting sync information Deployment mode is used by sleep compatible nodes when they are first powered up and the sync message has not been relayed A sleep coordinator in deployment mode will rapidly send sync messages until it receives a relay of one of those messages This allows a network to be deployed more effectively and allows a sleep coordinator which is accidentally or intentionally reset to rapidly re synchronize with the rest of the network If a node which has exited deployment mode receives a sync message from a sleep coordinator which is in deployment mode the sync will be rejected anda corrective sync will be sent to the sleep coordinator Deployment mode can be disabled using the sleep options command SO XBee XBee PRO DigiMesh 2 4 User Guide 46 XBee asynchronous sleep operation A sleep coordinator which is not in deployment mode or which has had deployment mode disabled will send a sync message at the beginning of the wake cycle The sleep coordinator will then listen for a neighboring node to relay the sync If the relay is not heard the sync coordinator will send the sync one additional time A node which is not acting as a sleep coordinator which has never been synchronized will send a message requesting sync information at the beginning of its wake cycle Synchronized nodes which rece
76. hronous cyclic sleep mode SM 4 Cyclic sleep allows the module to sleep for a specified time and wake for a short time to poll Cyclic sleep mode is enabled by setting the SM command to 4 In cyclic sleep the module sleeps for a specified time If the XBee receives serial or RF data while awake it will extend the time before it returns to sleep by the amount specified by the ST command Otherwise it will enter sleep mode immediately The On_SLEEP line is asserted high when the module wakes and is de asserted low when the module sleeps If hardware flow control is enabled D7 command the CTS pin asserts low when the module wakes and can receive serial data and de assert high when the module sleeps Asynchronous cyclic sleep with pin wake up mode SM 5 SM 5 is a slight variation on SM 4 that allows the module to be woken prematurely by asserting the Sleep_RQ pin pin 9 In SM 5 the XBee can wake after the sleep period expires or if a high to low transition occurs on the Sleep_RQ pin Synchronous sleep support mode SM 7 A node in synchronous sleep support mode will synchronize itself with a sleeping network but will not sleep itself At any time the node will respond to new nodes which are attempting to join the sleeping network with a sync message A sleep support node only transmits normal data when the other nodes in the sleeping network are awake Sleep support nodes are especially useful when used as preferred sle
77. i a a 1 o o o Idle high i UART Signal Signal OVDC Voltage Start Bit low Stop Bit high Time r The module UART performs tasks such as timing and parity checking which is needed for data communications Serial communications depend on the two UARTs to be configured with compatible settings baud rate parity start bits stop bits data bits XBee serial buffers The XBee PRO modules maintain buffers to collect received serial and RF data which is illustrated in the figure below The serial receive buffer collects incoming serial characters and holds them until they can be processed The serial transmit buffer collects data that is received via the RF link that will be transmitted out the UART XBee XBee PRO DigiMesh 2 4 User Guide 20 XBee serial flow control Process of XBee PRO buffers collecting received serial data 1 Serial DIN C Receiver l pe Transmitter J Buffer RF Switch ee vee A Processor a alas Y enD s Y Pa Serial Transmit RF RX i DOUT i Buffer Buffer Receiver A RTS Serial receive buffer When serial data enters the RF module through the DIN Pin pin 3 the data is stored in the serial receive buffer until it can be processed Under certain conditions the module may not be able to process data in the serial receive buffer immediately If large a
78. ides 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 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 All rights reserved Customer support Telephone 8 00 am 5 00 pm CST US amp Canada 866 765 9885 Worldwide 801 765 9885 Online www digi com support eservice Mail Digi International 11001 Bren Road East Minnetonka MN 55343 USA Warranty View the product s warranty online http www digi com howtobuy terms XBee XBee PRO DigiMesh 2 4 User Guide Contents General information about the XBee XBee PRO DigiMesh 2 4 RF Module Key features of the XBee XBee PRO 2 4 DigiMesh 8 Worldwide acceptance of the XBee XBee PRO 2 4 DigiMesh 9 Specifications of the XBee XBee PRO 2 4 DigiMesh 9 Mechanical drawings of the XBee XBee PRO 2 4 DigiMesh 11 Mounting considerations for the XBee XBee PRO DigiMesh 2 4 12 Hardware diagram 13 XBee XBee PRO DigiMesh 2 4 pin signals 13 Recommended pin connections for XBee XBee PRO DigiMe
79. ing the following node identification indicator would be received 0x7e 0025 9500 13a2 0040 7402 acff fec2 fffe 0013 a200 4074 02ac 2000 fffe 0101 c105 101e 000c 0000 2e33 XBee XBee PRO DigiMesh 2 4 User Guide 93 XBee AP frame specifications Remote command response Frame type 0x97 If a module receives a remote command response RF data frame in response to a Remote AT Command Request the module will send a Remote AT Command Response message out the UART Some commands may send back multiple frames for example Node Discover ND command Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB 1 0x00 Number of bytes between the length and the checksum LSB2 0x13 Frame specific Data Frame Type 3 0x97 Frame ID 4 0x55 This is the same value passed in to the request 64 bit Source MSB5 0x00 The address of the remote radio returning this response remote Address 6 0x13 7 OxA2 8 0x00 9 0x40 10 0x52 11 0x2B LSB 12 OxAA Reserved 13 OxFF Reserved 14 OxFE AT Commands 15 0x53 Name of the command 16 0x4C Command 17 0x00 0 0K Status 1 ERROR XBee XBee PRO DigiMesh 2 4 User Guide 2 Invalid Command 3 Invalid Parameter 94 XBee AP frame specifications Frame Fields Offset Example Description Command Data 18 0x40 The value of the required register 19 0x52 20 0x2B 21 OxAA Checksum 22 OxF4 OxFF the 8 bit sum of by
80. ion 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 XBee PRO DigiMesh 2 4 User Guide 105 United States FCC Brazilian conformity Anatel DIGI model XB24 ASI 001 XB24 AUI 001 XB24 AWI 001 XB24 API 001 XB24 DMUIT 250 XB24 DMWIT 250 XB24 DMSIT 250 XB24 DMPIT 250 ANATEL Ag ncia Nacional de Telecomunica es 0369 15 1209 01 078990293 0529 5 Este equipamento opera em car ter secund rio isto nao tem direito a prote o contra interfer ncia prejudicial mesmo de esta es do mesmo tipo e nao pode causar interfer 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 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 nao tem direito a prote o contra interfer ncia prejudicial mesmo de esta es do mesmo tipo e n o pod
81. ion 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 RAS 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 Analog input must be between Veer and Vpery for valid conversion Values greater than Veery will convert to 3FF The resolution is the ideal step size or 1LSB VRerH VReFL 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 voltage for the current code The adjusted ideal transition voltage is Current Code 1 2 1 VrerH Ers VrerL Ezs Zero scale error is the difference between the transition to the first valid code and the ideal transition to that code The Ideal transition voltage to a given code is Code 1 2 1 VRerH VREF Full scale error is the difference between the transition to the last valid code and the ideal transition to that code The ideal transition voltage to a given code is Code 1 2 1 VRerH VReFL Input leakage err
82. ion frame break default Discard any other API frame types that are not being used break j XBee frame data The following sections illustrate the types of frames encountered while using the API AT command Frame type 0x08 Used to query or set module parameters on the local device This API command applies changes after executing the command Changes made to module parameters take effect once changes are applied Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB 1 0x00 Number of bytes between the length and the checksum LSB2 0x04 Frame specific Data Frame Type 3 0x08 Frame ID 4 0x52 R Identifies the UART data frame for the host to correlate with a subsequent ACK acknowledgment If set to 0 no response is sent ion AT Command Ox4E N Command Name Two ASCII characters that identify the AT Command 6 0x48 H XBee XBee PRO DigiMesh 2 4 User Guide 76 XBee AP frame specifications Frame Fields Offset Example Description Parameter Value If present indicates the requested parameter value to set the given optional register If no characters present register is queried Checksum 8 OxOF OxFF the 8 bit sum of bytes from offset 3 to this byte Example The API example above illustrates an API frame when you modify the NH parameter value of the module AT command queue parameter value Frame type 0x09 This API t
83. it Request API frame causes the module to send data as an RF packet to the specified destination The 64 bit destination address should be set to 0x000000000000FFFF for a broadcast transmission to all devices For unicast transmissions the 64 bit address field should be set to the address of the desired destination node The reserved field should be set to OxFFFE This example shows if escaping is disabled AP 1 Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB 1 0x00 Number of bytes between the length and the checksum LSB2 0x16 Frame specific Data Frame Type 3 0x10 Frame ID 4 0x01 Identifies the UART data frame for the host to correlate with a subsequent ACK acknowledgment If set to 0 no response is sent 64 bit Destination MSB5 0x00 Set to the 64 bit address of the destination device The following Address Baa address is also supported 0x000000000000FFFF Broadcast address 7 OxA2 8 0x00 9 0x40 10 Ox0A 11 0x01 LSB 12 0x27 Reserved 13 OxFF Set to OxFFFE 14 OxFE Broadcast Radius 15 0x00 Sets maximum number of hops a broadcast transmission can occur If set to 0 the broadcast radius is set to the maximum hops value Transmit Options 16 0x00 Bitfield XBee XBee PRO DigiMesh 2 4 User Guide bit 0 Disable ACK bit 1 Don t attempt route Discovery All other bits must be set to 0 78 XBee AP frame specifications
84. it status frame is always sent at the end of a data transmission unless the frame ID is set to 0 in the transmit request If the packet cannot be delivered to the destination the transmit status frame will indicate the cause of failure The received data frame 0x90 or 0x91 is set by the AP command Transmit request 0x10 or 0x11 ne RF data and ACK eceived data a 0x90 or 0x91 Transmit status p 0x8B e lt 4 Remote AT commands The following image shows the API frame exchanges that take place at the UART when sending a remote AT command A remote command response frame is not sent out the UART if the remote device does not receive the remote command Remote AT command 0x17 aa Remote AT command response 0x97 lt XBee XBee PRO DigiMesh 2 4 User Guide 75 XBee AP frame specifications Supporting the XBee API Applications that support the API should make provisions to deal with new API frames that may be introduced in future releases For example a section of code on a host microprocessor that handles received serial API frames sent out the module s DOUT pin might look like this void XBee_HandleRxAPIFrame _apiFrameUnion papiFrame 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 identificat
85. ive one of these messages will respond with a synchronization packet Nodes which are configured as non sleep coordinators using the SO command which have gone six or more cycles without hearing a sync will also send a message requesting sync at the beginning of their wake period The following diagram illustrates the synchronization behavior of sleep compatible modules Enter Deployment Mode Wait Sleep Guard Time Is Node in Deployment Mode Is Sleep Coordinator Is Sleep Coordinator Wait Random Holdoff Ever been Sync ed Listen for Listen for Relay of Sync Relay of Sync Is node a non sleep coord node which has lost sync Rapid Sync Disabled Deployment Mode Network Transmit Time Wait Sleep Guard Time Is Cyclic Sleep Node Wait Sleep Time in Low Power Mode XBee XBee PRO DigiMesh 2 4 User Guide 47 XBee asynchronous sleep operation Becoming a sleep coordinator Anode can become a sleep coordinator in one of four ways Preferred sleep coordinator option Anode can be specified to always act as a sleep coordinator Do this by setting the preferred sleep coordinator bit bit 0 in the sleep operations parameter SO to 1 A node with the sleep coordinator bit set will always send a sync message at the beginning of a wake cycle For this reason it is imperative that no more than one node in the network has thi
86. ived packet However 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 XBee XBee PRO DigiMesh 2 4 User Guide 29 XBee network commissioning and diagnostics transmission path or the quality of the worst link it only indicates the quality of the last link and should be used accordingly The DB value can be determined in hardware using the RSSI PWM module pin pin 6 If the RSSI PWM functionality is enabled PO command when the module receives data the RSSI PWM is set to a value based on the RSSI of the received packet Again this value only indicates the quality of the last hop This pin could potentially be connected to an LED to indicate if the link is stable or not XBee device discovery Network discovery The network discovery command can be used to discover all Digi modules that have joined a network Issuing the ND command sends a broadcast network discovery command throughout the network All devices that receive the command will send a response that includes the device s addressing information node identifier string see the NI command and other relevant information This command is useful for generating a list of all module addresses in a network When a device receives the network discovery command it waits a random time before sending its own response The
87. layer source endpoint value This value will be used as the source endpoint for all data transmissions The default value OxE8 Data endpoint is the Digi data endpoint XBee XBee PRO DigiMesh 2 4 User Guide 0 OxFF OxE8 58 Diagnostic addressing Diagnostic addressing AT Command Name and Description Parameter Range Default N Network Discovery Timeout The maximum response time read only 0x3D6A 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 Addressing discovery configuration AT Command Name and Description Parameter Range Default AG Aggregator Support The AG command sends a broadcast Any 64 bit through the network that has the following effects on nodes number which receive the broadcast The receiving node will establish a DigiMesh route back to the originating node provided there is space in the routing table The DH and DL of the receiving node will be updated to the address of the originating node if the AG parameter matches the current DH DL of the receiving node For API enabled modules on which DH and DL are updated an aggregate Addressing Update frame will be sent out the serial port Note that the AG command is only available on products that support DigiMesh DN Discover Node Destination Node Resolves an NI Node 20 byte ASCII Identi
88. lly update the DH 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 DL registers on a module which should be replaced by the 64 bit address of the node sending the AG broadcast If it is not desirable to update the DH DL of the module receiving the AG broadcast then the invalid address of OxFFFE can be used API enabled modules will output an Aggregator Update API frame if they update their DH DL address see the API section of this manual for a description of the frame All modules which receive an AG broadcast will update their routing table information to build a route to the sending module regardless of whether or not their DH DL address is updated This routing information will be used for future transmissions of DigiMesh unicasts Example 1 To update the DH DL registers of all modules in the network to be equal to the MAC address of an aggregator node with a MAC address of 0x0013a2004052c507 after network deployment the following technique could be employed 1 Deploy all modules in the network with the default DH DL of OxFFFF 2 Issue an ATAGFFFF command on the aggregator node XBee XBee PRO DigiMesh 2 4 User Guide 28 XBee network commissioning and diagnostics Following the preceding sequence would result in all of the nodes in the network which received the AG broadcast to have a DH of 0x0013a200 and a DL of 0x4052c507 These no
89. maximum time delay is set on the ND sender with the NT command The ND originator includes its NT setting in the transmission to provide a delay window for all devices in the network Large networks may need to increase NT to improve network discovery reliability The default NT value is 0x82 13 seconds Neighbor polling The neighbor poll command can be used to discover the modules which are immediate neighbors within RF range of a particular node This command is useful in determining network topology and determining possible routes The command is issued using the FN command The FN command can be initiated locally on a node using AT command mode or by using a local AT command request frame The command can also be initiated remotely by sending the target node an FN command using a remote AT command request API frame A node which executes an FN command will send a broadcast to all of its immediate neighbors All radios which receive this broadcast will send an RF packet to the node that initiated the FN command In the case where the command is initiated remotely this means that the responses are sent directly to the node which sent the FN command to the target node The response packet is output on the initiating radio in the same format as a network discovery frame XBee DigiMesh 2 4 RF Module XBee link reliability For a mesh network installation to be successful the installer must be able to determine where to place individual XBee devic
90. mounts of serial data are sent to the module CTS flow control may be required to avoid overflowing the serial receive buffer Cases in which the serial receive buffer may become full and possibly overflow 1 If the module is receiving a continuous stream of RF data the data in the serial receive buffer will not be transmitted until the module is no longer receiving RF data 2 For mesh networking firmware if the module is transmitting an RF data packet the module may need to discover the destination address or establish a route to the destination After transmitting the data the module may need to retransmit the data if an acknowledgment is not received or if the transmission is a broadcast As a result these issues could delay the processing of data in the serial receive buffer Serial transmit buffer When RF data is received the data is moved into the serial transmit buffer and is sent out the serial port If the serial transmit buffer becomes full enough such that all data in a received RF packet won t fit in the serial transmit buffer the entire RF data packet is dropped Cases in which the serial transmit buffer may become full resulting in dropped RF packets 1 If the RF data rate is set higher than the interface data rate of the module the module could receive data faster than it can send the data to the host Even occasional transmissions from a large number of modules can quickly add up and overflow the transmit buffer
91. n packet 84 Aggregate addressing update 86 Receive packet 87 Explicit Rx indicator 89 Data sample Rx indicator 90 Node identification indicator 92 Remote command response 94 XBee XBee PRO terms and definitions Agency certifications United States FCC 98 OEM labeling requirements 98 FCC notices 98 FCC approved antennas 2 4 GHz 99 XBee RF module high gain antenna summary 101 Europe ETSI 103 OEM labeling requirements 103 Restrictions 103 Declarations of conformity 103 Approved antennas 104 Canada IC 104 Labeling requirements 104 Japan Telec 105 Labeling requirements 105 Australia C Tick 105 Labeling requirements 105 ANATEL Brazil certification 105 XBee XBee PRO DigiMesh 2 4 User Guide General information about the XBee XBee PRO DigiMesh 2 4 RF Module The XBee and XBee PRO DigiMesh 2 4 RF Modules are engineered to support the unique needs of low cost low power wireless sensor networks The modules require minimal power and provide reliable delivery of data between remote devices The modules operate within the ISM 2 4 MHz frequency band Easily build networks up to 32 nodes using the XBee modules For larger networks up to 1000 nodes Digi offers RF Optimization Services to assist with proper network configuration Contact Digi Technical Support for more details Key features of the XBee XBee PRO 2 4 DigiMesh The following table highlights the key features of the XBee DigiMesh 2 4 RF Module High
92. n 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 up with Use this node to slightly change the sleep cycle settings of the network increment ST for example 3 Wait for the subnet s next wake cycle During this cycle the node selected to change the sleep cycle parameters will send the new settings to the entire subnet it is in range of including the sleep support node which is in range of the other subnet 4 Wait for the out of sync subnet to wake up and send a sync When the sleep support node receives this sync it will reject it and send a sync to the subnet with the new sleep settings 5 The subnets will now be in sync The sleep support node can be removed If desired the sleep cycle settings can be changed back to what they were In the case that only a few nodes need to be replaced this method can also be used 1 Reset the out of sync node and set its sleep mode to cyclic sleep SM 8 Set it up to have a short sleep cycle 2 Place the node in range of a sleep support node or wake a sleeping node with the commissioning button 3 The out of sync node will receive a sync from the node which is synchronized to the network and sync to the network sleep settings XBee DigiMesh diagnostics The following are useful in some applications when managing a sleeping router network Query sleep cycle The OS and OW
93. na performance improves with a larger keepout area H H No tes 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 inch 2 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 F Whip antennas radiate best over the center of a ground plane J k K Rev ECO DESCRIPTION OF CHANGE BY CKD APPR DATE APPROVALS DATE THEE 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 XBee PRO DigiMesh 2 4 User Guide 16 XBee XBee PRO DigiMesh 2 4 electrical characteristics XBee XBee PRO DigiMesh 2 4 electrical characteristics The following table displays the electrical voltage parameters of the XBee XBee PRO DigiMesh 2 4 RF Module Symbols Parameter Condition Min Typical Max Units Vib Input low voltage All digital inputs 0 2 VCC V Vin Input high voltage All digital inputs 0 8 VCC V VoL Output low voltage lo 2 MA VCC gt 3 0 V 0 18 VCC V Vou Output high voltage lop 2 MA VCC gt 3 0 V 0 82 VCC V Hing Input leakage current
94. nd Application Programming Interface API serial interfaces Transparent operation When a module operates in transparent mode it acts as a Serial line replacement All UART data received through the DIN pin is queued up for RF transmission When a module receives RF data it sends the data out through the DOUT pin You can set the configuration parameters using the AT command mode interface Data is buffered in the serial receive buffer until one of the following causes the data to be packetized and transmitted No serial characters are received for the amount of time determined by the RO Packetization Timeout parameter If RO 0 packetization begins when a character is received The module receives the Command Mode Sequence GT CC GT If any characters were placed in the serial receive buffer before the sequence they are transmitted The module receives the maximum number of characters that will fit in an RF packet API operation API operation is an alternative to transparent operation The frame based API extends the level to which a host application can interact with the networking capabilities of the module When you operate the device in API mode all data entering and leaving the UART is contained in frames that define operations or events within the module Transmit Data Frames received through the DIN pin pin 3 include RF Transmit Data Frame Command Frame equivalent to AT commands Receive Data Fram
95. nds to one analog input channel bit 0 ADO DIOO bit 1 AD1 DI01 bit 2 AD2 DIO2 bit 3 AD3 DIO3 bit 4 AD4 DIO4 bit 5 ASSOC AD5 DIO5 Variable Sampled Data Set If any digital IO lines are enabled the first two bytes of the data set indicate the state of all enabled digital IO Only digital channels that are enabled in the Digital Channel Mask bytes have any meaning in the sample set If no digital IO are enabled on the device these 2 bytes will be omitted Following the digital IO data if any each enabled analog channel will return 2 bytes The data starts with AINO and continues sequentially for each enabled analog input channel up to AIN5 If the IS command is issued from AT command mode then a carriage return delimited list will be returned containing the above listed fields If the command is issued via an API frame then the module will return an AT command response API frame with the IO data included in the command data portion of the packet Example Sample AT Response Ox01 r 1 sample set OxO0COC r Digital Inputs DIO 2 3 10 11 enabled XBee XBee PRO DigiMesh 2 4 User Guide 37 XBee XBee PRO DigiMesh 2 4 I O line monitoring Example Sample AT Response 0x03 r Analog Inputs A D 0 1 enabled 0x0408 r Digital input states DIO 3 10 high DIO 2 11 low 0x03D0 r Analog input ADIO 0 0x3D0 0x0124 r Analog input ADIO 1 0x120 XBee periodic I O sampling Periodic s
96. nk The DB command value is measured in dBm For example if DB returns 0x60 then the RSSI of the last packet received was 96dBm n a n a GD Good Packets Read the number of good frames with valid MAC headers that are received on the RF interface When the value reaches OxFFFF it stays there n a n a EA MAC ACK Timeouts This count is incremented whenever a MAC ACK timeout occurs on a MAC level unicast Once the number reaches OxFFFF further events will not be counted The counter can be reset to any 16 bit value by appending a hexadecimal parameter to the command 0 OxFFFF TR Transmission Errors Read the number of MAC frames that exhaust MAC retries without ever receiving a MAC acknowledgment message from the adjacent node When the value reaches Oxffff it stays there n a n a UA MAC Unicast Transmission Count This count is incremented whenever a MAC unicast transmission occurs for which an ACK is requested Once the number reaches OxFFFF further evens will not be counted The counter can be reset to any 16 bit value by appending a hexadecimal parameter to the command 0 OxFFFF H MAC Unicast One Hop Time The MAC unicast one hop timeout in milliseconds Changing MAC parameters can change this value read only 8 MAC Broadcast One Hop Time The MAC broadcast one hop timeout in milliseconds Changing MAC parameters can change this value read only
97. nsitivity to nearby processors crystals or other PCB components As with all PCB designs power and ground traces should be thicker than signal traces and should be able to comfortably support the maximum current specifications No other special PCB design considerations are required for integrating XBee radios except in the antenna section XBee power supply design A poor power supply can lead to poor radio performance especially if the supply voltage is not kept within tolerance or is excessively noisy To help reduce noise place a 1 0 uF and 8 2 pF capacitor as near to pin one on the PCB as possible If you are using a switching regulator for your power supply switch the frequencies above 500 kHz The power supply ripple needs to be limited to a maximum 100 mV peak to peak XBee antenna performance Antenna location is an important consideration for optimal performance For optimal antenna performance see the following placement tips and suggestions Point your antenna up vertically up right Antennas radiate and receive the best signal perpendicular to the direction they point thus a vertical antenna s radiation pattern is strongest across the horizon Position 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 metal poles metal studs structure beams and concrete it is
98. nt 13 5 dBi Fixed 2m 6 4 dB A24 Y16RM Yagi 16 element RPSMA connector 13 5dBi Fixed 2m 6 4 dB A24 Y18NF Yagi 18 element 15 0 dBi Fixed 2m 7 9 dB Omni Directional Class Antennas 29000430 Integrated PCB Antenna 0 5 dBi Fixed Mobile 20cm A24 F2NF Omni directional Fiberglass base station 2 1 dBi Fixed Mobile 20cm A24 F3NF Omni directional Fiberglass base station 3 0 dBi Fixed Mobile 20cm A24 F5NF Omni directional Fiberglass base station 5 0 dBi Fixed Mobile 20cm A24 F8NF Omni directional Fiberglass base station 8 0 dBi Fixed 2m A24 FONF Omni directional Fiberglass base station 9 5 dBi Fixed 2m 0 2 dB A24 F10NF Omni directional Fiberglass base station 10 0dBi Fixed 2m 0 7 dB A24 F12NF Omni directional Fiberglass base station 12 0dBi Fixed 2m 2 7 dB A24 F15NF Omni directional Fiberglass base station 15 0dBi Fixed 2m 5 7 dB A24 W7NF Omni directional Base station 7 2 dBi Fixed 2m A24 M7NF Omni directional Mag mount base station 7 2 dBi Fixed 2m XBee XBee PRO DigiMesh 2 4 User Guide 100 United States FCC Part Minimum Required Number Type Description Gain Application Separation Cable Loss Panel Class Antennas A24 P8SF Flat Panel 8 5 dBi Fixed 2m 1 5 dB A24 P8NF Flat Panel 8 5 dBi Fixed 2m 1 5 dB A24 P13NF Flat Panel 13 0 dBi Fixed 2m 6 dB A24 P14NF Flat Panel 14 0 dBi Fixed 2m 7 dB A24 P15NF Flat Panel 15 0
99. ntain RS 232 and USB interface boards that use two 20 pin receptacles to receive modules XBee XBee PRO DigiMesh 2 4 RF module mounting to an RS 232 interface board The receptacles on Digi development boards are manufactured by Century Interconnect and Samtec Several other manufacturers provide comparable mounting solutions Digi currently uses the following receptacles 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 Surface mount single row receptacles Samtec P N SMM 110 02 SM S XBee XBee PRO DigiMesh 2 4 User Guide 12 Hardware diagram 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 e eect er oy ee pp Ato D PWM Interface 1 Amplifier section 1 on X BEE PRO Modules 1 Switch Antenna Switch Control XBee XBee PRO DigiMesh 2 4 pin signals The following table shows the XBee XBee PRO DigiMesh 2 4 RF Module pin signals and descriptions PIN 1 PIN 10 Pin Name Direction Description 1 Vcc Power supply 2 DOUT Output UART data out 3 DIN CONFIG Input UART data in 4 DIO12 Either Digital I O 12 XBee XBee PRO DigiMesh 2 4 User Guide 13 XBee XBee PRO DigiMesh 2 4 pin signals Pin
100. ode 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 information from the RREQ is saved and the RREQ is updated and broadcast When the ultimate destination receives the RREQ it unicasts a route reply RREP back to the source node along the path of the RREQ This is done regardless of route quality and regardless of how many times an RREQ has been seen 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 will use for the queued packet and for subsequent packets with the same destination address Throughput Throughput in a DigiMesh network varies by a number of variables including number of hops encryption enabled disabled sleeping end devices failures route discoveries Our empirical testing showed the following throughput performance in a robust operating environment low interference Configuration Data Throughput 1 hop encryption disabled 27 0 kb s 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 7 kb s Note Data throughput measurements were made setting the serial interface rate to 115200 b s and measuring the time to send 100 000 bytes from source to destination During the test no route
101. odules cable loss is not required Minimum Part Number Type Description Gain Application Separation A24 HASM 450 Dipole Half wave articulated RPSMA 4 5 2 1 dBi Fixed Mobile 20 cm 29000095 Dipole Half wave articulated RPSMA 4 5 2 1 dBi Fixed Mobile 20 cm A24 HABSM Dipole Articulated RPSMA 2 1 dBi Fixed 20 cm A24 HABUF P5I Dipole Half wave articulated bulkhead mount 2 1 dBi Fixed 20 cm U FL w 5 pigtail A24 HASM 525 Dipole Half wave articulated RPSMA 5 25 2 1 dBi Fixed Mobile 20 cm XBee XBee PRO DigiMesh 2 4 User Guide 99 United States FCC Minimum Part Number Type Description Gain Application Separation A24 QI Monopole Integrated whip 1 5 dBi Fixed 20 cm A24 C1 Surface Mount 1 5 dBi Fixed Mobile 20 cm Antennas approved for use with the XBee RF Modules cable loss is shown if required Part Minimum Required Number Type Description Gain Application Separation Cable Loss Yagi Class Antennas A24 Y4NF Yagi 4 element 6 0 dBi Fixed 2m A24 Y6NF Yagi 6 element 8 8 dBi Fixed 2m 1 7 dB A24 Y7NF Yagi 7 element 9 0 dBi Fixed 2m 1 9dB A24 Y9ONF Yagi 9 element 10 0dBi Fixed 2m 2 9 dB A24 Y10NF Yagi 10 element 11 0dBi Fixed 2m 3 9 dB A24 Y12NF Yagi 12 element 12 0 dBi Fixed 2m 4 9 dB A24 Y13NF Yagi 13 element 12 0 dBi Fixed 2m 4 9 dB A24 Y15NF Yagi 15 element 12 5 dBi Fixed 2m 5 4 dB A24 Y16NF Yagi 16 eleme
102. or is error due to input leakage across the real portion of the impedance of the network driving the analog pin Reducing the impedance of the network reduces this error 10 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 2LSB and circuit error differential integral zero scale and full scale error The specified value of E7y assumes zero E no leakage or zero real source impedance XBee XBee PRO DigiMesh 2 4 User Guide 18 XBee XBee PRO module operation The XBee module provides a serial interface to an RF link The XBee module converts serial data to RF data that is sent to any device in an RF network In addition to RF data communication devices the XBee module provides a software interface for interacting with a variety of peripheral functions including I O sampling commissioning and management devices The following diagram illustrates the functionality of the XBee module Functionality of the XBee XBee PRO DigiMesh 2 4 RF Module Serial Interface API Frame Transparent Data AT Command Parser Packetizer Mode Parser Command Handler Sleep Manager Packet Rout Loop back E a A outer 1 O Manager Mandap Node Discovery Handler Security Mesh Networking Layer Mesh products only Mac Layer Baseband Layer XBee XBee PRO DigiMesh 2 4 Use
103. p coordinator presumably because the sleep coordinator has been disabled it may become a sleep coordinator Depending on the platform and other configured options such a node eventually nominates itself after a number of cycles without a sync A nominated node will begin acting as the new network sleep coordinator It is possible for multiple nodes to nominate themselves as the sleep coordinator If this occurs an election will take place to establish seniority among the multiple sleep coordinators Seniority is determined by four factors in order of priority 1 Newer sleep parameters A node using newer sleep parameters SP ST is considered senior to a node using older sleep parameters See Changing sleep parameters on page 51 2 Preferred sleep coordinator A node acting as a preferred sleep coordinator is senior to other nodes 3 Sleep support node Sleep support nodes are senior to cyclic sleep nodes This behavior can be modified using the SO parameter 4 Serial number In the event that the above factors do not resolve seniority the node with the higher serial number is considered senior Commissioning button option The commissioning button is used to select a module to act as the sleep coordinator If the commissioning button functionality is enabled a node can be immediately nominated as a sleep coordinator by pressing the commissioning button twice or by issuing the CB2 command A node nominated in this manner is still
104. performance low cost Low power XBee Indoor Urban up to 100 ft 30 m Outdoor line of sight up to 300 ft 100 m Transmit power output 1 mW 0 dBm Receiver sensitivity 92 dBm XBee PRO Indoor Urban up to 300 ft 100 m Outdoor line of sight up to 1 mile 1500m Transmit power output 63 mW 18 dBm Receiver sensitivity 100 dBm RF data rate 250 kb s XBee XBee PRO DigiMesh 2 4 User Guide XBee TX peak current 45mA 3 3V Power down current cyclic sleep lt 50 pA Power down current pin sleep lt 10 pA XBee PRO TX peak current 250 mA 150 mA for international variant TX peak current RPSMA module only 340 mA 180 mA for international variant RX current 55 mA 3 3V Power down current cyclic sleep lt 50 pA Power down current pin sleep lt 10 pA Advanced networking and security Worldwide acceptance of the XBee XBee PRO 2 4 DigiMesh Easy to use Retries and acknowledgments Optional self routing self healing mesh networking available DSSS Direct Sequencing Spread Spectrum No configuration necessary for out of box RF communications AT and API command modes for configuring the module Small form factor Worldwide acceptance of the XBee XBee PRO 2 4 DigiMesh Our XBee DigiMesh 2 4 RF modules meet the following standards USA FCC approval refer to Appendix B for FCC requirements Systems that contain XBee PRO DigiMesh 2 4 RF Modules inherit Digi certifica
105. placement For a network installation to be successful the installer must be able to determine where to place individual XBee devices to establish reliable links throughout the network Link testing A good way to measure the performance of a network is to send unicast data through the network from one device to another to determine the success rate of many transmissions To simplify link testing the modules support a loopback cluster ID 0x12 on the data endpoint OxE8 Any data sent to this cluster ID on the data endpoint will be transmitted back to the sender The configuration steps to send data to the loopback cluster ID depend on the AP setting AT configuration AP 0 To send data to the loopback cluster ID on the data endpoint of a remote device set the Cl command value to 0x12 The SE and DE commands should be set to OxE8 default value The DH and DL commands should be set to the address of the remote After exiting command mode any received serial characters will be transmitted to the remote device and returned to the sender API configuration AP 1 or AP 2 Send an Explicit Addressing Command API frame 0x11 using 0x12 as the cluster ID and OxE8 as the source and destination endpoint Data packets received by the remote will be echoed back to the sender RSSI indicators It is possible to measure the received signal strength on a device using the DB command DB returns the RSSI value measured in dBm of the last rece
106. put 3 Digital input 4 Digital output low 5 Digital output high 0 2 3 4 5 P2 DIO12 Configuration pin 4 0 Disabled 1 N A 2 N A 3 Digital input 4 Digital output low 5 Digital output high XBee XBee PRO DigiMesh 2 4 User Guide 0 3 4 5 64 AT Command PR Name and Description Pull up Resistor The bit field that configures the internal pull up resistor status for the I O lines 1 specifies the pull up resistor is enabled 0 specifies no pullup Bits 0 AD4 DIO4 1 AD3 DIO3 2 AD2 DIO2 3 AD1 DIO1 4 ADO DIOO 5 AD6 DIO6 RTS 6 DIO8 SLEEP_RQ 7 DIN pin3 8 AD5 DIO5 ASSOCIATE 9 DIO9 ON 10 DIO12 11 DIO10 RSSI PWMO 12 DIO11 PWM1 13 DIO7 14 DOUT pin 2 Parameter Range O 0x7FFF bitfield I O settings Default Ox1FFF MO PWMO Duty Cycle The duty cycle of the PWMO line The line should be configured as a PWM output using the PO command 0 Ox3FF M1 PWM1 Duty Cycle The duty cycle of the PWM1 line The line should be configured as a PWM output using the P1 command 0 Ox3FF LT Assoc LED Blink Time The Associate LED blink time If the Associate LED functionality is enabled D5 command this value determines the on and off blink times for the LED If LT 0 the default blink rate will be used 500ms sleep coordinator 250ms otherwise For all other LT values LT is measured
107. r Guide 19 Serial communications for the XBee RF Module Serial communications for the XBee RF Module The XBee PRO RF Modules interface to a host device through a logic level asynchronous serial port Through its serial port the module can communicate with any logic and voltage compatible UART or through a level translator to any serial device for example through a Digi proprietary RS 232 or USB interface board XBee UART data flow Devices that have a universal asynchronous receiver transmitter UART interface can connect directly to the pins of the RF modules as shown in the figure below System data flow diagram in a UART interfaced environment low asserted signals distinguished with horizontal line over signal name CMOS Logic 3 0 3 6V SZ poeno Z CMOS Logic 3 0 3 6V N DIN data in DIN data in a aad Module Module Microcontroller o Bo XBee serial data Data enters the module UART through the DIN pin 3 as an asynchronous Serial signal The signal will idle high when no data is being transmitted Each data byte consists of a start bit low 8 data bits least significant bit first and a stop bit high The following figure illustrates the serial bit pattern of data passing through the module UART data packet 0x1F decimal number 31 as transmitted through the RF module Example data format is 8 N 1 bits parity of stop bits Microcontroller Least Significant Bit first h
108. r it fails a route discovery will be initiated and upon completion of the route discovery the data will be transmitted along the new route The timeout associated with the entire operation can be estimated as follows brokenRouteUnicast BroadcastTxTime NH unicastOneHopTime 2 knownRouteUnicast XBee XBee PRO DigiMesh 2 4 User Guide 43 XBee XBee PRO DigiMesh 2 4 sleep modes A number of low power modes exist to enable modules to operate for extended periods of time on battery power These sleep modes are enabled with the SM command The sleep modes are characterized as either asynchronous SM 1 4 5 or synchronous SM 7 8 Do not use asynchronous sleeping modes in a synchronous sleeping network and vice versa Asynchronous sleep modes are used to control the sleep state on a module by module basis Do not use modules operating in asynchronous mode to route data We strongly encourage users to set asynchronous sleeping modules as end devices using the CE command This prevents the node from attempting to route data The synchronous sleep feature of DigiMesh 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 cyclic sleeping network Nodes synchronize by receiving a special RF packet called a sync message which is sent by a node acting as a sleep coordinator Anode in the network can become a coordinator
109. rame ID 4 0x00 Identifies the UART data frame for the host to correlate with a subsequent ACK acknowledgment If set to 0 no response is sent 64 bit Source MSB5 0x13 64 bit address of sender Address OxA2 7 0x00 8 0x40 9 0x52 10 0x2B LSB 11 OxAA Reserved 12 OXxFF Reserved 13 OxFE Receive 14 0x01 Bitfield Options 0x01 Packet Acknowledged 0x02 Packet was a broadcast packet All other bits are reserved and should be ignored Received Data 15 0x52 Received RF data 16 0x78 17 0x44 18 0x61 19 0x74 20 0x61 Checksum 21 0x11 OxFF the 8 bit sum of bytes from offset 3 to this byte Example In the example above 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 would send the above frame out its UART XBee XBee PRO DigiMesh 2 4 User Guide 88 Explicit Rx indicator Frame type 0x91 XBee AP frame specifications When the module receives an RF packet it is sent out the UART using this message type when AO 1 Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB1 0x00 Number of bytes between the length and the checksum LSB 2 0x18 Frame specific Data Frame Type 3 0x91 64 bit Source MSB4 0x00 64 bit address of sender Address 5 0x13 6 OxA2 7 0x00 8 0x40 9 0x52 10 0x2B LSB 11 OxAA Reserved 12 OxFF Reserved
110. ress the commissioning button twice This will cause 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 Next power on nodes in range of the sleep coordinator or other nodes which have synchronized with the network If the synchronized node is asleep it can be woken by pressing the commissioning button once Wait a cycle for the new node to sync itself 5 Verify that the node syncs with the network The associate LED will blink when the module is awake and synchronized Continue this process until all nodes have been deployed XBee XBee PRO DigiMesh 2 4 User Guide 50 XBee asynchronous sleep operation 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 will periodically send a broadcast requesting a sync message and then sleep for its SP period Any node in the network that receives this message will respond with a sync Because the network can be asleep for extended periods of time and as such 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 will be
111. roadcast transmission can traverse If set to 0 the transmission radius will be set to the network maximum hops value Transmit Options 22 0x00 Bitfield XBee XBee PRO DigiMesh 2 4 User Guide bit 0 Disable ACK bit 1 Don t attempt route Discovery All other bits must be set to 0 80 XBee AP frame specifications Frame Fields Offset Example Description Data Payload 23 0x54 24 0x78 25 0x44 26 0x61 27 0x74 28 0x61 Checksum 29 0xDD OxFF the 8 bit sum of bytes from offset 3 to this byte Example The example above sends a data transmission to a radio with a 64 bit address of 0x0013A20001238400 using a source endpoint of OxA0 destination endpoint OxA1 cluster ID 0x1554 and profile ID 0xC105 Payload will be TxData Remote AT command request Frame type 0x17 Used to query or set module parameters on a remote device For parameter changes on the remote device to take effect changes must be applied either by setting the apply changes options bit or by sending an AC command to the remote Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB 1 0x00 Number of bytes between the length and the checksum LSB2 0x10 Frame specific Data Frame Type 3 0x17 Frame ID 4 0x01 Identifies the UART data frame for the host to correlate with a subsequent ACK If set to 0 no response is sent 64 bit Destination MSB5 0x00 Set to the 6
112. s 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 Ox8A Transmit Status Ox8B Receive Packet AO 0 0x90 Explicit Rx Indicator AO 1 0x91 Node Identification Indicator AO 0 0x95 Remote Command Response 0x97 Route Information Packet 0x8D Aggregate Addressing Update Ox8E I O Data Sample Rx Indicator 0x92 Checksum XBee AP frame specifications To test data integrity a checksum is calculated and verified on non escaped data To calculate Not including frame delimiters and length add all bytes keeping only the lowest 8 bits of the result and subtract the result from OxFF To verify Add all bytes include checksum but not the delimiter and length If the checksum is correct the sum will equal OxFF XBee XBee PRO DigiMesh 2 4 User Guide 74 XBee API frame specifications XBee API UART exchanges AT commands The following image shows the API frame exchange that takes place at the UART when sending an AT command request to read or set a module parameter The response can be disabled by setting the frame ID to 0 in the request AT Command request 0x08 or 0x09 gt AT Command response 0x88 Transmitting and receiving RF data The following image shows the API exchanges that take place at the UART when sending RF data to another device The transm
113. s bit set Although it is not necessary to specify a preferred sleep coordinator it is often useful to select a node for this purpose to improve network performance A node which is centrally located in the network can serve as a good sleep coordinator to minimize the number of hops a sync message must take to get across the network A sleep support node and or a node which is mains powered may be a good candidate Use the preferred sleep coordinator bit with caution The advantages of using the option become weaknesses when used on a node that is not positioned or configured properly The preferred sleep coordinator option can also be used when setting up a network for the first time When starting a network a node can be configured as a sleep coordinator so it will begin sending sleep messages After the network is set up disable the preferred sleep coordinator bit Nomination and election option Nomination is an optional process that can occur on a node in the event that contact with the network sleep coordinator is lost By default this behavior is disabled This behavior can be enabled with the sleep options command SO This process will automatically occur in the event that contact with the previous sleep coordinator is lost Any sleep compatible node which has this behavior enabled is eligible to become the sleep coordinator for the network If a sleep compatible node has missed three or more sync messages and is not configured as a non slee
114. s is not discovered the packet is discarded The data will be transmitted once a route is established Route discovery will be attempted only once per packet Transmit Mode sequence Successful Transmission Yes Idle Mode Route Known Transmit Data New Transmission ie Route Discovery Route Discovered No Data Discarded XBee XBee PRO DigiMesh 2 4 User Guide 24 Receive mode When one node transmits data to another a network level acknowledgment is transmitted back across the established route to the source node This acknowledgment packet tells the source node that the data packet was received by the destination node If the source node does not receive network acknowledgment it re transmits the data See DigiMesh data transmission and routing on page 40 section for more information Receive mode If a destination node receives a valid RF packet the data transfers to the serial transmit buffer Command mode To modify or read RF module parameters the module must first enter into Command Mode a state in which incoming serial characters are interpreted as commands Refer to XBee XBee PRO DigiMesh 2 4 API operation on page 72 for an alternative means of configuring modules AT Command Mode To enter AT Command Mode Send the three character command sequence and observe the guard times before and after the command characters Refer to the Default AT Command Mode Sequence below De
115. sed to differentiate multiple XBee based products read only NP Maximum RF Payload Bytes 0 OXFFFF This value returns the maximum number of RF payload bytes that can be sent in a unicast transmission based on the current configurations CK Configuration Code Read the configuration code associated 0 OxFFFFFFFF n a with the current AT command configuration The code returned can be used as a quick check to determine if a node has been configured as desired XBee XBee PRO DigiMesh 2 4 User Guide 70 Firmware commands firmware version information XBee XBee PRO DigiMesh 2 4 User Guide 71 XBee XBee PRO DigiMesh 2 4 API operation As an alternative to Transparent Operation API Application Programming Interface Operations are available API operation requires that communication with the module be done through a structured interface data is communicated in frames in a defined order The API specifies how commands command responses and module status messages are sent and received from the module using a UART Data Frame Please note that Digi may add new frame types to future versions of firmware so please build into your software interface the ability to filter out additional API frames with unknown Frame Types XBee API frame specifications Two API modes are supported and both can be enabled using the AP API Enable command Use the following AP parameter values to configure the module to operate in a particular mode
116. sh 2 4 14 XBee DigiMesh 2 4 design notes 15 XBee board layout 15 XBee power supply design 15 XBee antenna performance 15 Point your antenna up vertically up right 15 Position antennas away from metal objects whenever possible 15 Use an external antenna if the XBee device is placed inside a metal enclosure 15 Do not place XBee modules with the chip or integrated PCB antennas inside a metal en closure 15 XBee XBee PRO DigiMesh 2 4 electrical characteristics 17 XBee XBee PRO module operation Serial communications for the XBee RF Module 20 XBee UART data flow 20 XBee serial data 20 XBee serial buffers 20 Serial receive buffer 21 Serial transmit buffer 21 XBee serial flow control 21 CTS flow control 22 RTS flow control 22 XBee serial interface protocols 22 Transparent operation 22 API operation 22 Comparing transparent and API operation 23 XBee XBee PRO DigiMesh 2 4 User Guide 4 Idle mode 24 Transmit mode 24 Receive mode 25 Command mode 25 AT Command Mode 25 Sleep Mode 26 XBee XBee PRO DigiMesh 2 4 advanced application features XBee remote configuration commands 27 Sending aremote command 27 Applying changes on remote devices 27 XBee remote command responses 27 XBee network commissioning and diagnostics 28 XBee PRO 900HP device configuration 28 XBee network link establishment and maintenance 28 Building aggregate routes 28 Node replacement 29 XBee device placement 29 Link testing 29 RSSI indicators 29 XBee device discovery
117. string is returned as part of the ATND Network Discover command This identifier is also used with the ATDN Destination Node command up to 20 byte ASCII string a space character NT Node Discover Timeout Set Read the amount of time a node will spend discovering other nodes when ND or DN is issued 0 OxFC x100 ms 0x82 13 seconds NO Network Discovery Options Set Read the options value for the network discovery command The options bitfield value can change the behavior of the ND network discovery command and or change what optional values are returned in any received ND responses or API node identification frames Options include 0x01 Append DD value to ND responses or API node identification frames 0x02 Local device sends ND response frame when ND is issued 0x04 Append RSSI of the last hop for DigiMesh networks to ND or FN responses or API node identification frames 0 0x07 bitfield 0 Cl Cluster Identifier Set read application layer cluster ID value This value will be used as the cluster ID for all data transmissions The default value 0x11 Transparent data cluster ID 0 OxFFFF 0x11 DE Destination Endpoint Set read application layer destination ID value This value will be used as the destination endpoint for all data transmissions The default value OxE8 is the Digi data endpoint 0 OxFF OxE8 SE Source Endpoint Set read the application
118. subject to the election process described above A node configured as a non sleep coordinator will ignore commissioning button nomination requests XBee XBee PRO DigiMesh 2 4 User Guide 48 XBee asynchronous sleep operation Changing the sleep parameters Any sleep compatible node in the network which does not have the non sleep coordinator sleep option set can be used to make changes to the network s sleep and wake times If a node s SP and or ST are changed to values different from those that the network is using the node becomes the sleep coordinator That node begins sending sync messages with the new sleep parameters at the beginning of the next wake cycle Note For normal operations a module will use the sleep and wake parameters it gets from the sleep sync message not the ones specified in its SP and ST parameters The SP and ST parameters are not updated with the values of the sync message The current network sleep and wake times used by the node can be queried using the OS and OW commands Note 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 In most applications these network parameters should only be config
119. t I i 1 I I i I 1 1 i Enabling Edge Detection will force an immediate sample of all monitored digital IO lines if any digital IO lines change state 0 XBee XBee PRO DigiMesh 2 4 User Guide 38 XBee XBee PRO DigiMesh 2 4 networking Mesh networking allows messages to be routed through several different nodes to a final destination DigiMesh firmware allows manufacturers and system integrators to bolster their networks with the self healing attributes of mesh networking In the event that one RF connection between nodes is lost due to power loss environmental obstructions and so forth critical data can still reach its destination due to the mesh networking capabilities embedded inside the modules DigiMesh feature set DigiMesh contains the following features Self healing Any node may enter or leave the network at any time without causing the network as a whole to fail Peer to peer architecture No hierarchy and no parent child relationships are needed Quiet protocol Routing overhead will be reduced by using a reactive protocol similar to AODV e Route discovery Rather than maintaining a network map routes will be discovered and created only when needed Selective acknowledgments Only the destination node will reply to route requests Reliable delivery Reliable delivery of data is accomplished by means of acknowledgments Sleep modes Low power sleep modes with synchronized wake are supported
120. tes from offset 3 to this byte Example If a remote command is sent to a remote device with 64 bit address 0x0013A200 40522BAA to query the SL command and if the frame ID 0x55 the response would look like the above example XBee XBee PRO DigiMesh 2 4 User Guide 95 XBee XBee PRO terms and definitions Terms and Definitions PAN Personal Area Network A data communication network that includes a coordinator and one or more routers end devices Synonymous with Network ID Network Address The 16 bit address is used for compatibility and has an address of OxFFFE Route Request Broadcast transmission sent by a coordinator or router throughout the network in attempt to establish a route to a destination node Route Reply Unicast transmission sent back to the originator of the route request It is initiated by a node when it receives a route request packet and its address matches the Destination Address in the route request packet Route Discovery DigiMesh Protocol The process of establishing a route to a destination node when one does not exist in the Routing Table It is based on the AODV Ad hoc On demand Distance Vector routing protocol Election An election takes place to resolve which node will function as the network s sleep coordinator if multiple nodes nominate themselves at the same time Hopping One direct host to host connection forming part of the route between hosts Network Iden
121. the DigiMesh network 46 DigiMesh synchronization messages 46 Becoming asleep coordinator 48 Sleep guardtimes 49 Auto early wake up sleep option 49 XBee DigiMesh configuration 49 Selecting sleep parameters 49 Starting a sleeping DigiMesh network 50 Adding a new node to an existing network 51 Changing sleep parameters 51 XBee DigiMesh diagnostics 52 Query sleep cycle 52 Sleep status 53 Missed sync messages command 53 Sleep status API messages 53 XBee XBee PRO command reference tables Special 54 MAC PHY level 54 Diagnostics 56 Network 57 Addressing 57 Diagnostic addressing 59 Addressing discovery configuration 59 Security 60 Serial interfacing 61 I O settings 62 I O sampling 66 Sleep 67 Sleep diagnostics 69 AT command options 70 Firmware commands firmware version information 70 XBee XBee PRO DigiMesh 2 4 API operation XBee API frame specifications 72 XBee XBee PRO DigiMesh 2 4 User Guide XBee API operation AP parameter 1 72 XBee API operation with escape characters AP parameter 2 72 XBee escape characters 73 XBee UART frame data 73 Checksum 74 XBee API UART exchanges 75 ATcommands 75 Transmitting and receiving RF data 75 Remote ATcommands 75 Supporting the XBee API 76 XBee frame data 76 ATcommand 76 AT command queue parameter value 77 Transmit request 78 Explicit addressing command frame 79 Remote AT command request 81 AT command response 82 Modem status 83 Transmit status 83 Route informatio
122. the Trace Route option only be used for occasional diagnostic purposes and not for normal operations Trace Route example About XModem PC Settings Range Test Terminal Modem Configuration Line Status Assert 5 MOTELS TAH ATS Brek comPort Packet Sareen Hex Po aia 7E 00 11 10 01 00 13 A2 00 40 49 80 1 Se 89 FF FF 00 08 01 02 03 9B 7E 00 2E is 6 9 6 8D 12 2B 04 00 A5 9F 00 00 00 00 13 Hise atete A A A2 00 40 49 80 89 00 13 A2 00 40 3A e 98 5E 00 13 A2 00 40 3A 98 5E 00 13 Aracati A2 00 40 49 80 89 00 00 02 C1 00 00 ussu 00 00 52 7E 00 07 8B 01 FF FE 01 00 ee 02 73 i S i f l COM1 38400 8 N 1 FLOW HW Rx 65 bytes NACK messages The NACK API option of Tx Request Packets see XBee XBee PRO DigiMesh 2 4 API operation on page 72 for a description of the API frames provides the option to have a Route Information packet generated and sent to the originator of a unicast when a MAC acknowledgment failure occurs on one of the hops to the destination This information is useful because it allows marginal links to be identified and repaired XBee XBee PRO DigiMesh 2 4 User Guide 33 XBee network commissioning and diagnostics Commissioning pushbutton and associate LED The XBee modules support a set of commissioning and LED behaviors to aid in device deployment and commissioning These include the commissioning push button definitions and associate LED behaviors Th
123. tifier A user configurable string used to identify a node apart from its address Network Address The 64 bit address assigned to a node after it has joined to another node Nomination Nomination is the process where a node becomes a sleep coordinator Route Request Broadcast transmission sent by a coordinator or router throughout the network in attempt to establish a route to a destination node Route Reply XBee XBee PRO DigiMesh 2 4 User Guide Unicast transmission sent back to the originator of the route request It is initiated by a node when it receives a route request packet and its address matches the Destination Address in the route request packet 96 Route Discovery The process of establishing a route to a destination node when one does not exist in the Routing Table It is based on the AODV Ad hoc On demand Distance Vector routing protocol Sleep coordinator Node used to send sync messages in a cyclic sleeping network Sync message A transmission used in a cyclic sleeping network to maintain synchronization XBee XBee PRO DigiMesh 2 4 User Guide 97 Agency certifications United States FCC XBee XBee PRO DigiMesh 2 4 RF Modules comply with Part 15 of the FCC rules and regulations Compliance with the labeling requirements FCC notices and antenna usage guidelines is required To fulfill FCC Certification requirements the OEM must comply with the following regulations
124. tion bit in the API frame Issue an AC command to the remote device Issue a WR FR command to the remote device to save changes and reset the device XBee remote command responses 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 the status of the command success or reason for failure and in the case of a command query it will include the register value The device that sends a remote command will not receive a remote command response frame if XBee XBee PRO DigiMesh 2 4 User Guide 27 XBee network commissioning and diagnostics The destination device could not be reached The frame ID in the remote command request is set to 0 XBee network commissioning and diagnostics Network commissioning is the process whereby devices in a network are discovered and configured for operation The XBee modules include several features to support device discovery and configuration In addition to configuring devices a strategy must be developed to place devices to ensure reliable routes To accommodate these requirements the XBee modules include various features to aid in device placement configuration and network diagnostics XBee PRO 90
125. tions FE ISM industrial scientific and medical 2 4 GHz frequency band e Manufactured under ISO 9001 2000 registered standards XBee PRO DigiMesh 2 4 RF Modules are optimized for use in U S and Canada contact Digi for complete list of agency approvals Specifications of the XBee XBee PRO 2 4 DigiMesh The following table describes the hardware and mechanical specifications of the XBee PRO DigiMesh 2 4 RF Module Specification Performance XBee XBee PRO Indoor Urban range Up to 100 ft 30 m Up to 300 ft 90 m up to 200 ft 60 m international variant Outdoor RF line of sight range Up to 300 ft 90 m Up to 1 mile 1 5 km w 2 0 dB dipole antenna Up to 6 miles 10 km w high gain antenna Transmit power output 1 mW 0 dBm 63 mW 18 dBm 10 mW 10 dBm for international variant RF data rate 250 kb s 250 kb s Serial interface data rate software selectable 1200 bps 250 kb s non standard baud rates also supported 1200 bps 250 kb s non standard baud rates also supported Receiver sensitivity 92 dBm 1 packet error rate 100 dBm 1 packet error rate Power requirements Supply voltage 2 8 3 4 VDC 2 8 3 4 VDC Transmit current 45 mA 3 3 V XBee XBee PRO DigiMesh 2 4 User Guide 250 mA 3 3 V 150 mA for international variant RPSMA module only 340 mA 3 3 V 180 mA for international variant Specific
126. 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 FCC test report or CISPR 22 test report for compliance with ICES 003 XBee XBee PRO DigiMesh 2 4 User Guide 104 United States FCC Japan Telec In order to use 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 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 have 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 agent in Australia that will sponsor the importing of the end product Contact Digi for questions related to locating a contact in Australia ANATEL Brazil certification The XBee RF modules with DigiMesh firmware models noted in conformity information below comply with Brazil ANATEL standards in Resolut
127. up it returns the API frame above Transmit status Frame type 0x8B When a TX Request is completed the module sends a TX Status message This message will indicate if the packet was transmitted successfully or if there was a failure Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB1 0x00 Number of bytes between the length and the checksum LSB 2 0x07 Frame specific Data Frame Type 3 0x8B Frame ID 4 0x47 Identifies the UART data frame being reported XBee XBee PRO DigiMesh 2 4 User Guide Note If Frame ID 0 in AT Command Mode no AT Command Response will be given 83 XBee AP frame specifications Frame Fields Offset Example Description Reserved 5 OxFF Reserved 6 OxFE Transmit Retry 7 0x00 The number of application transmission retries that took place Count Delivery Status 8 0x00 0x00 Success 0x01 MAC ACK Failure 0x15 Invalid destination endpoint 0x21 Network ACK Failure 0x25 Route Not Found Discovery Status 9 0x02 0x00 No Discovery Overhead 0x02 Route Discovery Checksum 10 Ox2E OxFF the 8 bit sum of bytes from offset 3 to this byte Example In the example above a unicast data transmission was sent successfully to a destination device using a frame ID of 0x47 Route information packet Frame type 0x8D A route information packet that can be output for DigiMesh unicast transmissions on which the NACK is enabled
128. ured during deployment Sleep guard times To compensate for variations in the timekeeping hardware of the various modules in a sleeping router network sleep guard times are allocated at the beginning and end of the wake time The size of the sleep guard time varies based on the sleep and wake times selected and the number of cycles that have elapsed since the last sync message was received The sleep guard time guarantees that a destination radio will be awake when a transmission is sent As more and more consecutive sync messages are missed the sleep guard time increases in duration and decreases the available transmission time Auto early wake up sleep option Similarly to the sleep guard time the auto early wake up option decreases the sleep period based on the number of sync messages missed This option comes at the expense of battery life Auto early wake up sleep can be disabled using the sleep options SO command XBee DigiMesh configuration Selecting 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 appropriate values for the Network Hops NH and Network Delay Slots NN parameters Note The default values of NH and NN have been optimized to work for the majority of deployments
129. urope ETSI The XBee PRO RF Module has been certified for use in several European countries For a complete list refer to www digi com 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 CE labeling requirements o 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 drawing must be respected 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 The CE marking must be af
130. usually reinforced with metal rods Use an external antenna if the XBee device is placed inside a metal enclosure Common objects that have metal enclosures include vehicles elevators ventilation ducts refrigerators microwave ovens batteries and tall electrolytic capacitors Do not place XBee modules with the chip or integrated PCB antennas inside a metal enclosure There should not be any ground planes or metal objects above or below the antenna For best results place the XBee at the edge of the host PCB on which it is mounted Ensure that the ground XBee XBee PRO DigiMesh 2 4 User Guide 15 XBee DigiMesh 2 4 design notes power and signal planes are vacant immediately below the antenna section It is recommended that you allow a keepout area which is shown in detail below Keepout area for the XBee XBee PRO DigiMesh 2 4 RF Module 1 2 3 4 5 5 7 8 Minimum Keepout Area All PCB Layers A k 83 8mm gt k 33 28TH 5 a 3 E N E No metal in keepout on all layers w o B T B gt E 2 E oO S g Rg olo amp XBee form factor 6 XBee PRO form factor Recommended Keepout Area All PCB Layers D D 111 8mm le 44 8Thou No metal in keepout on all layers E g a E a kod wo fe o m m Preferred edge of PCB 3f ef When possible keep XBee close E 2 E to edge of board E 5m i G G The anten
131. ut Analog samples are ordered sequentially from ADO DIOO to AD3 DIO3 Checksum 23 OxF5 OxFF the 8 bit sum of bytes from offset 3 to this byte Example In the example above an I O sample was received from a radio with a 64 bit serial number of 0x0013A200 40522BAA The transmitting radio was configured to take a digital sample of a number of digital I O lines and an analog sample of AD1 The digital lines were read to be 0x0014 and the analog sample had a value of 0x0225 The complete example frame should be 7E O 1492 0013 A200 4052 2BAA FFFE 0101 001C 0200 1402 25F9 XBee XBee PRO DigiMesh 2 4 User Guide 91 Node identification indicator XBee AP frame specifications Frame type 0x95 frame see ND command This frame is received when a module transmits a node identification message to identify itself when AO 0 The data portion of this frame is similar to a network discovery response frame see the ND command Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB1 0x00 Number of bytes between the length and the checksum LSB 2 0x25 Frame specific Frame Type 3 0x95 A 64 bit Source MSB4 0x00 64 bit address of sender Address 5 0x13 6 OxA2 7 0x00 8 0x40 9 0x74 10 0x02 LSB 11 OxAC Reserved 12 OxFF Reserved 13 OxFE Receive 14 0xC2 0x01 Packet acknowledged Options 0x02 Packet was a broadcast packet 0x40 Point multipoint packet 0x80 Direct
132. will increase the sleeping current draw especially in SM1 mode When asleep hold down the commissioning button for up to two seconds to wake the module from sleep then issue the two or four button presses Associate LED The Associate pin pin 15 can provide indication of the device s sleep status and diagnostic information To take advantage of these indications an LED can be connected to the Associate pin as shown in the figure above The Associate LED functionality is enabled by setting the D5 command to 1 enabled by default If enabled the Associate pin is configured as an output and will behave as described in the following sections The Associate pin indicates the synchronization status of a sleep compatible node On a non sleep compatible node the pin functions as a power indicator The following table describes this functionality The LT command can be used to override the blink rate of the Associate pin When set to 0 the device uses the default blink time 500 ms for sleep coordinator 250 ms otherwise Sleep mode LED Status Meaning 0 On blinking The device is powered and operating properly 1 4 5 Off The device is in a low power mode 1 4 5 On blinking The device is powered awake and is operating properly 7 On solid The network is asleep or the device has not synchronized with the network or has lost synchronization with the network 7 8 On slow blinking 500 The device is actin
133. work By default all new nodes operate in normal non sleep mode To start a sleeping network follow these steps 1 Enable the preferred sleep coordinator option on one of the nodes and set its SM to a sleep compatible mode 7 or 8 with its SP and ST set to a quick cycle time The purpose of a quick cycle time is to allow commands to be sent quickly through the network during commissioning Next power on the new nodes within range of the sleep coordinator The nodes will quickly receive a sync message and synchronize themselves to the short cycle SP and ST Configure the new nodes in their desired sleep mode as cyclic sleeping nodes or sleep support nodes Set the SP and ST values on the sleep coordinator to the desired values for the deployed network 5 Wait a cycle for the sleeping nodes to sync themselves to the new SP and ST values 7 Disable the preferred sleep coordinator option bit on the sleep coordinator unless a preferred sleep coordinator is desired Deploy the nodes to their positions Alternatively nodes can be set up with their sleep pre configured and written to flash using the WR command prior to deployment If this is the case the commissioning button and associate LED can be used to aid in deployment 1 If a preferred sleep coordinator is going to be used in the network deploy it first If there will be no preferred sleep coordinator select a node for deployment power it on and p
134. y based on other settings Parameter Range 0x45 0x36EE80 Sleep Default 0x7D0 2 seconds WH Wake Host Set Read the wake host timer value If the wake host timer is set to a non zero value this timer specifies a time in millisecond units that the device should allow after waking from sleep before sending data out the UART or transmitting an I O sample If serial characters are received the WH timer is stopped immediately When in synchronous sleep the device will shorten its sleep period by the value specified by the WH command to ensure that it is prepared to communicate when the network wakes up When in this sleep mode the device will always stay awake for the WH time plus the amount of time it takes to transmit a one hop unicast to another node XBee XBee PRO DigiMesh 2 4 User Guide 0 0OxFFFF x 1ms 68 Sleep diagnostics AT Command Name and Description Sleep diagnostics Parameter Range Default SS Sleep Status The SS command can be used to query a number of Boolean values describing the status of the module Bit 0 This bit will be true when the network is in its wake state Bit 1 This bit will be true if the node is currently acting as a network sleep coordinator Bit 2 This bit will be true if the node has ever received a valid sync message since the time it was powered on Bit 3 This bit will be true if the node has received a sync message in the current wake
135. ype allows module parameters to be queried or set In contrast to the AT Command API type new parameter values are queued and not applied until either the AT Command 0x08 API type or the Apply Changes AC command is issued Register queries reading parameter values are returned immediately Frame Fields Offset Example Description Start Delimiter 0 Ox7E Length MSB1 0x00 Number of bytes between the length and the checksum LSB 2 0x05 Frame specific Data Frame Type 3 0x09 Frame ID 4 0x01 Identifies the UART data frame for the host to correlate with a subsequent ACK acknowledgment If set to 0 no response is sent AT Command 5 0x42 B Command Name Two ASCII characters that identify the AT Command 6 0x44 D Parameter Value 0x07 If present indicates the requested parameter value to set the given ATBD7 115200 register If no characters present register is queried baud Checksum 8 0x68 OxFF the 8 bit sum of bytes from offset 3 to this byte Example The example above sends a command to change the baud rate BD to 115200 baud but does not apply the changes immediately The module continues to operate at the previous baud rate until the changes are applied Note Inthis example the parameter could have been sent as a zero padded 2 byte or 4 byte value XBee XBee PRO DigiMesh 2 4 User Guide 77 Transmit request Frame type 0x10 XBee API frame specifications A Transm
136. yte to be escaped XOR d with 0x20 Data bytes that need to be escaped Ox7E Frame Delimiter 0Ox7D Escape 0x11 XON 0x13 XOFF Example Raw UART Data Frame before escaping interfering bytes Ox7E 0x00 0x02 0x23 0x11 OxCB 0x11 needs to be escaped which results in the following frame Ox7E 0x00 0x02 0x23 0x7D 0x31 0xCB Note Inthe above example the length of the raw data excluding the checksum is Ox0002 and the checksum of the non escaped data excluding frame delimiter and length is calculated as OXxFF 0x23 0x11 OXFF 0x34 OxCB Length The length field has a two byte value that specifies the number of bytes that will be contained in the frame data field It does not include the checksum field XBee UART frame data Frame data of the UART data frame forms an API specific structure as follows UART data frame and API specific structure Start Delimiter Length Frame Data Checksum Byte 1 Bytes 2 3 Bytes 4 n Byte n 1 Ox7E MSB LSB API specific Structure 1 Byte API Identifier Identifier specific Data cmdiD cmdData The cmdID frame API identifier indicates which API messages will be contained in the cmdData frame Identifier specific data Note that multi byte values are sent big endian The XBee modules support the following API frames XBee XBee PRO DigiMesh 2 4 User Guide 73 API Frame Name

XBee/XBee-PRO DigiMesh 2.4 User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents