Digi XLR PRO User manual

XLR PRO
Radio Frequency (RF) Modem
User Guide

XLR PRO Radio Frequency (RF) Modem User Guide
90002202
Revision Date Description
A September
2014
Initial release.
B March
2014
lRemoved the data sample RX indicator frame type.
lUpdated descriptions for the DN, ND, and FN
commands; added clarification note to the WR
command documentation.
C May 2015 lUpdated web configuration and Device Cloud options
available with XLR PRO firmware version 1006.
lUpdated Device Cloud brand name and login URLs.
D December
2015
lAdded certifications for Mexico and Australia.
lAdded USB support available with XLR PRO firmware
version 1007.
E February
2016
lNoted that user guide applies to all XLR PROmodels
(XLR PRO and XLR PRO INTL).
lMoved source content and made miscellaneous
editorial corrections.
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.
© 2016 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
XLR PRO Radio Frequency (RF) Modem User Guide 2

XLR PRO Radio Frequency (RF) Modem User Guide 3
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:
http://www.digi.com/howtobuy/terms
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 877.912.3444 or visit us at www.digi.com/support.
Online: www.digi.com/support/eservice

XLR PRO Radio Frequency (RF) Modem User Guide 4
Contents
XLR PRO Radio Frequency (RF) Modem User Guide
Technical specifications 13
General 13
Frequency range 13
Rural range line-of-sight 14
Urban range line-of-sight 14
Receiver sensitivity 14
Receiver selectivity 15
UART interface data rates (software selectable) 15
Networking and security 15
Power requirements 15
Environmental 16
Regulatory approvals 16
Connectors 17
Data rates and sensitivity 17
Power supply 18
Operational modes 18
Hardware interfaces 18
LEDs 19
Reset button 20
Antenna port 21
For more information 21
Hardware setup
XLR PRO kit contents 23
XLR PRO front panel 24

XLR PRO Radio Frequency (RF) Modem User Guide 5
RJ45 serial port pinout 26
Hardware setup 26
Connect the hardware 26
Mount the XLR PRO 27
Mounting guidelines 28
Antenna placement 29
Operations
XLR PRO operational design 30
Ethernet RF bridging 31
Serial mode selection 32
USB mode 34
Serial mode 34
RS-232 34
RS-485/422 35
IP socket mode 35
Serial communications 37
Serial buffers 37
Networking methods
MAC/PHY layers 38
Ethernet bridging 39
Ethernet packet handling 39
Bridging precautions 40
Enabling bridging 40
64-bit addresses 40
Unicast 40
Broadcast 41
Serial addressing basics 41
64-bit addresses 41
Unicast 41
Broadcast 41
Delivery method 42
AT command reference for XLR PRO
Special commands 44

XLR PRO Radio Frequency (RF) Modem User Guide 6
AC (apply changes) 44
FR (software reset) 44
RE (restore defaults) 45
WR (write) 45
MAC/PHY level commands 45
ID (network ID) 45
BR (RF data rate) 46
PL (power level) 47
RR (unicast retries) 47
MT (broadcast multi-transmit) 47
Diagnostics commands 48
DB (received signal strength) 48
EA (MAC ACK timeouts) 48
ER (received error count) 49
GD (good packets received) 49
TR (transmission failure count) 49
UA (unicasts attempted) 50
%H (MAC unicast one-hop timeout) 50
%8 (MAC broadcast one-hop timeout) 50
N? (network discovery timeout) 51
RF network commands 51
CE (node messaging options) 51
BH (broadcast hops) 52
NH (network hops) 52
NN (network delay slots) 52
RF addressing commands 52
SH (serial number high) 52
SL (serial number low) 53
DH (destination address high) 53
DL (destination address low) 53
TO (transmit options) 54
NI (node identifier) 54
NT (node discovery timeout) 55
NO (node discovery options) 55
CI (cluster ID) 56
DE (destination endpoint) 57
SE (source endpoint) 57
Addressing discovery & configuration commands 57
DN (discover node) 58

XLR PRO Radio Frequency (RF) Modem User Guide 7
ND (network discover) 58
FN (find neighbors) 59
Security commands 60
KY (AES encryption key) 60
Serial interfacing commands 61
BD (baud rate) 61
NB (parity) 62
SB (stop bits) 62
RO (packetization timeout) 63
FT (flow control threshold) 63
AP (API mode) 63
AO (API options) 64
D6 (RTS flow control) 64
D7 (CTS flow control) 65
4E (serial protocol) 65
4D (RS-485 duplex) 66
4T (RS-485 termination) 66
Hardware diagnostics commands 66
TP (temperature) 67
RP (RSSI timer) 67
Ethernet and IP socket mode commands 67
ES (IP socket mode enable) 67
IB (IP socket baud rate) 68
IP (IP protocol) 69
DX (destination IP address) 69
C0 (source port) 70
DY (destination port) 70
TM (TCP client connection timeout) 70
TS (TCP server connection timeout) 71
MA (IP addressing mode) 71
MY (XLR IP address) 71
MK (subnet mask) 72
GW (default gateway address) 72
NS (DNS address) 73
%M (Ethernet MAC address) 73
Device Cloud commands 73
DO (Device Cloud enable) 73
KP (device description) 74
KC (device contact) 74

XLR PRO Radio Frequency (RF) Modem User Guide 8
KL (device location) 74
LX (latitude) 75
LY (longitude) 75
EQ (Device Cloud FQDN) 75
DI (Device Cloud indicator) 76
Web configuration commands 76
HE (web configuration enable) 76
HU (web configuration user name) 77
HW (web configuration password) 77
Ethernet bridging commands 77
BE (Ethernet RF bridging enable) 77
BA (bridge destination MAC) 78
AT command options 78
CC (command sequence character) 78
CN (exit command mode) 79
CT (command mode timeout) 79
GT (guard time) 79
Firmware commands 79
VB (firmware version) 79
VR (XLR PRO module firmware version) 80
HV (XLR PRO RF module hardware versions) 80
VH (XLR PRO baseboard hardware version) 80
*C (compatibility) 80
DD (device type identifier) 81
PN (part number) 81
NP (maximum packet payload bytes) 81
CK (configuration CRC) 82
API operation
About API mode 83
Using the AP command to set the operation mode 83
API frame format 83
API operation (AP = 1) frame format 84
API operation with escapes (AP = 2) frame format 84
Length field 85
Frame data field 85
Checksum field 87
API serial exchanges 87

XLR PRO Radio Frequency (RF) Modem User Guide 9
AT commands 87
Transmitting and receiving RF data 87
Remote AT commands 88
Application API support 88
API Frame types 88
AT command—apply changes 89
AT command—queue new parameter value 89
TX request 90
Explicit TX request 92
Remote AT command request 94
AT command response 95
Modem status 96
Transmit status 97
RX indicator 98
Explicit RX indicator 99
Remote command response 100
Advanced application features
Remote configuration commands 103
Sending a remote command 103
Appying changes on remote devices 103
Remote command responses 104
Network commissioning and diagnostics 104
Device configuration 104
Device placement 104
Loopback testing 104
Device discovery 105
General purpose flash memory 106
Accessing general purpose flash memory 106
Working with flash memory 117
Over-the-air (OTA) firmware upgrades 117
Distributing the new application 118
Verifying the new application 119
Installing the application 119
Keep in mind 120

XLR PRO Radio Frequency (RF) Modem User Guide 10
Configuring XLR PRO using the web configuration interface
Access the XLR PRO web configuration interface 121
Set general options 121
Set Ethernet network options 122
Set Ethernet RF bridging options 123
Set Device Cloud connectivity options 123
Set XLR radio options 124
Set XLR radio serial options 125
Set XLR radio IP socket (Ethernet) options 126
Update firmware 127
Set web configuration options 128
Configuring XLR PRO using XCTU
Download and install XCTU 129
Download and install USB driver 129
Connect XLR PRO to your PC 129
Launch XCTU and add the XLR PRO 129
Configure parameters using XCTU 130
Determine or assign an IP address 130
Determine the assigned DHCP address 130
Assign a static IP address 131
Update firmware with XCTU 131
Configuration XLR PRO using Device Cloud
Create a Device Cloud account 133
Get the XLR PRO MAC address 133
Add a Digi XLR PRO to Device Cloud 134
Update firmware with Device Cloud 134
Configure Device Cloud connectivity options 135
Configure Ethernet network options 135
Configure Ethernet RF bridging options 136
Configure IP socket mode options 137
Configure serial mode options 138
Configure system options 139
Configure web configuration options 140
Configure XLR radio configuration options 141