Digi XB3-C-A2-UT series User manual

Digi XBee3® Cellular LTE-M
Smart Modem
User Guide

Revision history—900002258
Revision Date Description
ADecember 2017 Initial 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.
© 2017 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 Cellular LTE-M Global Smart Modem User Guide 2

Contents
Digi XBee3 Cellular LTE-M Global Smart Modem User Guide
Applicable firmware and hardware 9
SIM cards 9
Getting started with the XBee Smart Modem Development Kit
Identify the kit contents 11
XBIB-U-DEV reference 12
Cellular service 13
Connect the hardware 14
Configure the device using XCTU 15
Add a device 15
Check for cellular registration and connection 16
Update to the latest firmware 16
Send an SMS message to a phone 18
Debugging 19
Connect to the ELIZA server 20
Debugging 21
Connect to the echo server 22
Debugging 23
Connect to the Daytime server 24
Debugging 25
Connect to a TCP/IP address 26
Debugging 27
Perform a (GET) HTTP request 28
Debugging 29
Get started with MQTT 30
Example: MQTT connect 30
Send a connect packet 32
Example: send messages (publish) with MQTT 34
Example: receive messages (subscribe) with MQTT 34
Use MQTT over the XBee Cellular Modem with a PC 35
Get started with CoAP 39
CoAP terms 39
CoAP quick start example 39
Configure the device 40
Example: manually perform a CoAPrequest 40
Example: use Python to generate a CoAP message 41
Configure the XBee Smart Modem using Digi Remote Manager 44
Create a Remote Manager account 44
Digi XBee3 Cellular LTE-M Global Smart Modem User Guide 3

Digi XBee3 Cellular LTE-M Global Smart Modem User Guide 4
Get the XBee Smart Modem IMEI number 44
Add a XBee Smart Modem to Remote Manager 44
Update the firmware 45
Software libraries 45
Get started with MicroPython
About MicroPython 47
Why use MicroPython 47
MicroPython on the XBee Smart Modem 47
Use XCTU to enter the MicroPython environment 47
Use the MicroPython Terminal in XCTU 48
Example: hello world 48
Example: turn on an LED 48
Example: code a request help button 49
Enter MicroPython paste mode 50
Catch a button press 50
Send a text (SMS) when the button is pressed 52
Add the time the button was pressed 53
Exit MicroPython mode 54
Other terminal programs 54
Tera Term for Windows 54
Use picocom in Linux 55
Technical specifications
Interface and hardware specifications 58
Cellular RF characteristics 58
Bluetooth RF characteristics 58
Cellular Networking specifications 58
Power requirements 59
Power consumption 59
Electrical specifications 59
Regulatory approvals 60
Hardware
Mechanical drawings 62
Pin signals 62
Pin connection recommendations 64
RSSI PWM 64
SIM card 64
The Associate LED 65
Antenna recommendations
Antenna placement 67
Design recommendations
Power supply considerations 69
Minimum connection diagram 69

Digi XBee3 Cellular LTE-M Global Smart Modem User Guide 5
Heat considerations and testing 69
Heat sink guidelines 71
Bolt-down style 71
Adhesive style heat sink 71
Add a fan to provide active cooling 72
Cellular connection process
Connecting 74
Cellular network 74
Data network connection 74
Data communication with remote servers (TCP/UDP) 74
Disconnecting 74
Modes
Select an operating mode 77
Transparent operating mode 78
API operating mode 78
Bypass operating mode 78
Enter Bypass operating mode 78
Leave Bypass operating mode 79
Restore cellular settings to default in Bypass operating mode 79
USB direct mode 79
Configure the data pins 79
Enable USB direct mode 79
Enable the VBUS option 80
Command mode 80
Enter Command mode 80
Send AT commands 81
Apply command changes 81
Make command changes permanent 81
Exit Command mode 82
Sleep modes
About sleep modes 84
Normal mode 84
Pin sleep mode 84
Cyclic sleep mode 84
Cyclic sleep with pin wake up mode 84
Airplane mode 84
SPI mode and sleep pin functionality 84
The sleep timer 85
MicroPython sleep behavior 85
Serial communication
Serial interface 88
Serial data 88
UART data flow 88
Serial buffers 89
CTS flow control 89

Digi XBee3 Cellular LTE-M Global Smart Modem User Guide 6
RTS flow control 89
Enable UART or SPI ports 89
SPI operation
SPI communications 92
Full duplex operation 93
Low power operation 94
Select the SPI port 94
Force UART operation 95
Data format 95
AT commands
Special commands 97
AC (Apply Changes) 97
FR (Force Reset) 97
RE command 97
WR command 97
Cellular commands 98
PH (Phone Number) 98
S# (ICCID) 98
IM (IMEI) 98
MN (Operator) 98
MV (Modem Firmware Version) 99
DB (Cellular Signal Strength) 99
AN (Access Point Name) 99
AM (Airplane Mode) 99
Network commands 100
IP (IP Protocol) 100
TL (SSL/TLS Protocol Version) 100
TM (IP Client Connection Timeout) 100
TS (IP Server Connection Timeout) 101
DO (Device Options) 101
EQ (Device Cloud FQDN) 102
Addressing commands 102
SH (Serial Number High) 102
SL (Serial Number Low) 102
MY (Module IP Address) 102
P# (Destination Phone Number) 103
N1 (DNS Address) 103
N2 (DNS Address) 103
DL (Destination Address) 103
OD (Operating Destination Address) 104
DE (Destination Port) 104
C0 (Source Port) 104
LA (Lookup IP Address of FQDN) 105
Serial interfacing commands 105
BD (Baud Rate) 105
NB (Parity) 106
SB (Stop Bits) 106
RO (Packetization Timeout) 106
TD (Text Delimiter) 107
FT (Flow Control Threshold) 107

Digi XBee3 Cellular LTE-M Global Smart Modem User Guide 7
AP (API Enable) 107
I/O settings commands 107
D0 (DIO0/AD0) 108
D1 (DIO1/AD1) 108
D2 (DIO2/AD2) 108
D3 (DIO3/AD3) 109
D4 (DIO4) 109
D5 (DIO5/ASSOCIATED_INDICATOR) 110
D6 (DIO6/RTS) 110
D7 (DIO7/CTS) 110
D8 (DIO8/SLEEP_REQUEST) 111
P0 (DIO10/PWM0 Configuration) 112
P1 (DIO11/PWM1 Configuration) 112
P2 (DIO12 Configuration) 113
P3 (DIO13/DOUT) 113
P4 (DIO14/DIN) 113
PD (Pull Direction) 114
PR (Pull-up/down Resistor Enable) 114
M0 (PWM0 Duty Cycle) 115
I/O sampling commands 115
TP (Temperature) 115
Sleep commands 116
SM (Sleep Mode) 116
SP (Sleep Period) 116
ST (Wake Time) 116
Command mode options 117
CC (Command Sequence Character) 117
CT (Command Mode Timeout) 117
GT (Guard Times) 117
MicroPython commands 117
PS (Python Startup) 118
PY (MicroPython Command) 118
Firmware version/information commands 119
VR (Firmware Version) 119
VL (Verbose Firmware Version) 119
HV (Hardware Version) 119
AI (Association Indication) 119
DI (Device Cloud Indicator) 120
CI (Protocol/Connection Indication) 120
HS (Hardware Series) 122
CK (Configuration CRC) 122
Execution commands 122
!R (Modem Reset) 122
IS (Force Sample) 123
Operate in API mode
API mode overview 125
Use the AP command to set the operation mode 125
API frame format 125
API operation (AP parameter = 1) 125
API operation with escaped characters (AP parameter = 2) 126
Frame descriptions 129
AT Command - 0x08 129
AT Command: Queue Parameter Value - 0x09 130

Digi XBee3 Cellular LTE-M Global Smart Modem User Guide 8
Transmit (TX) Request: IPv4 - 0x20 131
AT Command Response - 0x88 132
Transmit (TX) Status - 0x89 133
Modem Status - 0x8A 134
Receive (RX) Packet: IPv4 - 0xB0 135
Socket behavior
Supported sockets 137
Socket timeouts 137
Socket limits in API mode 137
Enable incoming TCP sockets in API mode 137
API mode behavior for outgoing TCP and SSL connections 137
API mode behavior for outgoing UDP data 138
API mode behavior for incoming TCP connections 138
API mode behavior for incoming UDP data 139
Transparent mode behavior for outgoing TCP and SSL connections 139
Transparent mode behavior for outgoing UDP data 139
Transparent mode behavior for incoming TCP connections 140
Transparent mode behavior for incoming UDP connections 140
Troubleshooting
Cannot find the serial port for the device 142
Condition 142
Solution 142
Correct a macOS Java error 144
Condition 144
Solution 144
Unresponsive cellular component in Bypass mode 145
Condition 145
Solution 145
Syntax error at line 1 145
Solution 145
Network connection issues 145
Condition 145
Solution 145
Set the APN value 145
Regulatory information
United States (FCC) 148
OEM labeling requirements 148
FCC notices 148
FCC-approved antennas 149
RF exposure 150
IC (Industry Canada) 150
Labeling requirements 150
RF Exposure 150

Digi XBee3 Cellular LTE-M Global Smart Modem User
Guide
The XBee Smart Modem provides OEMs with a simple way to integrate low-power cellular connectivity
into their devices. Features include:
nFCC certified and carrier end-device certified
nExcellent coverage and building penetration
nDigi XBee Transparent and API modes simplify design
nLow power consumption optimized for long battery life
nReduced hardware complexity with only 1 antenna required
nIntegrated MicroPython programmability enables custom scripting directly on the modem
nEnhanced with Digi TrustFence™ security framework
nManage and configure with XCTU and Digi Remote Manager®
nAvailable with Digi provided SIM cards and data plans
Applicable firmware and hardware
This manual supports the following firmware:
n311xx
It supports the following hardware:
nXB3-C-A2-UT-xxx
SIM cards
The XBee Smart Modem requires a 4FF (Nano) size SIM card. The SIM interface supports both 1.8 V
and 3 V SIM types.
Digi XBee3 Cellular LTE-M Global Smart Modem User Guide 9

Getting started with the XBee Smart Modem
Development Kit
This section describes how to connect the hardware in the XBee Smart Modem Development Kit, and
provides some examples you can use to communicate with the device.
Identify the kit contents 11
XBIB-U-DEV reference 12
Cellular service 13
Connect the hardware 14
Configure the device using XCTU 15
Send an SMS message to a phone 18
Connect to the ELIZA server 20
Connect to the echo server 22
Connect to the Daytime server 24
Connect to a TCP/IP address 26
Perform a (GET) HTTP request 28
Get started with MQTT 30
Get started with CoAP 39
Configure the XBee Smart Modem using Digi Remote Manager 44
Software libraries 45
Digi XBee3 Cellular LTE-M Global Smart Modem User Guide 10