Page 1
Digi XBee3® DigiMesh 2.4 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.
API operating mode Command mode Enter Command mode Send AT commands Apply command changes Exit Command mode Idle mode Transmit mode Receive mode Serial communication Serial interface Serial data UART data flow Serial receive buffer Digi XBee3® DigiMesh RF Module User Guide...
Page 4
AT commands Network commands ID (Network ID) NI (Network Identifier) NT (Network Discovery Back-off) NO (Network Discovery Options) NP (Maximum Packet Payload Bytes) CE (Routing / Messaging Mode) DM (DigiMesh Options) Addressing discovery/configuration commands Digi XBee3® DigiMesh RF Module User Guide...
Page 5
FT (Flow Control Threshold) Command mode options CC (Command Character) CT (Command Mode Timeout) GT (Guard Time) Diagnostics – Firmware/Hardware Information VR (Firmware Version) HV (Hardware Version) DD (Device Type Identifier) CK (Configuration CRC) Digi XBee3® DigiMesh RF Module User Guide...
Hardware Reference Manual. Digi XBee3 devices offer the flexibility to switch between multiple frequencies and wireless protocols as needed. These devices use the DigiMesh networking protocol using a globally deployable 2.4 GHz transceiver. This peer-to-peer mesh network offers users added network stability through self- healing, dense network operation, extending the operational life of battery dependent networks and provides an upgrade path to IEEE 802.15.4 or ZigBee mesh protocols, if desired.
You can switch the firmware loaded onto the XBee3 hardware to run any of the following protocols: Zigbee 802.15.4 DigiMesh To change protocols, use the Update firmware feature in XCTU and select the firmware. See the XCTU User Guide. Digi XBee3® DigiMesh RF Module User Guide...
Page 9
Getting started Verify kit contents Assemble the hardware Configure the device using XCTU Configure remote devices Configure the devices for a range test Perform a range test Digi XBee3® DigiMesh RF Module User Guide...
This guide walks you through the steps required to assemble and disassemble the hardware components of your kit. Plug in the XBee3 DigiMesh RF Module How to unplug an XBee module The kit includes several XBee Grove Development Boards. For more information about this hardware, Digi XBee3® DigiMesh RF Module User Guide...
2. Once the XBee module is plugged into the board (and not before), connect the board to your computer using the micro USB cables provided. 3. Ensure the loopback jumper is in the UART position. Digi XBee3® DigiMesh RF Module User Guide...
These instructions show you how to configure a remote device parameter on a remote device. 1. Add two XBee devices to XCTU. 2. Load XBee3 DigiMesh 2.4 firmware onto each device if it is not already loaded. 3. Configure the first device in API mode and name it XBEE_A.
The Port indicates that the LOCAL_DEVICE is in API mode. 8. Disconnect REMOTE_DEVICE from the computer, remove it from XCTU, and connect it to its own power supply. 9. Leave LOCAL_DEVICE connected to the computer. Digi XBee3® DigiMesh RF Module User Guide...
Perform a range test 1. Go to the XCTU display for radio 1. 2. Click to discover remote devices within the same network. The Discover remote devices dialog appears. 3. Click Add selected devices. Digi XBee3® DigiMesh RF Module User Guide...
Page 15
Range test. The Radio Range Test dialog appears. 5. In the Select the local radio device area, select radio 1. XCTU automatically selects the Discovered device option, and the Start Range Test button is active. Digi XBee3® DigiMesh RF Module User Guide...
Page 16
7. Move Radio 1 around to see the resulting signal strength at different distances. You can also test different power levels by reconfiguring the PL (TX Power Level) parameter on both devices. When the test is complete, click Stop Range Test. Digi XBee3® DigiMesh RF Module User Guide...
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.
Failure to enter Command mode is often due to baud rate mismatch. Ensure that the baud rate of the connection matches the baud rate of the device. By default, the BD parameter = 3 (9600 baud). Digi XBee3® DigiMesh RF Module User Guide...
2. If the device does not receive any valid AT commands within the time specified by CT (Command mode Timeout), it returns to Transparent or API mode. The default Command mode Timeout is 10 seconds. Digi XBee3® DigiMesh RF Module User Guide...
This is the default mode for the XBee3 DigiMesh RF Module. The device is in Receive mode when it is not transmitting data. If a destination node receives a valid RF packet, the destination node transfers the data to its serial transmit buffer. Digi XBee3® DigiMesh RF Module User Guide...
Serial communication Serial interface Serial data UART data flow Serial receive buffer Serial transmit buffer Flow control Digi XBee3® DigiMesh RF Module User Guide...
Devices that have a UART interface connect directly to the pins of the XBee3 DigiMesh RF Module as shown in the following figure. The figure shows system data flow in a UART-interfaced environment. Low-asserted signals have a horizontal line over the signal name. Digi XBee3® DigiMesh RF Module User Guide...
The serial transmit buffer collects the data it receives via the RF link until it transmits that data out the serial port. The following figure shows the process of device buffers collecting received serial data. D6 (DIO6/RTS) D7 (DIO7/CTS) to set flow control. Digi XBee3® DigiMesh RF Module User Guide...
If the device receives an RF data packet and the serial transmit buffer does not have enough space for all of the data bytes, it discards the entire RF data packet. Digi XBee3® DigiMesh RF Module User Guide...
TO command apply. Point-to-multipoint transmissions occur between two adjacent nodes within RF range. No route discovery and no routing occur for these types of transmissions. The networking layer is entirely skipped. Digi XBee3® DigiMesh RF Module User Guide...
Note Mesh networks use more bandwidth for routing than point to multipoint networks and therefore have less available for payloads. Digi XBee3® DigiMesh RF Module User Guide...
Intermediate nodes may either drop or forward a RREQ, depending on whether the new RREQ has a better route back to the source node. If so, the node saves, updates and broadcasts the RREQ. Digi XBee3® DigiMesh RF Module User Guide...
The BH parameter sets the maximum number of hops that a broadcast is repeated, but there are two special cases. If BH is 0 or if BH is > NH, then NH specifies the maximum hops for broadcasts instead. Digi XBee3® DigiMesh RF Module User Guide...
Transmit Status frame (0x89) with the Status field set to 74 (Data payload too large). In Transparent mode, the firmware splits the data as necessary to cope with maximum payloads. Digi XBee3® DigiMesh RF Module User Guide...
Page 33
To accommodate these requirements, modules include features to aid in placing devices, configuring devices, and network diagnostics. Local configuration Remote configuration Build aggregate routes Associate LED Node discovery Digi XBee3® DigiMesh RF Module User Guide...
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. Digi XBee3® DigiMesh RF Module User Guide...
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. Digi XBee3® DigiMesh RF Module User Guide...
5. When device B completes transmitting the test link packets, it sends the following data packet to device A's Test Link Result Cluster (0x0094) on endpoint (0xE6). 6. Device A outputs the following information as an API Explicit RX Indicator (0x91) frame: Digi XBee3® DigiMesh RF Module User Guide...
Page 37
B and send the results back to device C to be output. It is also possible for device B to request device A to perform the previously mentioned test. In other words, the Digi XBee3® DigiMesh RF Module User Guide...
There is no guarantee that Route Information Packet frames will arrive in the same order as the route taken by the unicast packet. On a weak route, it is also possible for the transmission of Route Information Packet frames to fail before arriving at the unicast originator. Digi XBee3® DigiMesh RF Module User Guide...
API mode. If no nodes respond, there will be no responses at all to the node discover command. The requesting node is not able to process a new AT command until N? times out. Digi XBee3® DigiMesh RF Module User Guide...
In Transparent mode, unlike ND (with or without an NI string), DN does not cause the information from the responding node to be output; rather it simply sets DH/DL to the address of the responding node. Digi XBee3® DigiMesh RF Module User Guide...
If you sent FN remotely, the target devices respond directly to the device that sent the FN command. The device that sends FN outputs a response packet in the same format as an Command Response frame - 0x88. Digi XBee3® DigiMesh RF Module User Guide...
The options bit field value changes the behavior of the ND command and what optional values the local device returns when it receives an ND command or API Node Identification Indicator (0x95) frame. Digi XBee3® DigiMesh RF Module User Guide...
Node Discover includes a response entry for itself. Parameter range 0x0 - 0x7 (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.
DH/DL set to the node that is found so that the next serial input is sent to the node designated by the DN parameter. 4. If the requesting node returns ERROR, (node not found), it remains in Command mode, allowing you to enter further commands. Digi XBee3® DigiMesh RF Module User Guide...
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>.
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>.
When this count reaches its maximum value of 0xFFFF, it stops counting. You can reset EC to 0 (or any other value) at any time to make it easier to track errors. Digi XBee3® DigiMesh RF Module User Guide...
Enables or disables Advanced Encryption Standard (AES) encryption. See bit 2 of C8 (Compatibility Options), which controls the encryption mode. Set this command parameter the same on all devices in a network. Parameter range 0 - 1 Parameter Description Encryption Disabled Encryption Enabled Digi XBee3® DigiMesh RF Module User Guide...
Transparent mode. 0x000000000000FFFF is the broadcast address. It is also used as the polling address when the device functions as end device. Digi XBee3® DigiMesh RF Module User Guide...
If you set BH to 0, the device uses NH as a limit to the maximum number of hops. When working in API mode, the Broadcast Radius field in the API frame is used instead of this configuration. Digi XBee3® DigiMesh RF Module User Guide...
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 Digi XBee3® DigiMesh RF Module User Guide...
When encryption is enabled, AES Counter mode is used with a 256-bit key. compatibility When encryption is enabled AES ECB mode is used with a 128-bit key. This is compatible with legacy versions of DigiMesh 2.4. Digi XBee3® DigiMesh RF Module User Guide...
The time to send a broadcast between two nodes in the network should not exceed the product of the broadcast one hop time (%8) and the number of hops between those two nodes. Parameter range [read-only] Default Digi XBee3® DigiMesh RF Module User Guide...
If operating on channel 26 (CH = 0x1A), output power will be capped and cannot exceed 8 dBm regardless of the PL setting. Parameter range 0 - 4 PL setting XBee3 TX power XBee3-PRO TX power 8 dBm 19 dBm 5 dBm 15 dBm Digi XBee3® DigiMesh RF Module User Guide...
If the XBee3 DigiMesh RF Module has been reset and has not yet received a packet, DB reports 0. This value is volatile (the value does not persist in the device's memory after a power-up sequence). Parameter range [read-only] Digi XBee3® DigiMesh RF Module User Guide...
921,600 b/s 0x4B0 (1200 b/s) to 0xEC400 (967680 b/s) (non standard baud rates) Default 0x03 (9600 baud) NB (Parity) Set or read the serial parity settings for UART communications. Parameter range 0x00 - 0x03 Digi XBee3® DigiMesh RF Module User Guide...
0 - 2 Parameter Description API disabled (operate in Transparent mode) API enabled API enabled (with escaped control characters) Default AO (API Options) The API data frame output format for RF packets received. Digi XBee3® DigiMesh RF Module User Guide...
The default value (0x2B) is the ASCII code for the plus (+) character. You must enter it three times within the guard time to enter Command mode. To enter Command mode, there is also a required Digi XBee3® DigiMesh RF Module User Guide...
The following AT commands are firmware commands. VR (Firmware Version) Reads the firmware version on a device. Parameter range 0x9000 - 0x90FF [read-only] Default Set in the firmware HV (Hardware Version) Display the hardware version number of the device. Digi XBee3® DigiMesh RF Module User Guide...
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 types of devices. If you change DD, RE (Restore Defaults) will not restore defaults. The only way to get DD back to default values is to explicitly set it to defaults.
OK response. Use the WR command sparingly; the device’s flash supports a limited number of write cycles. Parameter range Default RE (Restore Defaults) Restore device parameters to factory defaults. Parameter range Default Digi XBee3® DigiMesh RF Module User Guide...
Operate in API mode API mode overview Use the AP command to set the operation mode API frame format Frame descriptions Digi XBee3® DigiMesh RF Module User Guide...
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. Example: escape an API frame To express the following API non-escaped frame in API operating mode with escaped characters: Digi XBee3® DigiMesh RF Module User Guide...
Page 66
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: Digi XBee3® DigiMesh RF Module User Guide...
The following example illustrates an AT Command frame when you modify the device's NH parameter value. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x04 Frame type 0x08 Frame ID 0x52 Digi XBee3® DigiMesh RF Module User Guide...
Page 69
Operate in API mode Frame descriptions Frame data fields Offset Example AT command 0x4E (N) 0x48 (H) Parameter value (NH2 = two network hops) 0x02 Checksum 0x0D Digi XBee3® DigiMesh RF Module User Guide...
Up to NP bytes per packet. Sent to the destination device. 17-n Transmit Options bit field Bit field Meaning Description Disable ACK Disable acknowledgments on all unicasts Disable RD Disable Route Discovery on all DigiMesh unicasts Digi XBee3® DigiMesh RF Module User Guide...
Page 73
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)]. Digi XBee3® DigiMesh RF Module User Guide...
If set to 0, the transmission radius set to the network maximum hops value. Radius If the broadcast radius exceeds the value of NH then the devices use the value of NH as the radius. Only broadcast transmissions use this parameter. Digi XBee3® DigiMesh RF Module User Guide...
Change the broadcast hops register on a remote device to 1 (broadcasts go to 1-hop neighbors only). Apply changes so the new configuration value takes effect immediately. In this example, the 64-bit address of the remote device is 0x0013A200 40401122. Digi XBee3® DigiMesh RF Module User Guide...
Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x05 Frame type 0x88 Frame ID 0x01 AT command 0x42 (B) 0x44 (D) Digi XBee3® DigiMesh RF Module User Guide...
Page 80
Operate in API mode Frame descriptions Frame data fields Offset Example Command status 0x00 Command data (No command data implies the parameter was set rather than queried) Checksum 0xF0 Digi XBee3® DigiMesh RF Module User Guide...
When a device powers up, it returns the following API frame. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 LSB 2 0x02 Frame type 0x8A Status 0x00 Checksum 0x75 Digi XBee3® DigiMesh RF Module User Guide...
In the following example, the destination device reports a successful unicast data transmission successful and a route discovery occurred. The outgoing Transmit Request that this response frame came from uses Frame ID of 0x47. Frame Fields Offset Example Start delimiter 0x7E Digi XBee3® DigiMesh RF Module User Guide...
Page 83
Frame descriptions Frame Fields Offset Example Length MSB 1 0x00 LSB 2 0x07 Frame type 0x8B Frame ID 0x47 Reserved 0xFF 0xFE Transmit retry count 0x00 Delivery status 0x00 Discovery status 0x02 Checksum 0x2E Digi XBee3® DigiMesh RF Module User Guide...
The following example represents a possible Route Information Packet. A device receives the packet when it performs a trace route on a transmission from one device (serial number 0x0013A200 4052AAAA) to another (serial number 0x0013A200 4052DDDD). Digi XBee3® DigiMesh RF Module User Guide...
In the following example, a device with destination address (DH/DL) of 0x0013A200 4052AAAA updates its destination address to 0x0013A200 4052BBBB. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x12 Frame type 0x8E Format ID 0x00 Digi XBee3® DigiMesh RF Module User Guide...
Page 88
Frame descriptions 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 Digi XBee3® DigiMesh RF Module User Guide...
RxData. If AO = 0 on the receiving device, it sends the following frame out its serial interface. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x12 Digi XBee3® DigiMesh RF Module User Guide...
Received RF data. Example In the following example, a device with a 64-bit address of 0x0013A200 40522BAA sends a broadcast data transmission to a remote device with payload RxData. If a device sends the transmission: Digi XBee3® DigiMesh RF Module User Guide...
Page 93
Operate in API mode Frame descriptions Frame data fields Offset Example Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x68 Digi XBee3® DigiMesh RF Module User Guide...
Indicates the 64-bit address of the remote device that transmitted the address Node Identification Indicator frame. NI string 25-26 Node identifier string on the remote device. The NI string is terminated with a NULL byte (0x00). Reserved Reserved 27-28 Digi XBee3® DigiMesh RF Module User Guide...
Page 95
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 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...
Page 96
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 Digi XBee3® DigiMesh RF Module User Guide...
SL command, and if the frame ID = 0x55, the response would look like the following example. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x13 Frame type 0x97 Frame ID 0x55 Digi XBee3® DigiMesh RF Module User Guide...
Page 98
64-bit source (remote) address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 12 0xAA Reserved 0xFF 0xFE AT commands 0x53 (S) 0x4C (L) Command status 0x00 Command data 0x40 0x52 0x2B 0xAA Checksum 0xF4 Digi XBee3® DigiMesh RF Module User Guide...
Need help?
Do you have a question about the XBee3 DigiMesh 2.4 and is the answer not in the manual?
Questions and answers