XBee DigiMesh 2.4
Radio Frequency (RF) Modules
Getting Started Guide
Revision history—90001110-88
Revision Date Description
D October
2015
E February
2016
F February
2016
Updated content to reflect new version of XCTU software, and added several
new topics.
Updated screenshots and UI terminology to reflect the changes in XCTU v.
6.3.
Changed title of first topic and changed link type for cross-references so that
they don't open in new windows.
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.
© 2017 Digi International Inc. All rights reserved.
Disclaimers
Information in this document is subject to change without notice and does not represent a
commitment on the part of Digi International. Digi provides this document “as is,” without warranty of
any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or
merchantability for a particular purpose. Digi may make improvements and/or changes in this manual
or in the product(s) and/or the program(s) described in this manual at any time.
Warranty
To view product warranty information, go to the following website:
www.digi.com/howtobuy/terms
Send comments
Documentation feedback: To provide feedback on this document, send your comments to
techcomm@digi.com.
Customer support
Digi Technical Support: Digi offers multiple technical support plans and service packages to help our
customers get the most out of their Digi product. For information on Technical Support plans and
pricing, contact us at +1 952.912.3456 or visit us at www.digi.com/support.
XBee DigiMesh 2.4 Getting Started Guide
2
Contents
XBee/XBee PRO DigiMesh 2.4 Getting Started Guide
DigiMesh networks 5
Synchronous sleeping network 5
Mesh networking 6
Do more with your XBee devices
Update the firmware of your XBee modules 8
Configure remote XBee modules 8
Set up and perform a range test 9
Configure the XBee modules for a range test 9
Perform a range test 10
Set up basic encryption for your XBee network 13
Troubleshooting
Cannot install device driver 16
Potential cause 16
Resolution 16
Use LEDs to identify XBee modules 16
Resolution 16
No remote devices to select for a range test 16
Check cables 16
Check that the XBee module is fully seated in the XBee development board 16
Check the XBee module orientation 17
Check that the XBee modules are in the same network 17
Restore default settings 17
Port in use 17
Potential cause 17
Resolution 17
XCTU can't discover devices 17
Check the configuration of your USB serial converter 17
Check cables 18
Check that the XBee module is fully seated in the XBee development board 18
Check the XBee module orientation 18
Check driver installation 18
Check if the modules are sleeping 18
XCTUcannot discover remote devices 18
Potential cause 18
Resolution 19
XBee DigiMesh 2.4 Getting Started Guide
3
XCTUcannot discover remote devices for a range test 19
Potential cause 19
Resolution 19
XCTU installation error 19
Potential cause 19
Resolution 19
XBee DigiMesh 2.4 Getting Started Guide
4
XBee/XBee PRO DigiMesh 2.4 Getting Started Guide
The XBee/XBee PRO DigiMesh 2.4 modules support low-cost, low-power, peer-to-peer or wireless
mesh networks. The XBee modules provide reliable delivery of data between remote devices.
This guide shows you how to set up an XBee mesh network using the DigiMesh protocol, send data
between your XBee modules, and adjust your XBee module settings.
DigiMesh networks
DigiMesh is a proprietary networking topology for use in wireless end-point connectivity solutions. It
supports advanced networking features including sleeping routers and dense mesh networks.
DigiMesh supports multiple network topologies such as point-to-point, point-to-multipoint, and mesh
networks. With support for sleeping routers, DigiMesh is ideal for power-sensitive applications that
rely upon batteries or power-harvesting technology.
DigiMesh contains the following features:
n Self-healing: Any node may enter or leave the network at any time without causing the
network as a whole to fail.
n Peer-to-peer architecture: No hierarchy and no parent-child relationships are needed.
n Easy to use: Mesh networking is simplified because it does not require hierarchy or parent-child
relationships.
n Quiet: Routing overhead is reduced by using a reactive protocol similar to Ad-hoc On Demand
Distance Vector routing (AODV).
n Route discovery: Routes are discovered and created only when needed, eliminating the need to
maintain a network map.
n Selective acknowledgments: Only the destination node will reply to route requests.
n Reliable: Acknowledgments confirm successful delivery of data.
n Sleep modes: Supports low-power sleep modes with synchronized wake up as well as variable
sleep and wake times.
Synchronous sleeping network
One advantage of DigiMesh is that it allows all nodes in the network to both route data and enter lowpower states. The synchronous sleep feature makes it possible for all nodes in the network to
XBee DigiMesh 2.4 Getting Started Guide
5
XBee/XBee PRO DigiMesh 2.4 Getting Started Guide Mesh networking
synchronize their sleep and wake times. This allows some or all XBee modules in the network to be
battery powered.
All modules go to sleep at the same time. This forms a cyclic sleeping network where we can define
two different device types: sleeping router and sleep coordinator.
For more information on the synchronous sleep feature, see Low power and battery life.
Mesh networking
A mesh network is a topology in which each node in the network is connected to other nodes around
it. Each node cooperates in the transmission of information. Mesh networking provides three
important benefits:
n Routing. With this technique, the message is propagated along a path by hopping from node to
node until it reaches its final destination.
n Ad-hoc network creation. This is an automated process that creates an entire network of
nodes on the fly, without any human intervention.
n Self-healing. This process automatically figures out if one or more nodes on the network is
missing and reconfigures the network to repair any broken routes.
With mesh networking, the distance between two nodes does not matter as long as there are enough
nodes in between to pass the message along. When one node wants to communicate with another,
the network automatically calculates the best path.
A mesh network is also reliable and offers redundancy. If a node can no longer operate, for example
because it has been removed from the network or because a barrier blocks its ability to communicate,
the rest of the nodes can still communicate with each other, either directly or through intermediate
nodes.
Note Mesh networks use more bandwidth for administration and therefore have less available for
payloads. They can also be more complex to configure and debug in some cases.
XBee DigiMesh 2.4 Getting Started Guide
6
Do more with your XBee devices
Update the firmware of your XBee modules 8
Configure remote XBee modules 8
Set up and perform a range test 9
Set up basic encryption for your XBee network 13
XBee DigiMesh 2.4 Getting Started Guide
7
Do more with your XBee devices Update the firmware of your XBee modules
Update the firmware of your XBee modules
Radio firmware is the program code stored in the device's persistent memory that provides the
control program for the device. Use XCTU to update the firmware.
Click the Configuration working modes button .
1.
2. Add local and remote XBee modules to your computer. See Add XBee modules to XCTU and
Configure remote XBee modules.
3. Select a local or remote XBee module from the Radio Modules list.
Click the Update firmware button .
4.
The Update firmware dialog displays the available and compatible firmware for the selected
XBee module.
5. Select the product family of the XBee module, the function set, and the latest firmware version.
6. Click Update. A dialog displays update progress.
Configure remote XBee modules
You can communicate with remote devices over the air through a corresponding local device.
Configure the local device in API mode because remote commands work only in API mode. Configure
remote radio modules in either API or transparent mode.
These instructions show you how to configure the LT (Associate LED blink times) parameter on a
remote module.
1. Add two XBee modules to XCTU. See Add XBee modules to XCTU.
2. Configure the first XBee module in APImode and name it XBEE_A. See Configure an XBee
module in APImode.
3. Configure the second XBee module in either API or transparent mode, and name it XBEE_B.
See Configure the first two XBee modules in transparent mode.
4. Disconnect XBEE_B from your computer and remove it from XCTU by clicking the Remove the
list of remote modules button .
5. Connect XBEE_B to a power supply (or laptop or portable battery).
Your Radio Modules area should look something like this.
Select XBEE_A and click the Discover radio nodes in the same network button .
6.
7. Click Add selected devices in the Discovering remote devices dialog. The discovered remote
device appears below XBEE_A.
8. Select the remote device XBEE_B, and configure the following parameter:
LT: FF (hexidecimal representation for 2550 ms)
XBee DigiMesh 2.4 Getting Started Guide
8
Do more with your XBee devices Set up and perform a range test
Click the Write radio settings button .
9.
The remote XBee module now has a different LED blink time.
10. To return to the default LED blink times, change the LT parameter back to 0 for XBEE_B.
Set up and perform a range test
This section shows you how to set up two XBee modules to perform a range test, which demonstrates
the real-world RF range and link quality between two XBee modules in the same network. Performing
a range test gives an initial indication of the expected communication performance of the kit
components. When deploying an actual network, perform multiple range tests to analyze varying
conditions in your application.
Configure the XBee modules for a range test
For XBee modules to communicate with each other, you configure them so they are in the same
network. You also set the local device to API mode to obtain all possible data of the remote XBee
module.
1. Add two XBee modules to XCTU. See Step 3: Add the XBee modules to XCTU.
Select the first XBee module and click the Load default firmware settings button .
2.
3. Configure the following parameters:
ID: 2015
NI: XBEE_A
AP: API enabled [1]
Click the Write radio settings button .
4.
Select the other XBee module and click .
5.
6. Configure the following parameters:
NI: XBEE_B
AP: API disabled [0]
Click the Write radio settings button .
7.
After you write the radio settings for each XBee module, their names appear in the Radio
Modules area. The Port indicates XBEE_A is in API mode.
8. Disconnect XBEE_B from your computer and remove it from XCTU by clicking the Remove the
list of remote modules button .
9. Connect XBEE_B to a power supply (or laptop or portable battery) and move it away from
XBEE_A to the desired location for your range test.
XBee module Indoor range (approximate) Outdoor range (approximate)
XBee DigiMesh 2.4 Getting Started Guide
9
Do more with your XBee devices Set up and perform a range test
Perform a range test
These instructions show you how to use the loopback cluster (0x12) when performing a range test.
The benefit of using this type of range test is you do not have to close the loopback jumper of the
remote module and the module can work in any operating mode.
In XCTU, open the Tools menu and select the Range Test option.
1.
The Radio Range Test window opens. Your local device appears on the left side of the Device
Selection area.
XBee DigiMesh 2.4 Getting Started Guide
10
Do more with your XBee devices Set up and perform a range test
Select XBEE_A and click the Discover remote devices button .
2.
The discovery of remote devices starts. When the discovery process finishes, the other device
(XBEE_B) appears in the Discovering remote devices dialog.
3. Click Add selected devices.
XBee DigiMesh 2.4 Getting Started Guide
11
Do more with your XBee devices Set up and perform a range test
4. Select XBEE_B from the Discovered device drop-down menu in the Device Selection area.
5. For Range Test type, select Cluster ID 0x12.
Click the Start Range Test button .
6.
7. If a notification dialog asks you to close the loopback jumper in the remote device, click OK.
8. Test the signal interference by doing one of the following:
n Place your hands over one of the XBee modules.
n Block line-of-sight with your body.
n Place a metal box over an XBee module.
n Move the remote XBee module to a different room or floor of the building.
The Received Signal Strength Indicator (RSSI) value will decrease and some packets may even
be lost.
XBee DigiMesh 2.4 Getting Started Guide
12
Do more with your XBee devices Set up basic encryption for your XBee network
9. Observe how XCTU represents the retrieved data:
n Range Test chart represents the RSSI values of the local and remote devices during the
range test session. The chart also shows the percentage of total packets successfully
sent.
n Local and Remote bar graphs represent the signal strengths of the local and remote
XBee modules. These values are retrieved for the last packet sent/received. RSSI is
measured in dBm. A greater negative value in dBm indicates a weaker signal. Therefore,
-50 dBm is better than -60 dBm.
n Packets sent and Packets received area shows the total number of packets sent,
packets received, transmission errors, and packets lost. The percentage bar graph
indicates the percentage of packets that are successfully sent and received during a
range test session.
In the following illustration, the percentage of packets successfully sent is 69% and received is
64%. The actual percentage of packets successfully sent or received may be higher.
Click the Stop Range Test button to stop the process at any time.
10.
11. When you have completed the range test, click the Remove the list of remote modules
button to remove the remote XBee modules from XCTU.
Set up basic encryption for your XBee network
The information transmitted in an XBee network sometimes needs to be protected. For example, an
XBee network transferring financial information must be carefully protected against external agents.
XBee DigiMesh 2.4 Getting Started Guide
13
Do more with your XBee devices Set up basic encryption for your XBee network
These instructions show you how to configure XBee modules for secure communication via encryption
keys.
Note You can use encryption for XBee modules that have been configured for either AT (transparent)
or API mode.
1. Add two XBee modules to XCTU. See Step 3: Add the XBee modules to XCTU.
2. Configure the XBee modules so they can talk to each other. See Configure the first two XBee
modules in transparent mode.
3. Name your two XBee modules XBee_A and XBee_B.
4. Select XBee_A and configure the following parameters:
EE: Set the AES Encryption Enable parameter to 1.
KY: Set the AES Encryption Key parameter to a 32 hexadecimal character string. Example:
11111222223333344444555556666677
Click the Write radio settings button .
5.
Configure the parameters for XBEE_B as you did for XBEE_A, and then click .
6.
7. Send a secure message between XBee_A and XBee_B. See Send messages through XCTU.
Note If you add more XBee modules, give them the same encryption key so they can communicate
with the other XBee modules.
8. To return to the encryption disabled setting, change the EEparameter back to 0 for XBEE_A
and XBEE_B.
XBee DigiMesh 2.4 Getting Started Guide
14
Troubleshooting
If you get stuck while performing any of the tasks in this guide, try one of these troubleshooting tips.
Cannot install device driver 16
Use LEDs to identify XBee modules 16
No remote devices to select for a range test 16
Port in use 17
XCTU can't discover devices 17
XCTUcannot discover remote devices 18
XCTUcannot discover remote devices for a range test 19
XCTU installation error 19
XBee DigiMesh 2.4 Getting Started Guide
15
Troubleshooting Cannot install device driver
Cannot install device driver
The device driver software was not successfully installed.
Potential cause
Resolution
Try the following, in order. If one of the steps resolves the issue, you're done.
1. Remove and re-insert the XBee module into your computer.
2. If the OS is still unable to install the driver, remove and re-insert the XBee module into another
USB port.
3. If your computer fails during the driver initialization problem and you are still unable to install
the drivers, complete the following steps:
a. Open the Device Manager.
b. In the Other Devices section, right-click on the device T232R USB UART and click
uninstall.
c. Plug in your device and allow your system to reinstall the drivers.
Use LEDs to identify XBee modules
You want to force LEDs to blink so you can easily locate an XBee module.
Resolution
To locate an XBee module using LEDs:
In XCTU, select one of your XBee modules and click the Read radio settings button .
1.
2. Observe which XBee module has the Rx and Tx LED lights blinking green and yellow on its
development board.
No remote devices to select for a range test
If there are no remote XBee modules to select in the Radio Range Test dialog, try one of the following
resolutions.
Check cables
The USB cables should be firmly and fully attached to both the computer and the XBee development
board. When attached correctly, the association LED on the adapter is lit.
Check that the XBee module is fully seated in the XBee
development board
When the XBee module is correctly installed, it is pushed fully into the board and no air or metal is
visible between the plastic of the adapter socket and the XBee module headers. Also, check that all
XBee DigiMesh 2.4 Getting Started Guide
16
Troubleshooting Port in use
ten pins on each side of the XBee module are in a matching hole in the socket.
Check the XBee module orientation
The angled "nose" of the XBee module should match the lines on the silk screening of the board and
point away from the USB socket on the XBee development board.
Check that the XBee modules are in the same network
Check that the following parameters have the same value for all XBee modules on your network:
XBee module development kit Parameters
Restore default settings
If the XBee modules are properly connected and in the same network, restore default settings and
configure them again.
Port in use
Message:"The port is already in use by other applications."
Potential cause
The serial port where the local XBee module is connected can only be in use by one application.
Resolution
Make sure the connection with the XBee module in the XCTU console is closed and there are no other
applications using the port.
XCTU can't discover devices
If XCTU doesn't discover an XBee module or doesn't display any serial ports, try the following
resolutions.
Check the configuration of your USB serial converter
1. On the Start menu, click Computer > System Properties > Device Manager.
2. Under Serial Bus controllers, double-click the first USB Serial Converter to open the USB Serial
Converter dialog.
3. Click the Advanced tab, make sure Load VCP is selected, and click OK.
4. Repeat steps 2 and 3 for each USB Serial Converter listed in the Device Manager.
XBee DigiMesh 2.4 Getting Started Guide
17
Troubleshooting XCTUcannot discover remote devices
Check cables
Double-check all cables. The USB cable should be firmly and fully attached to both the computer and
the XBee development board. When attached correctly, the association LED on the adapter will be lit.
Check that the XBee module is fully seated in the XBee
development board
When the XBee module is correctly installed, it should be pushed fully into the board and no air or
metal should be visible between the plastic of the adapter socket and the XBee module headers. Also,
double-check that all ten pins on each side of the XBee module made it into a matching hole in the
socket.
Check the XBee module orientation
The angled "nose" of the XBee module should match the lines on the silk screening of the board and
point away from the USB socket on the XBee development board.
Check driver installation
Drivers are installed the first time the XBee development board is plugged in. If this process is not
complete or has failed, try the following steps:
1. Remove and re-insert the board into your computer. This may cause driver installation to re-
occur.
2. Remove and re-insert the board into another USB port.
3. (Windows) Open Computer management, find the failing device in the Device Manager section
and remove it.
4. Download the appropriate driver. You can download drivers for all major operating systems
from FTDI for manual installation.
Check if the modules are sleeping
The On/Sleep LED of the XBee development board indicates if the XBee module is awake (LED on) or
asleep (LED off). When an XBee module is sleeping, XCTUcannot discover it, so press the
Commissioning button to wake it up for 30 seconds.
XCTUcannot discover remote devices
XCTUdoes not discover remote XBee module.
Potential cause
The XBee modules do not have the appropriate values for the following parameters:
XBee module development kit Parameters
XBee DigiMesh 2.4 Getting Started Guide
18
Troubleshooting XCTUcannot discover remote devices for a range test
Resolution
1. Ensure that all XBee modules on your network have the same value for each of the parameters
listed in the table.
2. If this doesn't resolve the issue, try setting your modules back to their default settings. Select
each XBee module and click the Load default firmware settings button .
XCTUcannot discover remote devices for a range test
When setting up a range test in the Radio Range Test dialog, you receive the message "There are not
remote devices discovered for the selected local device."
Potential cause
In the Radio Range Test dialog, the local radio device you selected has not yet discovered any remote
devices.
Resolution
In the Device Selection area in the Radio Range Test dialog, click the Discover remote devices button
and XCTU will discover devices on the local device's network.
XCTU installation error
An error is reported when installing XCTU.
Potential cause
XCTU requires Administrator permissions.
Resolution
Check that you have Administrator access on the computer where you are installing XCTU. On
Windows systems, a User Account Control dialog may appear when you install XCTU or try to run the
XCTU program. You must answer yes when prompted to allow the program to make changes to your
computer, or XCTU will not work correctly. Note that you may also need to talk to your network
manager to gain permission to install or run applications as administrator.
XBee DigiMesh 2.4 Getting Started Guide
19
Loading...