Digi XBee-PRO 900HP User manual

XBee-PRO 900HP DigiMesh Kit
Radio Frequency (RF) Module
User Guide

Revision history—90001496
Revision Date Description
A January 2016 Initial release.
B March 2016 Rebranded with minor updates.
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.
© 2018 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
[e-mail].
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.3444 or visit us at www.digi.com/support.
XBee-PRO 900HP DigiMesh Kit User Guide 2

Contents
XBee-PRO 900HP DigiMesh Kit User Guide
Kit contents
Introduction to XBee modules
DigiMesh networks
Synchronous sleeping network 15
Mesh networking 15
Getting Started with your DigiMesh kit
Plug in the XBee module 17
How to unplug an XBee module 18
Download and install XCTU 18
Install XCTU - Windows 18
Install XCTU - Linux 18
Install XCTU - OSX 19
Optional: Install XCTU updates 19
Optional: Manually install USB drivers 19
Lab: Set up a simple DigiMesh network 20
Step 1:Requirements 20
Step 2:Connect the components 20
Step 3: Add the XBee modules to XCTU 20
Step 4: Configure the XBee modules 21
Step 5: Check the network 22
Step 6: Send wireless messages 23
How XBee devices work
How XBee devices communicate 26
Wireless communication 26
Addressing 26
Network identifier 27
Preamble identifier 27
Radio frequency channels and channel masks 28
Serial communication 29
Operating modes 30
XBee-PRO 900HP DigiMesh Kit User Guide 3

XBee-PRO 900HP DigiMesh Kit User Guide 4
Comparison of transparent and API modes 30
XBee transparent mode
XBee transparent mode in detail 34
Command mode 34
AT commands 35
Use AT commands 36
XBee API mode
API mode in detail 39
Advantages of API mode 39
API frame structure 40
Start delimiter 40
Length 40
Frame data 40
Checksum 41
DigiMesh supported frames 42
Frame examples 43
Operating mode configuration 48
API escaped operating mode (API 2) 49
XBee frame exchange 50
AT Command: configure a local XBee device 50
Transmit Request/Receive Packet: Transmit and receive wireless data 53
Lab:Transmit and receive data 54
Remote AT Command: Remotely configure an XBee module 59
Do more with API mode: XBee libraries 60
DigiMesh network setup
Set up a DigiMesh network 62
Routing 62
Route discovery 63
Trace routing 64
Aggregate routes 64
Use the AG command 64
Disable routing 65
View the network 65
Lab: Build and experiment with a DigiMesh network 66
Step 1: Requirements 66
Step 2: Connect the components 66
Step 3:Configure the XBee modules 66
Step 4:Set up the components 68
Step 5: Send messages via a bridge node 68
Wireless data transmission
Transmission methods 72
Broadcast transmission 72
Unicast transmission 72
Lab: Transmit data wirelessly 73
Step 1: Requirements 73

XBee-PRO 900HP DigiMesh Kit User Guide 5
Step 2:Connect the components 74
Step 3: Configure the XBee modules 74
Step 4: Create a Java project 75
Step 5:Link libraries to the project 75
Step 6:Add the source code to the project 77
Step 7:Set the port names and launch applications 78
Step 8:Transmit data over the network 78
Step 9:Section summary of wireless data transmission 78
Step 10:Do more with wireless data transmission 79
Low power and battery life
Low power devices and battery life 81
A real world scenario 81
Design considerations for applications using sleep mode 81
Sleep modes 81
Synchronous sleep modes 82
Asynchronous sleep modes 82
Asynchronous sleep 82
Synchronous sleep 83
Synchronous sleep operation 83
Synchronous sleep modes 84
Synchronous sleep parameters 85
Designate a sleep coordinator 87
Start a sleeping network 89
Lab: Use synchronous sleep 89
Step 1:Requirements 89
Step 2: Connect the components 90
Step 3:Configure the XBee Modules 90
Step 4:Test the sleep configuration 93
Step 5:Section summary of synchronous sleep 95
Step 6: Do more with sleep mode 96
Inputs and outputs
XBee I/O pins 98
How XBee devices get sensor data 99
Sensors 99
How to configure a pin as an input 99
How to obtain data from a sensor 100
Lab: receive digital data 101
Step 1:Requirements 102
Step 2:Connect the components 102
Step 3:Configure the XBee modules 102
Step 4:Create a Java project 104
Step 5:Link libraries to the project 104
Step 6: Add the source code to the project 105
Step 7:Set the port name and launch the application 107
Step 8:Section summary of receiving digital data 107
Step 9:Do more with receiving digital data 108
Lab: Receive analog data 108
Step 1: Requirements 109
Step 2:Connect the components 109
Step 3:Configure the XBee modules 109

XBee-PRO 900HP DigiMesh Kit User Guide 6
Step 4: Create a Java project 111
Step 5:Link libraries to the project 112
Step 6:Add the source code to the project 113
Step 7:Set the port name and launch the application 114
Step 8:Section summary of receiving analog data 114
Step 9:Do more with receiving analog data 115
How XBee modules control devices 115
Actuators 116
Set pins for digital and analog actuators 116
How to configure a pin as an output 116
How to send actuations 117
Lab:Send digital actuations 117
Step 1:Requirements 117
Step 2:Connect the components 118
Step 3:Configure the XBee modules 118
Step 4:Create a Java project 119
Step 5:Link libraries to the project 120
Step 6:Add the source code to the project 121
Step 7:Set the port name and launch the application 122
Step 8:Section summary of sending digital actuations 122
Step 9: Do more with sending digital actuations 122
Lab: Send analog actuations 123
Step 1:Requirements 123
Step 2:Connect the components 123
Step 3:Configure the XBee modules 123
Step 4:Create a Java project 124
Step 5:Link libraries to the project 125
Step 6:Add the source code to the project 126
Step 7:Set the port name and launch the application 127
Step 8:Section summary of sending analog actuations 127
Step 9: Do more with sending analog actuations 127
Security and encryption
How to enable network security 130
Lab: Encrypt a simple DigiMesh network 130
Test your encryption 130
Additional recommendations 130
Signal strength and radio frequency range
Distance and obstacles 133
Factors affecting wireless communication 134
Signal strength and the RSSI pin 135
Is RSSI the best indication of link quality? 137
Range test 137
Example: perform a range test 139
Step 1:Requirements 139
Step 2:Connect the components 140
Step 3:Configure the XBee modules 140
Perform a range test 141
Step 5:Section summary of signal strength 141

XBee-PRO 900HP DigiMesh Kit User Guide 7
Radio firmware
Firmware identification 143
Update radio firmware 143
Update your device's firmware 144
Download new firmware 144
Troubleshooting for XBee-PRO 900HP DigiMesh Kit kit
General 146
Cannot find the serial port for the module 146
Can't identify XBee modules 146
Error: Port is already in use 146
Error: Device driver was not successfully installed 146
XCTU 147
Error upon installation of XCTU 147
Discovery process either does not find devices, or XCTU does not list serial ports 147
XCTU reports errors for KY and DD settings after resetting to factory defaults 148
DigiMesh network setup 148
The modules are not found when checking the network 148
Wireless data transmission 148
Error: Parsing text error message 148
Error: Could not find the module in the network 148
XBee Java library 148
Warning message: RXTX version mismatch 149
Invalid operating mode exception message 149
Java lang unsatisfied exception message 149
Interface in use exception message 150
Java lang no class definition exception message 150
SLF4J class path contains multiple bindings message 151
XBee Java Library and transparent mode 151
Synchronous sleep 151
A receiver module does not receive any message 151
Range test 151
Error: There are not remote devices discovered for the selected local device 151
There are no remote devices to select 151
The local RSSI and the number of packets received are always 0 152
Remote RSSI is not included in the chart and the Remote RSSI control is disabled 152
Additional resources
XBee buying guide 154
Where to buy XBee devices 154
Find products from Digi and Digi distributors 154
Find Digi products through resellers 155
XCTU walkthrough 155
XCTU overview 155
Application working modes 158
Add a module 158
Read settings 159
Change settings 160
Save settings 160
Real projects with XBee modules 160
Community 161

XBee-PRO 900HP DigiMesh Kit User Guide 8
Industrial solutions 161
Related products 162

XBee-PRO 900HP DigiMesh Kit User Guide
Digi’s XBee-PRO 900HP DigiMesh Kit is a great way to learn how to use XBee RF modules for device
connectivity and mesh networking. This kit lets anyone get started in the world of DigiMesh. Whether
you're a hardware or software engineer, corporate technologist, educator, or student, you can quickly
create wireless mesh networks.
XBee-PRO 900HP embedded modules provide best-in-class long-range wireless connectivity to
devices. Supporting RF line-of-sight ranges from 1000 feet (305 m) indoors to 4 miles (6.5 km)
outdoors with dipole antennas, and data rates of up to 200 Kbps, these modules are ideal for
extended-range applications requiring increased data throughput.
XBee-PRO 900HP modules take advantage of the DigiMesh networking protocol. This innovative mesh
protocol offers users added network stability through self-healing, self-discovering, and dense
network operation. With support for sleeping routers, DigiMesh is ideal for power-sensitive
applications that rely upon batteries or power-harvesting technology.
Follow this guide to:
nAssemble your kit components
nSet up device communications
nBuild working control systems
nDesign sensing networks with excellent battery life and robust security
XBee-PRO 900HP DigiMesh Kit User Guide 9

XBee-PRO 900HP DigiMesh Kit User Guide
XBee-PRO 900HP DigiMesh Kit User Guide 10
Each section of this guide explains a basic topic related to XBees and DigiMesh with step-by-step
examples that put into practice the concepts you have learned. The topics are arranged according to
their complexity, from the most basic to the more powerful features.
Certain examples use the Java programming language. These examples are easy for anyone to use,
and those with some programming background can extend them to real-world scenarios.

Kit contents
Your XBee-PRO 900HP DigiMesh Kit contains the following components:
Qty. Part
3 XBee Grove Development Boards
3 XBee-PRO 900HP RF modules
3 Micro USB cables
XBee-PRO 900HP DigiMesh Kit User Guide 11

Kit contents
XBee-PRO 900HP DigiMesh Kit User Guide 12
Qty. Part
2 XBee stickers
XBee modules come in two hardware footprints: through-hole and surface mount.
nThrough-hole technology (THT) XBees include the 20-pin socket and require holes for mounting
the component on the printed circuit board (PCB), although it is common for the carrier board
to contain a female socket.
nSurface-mount technology (SMT) XBees include 37 pads. They are placed directly on the PCB,
which means they do not require holes or sockets for mounting the component.

Introduction to XBee modules
XBee modules are small RF (radio frequency) devices that transmit and receive data over the air using
radio signals. Wireless capability is essential whenever you want to place sensors where no cables can
be installed, or where such tethering is undesirable.
XBee devices are highly configurable and support multiple protocols, which lets you choose the right
technology for your application—whether you want to set up a pair of radios to swap data or design a
large mesh network with multiple devices.
Here are some of the ways you can use XBee devices:
nControlling a robot remotely or creating wearable electronics for people, pets, or wildlife,
without hindering movement.
nMaking a building smarter and more responsive to human interaction.
nUsing XBee technology in industrial solutions. For example, XBee devices are used as sensors
to monitor industrial tanks for liquid levels, temperature, and pressure, and to monitor and
control complex machines such as wind turbines.
XBee-PRO 900HP DigiMesh Kit User Guide 13

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:
nSelf-healing: Any node may enter or leave the network at any time without causing the
network as a whole to fail.
nPeer-to-peer architecture: No hierarchy and no parent-child relationships are needed.
nEasy to use: Mesh networking is simplified because it does not require hierarchy or parent-child
relationships.
nQuiet: Routing overhead is reduced by using a reactive protocol similar to Ad-hoc On Demand
Distance Vector routing (AODV).
nRoute discovery: Routes are discovered and created only when needed, eliminating the need to
maintain a network map.
nSelective acknowledgments: Only the destination node will reply to route requests.
nReliable: Acknowledgments confirm successful delivery of data.
nSleep modes: Supports low-power sleep modes with synchronized wake up as well as variable
sleep and wake times.
Synchronous sleeping network 15
Mesh networking 15
XBee-PRO 900HP DigiMesh Kit User Guide 14

DigiMesh networks Synchronous sleeping network
XBee-PRO 900HP DigiMesh Kit User Guide 15
Synchronous sleeping network
One advantage of DigiMesh is that it allows all nodes in the network to both route data and enter low-
power states. The synchronous sleep feature makes it possible for all nodes in the network to
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:
nRouting. With this technique, the message is propagated along a path by hopping from node to
node until it reaches its final destination.
nAd-hoc network creation. This is an automated process that creates an entire network of
nodes on the fly, without any human intervention.
nSelf-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.

Getting Started with your DigiMesh kit
This section provides everything you need to set up your XBee-PRO 900HP DigiMesh Kit and your first
XBee DigiMesh application.
Plug in the XBee module 17
How to unplug an XBee module 18
Download and install XCTU 18
Lab: Set up a simple DigiMesh network 20
XBee-PRO 900HP DigiMesh Kit User Guide 16

Getting Started with your DigiMesh kit Plug in the XBee module
XBee-PRO 900HP DigiMesh Kit User Guide 17
Plug in the XBee module
This kit includes several XBee Grove Development Boards. For more information about this hardware,
visit the XBee Grove Development Board documentation.
Follow these steps to connect the XBee devices to the boards included in the kit:
1. Plug one XBee-PRO 900HP DigiMesh Kit module into the XBee Grove Development Board.
Make sure the board is NOT powered (either by the micro USB or a battery) when
you plug in the XBee module.
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.

Getting Started with your DigiMesh kit How to unplug an XBee module
XBee-PRO 900HP DigiMesh Kit User Guide 18
How to unplug an XBee module
To disconnect your XBee module from the XBee Grove Development Board:
1. Disconnect the micro USB cable (or the battery) from the board so it is not powered.
2. Remove the XBee module from the board socket, taking care not to bend any of the pins.
Make sure the board is not powered when you remove the XBee module.
Download and install XCTU
This section contains download and install instructions based on operating system. XCTU is
compatible with Linux, OSX, and Windows. It may be necessary to configure your system prior to
installing XCTU for the first time.
Install XCTU - Windows
Follow the steps below to download and install XCTU on your computer.
1. Go to www.digi.com/xctu.
2. Click Download XCTU.
3. Under Utilities, click the Windows installer link.
4. When the file has finished downloading, run the executable file and follow the steps in the XCTU
Setup Wizard. A “What’s new” dialog appears when installation is complete.
Install XCTU - Linux
By default, access to the serial and USB ports in Linux is restricted to root and dialout group users. To
access your XBee devices and use XCTU to communicate with them, your Linux user must belong to
this group.
To add your Linux user to the dialout group:
1. Open a terminal console.
2. Execute this following command, where <user> is the user you want to add to the dialout
group.:
sudo usermod -a -G dialout <user>
3. Log out and log in again with your user in the system.
Then download and install XCTU:
1. Go to www.digi.com/xctu.
2. Click Download XCTU.
3. Under Utilities, click the Linux installer link.
4. When the file has finished downloading, run the executable file and follow the steps in the XCTU
Setup Wizard. A “What’s new” dialog appears when installation is complete.

Getting Started with your DigiMesh kit Download and install XCTU
XBee-PRO 900HP DigiMesh Kit User Guide 19
Install XCTU - OSX
OSX version 10.8 (Mountain Lion) and greater only allows you to install applications downloaded from
the Apple Store. To install XCTU, you must temporarily disable this setting.
Follow these steps to enable installation of "unsigned" software:
1. Click the Apple icon in the top-left corner of your screen and choose System Preferences.
2. Click the Security & Privacy icon.
3. To edit security settings, click the padlock icon in the bottom left of the window.
4. Enter your Mac credentials and click Unlock. The Allow applications downloaded from dialog
appears.
5. Click the Anywhere radio button and, in the confirmation window, click Allow From
Anywhere.
Note We recommend you set this option back to Mac App Store or Mac App Store and identified
developers once you have finished installing XCTU.
Download and install XCTU:
1. Go to www.digi.com/xctu.
2. Click Download XCTU.
3. Under Utilities, click the OSX installer link.
4. When the file has finished downloading, unzip and run the executable file and follow the steps
in the XCTU Setup Wizard. A “What’s new” dialog appears when installation is complete.
Optional: Install XCTU updates
When you start XCTU, you may be notified about software updates. You should always run the latest
version of XCTU.
1. When a new version is available, a popup window appears in the bottom-right corner of XCTU.
2. Click on that window and follow the prompts to install the XCTU update.
You can also do the following:
nCheck for updates and manually update the tool by clicking Help > Check for XCTU Updates.
nCheck the XCTU version by clicking Help > About XCTU.
For more information about XCTU, see the XCTU walkthrough.
Optional: Manually install USB drivers
When you connect the XBee board to your computer for the first time, drivers are automatically
installed. You can also install device drivers manually:
1. Download and install the appropriate USB drivers from the Digi Support Site.
2. Choose your operating system.
3. Download and run the file.
4. Follow the steps in the installation wizard.

Getting Started with your DigiMesh kit Lab: Set up a simple DigiMesh network
XBee-PRO 900HP DigiMesh Kit User Guide 20
Lab: Set up a simple DigiMesh network
Follow the steps in this section to set up your first DigiMesh network and start transmitting data
between nodes. These steps include assembling the hardware, configuring the XBee modules for
wireless communication, creating a network, and sending messages.
The initial network involves just two nodes, one of them sending broadcast messages. To
demonstrate how easy it is to integrate additional XBee modules running DigiMesh topology, you can
then connect a third module and see that it receives the messages as well.
If you get stuck, see Troubleshooting for XBee-PRO 900HP DigiMesh Kit kit.
Step 1:Requirements
For this setup you need the following hardware and software.
Hardware
nThree XBee Grove Development Boards
nThree micro USB cables
nOne computer
Software
nXCTU 6.3.1 or later
Tip For more information about XCTU, see the XCTU walkthrough.
Step 2:Connect the components
To get started, connect the components and start XCTU.
1. Plug the XBee modules into the XBee Grove Development Boards and connect them to your
computer using the micro USB cables provided. For more information, see Plug in the XBee
module.
2. After connecting the modules to your computer, open XCTU.
3. Make sure you are in Configuration working mode.
Step 3: Add the XBee modules to XCTU
Use XCTU to find your XBee modules and add them to the tool.
1. Click Discover radio modules from the toolbar.