Digi XBee3 DigiMesh 2.4 User manual

Digi XBee3® DigiMesh 2.4
RF Module
User Guide

Revision history—90002277
Revision Date Description
A April 2018 Initial release.
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.
Digi XBee3® DigiMesh RF Module User Guide 2

Contents
About the XBee3 DigiMesh RF Module
Applicable firmware and hardware 8
Change the firmware protocol 8
Getting started
Verify kit contents 10
Assemble the hardware 10
Plug in the XBee3 DigiMesh RF Module 11
How to unplug an XBee module 12
Configure the device using XCTU 12
Configure remote devices 12
Configure the devices for a range test 13
Perform a range test 14
Configure the XBee3 DigiMesh RF Module
Software libraries 18
Configure the device using XCTU 18
Modes
Transparent operating mode 20
API operating mode 20
Command mode 20
Enter Command mode 20
Send AT commands 21
Apply command changes 21
Exit Command mode 21
Idle mode 22
Transmit mode 22
Receive mode 22
Serial communication
Serial interface 24
Serial data 24
UART data flow 24
Serial receive buffer 25
Digi XBee3® DigiMesh RF Module User Guide 3

Digi XBee3® DigiMesh RF Module User Guide 4
Serial transmit buffer 25
Flow control 25
CTS flow control 26
RTS flow control 26
Networking
Network identifiers 28
Operating channels 28
Delivery methods 28
Point-to-multipoint 28
DigiMesh networking 29
Broadcast addressing 30
Unicast addressing 30
Route discovery 30
Routing 31
Routers 31
Repeater/directed broadcast 31
MAC layer 31
Encryption 32
Maximum payload 32
Network commissioning and diagnostics
Local configuration 34
Remote configuration 34
Send a remote command 34
Apply changes on remote devices 34
Remote command response 34
Build aggregate routes 35
DigiMesh routing examples 35
Replace nodes 36
Test links between adjacent devices 36
Trace route option 38
NACK messages 39
Associate LED 39
Node discovery 39
Discover all the devices on a network 40
Directed node discovery 40
Destination Node 40
Discover devices within RF range 41
AT commands
Network commands 43
ID (Network ID) 43
NI (Network Identifier) 43
NT (Network Discovery Back-off) 43
NO (Network Discovery Options) 43
NP (Maximum Packet Payload Bytes) 44
CE (Routing / Messaging Mode) 44
DM (DigiMesh Options) 45
Addressing discovery/configuration commands 45

Digi XBee3® DigiMesh RF Module User Guide 5
AG (Aggregator Support) 45
DN (Discover Node) 45
ND (Network Discover) 46
FN (Find Neighbors) 47
MAC diagnostics 47
BC (Bytes Transmitted) 48
GD (Good Packets Received) 48
EA (MAC ACK Failure Count) 48
EC (CCA Failures) 48
TR (Transmission Failure Count) 49
UA (Unicasts Attempted Count) 49
Security commands 49
EE (Encryption Enable) 49
KY (AES Encryption Key) 50
Addressing commands 50
SH (Serial Number High) 50
SL (Serial Number Low) 50
DH (Destination Address High) 50
DL (Destination Address Low) 51
RR (Unicast Mac Retries) 51
MT(Broadcast Multi-Transmits) 51
BH (Broadcast Hops) 51
NH (Network Hops) 52
MR (Mesh Unicast Retries) 52
NN (Network Delay Slots) 52
TO (Transmit Options) 53
C8 (Compatibility Options) 53
CI (Cluster ID) 54
Diagnostic commands - addressing timeouts 54
%H (MAC Unicast One Hop Time) 54
%8 (MAC Broadcast One Hop Time) 54
N? (Network Discovery Timeout) 55
RF interfacing commands 55
CH (Operating Channel) 55
PL (TX Power Level) 55
PP (Output Power in dBm) 56
CA (CCA Threshold) 56
DB (Last Packet RSSI) 56
UART serial interfacing 57
BD (Baud Rate) 57
NB (Parity) 57
SB (Stop Bits) 58
AP (API Enable) 58
AO (API Options) 58
RO (Packetization Timeout) 59
FT (Flow Control Threshold) 59
Command mode options 59
CC (Command Character) 59
CT (Command Mode Timeout) 60
GT (Guard Time) 60
Diagnostics – Firmware/Hardware Information 60
VR (Firmware Version) 60
HV (Hardware Version) 60
DD (Device Type Identifier) 61
CK (Configuration CRC) 61

Digi XBee3® DigiMesh RF Module User Guide 6
FR (Software Reset) 61
Memory access commands 61
AC (Apply Changes) 62
WR (Write) 62
RE (Restore Defaults) 62
Operate in API mode
API mode overview 64
Use the AP command to set the operation mode 64
API frame format 64
API operation (AP parameter = 1) 64
API operation with escaped characters (AP parameter = 2) 65
Frame descriptions 68
AT Command Frame - 0x08 68
AT Command - Queue Parameter Value frame - 0x09 70
Transmit Request frame - 0x10 71
Explicit Addressing Command frame - 0x11 74
Remote AT Command Request frame - 0x17 77
AT Command Response frame - 0x88 79
Modem Status frame - 0x8A 81
Transmit Status frame - 0x8B 82
Route Information Packet frame - 0x8D 84
Aggregate Addressing Update frame - 0x8E 87
Receive Packet frame - 0x90 89
Explicit Rx Indicator frame - 0x91 91
Node Identification Indicator frame - 0x95 94
Remote Command Response frame - 0x97 97

About the XBee3 DigiMesh RF Module
The XBee3 DigiMesh RF Module consists of DigiMesh 2.4 firmware loaded on the XBee3 hardware. This
user guide covers the firmware, for information about XBee3 hardware, see the XBee3 RF Module
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.
Applicable firmware and hardware 8
Change the firmware protocol 8
Digi XBee3® DigiMesh RF Module User Guide 7

About the XBee3 DigiMesh RF Module Applicable firmware and hardware
Digi XBee3® DigiMesh RF Module User Guide 8
Applicable firmware and hardware
This manual supports the following firmware:
n3000
It supports the following hardware:
nXBee3
Change the firmware protocol
You can switch the firmware loaded onto the XBee3 hardware to run any of the following protocols:
nZigbee
n802.15.4
nDigiMesh
To change protocols, use the Update firmware feature in XCTU and select the firmware. See the
XCTU User Guide.

Getting started
Verify kit contents 10
Assemble the hardware 10
Configure the device using XCTU 12
Configure remote devices 12
Configure the devices for a range test 13
Perform a range test 14
Digi XBee3® DigiMesh RF Module User Guide 9

Getting started Verify kit contents
Digi XBee3® DigiMesh RF Module User Guide 10
Verify kit contents
The XBee3 DigiMesh RF Module development kit contains the following components:
Part
XBee3 Zigbee SMT module (3)
XBee Grove development board (3)
Micro USB cable (3)
Antenna - 2.4 GHz, half-wave dipole, 2.1 dBi, U.FL female, articulating
(3)
XBee stickers
Assemble the hardware
This guide walks you through the steps required to assemble and disassemble the hardware
components of your kit.
nPlug in the XBee3 DigiMesh RF Module
nHow to unplug an XBee module
The kit includes several XBee Grove Development Boards. For more information about this hardware,