Page 1
XBee/XBee-PRO DigiMesh 2.4 Radio Frequency (RF) Module User Guide...
Page 2
Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
Contents XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide Worldwide acceptance Antenna options Part numbers Technical specifications Performance specifications Power requirements General specifications Networking and security specifications Regulatory conformity summary Hardware Mechanical drawings Mounting considerations Hardware diagram Pin signals Notes Recommended pin connections Design notes Power supply design Board layout...
Page 4
Receive mode Sleep modes Transmit mode Enter Command mode Troubleshooting Send AT commands Exit Command mode Configure the XBee/XBee-PRO DigiMesh 2.4 Software libraries Configure the device using XCTU Serial communication Serial interface UART data flow Serial data Serial buffers Serial buffer issues Serial flow control CTS flow control RTS flow control...
Page 5
Unicast addressing Broadcast addressing Routing Route discovery DigiMesh throughput Transmission timeouts Sleep modes About sleep modes Asynchronous modes Synchronous modes Normal mode Asynchronous pin sleep mode Asynchronous cyclic sleep mode Asynchronous cyclic sleep with pin wake up mode Synchronous sleep support mode Synchronous cyclic sleep mode The sleep timer Sleep coordinator sleep modes in the DigiMesh network...
Page 6
GD (Good Packets Received) EA (MAC ACK Failure Count) TR (Transmission Failure Count) UA (Unicasts Attempted Count) %H (MAC Unicast One Hop Time) %8 (MAC Broadcast One Hop Time) Network commands CE (Routing / Messaging Mode) BH (Broadcast Hops) NH (Network Hops) DM (DigiMesh Options) NN (Network Delay Slots) MR (Mesh Unicast Retries)
Page 7
P2 (DIO12 Configuration) PR (Pull-up/Down Resistor Enable) M0 (PWM0 Duty Cycle) M1 (PWM1 Duty Cycle) LT (Associate LED Blink Time) RP (RSSI PWM Timer) I/O sampling commands IC (DIO Change Detect) IF (Sleep Sample Rate) IR (Sample Rate) IS (Force Sample) Sleep commands SM (Sleep Mode) SO (Sleep Options)
XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide The XBee/XBee-PRO DigiMesh 2.4 supports the unique needs of low-cost, low-power, wireless sensor networks. The devices require minimal power and provide reliable data delivery between remote devices. The devices operate within the ISM 2.4 MHz frequency band. These devices support routing table sizes of 32 nodes.
PCB. It uses a 1/4-wave wire that we solder directly to the PCB of the OEM device. All Digi devices with antenna connectors have less than 0.1 dB loss; we do not consider one to be "better" than the other in terms of reliability or insertion loss. RF device specifications such as -110 dBm receiver sensitivity, +3 0 dBm TX power, and so forth, already include any insertion loss due to the soldered RF connector.
Technical specifications The following tables provide the device's technical specifications. Performance specifications Power requirements General specifications Networking and security specifications Regulatory conformity summary XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Technical specifications Performance specifications Performance specifications The following table describes the performance specifications for the devices. Specification XBee XBee-PRO Indoor / urban range Up to 100 ft (30 m) Up to 300 ft (90 m) standard or up to 200 ft (60 m) international variant Outdoor RF line of Up to 300 ft (90 m)
Technical specifications Networking and security specifications Specification XBee XBee-PRO Operating frequency ISM 2.4 GHz ISM 2.4 GHz band Dimensions 2.438 cm x 2.761 cm (0.960 in x 1.087 in) 2.438 cm x 3.294 cm (0.960 in x 1.297 in) Operating temperature -40 to 85 °C (industrial) -40 to 85 °C (industrial) Relative humidity 0 to 95% non-condensing...
Page 14
Technical specifications Regulatory conformity summary Specification XBee XBee-PRO Brazil ANATEL 0369-15-1209 ANATEL 0378-15-1209 Regulatory information for region-specific certification requirements. XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Hardware Mechanical drawings Mechanical drawings The following figures show the mechanical drawings for the XBee/XBee-PRO DigiMesh 2.4. The drawings do not show antenna options. The following drawings show the RPSMA device. XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Hardware Mounting considerations Mounting considerations We design the through-hole module to mount into a receptacle so that you do not have to solder the module when you mount it to a board. The development kits may contain RS-232 and USB interface boards that use two 20-pin receptacles to receive modules.
Hardware Hardware diagram Through-hole single-row receptacles: Samtec part number: MMS-110-01-L-SV (or equivalent) Surface-mount double-row receptacles: Century Interconnect part number: CPRMSL20-D-0-1 (or equivalent) Surface-mount single-row receptacles: Samtec part number: SMM-110-02-SM-S Note We recommend that you print an outline of the module on the board to indicate the correct orientation for mounting the module.
Hardware Pin signals Pin signals The following table shows the pin signals and their descriptions. Pin name Direction Description Power supply DOUT Output UART data out DIN/CONFIG Input UART data in DIO12 Either Digital I/O 12 RESET Input/open Device reset. The reset pulse must be at least 100 µs. drain Drive this line as an open drain/collector.
Hardware Design notes Pin name Direction Description AD1 / DIO1 Either Analog input 1 or Digital I/O 1 AD0 / DIO0 / Either Analog input 0, Digital I/O 0, or Commissioning Commissioning Pushbutton Pushbutton Notes The table specifies signal direction with respect to the device. The device includes a 50 kΩ...
Hardware Design notes Antenna performance Antenna location is important for optimal performance. The following suggestions help you achieve optimal antenna performance. Point the antenna up vertically (upright). Antennas radiate and receive the best signal perpendicular to the direction they point, so a vertical antenna's omnidirectional radiation pattern is strongest across the horizon.
Page 22
Hardware Design notes Through-hole keepout Notes 1. We recommend non-metal enclosures. For metal enclosures, use an external antenna. 2. Keep metal chassis or mounting structures in the keepout area at least 2.54 cm (1 in) from the antenna. 3. Maximize the distance between the antenna and metal objects that might be mounted in the keepout area.
Hardware DC characteristics DC characteristics The following table displays the DC characteristics (VCC = 2.8 - 3.4 VDC). Symbols Parameter Condition Typical Max Units Input low voltage All digital inputs Input high voltage All digital inputs Output low = 2 mA, VCC >= 3.0 V 0.18 voltage Output high...
Hardware ADC timing and performance characteristics ADC timing and performance characteristics The following table displays the ADC timing and performance characteristics. Symbols Parameter Condition Typical Units Source impedance at input kΩ Ideal resolution (1 LSB) 2.08V > V > 3.6V 2.031 3.516 DDAD...
Modes The XBee/XBee-PRO DigiMesh 2.4 is in Receive Mode when it is not transmitting data. The device 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) Sleep Mode Command Mode (Command Mode Sequence is issued, not available when using the SPI port) Transparent and API operating modes...
Modes Transparent and API operating modes Transparent and API operating modes The firmware operates in several different modes. Two top-level modes establish how the device communicates with other devices through its serial interface: Transparent operating mode and API operating mode. Transparent operating mode Devices operate in this mode by default.
Page 27
Modes Transparent and API operating modes Transparent operating mode API operating mode Advantages: Advantages: Provides a simple interface. You can set or read the configuration of remote XBee devices in the network. It is easy for an application to support; what you send is exactly You can transmit data to one or multiple what other modules get, and vice destinations;...
Modes Additional modes Additional modes In addition to the serial communication modes, several modes apply to how devices communicate with each other. Command mode Command mode is a state in which the firmware interprets incoming characters as commands. Command mode allows you to modify the device’s firmware using parameters you can set using AT commands.
Modes Enter Command mode Synchronous Sleep Support mode. A node in this mode synchronizes itself with a sleeping network, but does not sleep itself. At any time, the node responds to new nodes that attempt to join the sleeping network using a sync message. Synchronous Cyclic Sleep mode.
Modes Exit Command mode Multiple AT commands You can send multiple AT commands at a time when they are separated by a comma in Command mode; for example, ATSH,SL. Parameter format Refer to the list of AT commands for the format of individual AT command parameters. Valid formats for hexidecimal values include with or without a leading 0x for example FFFF or 0xFFFF.
XBee Configuration and Test Utility (XCTU) is a multi-platform program that enables users to interact with Digi radio frequency (RF) devices through a graphical interface. The application includes built-in tools that make it easy to set up, configure, and test Digi RF devices.
Serial communication Serial interface Serial interface The XBee/XBee-PRO DigiMesh 2.4 provides a serial interface to an RF link. The XBee/XBee-PRO DigiMesh 2.4 converts serial data to RF data and sends that data to any device in an RF network. The device can communicate through its serial port with any logic and voltage compatible universal asynchronous receiver/transmitter (UART) or through a level translator to any serial device.
Serial communication Serial buffers Serial buffers The XBee/XBee-PRO DigiMesh 2.4 maintains internal buffers to collect serial and RF data that it receives. The serial receive buffer collects incoming serial characters and holds them until the device can process them. The serial transmit buffer collects the data it receives via the RF link until it transmits that data out the serial port.
Serial communication Serial flow control Serial flow control The RTS and CTS device pins provide RTS and/or CTS flow control. CTS flow control signals the host to stop sending serial data to the device. RTS flow control lets the host signal the device so it will not send the data in the serial transmit buffer out the UART.
Page 37
Work with networked devices Network commissioning and diagnostics Establish and maintain network links Test links in a network - loopback cluster Test links between adjacent devices Monitor I/O lines XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Work with networked devices Network commissioning and diagnostics Network commissioning and diagnostics We call the process of discovering and configuring devices in a network for operation, "network commissioning." Devices include several device discovery and configuration features. In addition to configuring devices, you must develop a strategy to place devices to ensure reliable routes. To accommodate these requirements, modules include features to aid in placing devices, configuring devices, and network diagnostics.
Work with networked devices Establish and maintain network links The device that sends a remote command does not receive a remote command response frame if: 1. It could not reach the destination device. 2. You set the frame ID to 0 in the remote command request. Establish and maintain network links Build aggregate routes In many applications, many or all of the nodes in the network must transmit data to a central...
Work with networked devices Test links in a network - loopback cluster 1. Send the ATAGFFFE command to the aggregator node. This sends an AG broadcast to all of the nodes in the network. 2. All of the nodes internally update only their routing table information to contain a route to the aggregator node.
Work with networked devices Test links between adjacent devices Transparent operating mode configuration (AP = 0) To send data to the loopback cluster ID on the data endpoint of a remote device: 1. Set the CI command to 0x12. 2. Set the DH and DL commands to the address of the remote device. After exiting Command mode, the device transmits any serial characters it received to the remote device, which returns those characters to the sending device.
Work with networked devices Test links between adjacent devices Number of bytes Field name Description Payload size The size of the test packet device A sent to test the link. Iterations The number of packets that device A sent. Success The number of packets that were successfully acknowledged.
Work with networked devices Test links between adjacent devices RSSI indicators The received signal strength indicator (RSSI) measures the amount of power present in a radio signal. It is an approximate value for signal strength received on an antenna. You can use the DB command to measure the RSSI on a device. DB returns the RSSI value measured in -dBm of the last packet the device received.
Work with networked devices Test links between adjacent devices Addressing information for the unicast. Addressing information for the intermediate hop. Other link quality information. For a full description of the Route Information Packet frame, see Route Information Packet frame - 0x8D.
Work with networked devices Test links between adjacent devices If you use this option when transmitting data, when a MAC acknowledgment failure occurs on one of the hops to the destination device, the device generates a Route Information Packet (0x8D) frame and sends it to the originator of the unicast.
Work with networked devices Test links between adjacent devices Sleep configuration Button and sync presses status Action Configured for Wakes the device for 30 seconds. Immediately sends a Node Identification broadcast transmission. asynchronous All devices that receive this transmission blink their Associate LED rapidly sleep for one second.
Page 47
Work with networked devices Test links between adjacent devices Use the LT command to override the blink rate of the Associate pin. If you set LT to 0, the device uses the default blink time: 500 ms for a sleep coordinator, 250 ms otherwise. The following table describes the Associate LED functionality.
Work with networked devices Monitor I/O lines Monitor I/O lines Pin command parameter Description Unmonitored digital input Reserved for pin-specific alternate functionality Analog input (A/D pins) or PWM output (PWM pins) Digital input, monitored Digital output, low Digital output, high Alternate functionality, where applicable The following table provides the pin configurations when you set the configuration command for a particular pin.
Page 49
Work with networked devices Monitor I/O lines If you send the IS command from Command mode, then the device returns a carriage return delimited list containing the following fields. Field Name Description Sample Number of sample sets in the packet. Always set to 1. sets Indicates which digital I/O lines have sampling enabled.
Work with networked devices Monitor I/O lines Example Sample AT response 0x0408 [Digital input states: DIO 3, 10 high, DIO 2, 11 low] 0x03D0 [Analog input: ADIO 0 = 0x3D0] 0x0124 [Analog input: ADIO 1 =0x120] Periodic I/O sampling Periodic sampling allows a device to take an I/O sample and transmit it to a remote device at a periodic rate.
Page 51
Work with networked devices Monitor I/O lines Use IR in conjunction with IC in this instance, since IR generates an I/O sample upon wakeup and ensures that the change is properly observed. XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Network configurations DigiMesh networking DigiMesh networking A mesh network is a topology in which each node in the network is connected to other nodes around it. Each node cooperates in transmitting information. Mesh networking provides these important benefits: Routing. With this technique, the message is propagated along a path by hopping from node to node until it reaches its final destination.
Network configurations Network identifiers Network identifiers You define DigiMesh networks with a unique network identifier. Use the ID command to set this identifier. For devices to communicate, you must configure them with the same network identifier and the same operating channel. For devices to communicate, the CH and ID commands must be equal on all devices in the network.
Network configurations Routing Broadcast addressing All of the routers in a network receive and repeat broadcast transmissions. Broadcast transmissions do not use ACKs, so the sending device sends the broadcast multiple times. By default, the sending device sends a broadcast transmission four times. The transmissions become automatic retries without acknowledgments.
Network configurations Routing DigiMesh throughput Throughput in a DigiMesh network can vary due to a number of variables, including: The number of hops. If you enable or disable encryption. Sleeping end devices. Failures and route discoveries. Our empirical testing shows the following throughput performance in a robust operating environment with low interference.
Page 57
Network configurations Routing Unicast one hop time unicastOneHopTime is a building block of many of the following calculations. It represents the amount of time it takes to send a unicast transmission between two adjacent nodes. The amount of time depends on the RR parameter. DigiMesh networks assume that the average number of MAC-level retries across a multi-hop wireless link will be three or less.
Page 58
Sleep modes About sleep modes Normal mode Asynchronous pin sleep mode Asynchronous cyclic sleep mode Asynchronous cyclic sleep with pin wake up mode Synchronous sleep support mode Synchronous cyclic sleep mode The sleep timer Sleep coordinator sleep modes in the DigiMesh network Synchronization messages Become a sleep coordinator Select sleep parameters...
Sleep modes About sleep modes About sleep modes A number of low-power modes exist to enable devices to operate for extended periods of time on battery power. Use the SM command to enable these sleep modes. The sleep modes are characterized as either: Asynchronous (SM = 1, 4, 5).
Sleep modes Asynchronous pin sleep mode When synchronized, a device in Normal mode relays sync messages that sleep-compatible nodes generate, but does not generate sync messages itself. Once a device in Normal mode synchronizes with a sleeping network, you can put it into a sleep- compatible sleep mode at any time.
Sleep modes Synchronous cyclic sleep mode Synchronous cyclic sleep mode Set SM to 8 to enter synchronous cyclic sleep mode. A device in synchronous cyclic sleep mode sleeps for a programmed time, wakes in unison with other nodes, exchanges data and sync messages, and then returns to sleep. While asleep, it cannot receive RF messages or receive data (including commands) from the UART port.
Sleep modes Synchronization messages Synchronization messages A sleep coordinator regularly sends sync messages to keep the network in sync. Unsynchronized nodes also send messages requesting sync information. Sleep compatible nodes use Deployment mode when they first power up and the sync message has not been relayed.
Sleep modes Become a sleep coordinator Become a sleep coordinator In DigiMesh networks, a device can become a sleep coordinator in one of four ways: Define a preferred sleep coordinator A potential sleep coordinator misses three or more sync messages Press the Commissioning Pushbutton twice on a potential sleep coordinator Change the sleep timing values on a potential sleep coordinator Preferred sleep coordinator option...
Sleep modes Become a sleep coordinator It is possible for multiple nodes to declare themselves as the sleep coordinator. If this occurs, the firmware uses the following resolution criteria to identify the sleep coordinator from among the nodes using the selection process: 1.
Sleep modes Select sleep parameters Auto-early wake-up sleep option If you have nodes that are missing sync messages and could be going out of sync with the rest of the network, enabling an early wake gives the device a better chance to hear the sync messages that are being broadcast.
Sleep modes Add a new node to an existing network 3. Power on the new nodes within range of the sleep coordinator. The nodes quickly receive a sync message and synchronize themselves to the short cycle SP and ST set on the sleep coordinator.
Sleep modes Change sleep parameters If you do not use one of these two methods, you must wait for the network to wake up before adding the new node. Place the new node in range of the network with a sleep/wake cycle that is shorter than the wake period of the network.
Sleep modes Diagnostics intervals. When this occurs the first task is to repair, replace, and strengthen the weak link with new and/or redundant devices to fix the problem and prevent it from occurring in the future. When you use the default DigiMesh sleep parameters, separated subnets do not drift out of phase with each other.
Sleep modes Diagnostics Missed sync messages command Use the MS command to query the number of cycles that elapsed since the device received a sync message. Sleep status API messages When you use the SO command to enable this option, a device that is in API operating mode outputs modem status frames immediately after it wakes up and prior to going to sleep.
AT commands Special commands Special commands The following commands are special commands. AC (Apply Changes) Immediately applies new settings without exiting Command mode. Parameter range Default FR (Software Reset) Resets the device. The device responds immediately with an OK and performs a reset 100 ms later. If you issue FR while the device is in Command Mode, the reset effectively exits Command mode.
AT commands MAC/PHY commands MAC/PHY commands The following AT commands are MAC/PHY commands. CH (Operating Channel) Set or read the operating channel devices used to transmit and receive data. The channel is one of three addressing configurations available to the device. The other configurations are the PAN ID (ID command) and destination addresses (DL and DH commands).
AT commands MAC/PHY commands CA (CCA Threshold) Set or read the Clear Channel Assessment (CCA) threshold. Prior to transmitting a packet, the device performs a CCA to detect energy on the channel. If the device detects energy above the CCA threshold, it will not transmit the packet.
AT commands MAC/PHY commands Setting Power level +10 dBm +12 dBm +14 dBm +16 dBm +18 dBm Default RR (Unicast Mac Retries) Set or read the maximum number of MAC level packet delivery attempts for unicasts. If RR is non- zero, the sent unicast packets request an acknowledgment from the recipient.
AT commands MAC/PHY commands Default DB (Last Packet RSSI) Reports the RSSI in -dBm of the last received RF data packet. DB returns a hexadecimal value for the - dBm measurement. For example, if DB returns 0x60, then the RSSI of the last packet received was -96 dBm. DB only indicates the signal strength of the last hop.
AT commands Network commands TR (Transmission Failure Count) This value is volatile (the value does not persist in the device's memory after a power-up sequence). Parameter range Default UA (Unicasts Attempted Count) The number of unicast transmissions expecting an acknowledgment (when RR > 0). This value is volatile (the value does not persist in the device's memory after a power-up sequence).
AT commands Network commands Parameter range 0 - 2 Parameter Description Routes packets Standard router End device Default BH (Broadcast Hops) The maximum transmission hops for broadcast data transmissions. If you set BH greater than NH, the device uses the value of NH. Parameter range 0 - 0x20 Default...
AT commands Addressing commands NN (Network Delay Slots) Set or read the maximum random number of network delay slots before rebroadcasting a network packet. One network delay slot is approximately 13 ms. Parameter range 1 - 0xA network delay slots Default MR (Mesh Unicast Retries) Set or read the maximum number of network packet delivery attempts.
AT commands Addressing commands Parameter range 0 - 0xFFFFFFFF [read-only] Default Set in the factory DH (Destination Address High) Set or read the upper 32 bits of the 64-bit destination address. When you combine DH with DL, it defines the destination address that the device uses for transmissions in Transparent mode. The destination address is also used for I/O sampling in both Transparent and API modes.
Parameter range 0x0 - 0x7 (bit field) Bit field Option Description Append the DD (Digi Device Identifier) value to ND responses or API node identification 0x01 frames. Local device sends ND response frame out the serial interface when ND is issued.
0x11 (Transparent data cluster ID) DE command Sets or displays the application layer destination ID value. The value is used as the destination endpoint for all data transmissions. The default value (0xE8) is the Digi data endpoint. Parameter range 0 - 0xFF...
AT commands Addressing discovery/configuration commands The receiving node establishes a DigiMesh route back to the originating node, if there is space in the routing table. The DH and DL of the receiving node update to the address of the originating node if the AG parameter matches the current DH/DL of the receiving node.
STATUS<CR> (1 Byte: Reserved) PROFILE_ID<CR> (2 Bytes) MANUFACTURER_ID<CR> (2 Bytes) DIGI DEVICE TYPE<CR> (4 Bytes. Optionally included based on NO settings.) RSSI OF LAST HOP<CR> (1 Byte. Optionally included based on NO settings.) <CR> If you send the FN command in Command mode, after (NT*100) ms + overhead time, the command ends by returning a carriage return, represented by <CR>.
AT commands Serial interfacing commands Parameter Description Disabled Enabled Default KY (AES Encryption Key) Sets the 16-byte network security key value that the device uses for encryption and decryption. This command is write-only. If you attempt to read KY, the device returns an OK status. Set this command parameter the same on all devices in a network.
AT commands Serial interfacing commands Value Description 19,200 b/s 38,400 b/s 57,600 b/s 115,200 b/s 0x39 to 0xF4240 if the host supports it. Default 0x03 (9600 b/s) NB (Parity) Set or read the serial parity settings for UART communications. Parameter range 0x00 - 0x04 Parameter Description...
AT commands Serial interfacing commands De-assert CTS and/or send XOFF when FT bytes are in the UART receive buffer. Re-assert CTS when less than FT-16 bytes are in the UART receive buffer. Parameter range 0x11 - 0xEE bytes Default 0xBE API Mode Set or read the API mode setting.
AT commands I/O settings commands I/O settings commands The following AT commands are I/O settings commands. CB (Commissioning Pushbutton) Use CB to simulate commissioning pushbutton presses in software. Set the parameter value to the number of button presses that you want to simulate. For example, send CB1 to perform the action of pressing the Commissioning Pushbutton once.
AT commands I/O settings commands Parameter Description Digital input Digital output, low Digital output, high PTI_EN Default D2 (DIO2/AD2) Sets or displays the DIO2/AD2 configuration (pin 18). Parameter range 0, 2 - 5 Parameter Description Disabled Digital input Digital output, low Digital output, high Default D3 (DIO3/AD3)
AT commands I/O settings commands Parameter Description Digital input Digital output, low Digital output, high Default D4 (DIO4/AD4) Sets or displays the DIO4/AD4 configuration (pin 11). Parameter range 0, 2 - 5 Parameter Description Disabled Digital input Digital output, low Digital output, high Default D5 (DIO5/AD5/ASSOCIATED_INDICATOR)
AT commands I/O settings commands Default D6 (DIO6/RTS) Sets or displays the DIO6/RTS configuration (pin 16). Parameter range 0, 1, 3 - 5 Parameter Description Disabled RTS flow control Digital input Digital output, low Digital output, high Default D7 (DIO7/CTS) Sets or displays the DIO7/CTS configuration (pin 12).
AT commands I/O settings commands D8 (DIO8/SLEEP_REQUEST) Sets or displays the DIO8/SLEEP_REQUEST configuration (pin 9). This line is also used with Pin Sleep, but pin sleep ignores the D8 configuration. It is always used to control pin sleep, regardless of configuration of D8. Parameter range 0, 1, 3 - 5 Parameter Description...
AT commands I/O settings commands Parameter Description Disabled Digital input Digital output, low Digital output, high Default PR (Pull-up/Down Resistor Enable) PR and PD only affect lines that are configured as digital inputs or disabled. The following table defines the bit-field map for PR and PD commands. The bit field that configures the internal pull-up resistor status for the I/O lines.
AT commands I/O settings commands Parameter range 0 - 0x7FFF (bit field) Default 0x1FFF M0 (PWM0 Duty Cycle) The duty cycle of the PWM0 line (pin 6). Use the P0 command to configure the line as a PWM output. Parameter range 0 - 0x3FF Default M1 (PWM1 Duty Cycle)
AT commands I/O sampling commands Parameter range 0 - 0xFF (x 100 ms) Default 0x28 (four seconds) I/O sampling commands The following AT commands configure I/O sampling parameters. IC (DIO Change Detect) Set or read the digital I/O pins to monitor for changes in the I/O state. IC works with the individual pin configuration commands (D0 - D9, P0 - P2).
AT commands I/O sampling commands IF (Sleep Sample Rate) Set or read the number of sleep cycles that must elapse between periodic I/O samples. This allows the firmware to take I/O samples only during some wake cycles. During those cycles, the firmware takes I/O samples at the rate specified by IR.
AT commands Sleep commands Default Sleep commands The following commands are sleep commands. SM (Sleep Mode) Sets or displays the sleep mode of the device. Normal mode is always awake. Pin sleep modes allow you to wake the device with the SLEEP_ REQUEST line.
AT commands Sleep commands Parameter range 0x0 - 0xFFFF For synchronous sleep devices, the following sleep bit field options are defined: Bit Option Preferred sleep coordinator; setting this bit causes a sleep compatible device to always act as sleep coordinator Non-sleep coordinator;...
AT commands Diagnostic - sleep status/timing commands SP (Sleep Time) Sets or displays the device's sleep time. This command defines the amount of time the device sleeps per cycle. Parameter range 0x1 - 0x15F900 (x 10 ms) Default 0xC8 ST (Wake Time) Sets or displays the wake time of the device.
AT commands Diagnostic - sleep status/timing commands SS (Sleep Status) Queries a number of Boolean values that describe the device's status. Description This bit is true when the network is in its wake state. This bit is true if the node currently acts as a network sleep coordinator. This bit is true if the node ever receives a valid sync message after it powers on.
AT commands Command mode options Default MS (Missed Sync Messages) Reads the number of sleep or wake cycles since the device received a sync message. Parameter range Default SQ (Missed Sleep Sync Count) Counts the number of sleep cycles in which the device does not receive a sleep sync. Set the value to 0 to reset this value.
AT commands Firmware version/information commands Parameter range 2 - 0x1770 (x 100 ms) Default 0x64 (10 seconds) CN (Exit Command mode) Immediately exits Command Mode and applies pending changes. Parameter range Default GT (Guard Times) Set the required period of silence before and after the command sequence characters of the Command mode sequence (GT + CC + GT).
Display the hardware version number of the device. Parameter range 0 - 0xFFFF [read-only] Default Set in firmware DD (Device Type Identifier) Stores the Digi device type identifier value. Use this value to differentiate between multiple XBee devices. Parameter range 0 - 0xFFFFFFFF [read-only] Default 0x50000 NP (Maximum Packet Payload Bytes) Reads the maximum number of RF payload bytes that you can send in a transmission.
Operate in API mode API mode overview API mode overview As an alternative to Transparent operating mode, you can use API operating mode. API mode provides a structured interface where data is communicated through the serial interface in organized packets and in a determined order.
Page 107
Operate in API mode API mode overview http://knowledge.digi.com/articles/Knowledge_Base_Article/Escaped-Characters-and-API-Mode-2 The following table shows the structure of an API frame with escaped characters: Frame fields Byte Description Start delimiter 1 0x7E Length 2 - 3 Most Significant Byte, Least Significant Byte Characters escaped if needed...
Operate in API mode API mode overview Frame type is the API frame type identifier. It determines the type of API frame and indicates how the Data field organizes the information. Data contains the data itself. This information and its order depend on the what type of frame that the Frame type field defines.
Operate in API mode API mode overview 1. Add all bytes of the packet, except the start delimiter 0x7E and the length (the second and third bytes). 2. Keep only the lowest 8 bits from the result. 3. Subtract this quantity from 0xFF. To verify the checksum of an API frame: 1.
Operate in API mode API frames 0x7E: start delimiter 0x7D: escape character 0x11: XON 0x13: XOFF To escape a character: 1. Insert 0x7D (escape character). 2. Append it with the byte you want to escape, XORed with 0x20. In API mode with escaped characters, the length field does not include any escape characters in the frame and the firmware calculates the checksum with non-escaped data.
Page 111
Operate in API mode API frames Note Using a Frame ID of 0 disables responses, which can reduce network congestion for non-critical transmissions. AT commands The following image shows the API frame exchange that takes place at the UART when you send a 0x08 AT Command Request or 0x09 AT Command-Queue Request to read or set a device parameter.
Page 112
Operate in API mode API frames XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Operate in API mode API frames Code to support future API frames If your software application supports the API, you should make provisions that allow for new API frames in future firmware releases. For example, you can include the following section of code on a host microprocessor that handles serial API frames that are sent out the device's DOUT pin: void XBee_HandleRxAPIFrame(_apiFrameUnion *papiFrame){ switch(papiFrame->api_id){...
Operate in API mode API frames AT Command Frame - 0x08 Description Use this frame to query or set device parameters on the local device. This API command applies changes after running the command. You can query parameter values by sending the 0x08 AT Command frame with no parameter value field (the two-byte AT command is immediately followed by the frame checksum).
Operate in API mode API frames AT Command - Queue Parameter Value frame - 0x09 Description This frame allows you to query or set device parameters. In contrast to the AT Command (0x08) frame, this frame queues new parameter values and does not apply them until you issue either: The AT Command (0x08) frame (for API type) The AC command When querying parameter values, the 0x09 frame behaves identically to the 0x08 frame.
Page 116
Operate in API mode API frames Frame data fields Offset Example AT command 0x42 (B) 0x44 (D) Parameter value (BD7 = 115200 baud) 0x07 Checksum 0x68 XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Operate in API mode API frames Transmit Request frame - 0x10 Description This frame causes the device to send payload data as an RF packet to a specific destination. For broadcast transmissions, set the 64-bit destination address to 0x000000000000FFFF . For unicast transmissions, set the 64 bit address field to the address of the desired destination node.
Page 118
Operate in API mode API frames Frame data fields Offset Description Transmit 0x01 = Disable ACK 0x02 = Disable network address discovery options 0x04 = Generate trace route frames for each hop of all transmitted packets 0x08 = Generate NACK frames (which look identical to trace route frames) on transmitted packets for any hop that fails along the path.
Page 119
Operate in API mode API frames Frame data fields Offset Example Options 0x00 RF data 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 Checksum 0x13 If you enable escaping (AP = 2), the frame should look like: 0x7E 0x00 0x16 0x10 0x01 0x00 0x7D 0x33 0xA2 0x00 0x40 0x0A 0x01 0x27 0xFF 0xFE 0x00 0x00 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 0x7D 0x33 The device calculates the checksum (on all non-escaped bytes) as [0xFF - (sum of all bytes from API frame type through data payload)].
Operate in API mode API frames Explicit Addressing Command frame - 0x11 Description This frame is similar to Transmit Request (0x10), but it also requires you to specify the application- layer addressing fields: endpoints, cluster ID, and profile ID. This frame causes the device to send payload data as an RF packet to a specific destination, using specific source and destination endpoints, cluster ID, and profile ID.
Page 121
Operate in API mode API frames Frame data fields Offset Description 0x01 = Disable ACK Transmission 0x02 = Disable network address discovery options 0x04 = Generate trace route frames for each hop of all transmitted packets 0x08 = Generate NACK frames (which look identical to trace route frames) on transmitted packets for any hop that fails along the path.
Page 122
Operate in API mode API frames Frame data fields Offset Example 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x01 0x23 0x84 LSB12 0x00 Reserved 0xFF 0xFE Source endpoint 0xE8 Destination endpoint 0xE8 Cluster ID 0x00 0x11 Profile ID 0xC1 0x05 Broadcast radius...
Operate in API mode API frames Remote AT Command Request frame - 0x17 Description Used to query or set device parameters on a remote device. For parameter changes on the remote device to take effect, you must apply changes, either by setting the Apply Changes options bit, or by sending an AC command to the remote.
Page 124
Operate in API mode API frames Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x10 0x17 Frame type Frame ID 0x01 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x40 0x11 LSB 12 0x22 Reserved 0xFF...
Operate in API mode API frames AT Command Response frame - 0x88 Description A device sends this frame in response to an AT Command (0x08 or 0x09) frame. Some commands send back multiple frames; for example, the ND command. Format Frame data fields Offset Description...
Operate in API mode API frames Modem Status frame - 0x8A Description Devices send the status messages in this frame in response to specific conditions. Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications.
Operate in API mode API frames Transmit Status frame - 0x8B Description When a Transmit Request (0x10, 0x11) completes, the device sends a Transmit Status message out of the serial interface. This message indicates if the Transmit Request was successful or if it failed. Format The following table provides the contents of the frame.
Page 128
Operate in API mode API frames Frame Fields Offset Example Frame ID 0x47 Reserved 0xFF 0xFE Transmit retry count 0x00 Delivery status 0x00 Discovery status 0x02 Checksum 0x2E XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Operate in API mode API frames Route Information Packet frame - 0x8D Description If you enable NACK or the Trace Route option on a DigiMesh unicast transmission, a device can output this frame for the transmission. Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications.
Page 130
Operate in API mode API frames Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x2A Frame type 0x8D Source event 0x12 Length 0x27 Timestamp MSB 6 0x9C 0x93 0x81 LSB 9 0x7F ACK timeout count 0x00 TX blocked count 0x00...
Page 131
Operate in API mode API frames Frame data fields Offset Example Responder address MSB 29 0x00 0x13 0xA2 0x00 0x40 0x52 0xBB LSB 36 0xBB Receiver address MSB 37 0x00 0x13 0xA2 0x00 0x40 0x52 0xCC LSB 44 0xCC Checksum 0xD2 XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Operate in API mode API frames Aggregate Addressing Update frame - 0x8E Description The device sends out an Aggregate Addressing Update frame on the serial interface of 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.
Page 133
Operate in API mode API frames Frame data fields Offset Example New address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0xBB LSB 12 0xBB Old address 0x00 0x13 0xA2 0x00 0x40 0x52 0xAA 0xAA Checksum 0x19 XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Operate in API mode API frames Receive Packet frame - 0x90 Description When a device configured with a standard API Rx Indicator (AO = 0) receives an RF data packet, it sends it out the serial interface using this message type. Format The following table provides the contents of the frame.
Page 135
Operate in API mode API frames Frame data fields Offset Example MSB 4 0x00 64-bit source address 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Receive options 0x01 Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x11 XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Operate in API mode API frames Explicit Rx Indicator frame - 0x91 Description When a device configured with explicit API Rx Indicator (AO = 1) receives an RF packet, it sends it out the serial interface using this message type. Format The following table provides the contents of the frame.
Page 137
Operate in API mode API frames Frame data fields Offset Example Frame type 0x91 64-bit source address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Source endpoint 0xE0 Destination endpoint 0xE0 Cluster ID 0x22 0x11 Profile ID...
Operate in API mode API frames Data Sample Rx Indicator frame - 0x92 Description When you enable periodic I/O sampling or digital I/O change detection on a remote device, the UART of the device that receives the sample data sends this frame out. Format The following table provides the contents of the frame.
Page 139
Operate in API mode API frames Frame fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x14 Frame-specific data 64-bit source address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved MSB 12 0xfffe LSB 13 0x84...
2=End Device For more options, see NO (Network Discovery Options). Source event 1=Frame sent by node identification pushbutton event - See (DIO0/AD0) Digi Profile ID 31-32 Set to the Digi application profile ID. XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Page 141
Operate in API mode API frames Frame data fields Offset Description Digi 33-34 Set to the Digi Manufacturer ID. Manufacturer Digi DD value Reports the DD value of the responding device. Use the NO command to 35-38 (optional) enable this field.
Page 142
0x74 0x02 0xAC LSB 24 NI string 0x20 0x00 Reserved 0xFF 0xFE Device type 0x01 Source event 0x01 Digi Profile ID 0xC1 0x05 Digi Manufacturer ID 0x10 0x1E Digi DD value 0x00 (optional) 0x0C 0x00 0x00 RSSI (optional) 0x2E Checksum 0x33 XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Operate in API mode API frames Remote Command Response frame - 0x97 Description If a device receives this frame in response to a Remote Command Request (0x17) frame, the device sends an AT Command Response (0x97) frame out the serial interface. Some commands, such as the ND command, may send back multiple frames.
Page 144
Operate in API mode API frames Frame data fields Offset Example 64-bit source (remote) address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 12 0xAA Reserved 0xFF 0xFE 16-bit source (remote) address MSB 13 0x7D LSB 14 0x84 AT commands 0x53 (S) 0x4C (L)
Regulatory information United States (FCC) Australia (C-Tick) Brazil ANATEL Canada - Industry Canada (IC) Europe Japan XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
IMPORTANT: The XBee / XBee-PRO 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 and 15.109) before declaring compliance of their final product to Part 15 of the FCC rules.
The antennas in the following tables are approved for use with this module. We do not carry all of these antenna variants. Contact Digi Sales for the available antennas. All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
Page 148
Regulatory information United States (FCC) Type Minimum Part number (description) Gain Application* separation A24-HABSM* Dipole (articulated 2.1 dBi Fixed 20 cm RPSMA) A24-HABUF-P5I Dipole (half-wave 2.1 dBi Fixed 20 cm articulated bulkhead mount U.FL. with 5” pigtail) A24-HASM-525 Dipole (half-wave 2.1 dBi Fixed/mobile 20 cm...
Page 149
Regulatory information United States (FCC) Type Minimum Required Part number (description) Gain Application* separation cable loss A24-Y12NF Yagi (12- 12.0 dBi Fixed 4.9 dB element) A24-Y13NF Yagi (13- 12.0 dBi Fixed 4.9 dB element) A24-Y15NF Yagi (15- 12.5 dBi Fixed 5.4 dB element) A24-Y16NF...
Page 150
Regulatory information United States (FCC) Type Minimum Required Part number (description) Gain Application* separation cable loss A24-F12NF Omni- 12.0 dBi Fixed 2.7 dB directional (fiberglass base station) A24-F15NF Omni- 15.0 dBi Fixed 5.7 dB directional (fiberglass base station) A24-W7NF Omni- 7.2 dBi Fixed directional...
Page 151
Regulatory information United States (FCC) Antennas approved for use with the XBee-PRO DigiMesh 2.4 RF Modules (cable loss is required) Type Minimum Required Part number (description) Gain Application* separation cable loss Yagi class antennas A24-Y4NF Yagi (4- 6.0 dBi Fixed 8.1 dB element) A24-Y6NF...
Page 152
Regulatory information United States (FCC) Type Minimum Required Part number (description) Gain Application* separation cable loss A24-F5NF Omni- 5.0 dBi Fixed/Mobile 20 cm 7.1 dB directional (fiberglass base station) A24-F8NF Omni- 8.0 dBi Fixed 10.1 dB directional (fiberglass base station) A24-F9NF Omni- 9.5 dBi...
1. Have a company presence in Australia. 2. Have a company, distributor, or agent in Australia that will sponsor importing the end product. Contact Digi for questions about locating a contact in Australia. Brazil ANATEL The XBee RF modules with 802.15.4 or DigiMesh firmware (models noted in the following conformity information) comply with Brazil ANATEL standards in Resolution No.
Europe The RF Module is certified for use in several European countries; for a complete list, go to www.digi.com. If the XBee/XBee-PRO DigiMesh 2.4 is incorporated into a product, the manufacturer must ensure compliance of the final product with articles 3.1a and 3.1b of the RE Directive (Radio Equipment Directive).
Digi for more information. Declarations of conformity Digi has issued Declarations of Conformity for the (product name) concerning emissions, EMC, and safety. For more information, see www.digi.com/resources/certifications. Important note Digi customers assume full responsibility for learning and meeting the required guidelines for each country in their distribution market.
When you integrate high-gain antennas, European regulations stipulate the EIRP power maximums. Use the following guidelines to determine which antennas to use when you design an application. All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
Page 157
Regulatory information Japan R201WW07215214 (XBee) R201WW08215111 (XBee-PRO) XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide...
Need help?
Do you have a question about the XBee DigiMesh 2.4 and is the answer not in the manual?
Questions and answers