Digi XTend vB DigiMesh XTP9B-DPM-001 User manual

XTend vB DigiMesh RF Module
User Guide
Radio Frequency (RF) Module
User Guide
This datasheet has been downloaded fromhttp://www.digchip.com at this page

Revision history
900001479 A
Revision Date Description
A December 2015 Baseline release of the document.
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.
© 2015 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 the product's warranty information, go to the following website:
http://www.digi.com/howtobuy/terms
Customer support
Telephone (8:00 am — 5:00 pm U.S. Central Time):
Toll-free US and Canada: 866.912.3444
Worldwide: +1 952.912.3456
Online: www.digi.com/support/eservice
Mail:
Digi International Inc.
11001 Bren Road East
Minnetonka, MN 55434
USA
XTend vB DigiMesh RF Module User Guide 2

XTend vB DigiMesh RF Module User Guide 3
Contents
Revision history 2
The XTend vB RF Module
About the XTend vB RF Module 9
XTend replacement numbers 9
Certification overview 9
Technical specifications 10
General specifications 10
Performance specifications 10
Networking specifications 11
Power requirements 11
Regulatory approvals 12
Hardware
Connect the hardware 13
Mechanical drawings 14
Pin signals 15
XTend vB RF Module Modes
Transparent and API operating modes 19
Transparent operating mode 19
API operating mode 19
Receive mode 20
Transmit mode 20
Command mode 21
Enter Command mode 21

XTend vB DigiMesh RF Module User Guide 4
Send AT commands 21
Apply command changes 22
Exit Command mode 22
Operation
Serial interface 23
UART data flow 23
Serial data 24
Flow control 24
Data In (DIN) buffer and flow control 25
Data Out (DO) buffer and flow control 26
Networking methods
The MAC and PHY layers 27
64-bit address 28
Make a unicast transmission 28
Delivery methods 29
Point to Point / Point to Multipoint (P2MP) 29
Repeater / directed broadcast 29
DigiMesh networking 30
AT commands
Addressing commands 34
CI (Cluster ID) 34
DH (Destination Address High) 34
DL (Destination Address Low) 35
NI (Node Identifier) 35
NO(Network Discovery Options) 35
NT (Network Discovery Back-off) 36
SH (Serial Number High) 36
SL (Serial Number Low) 36
TO (Transmit Options) 37
Command mode options 38
CC (Command Sequence Character) 38
CT (Command mode Timeout) 38
GT (Guard Times) 38
Diagnostic commands 39
%H (MAC Unicast One Hop Time) 39

XTend vB DigiMesh RF Module User Guide 5
%V (Board Voltage) 39
%8 (MAC Broadcast One Hop Time) 39
BC (Bytes Transmitted) 40
DB (Last Packet RSSI) 40
EA (MAC ACK Failure Count) 40
ER (Receive Count Error) 41
GD (Good Packets Received) 41
RC 41
R# (Reset Number) 42
TR (Transmission Failure Count) 42
UA(Unicasts Attempted Count) 43
Firmware commands 43
CK (Configuration CRC) 43
DD (Device Type Identifier) 43
NP (Maximum Packet Payload Bytes) 44
HV (Hardware Version) 44
VR (Firmware Version) 44
I/O settings commands 44
CD (GP02 Configuration) 44
CS (GP01 Configuration) 45
RP (RSSI PWM Timer) 46
RT (GPI1 Configuration) 47
I/O diagnostic commands 47
TP (Board Temperature) 47
MAC/PHY commands 47
HP (Preamble ID) 48
ID (Network ID) 48
MT(Broadcast Multi-Transmits) 48
PL (TX Power Level) 48
RR (Unicast Retries) 49
Network commands 49
BH (Broadcast Hops) 49
CE (Routing / Messaging Mode) 50
MR (Mesh Unicast Retries) 50
NH (Network Hops) 51
NN (Network Delay Slots) 51
Security commands 51
EE (Encryption Enable) 51
KY (AES Encryption Key) 52
Serial interfacing commands 52

XTend vB DigiMesh RF Module User Guide 6
AO (API Options) 52
AP (API Enable) 53
BD (Baud Rate) 53
FT (Flow Control Threshold) 55
NB (Parity) 55
RB (Packetization Threshold) 55
RO (Packetization Timeout) 56
SB (Stop Bits) 57
XTend vB RF ModuleSpecial commands 57
AC (Apply Changes) 57
CN (Exit Command mode) 57
FR (Software Reset) 58
RE (Restore Defaults) 58
WR (Write) 58
R1 (Restored Compiled) 58
Operate in API mode
API mode overview 60
API frame specifications 60
Calculate and verify checksums 62
Escaped characters in API frames 62
API frames 63
API frame exchanges 64
Code to support future API frames 65
AT Command frame 0x08 66
AT Command - Queue Parameter Value frame 0x09 67
Legacy TX Request frame 0x00 69
Transmit Request frame 0x10 71
Explicit Addressing Command frame 0x11 74
Remote AT Command Request frame 0x17 78
AT Command Response frame 0x88 81
Modem Status frame 0x8A 82
Transmit Status frame 0x8B 83
Legacy TX Status frame 0x89 85
Route Information Packet 0x8D 86
Aggregate Addressing Update frame 0x8E 91
Legacy RX Indicator frame 0x80 93
RX Indicator frame 0x90 96
Explicit Rx Indicator frame 0x91 98

XTend vB DigiMesh RF Module User Guide 7
Node Identification Indicator frame 0x95 101
Remote Command Response frame 0x97 105
Work with networked devices
Network commissioning and diagnostics 108
Configure devices 108
Configure a device remotely 108
Send a remote command 108
Apply changes on remote devices 109
Remote command response 109
Establish and maintain network links 109
Build aggregate routes 109
Examples 110
Replace nodes 111
Test links in a network 111
Test links between adjacent devices 112
Example 114
RSSI indicators 114
Discover devices 115
Trace route option 116
NACK messages 117
Certifications
FCC (United States) 118
OEM labeling requirements 118
FCC notices 118
FCC antenna certifications 119
Antenna options 120
Industry Canada (IC) 127
Labeling requirements 127
Transmitters for detachable antennas 128
Detachable antennas 128
ACMA (Australia) 128
Power requirements 128
Development Kit
Development Kit contents 130
Interface hardware 131

XTend vB DigiMesh RF Module User Guide 8
XTIB-R RS-232/485 Interface Board 132
Configuration switch 133
I/O and Power LEDs 133
Serial port 133
RSSI LEDs 133
Power connector 134
XTIB-R Dip switch 134
Adapters 135
NULL Modem Adapter (male-to-male) 135
NULL Modem Adapter (female-to-female) 135
Serial Loopback Adapter 136
Male DB-9 to RJ-45 Adapter 136
Female DB-9 to RJ-45 Adapter 137
Interface protocols 137
RS-232 operation 137
RS-485 (2-wire) operation 141
RS-485 (4-wire) and RS-422 operation 143

XTend vB DigiMesh RF Module User Guide 9
The XTend vB RF Module
About the XTend vB RF Module
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.
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
Certifications on page 118.
ISM (Industrial, Scientific and Medical) license-free 902-928 MHz frequency band.
Manufactured under ISO 9001:2000 registered standards.

Technical specifications
XTend vB DigiMesh RF Module User Guide 10
Technical specifications
The following tables provide the device's technical specifications.
When operating at 1 W power output, observe a minimum separation distance of 6 ft (2 m)
between devices. Transmitting in close proximity of other devices can damage the device's
front end.
General specifications
The following table provides the general specifications for the device.
Specification Value
Dimensions (RF/pin connectors not included) 1.46 x 2.40 x 0.190 in (3.7 x 6.1 x 4.8 cm)
Weight 16 g
RoHS Compliant
Manufacturing ISO 9001:2000 registered standards
Connector 20 pin 2 mm pitch header
Antenna connector options MMCX or RPSMA
Antenna impedance 50 ohms unbalanced
Operating temperature -40°C to 85°C
Maximum input RF level at antenna port 6 dBm
Performance specifications
The following table provides the performance specifications for the device.

Technical specifications
XTend vB DigiMesh RF Module User Guide 11
Specification Value
Frequency range 902 to 928 MHz US/Canada
915 to 928 MHz Australia
RF data rate 125 kb/s
Transmit power (software selectable) Up to 30 dBm (see Power requirements below)
Channels 10 hopping sequences share 50 frequencies
Outdoor line of sight 125 kb/s Up to 7 miles
Indoor range line of sight 125 kb/s Up to 500 feet (150 m)
Receiver sensitivity 125 kb/s -100 dBm
Networking specifications
The following table provides the general specifications for the device.
Specification Value
Modulation Frequency Shift Keying
Spread Spectrum Frequency Hopping Spread Spectrum (FHSS)
Supported Network Topologies
(software selectable)
Peer-to-peer (master/slave relationship not required), point-to-
point/point-to-multipoint, mesh
Encryption 128 bit AES CBC encryption
Power requirements
The following table provides the power requirements for the device. Specifications are given at 5 V, 25°C
unless otherwise noted.

Technical specifications
XTend vB DigiMesh RF Module User Guide 12
Requirement Value
Supply voltage 2.8 to 5.5 VDC, 5 V typical
Receive current @ 5 V 35 mA
Transmit current See the following table
Shutdown mode current 1 µA
Transmit power
level
20 dBm* 27 dBm 30 dBm
Supply voltage range 2.8 to 5.5 V 3.2 to 5.5 V 4.75 to 5.5 V
Transmit current (5 V,
typical)
250 mA 470 mA 710 mA
Transmit current (3.3
V, typical)
320 mA 615 mA N/A
* We do not recommend the 20 dBm power level when operating at temperatures below 0°C.
Output power may vary significantly when operating below 0°C.
Regulatory approvals
The following table provides the regulatory approvals for the device.
Nation Approval
United States Contains FCC ID: MCQ-XBPSX (pending)
Canada Contains IC: 1846A-XBPSX (pending)
Australia RCM (pending)

XTend vB DigiMesh RF Module User Guide 13
Hardware
Connect the hardware
The following figure shows the XTend vB RF Module and accessories you need to get started and how to
connect them. The accessories are in the XT09-DK development kit.
Item Description
1 Antenna, RPSMA (female)
2 XTend vB module, RPSMA version shown
3 DIP switches
4 9 V power supply
5 DB9 serial cable

Mechanical drawings
XTend vB DigiMesh RF Module User Guide 14
Mechanical drawings
The following drawings show the dimensions of the device.

Pin signals
XTend vB DigiMesh RF Module User Guide 15
Pin signals
When integrating the module with a Host PC board, all lines not used should be left disconnected
(floating).
Pin
number
Name I/O High
impedance
during
shutdown
Must
connect
Function
1 GND - - yes Ground
2 VCC I - yes Power: 2.8 - 5.5 VDC
3 GPO2 /
RX LED
O - yes GPO2: General Purpose Output. Default
(CD = 2) drives this pin low.
RX LED: Pin is driven high during RF data
reception; otherwise, the pin is driven
low. To enable this pin, see CD (GP02
Configuration) on page 44.

Pin signals
XTend vB DigiMesh RF Module User Guide 16
Pin
number
Name I/O High
impedance
during
shutdown
Must
connect
Function
4 TX_PWR O yes - Transmit_Power: Pin pulses low during
RF transmission; otherwise, the pin is
driven high to indicate power is on and
the device is not in Sleep or Shutdown
Mode.
5 DIN I yes yes Data In: Serial data entering the device
(from the UART host). For more
information, see .
6 DOUT O yes - Data Out: Serial data exiting the module
(to the UART host). For more information,
see .
7SHDN I no yes Shutdown: Drive this pin high to enable
normal operation and low during
Shutdown. Shutdown enables the lowest
power mode available to the module. For
more information, see Additional modes.
8 Reserved

Pin signals
XTend vB DigiMesh RF Module User Guide 17
Pin
number
Name I/O High
impedance
during
shutdown
Must
connect
Function
9 GPO1 /
CTS / RS-
485 TX_
EN
O yes - GPO1: General Purpose Output. Pin can
be driven low or high.
CTS (Clear-to-Send): CTS is enabled by
default. When the pin is driven low, the
UART host is permitted to send serial
data to the device. For more information,
see and CS (GP01 Configuration) on page
45.
RS-485 Transmit Enable: Enables RS-485
half and full-duplex communications. For
more information, see and CS (GP01
Configuration) on page 45.
10 RTS /
CMD
I yes - RTS (Request-to-Send):
Not used by default. This pin can be
configured to allow the UART host to
regulate the flow of serial data exiting
the module. For more information, see
and RT (GPI1 Configuration) on page 47.
11 CONFIG /
RSSI
I1no - Configuration: Pin can be used as a
backup method for entering Command
mode during power-up. For more
information, see Additional modes.
1The RF module has a 10 kΩinternal pull-up resistor.

Pin signals
XTend vB DigiMesh RF Module User Guide 18
Pin
number
Name I/O High
impedance
during
shutdown
Must
connect
Function
O1no - Receive Signal Strength Indicator: By
default, pin is used as an RSSI PWM
output after at the conclusion of the
power-up sequence. The PWM output is
2.8 V-level. For more information, see RP
(RSSI PWM Timer) on page 46.
12-20 Reserved
/ do not
connect
1The RF module has a 10 kΩinternal pull-up resistor.

XTend vB DigiMesh RF Module User Guide 19
XTend vB RF Module Modes
Transparent and API operating modes
The firmware operates in several different modes. Two top-level modes establish how the device
communicates with other devices through its serial interface: Transparent operating mode and API
operating mode.
Transparent operating mode
Devices operate in this mode by default. We also call this mode “AT operating mode.” The device acts as a
serial line replacement when it is in Transparent operating mode. The device queues all UART data it
receives through the DIN pin for RF transmission. When a device receives RF data, it sends the data out
through the DOUT pin. You can set the configuration parameters using the AT Command interface.
API operating mode
API operating mode is an alternative to Transparent mode. API mode is a frame-based protocol that
allows you to direct data on a packet basis. It can be particularly useful in large networks where you need
to control the route a data packet takes or when you need to know which node a data packet is from. The
device communicates UART data in packets, also known as API frames. This mode allows for structured
communications with serial devices. It is helpful in managing larger networks and is more appropriate for
performing tasks such as collecting data from multiple locations or controlling multiple devices remotely.
There are two types of API operating modes: one with escaped characters and another without escaped
characters.
lWithout escaped characters (AP = 1). This mode eliminates escaping character sequences.
This makes it simpler to create code and libraries, but runs a minor risk of lost frames or
errors due to the possibility that payload data can be confused with frame structure. We
do not recommend this mode for noisy radio environments and where payload data may
include special characters (specifically 0x7E, 0x7D, 0x11, and 0x13).

Receive mode
XTend vB DigiMesh RF Module User Guide 20
lWith escaped characters (AP = 2). API escaped operating mode works similarly to API
mode. The only difference is that when working in API escaped mode, the software must
escape any payload bytes that match API frame specific data, such as the start-of-frame
byte (0x7E).
Receive mode
This is the default mode for the XTend vB RF Module. When not transmitting data, the device is in Receive
mode.
If a destination node receives a valid RF packet, the destination node transfers the data to its serial
transmit buffer. For the serial interface to report receive data on the RF network, that data must meet
the following criteria:
lID match
lChannel match
lAddress match
Transmit mode
When the device receives serial data and is ready to packetize it, the device attempts to transmit the
serial data.
In the following diagram, route discovery applies only to DigiMesh transmissions. Once route discovery
establishes a route, the device transmits the data. If route discovery fails to establish a route, the device
discards the packet.