Digi XTend vB DigiMesh User manual

XTend vB DigiMesh
Radio Frequency (RF) Module
User Guide

Revision history—90001479
Revision Date Description
A December
2015
Baseline release of the document.
B May 2016 Removed Australian certification information. Updates various specifications
including the dimensions. Added the HScommand.
C June 2016 Added a drawing of the pinout locations.
D May 2018 Added note on range estimation. Changed ICto ISED.
E June 2019 Added FCC publication 996369 related information.
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
Customer support
Gather support information: Before contacting Digi technical support for help, gather the following
information:
Product name and model
Product serial number (s)
Firmware version
Operating system/browser (if applicable)
Logs (from time of reported issue)
Trace (if possible)
Description of issue
XTend vB DigiMesh RF Module User Guide 2

Steps to reproduce
Contact Digi technical support: Digi offers multiple technical support plans and service packages.
Contact us at +1 952.912.3444 or visit us at www.digi.com/support.
Feedback
To provide feedback on this document, email your comments to
[e-mail]
Include the document title and part number (XTend vB DigiMesh RF Module User Guide, 90001479 B)
in the subject line of your email.
XTend vB DigiMesh RF Module User Guide 3

Contents
XTend vB DigiMesh RF Module User Guide
Applicable firmware and hardware 10
XTend replacement numbers 10
Certification overview 10
Development Kit
Development Kit contents 12
Interface hardware 12
XTIB-R RS-232/485 Interface Board 13
Configuration switch 13
I/O and Power LEDs 14
Serial port 14
RSSI LEDs 14
Power connector 14
XTIB-R DIP switch 14
Adapters 15
NULL Modem Adapter (male-to-male) 16
NULL Modem Adapter (female-to-female) 16
Serial Loopback Adapter 16
Male DB-9 to RJ-45 Adapter 17
Female DB-9 to RJ-45 Adapter 17
Interface protocols 18
RS-232 operation 18
RS-485 (2-wire) operation 21
RS-485 (4-wire) and RS-422 operation 23
Technical specifications
General specifications 27
Performance specifications 27
Networking specifications 27
Power requirements 28
Regulatory conformity summary 28
Hardware
Connect the hardware 30
Mechanical drawings 31
XTend vB DigiMesh RF Module User Guide 4

XTend vB DigiMesh RF Module User Guide 5
Pin signals 31
Modes
Transparent and API operating modes 35
Transparent operating mode 35
API operating mode 35
Receive mode 35
Transmit mode 36
Command mode 36
Enter Command mode 36
Troubleshooting 37
Send AT commands 37
Response to AT commands 38
Apply command changes 38
Make command changes permanent 38
Exit Command mode 38
Operation
Serial interface 40
UART data flow 40
Serial data 40
Flow control 40
Data In (DIN) buffer and flow control 41
Data Out (DO) buffer and flow control 42
Networking methods
The MAC and PHY layers 44
64-bit addresses 44
Make a unicast transmission 45
Delivery methods 45
Point to Point / Point to Multipoint (P2MP) 45
Repeater/directed broadcast 45
DigiMesh networking 46
AT commands
Addressing commands 51
CI (Cluster ID) 51
DH (Destination Address High) 51
DL (Destination Address Low) 51
NI (Node Identifier) 51
NO (Network Discovery Options) 52
NT (Network Discovery Back-off) 52
SH (Serial Number High) 53
SL (Serial Number Low) 53
TO (Transmit Options) 53
Command mode options 54
CC (Command Character) 54
CT (Command Mode Timeout) 54
GT (Guard Times) 54

XTend vB DigiMesh RF Module User Guide 6
Diagnostic commands 55
%H (MAC Unicast One Hop Time) 55
%V (Board Voltage) 55
%8 (MAC Broadcast One Hop Time) 55
BC (Bytes Transmitted) 55
DB (Last Packet RSSI) 56
EA (MAC ACK Failure Count) 56
ER (Receive Count Error) 56
GD (Good Packets Received) 57
RC (RSSI for channel) 57
R# (Reset Number) 57
TR (Transmission Failure Count) 58
UA (Unicasts Attempted Count) 58
Firmware commands 58
CK (Configuration CRC) 58
DD (Device Type Identifier) 58
NP (Maximum Packet Payload Bytes) 59
HS (Hardware Series) 59
HV (Hardware Version) 59
VR (Firmware Version) 59
I/O settings commands 59
CD (GP02 Configuration) 60
CS (GP01 Configuration) 60
RP (RSSI PWM Timer) 60
RT (GPI1 Configuration) 61
I/O diagnostic commands 61
TP (Board Temperature) 61
MAC/PHY commands 62
HP (Preamble ID) 62
ID (Network ID) 62
MT(Broadcast Multi-Transmits) 62
PL (TX Power Level) 63
RR (Unicast Mac Retries) 63
Network commands 63
BH (Broadcast Hops) 63
CE (Routing / Messaging Mode) 64
MR (Mesh Unicast Retries) 64
NH (Network Hops) 64
NN (Network Delay Slots) 65
Security commands 65
EE (Encryption Enable) 65
KY (AES Encryption Key) 65
Serial interfacing commands 65
AO (API Options) 66
AP (API Enable) 66
BD (Baud Rate) 66
FT (Flow Control Threshold) 67
NB (Parity) 67
RB (Packetization Threshold) 68
RO (Packetization Timeout) 68
SB (Stop Bits) 69
Special commands 69
AC (Apply Changes) 69
CN (Exit Command Mode) 69
FR (Software Reset) 70

XTend vB DigiMesh RF Module User Guide 7
RE (Restore Defaults) 70
WR (Write) 70
R1 (Restored Compiled) 70
Operate in API mode
API mode overview 72
API frame specifications 72
Calculate and verify checksums 74
Escaped characters in API frames 75
API frames
API frame exchanges 77
AT commands 77
Transmit and Receive RF data 77
Remote AT commands 78
Device Registration 78
Code to support future API frames 78
AT Command frame - 0x08 80
AT Command - Queue Parameter Value frame - 0x09 82
Legacy TX Request frame - 0x00 84
Transmit Request frame - 0x10 86
Explicit Addressing Command frame - 0x11 89
Remote AT Command Request frame - 0x17 92
AT Command Response frame - 0x88 94
Modem Status frame - 0x8A 96
Transmit Status frame - 0x8B 97
Legacy TX Status frame - 0x89 99
Route Information Packet frame - 0x8D 100
Aggregate Addressing Update frame - 0x8E 103
Legacy RX Indicator frame - 0x80 105
RX Indicator frame - 0x90 107
Explicit Rx Indicator frame - 0x91 109
Node Identification Indicator frame - 0x95 111
Remote Command Response frame - 0x97 114
Work with networked devices
Network commissioning and diagnostics 117
Local configuration 117
Remote configuration 117
Send a remote command 117
Apply changes on remote devices 117
Remote command response 117
Establish and maintain network links 118
Build aggregate routes 118
DigiMesh routing examples 118
Replace nodes 119
Test links in a network - loopback cluster 119
Test links between adjacent devices 120
Example 121
RSSI indicators 122

XTend vB DigiMesh RF Module User Guide 8
Discover all the devices on a network 122
Trace route option 123
NACK messages 124
Regulatory information
FCC (United States) 126
OEM labeling requirements 126
FCC notices 126
RF exposure statement 127
FCC antenna certifications 127
XTend vB RF Module antenna options 128
FCC publication 996369 related information 133
ISED (Innovation, Science and Economic Development Canada) 135
Labeling requirements 135
Transmitters for detachable antennas 135
Detachable antennas 135

XTend vB DigiMesh RF Module User Guide
The XTend vB RF Module was engineered to provide customers with an easy-to-use radio frequency
(RF) solution that provides reliable delivery of critical data between remote devices. The module
transfers a standard asynchronous serial data stream, operates within the ISM 900 MHz frequency
band and operates at an RF data rate of 125 kb/s.
Applicable firmware and hardware 10
XTend replacement numbers 10
Certification overview 10
XTend vB DigiMesh RF Module User Guide 9

XTend vB DigiMesh RF Module User Guide Applicable firmware and hardware
XTend vB DigiMesh RF Module User Guide 10
Applicable firmware and hardware
This manual supports the following firmware:
nn 8xxx for XTend DigiMesh
It supports the following hardware:
nAs the name suggests, the XTend vB RF Module is form factor and over the air compatible with
our XTend module.
XTend replacement numbers
The following table provides the part numbers you can use to replace XTend devices with the XTend
vB RF Module.
Legacy part number Replacement part number
XT09-MI XTP9B-DPM-001
XT09-SI XTP9B-DPS-001
XT09-MI-MESH XTP9B-DMM-001
XT09-SI-MESH XTP9B-DMS-001
Certification overview
The XTend vB RF Module contains an FCC/IC approved RF module. For usage requirements, see
Regulatory information.
ISM (Industrial, Scientific and Medical) license-free 902-928 MHz frequency band.
Manufactured under ISO 9001:2000 registered standards.