Digi XBee3 XB3M1 User manual

Digi XBee3® Cellular LTE-M/NB-IoT
Smart Modem
User Guide

Revision history—90002258
Revision Date Description
F November
2018
Added information for BLE
G February
2019
Added information for XBIB-C-TH and XBIB-C-GPS development boards
H April 2019 Added information for Digi Remote Manager®
I May 2019 Added information for Clean shutdown and securing the connection
between and XBee and Remote Manager.
J June 2019 Added FCC publication 996369 related information.
Added firmware update 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.
© 2019 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)
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 2

Trace (if possible)
Description of issue
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 (Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem
User Guide, 90002258 I) in the subject line of your email.
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 3

Contents
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide
Applicable firmware and hardware 15
SIM cards 15
NB-IoT network 15
Get started with the XBee Smart Modem Development Kit
Identify the kit contents 17
Acquire a SIM card 18
UScustomers 18
European customers 18
Connect the hardware 19
XBIB-U-DEV reference 21
XBIB-CU-TH reference 23
XBIB-C-GPS reference 26
Interface with the XBIB-C-GPS module 27
I2C communication 28
UART communication 28
Run the MicroPython GPSdemo 28
Cellular service 29
Configure and update your XBee 30
Add a device 30
Update to the latest firmware from XCTU 31
Configure your module for cellular connectivity 31
Check for cellular registration and connection 33
Update an XBee module from A2.00 to A2.01 using APImode 34
Update an XBee module from A2.00 to A2.01 using FOTA 37
XBee bootloader 39
XBee connection examples
Connect to the Echo server 42
Connect to the ELIZA server 44
Connect to the Daytime server 46
Perform a (GET) HTTP request 48
Get started with CoAP 50
CoAP terms 50
CoAP quick start example 50
Configure the device 51
Example: manually perform a CoAPrequest 51
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 4

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 5
Example: use Python to generate a CoAP message 52
Connect to a TCP/IP address 54
Get started with MQTT 55
Example: MQTT connect 55
Send a connect packet 57
Example: send messages (publish) with MQTT 58
Example: receive messages (subscribe) with MQTT 59
Use MQTT over the XBee Cellular Modem with a PC 60
Debugging 63
Software libraries 63
Get started with MicroPython
About MicroPython 65
Why use MicroPython 65
MicroPython on the XBee Smart Modem 65
Use XCTU to enter the MicroPython environment 65
Use the MicroPython Terminal in XCTU 66
Troubleshooting 66
Example: hello world 66
Example: turn on an LED 66
Example: debug the secondary UART 67
Exit MicroPython mode 68
Other terminal programs 68
Tera Term for Windows 69
Use picocom in Linux 70
Get started with BLE
Enable BLE on an XBee device 72
Enable BLEand configure the BLEpassword using XCTU 72
Get the Digi XBeeMobile phone application 73
Connect with BLEand configure your XBee device 74
BLE reference 74
BLE advertising behavior and services 74
Device Information Service 74
XBee API BLEService 75
API Request characteristic 75
API Response characteristic 75
Get started with Digi Remote Manager
Create a Remote Manager account and add devices 77
Create a Remote Manager account 78
Add an XBee Smart Modem to Remote Manager 78
Verify the connection between a device and Remote Manager 79
Configure Remote Manager features by scheduling tasks 79
Overview: Create a schedule for a set of tasks 80
Examples 80
Example: Read settings and state using Remote Manager 80
Example: Configure a device from Remote Manager using XML 81
Example: Update XBee firmware using Remote Manager 82
Example: Update MicroPython from Remote Manager using XML 83

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 6
Restore persistent connection to a remote XBee 87
Manage data in Remote Manager 88
Review device status information from Remote Manager 89
Update the firmware from Remote Manager 89
Update the firmware using web services in Remote Manager 91
Manage secure files in Remote Manager 94
Remote Manager reference 95
Enable SM/UDP 95
Disconnect 96
Configure XBee settings within Remote Manager 96
Technical specifications
Interface and hardware specifications 100
Cellular RF characteristics 100
Bluetooth RF characteristics 100
Cellular networking specifications 100
Power requirements 101
Power consumption 102
Electrical specifications 103
Regulatory approvals 104
Hardware
Mechanical drawings 106
Pin signals 106
Pin connection recommendations 107
RSSI PWM 108
SIM card 108
Associate LED functionality 108
Antenna recommendations
Antenna placement 111
Design recommendations
Cellular component firmware updates 113
Power supply considerations 113
Minimum connection diagram 113
Heat considerations and testing 114
Custom configuration: Create a new factory default 114
Set a custom configuration 115
Clear all custom configurations on a device 115
Clean shutdown 115
SD (Shutdown) command 115
Sleep feature 116
Airplane mode 116
Cellular connection process
Connecting 118

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 7
Cellular network 118
Data network connection 118
Data communication with remote servers (TCP/UDP) 118
Disconnecting 119
Modes
Select an operating mode 121
Transparent operating mode 122
API operating mode 122
Command mode 122
Enter Command mode 122
Troubleshooting 123
Send AT commands 123
Response to AT commands 123
Apply command changes 124
Make command changes permanent 124
Exit Command mode 124
MicroPython mode 124
USB direct mode 125
Configure the data pins 125
Enable USB direct mode 125
Bypass operating mode (DEPRECATED) 125
Enter Bypass operating mode 126
Leave Bypass operating mode 126
Restore cellular settings to default in Bypass operating mode 126
Sleep modes
About sleep modes 128
Normal mode 128
Pin sleep mode 128
Cyclic sleep mode 128
Cyclic sleep with pin wake up mode 128
SPI mode and sleep pin functionality 128
The sleep timer 129
MicroPython sleep behavior 129
Power saving features
Airplane mode 131
Power Saving Mode (PSM) 131
PSM behavior 131
Deep Sleep mode 131
Serial communication
Serial interface 134
Serial data 134
UART data flow 134
Serial buffers 135
CTS flow control 135
RTS flow control 135

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 8
Enable UART or SPI ports 135
I2C 136
SPI operation
SPI communications 138
Full duplex operation 139
Low power operation 140
Select the SPI port 140
Force UART operation 141
Data format 141
File system
Overview of the file system 143
Directory structure 143
Paths 143
Secure files 143
XCTU interface 144
Encrypt files 144
Socket behavior
Supported sockets 146
Best practices when using sockets 146
Sockets and Remote Manager 146
Sockets and API mode 146
Socket timeouts 146
Socket limits in API mode 147
Enable incoming TCP sockets in API mode 147
API mode behavior for outgoing TCP and SSL connections 147
API mode behavior for outgoing UDP data 148
API mode behavior for incoming TCP connections 148
API mode behavior for incoming UDP data 149
Transparent mode behavior for outgoing TCP and SSL connections 149
Transparent mode behavior for outgoing UDP data 150
Transparent mode behavior for incoming TCP connections 150
Transparent mode behavior for incoming UDP connections 150
Transport Layer Security (TLS)
TLS AT commands 152
Transparent mode and TLS 153
API mode and TLS 153
Key formats 153
Certificate formats 153
Certificate limitations 153
Cipher suites 154
Server Name Indication (SNI) 154
Secure the connection between an XBee and Remote Manager with server authentication 154
Step 1: Get the certificate 155
Step 2: Configure device 155
Step 3: Verify that authentication is being performed 155

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 9
AT commands
Special commands 158
AC (Apply Changes) 158
FR (Force Reset) 158
RE (Restore Defaults) 158
WR (Write) 158
Cellular commands 160
PH (Phone Number) 160
S# (ICCID) 160
IM (IMEI) 160
MN (Operator) 160
MV (Modem Firmware Version) 160
DB (Cellular Signal Strength) 161
AN (Access Point Name) 161
CP (Carrier Profile) 161
BM (Bandmask) (LTE-M) 162
BN (Bandmask) (NB-IoT) 162
AM (Airplane Mode) 163
N# (Preferred Network Technology) 163
Network commands 165
IP (IP Protocol) 165
TL (SSL/TLS Protocol Version) 165
$0 (SSL/TLS Profile 0) 166
$1 (SSL/TLS Profile 1) 166
$2 (SSL/TLS Profile 2) 166
TM (IP Client Connection Timeout) 167
TS (IP Server Connection Timeout) 167
DO (Device Options) 167
DT (Cellular Network Time) 168
Addressing commands 169
SH (Serial Number High) 169
SL (Serial Number Low) 169
MY (Module IP Address) 169
P# (Destination Phone Number) 169
N1 (DNS Address) 170
N2 (DNS Address) 170
DL (Destination Address) 170
OD (Operating Destination Address) 170
DE (Destination port) 171
C0 (Source Port) 171
LA (Lookup IP Address of FQDN) 171
Serial interfacing commands 172
BD (Baud Rate) 172
NB (Parity) 172
SB (Stop Bits) 173
RO (Packetization Timeout) 173
TD (Text Delimiter) 173
FT (Flow Control Threshold) 173
AP (API Enable) 174
I/O settings commands 175
D0 (DIO0/AD0) 175
D1 (DIO1/AD1) 175
D2 (DIO2/AD2) 176
D3 (DIO3/AD3) 176

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 10
D4 (DIO4) 176
D5 (DIO5/ASSOCIATED_INDICATOR) 177
D6 (DIO6/RTS) 177
D7 (DIO7/CTS) 177
D8 (DIO8/SLEEP_REQUEST) 178
D9 (DIO9/ON_SLEEP) 178
P0 (DIO10/PWM0 Configuration) 179
P1 (DIO11/PWM1 Configuration) 179
P2 (DIO12 Configuration) 180
P3 (DIO13/DOUT) 180
P4 (DIO14/DIN) 181
PD (Pull Direction) 181
PR (Pull-up/down Resistor Enable) 181
M0 (PWM0 Duty Cycle) 182
I/O sampling commands 183
TP (Temperature) 183
IS (Force Sample) 183
Sleep commands 185
SM (Sleep Mode) 185
SP (Sleep Period) 185
ST (Wake Time) 185
PA (Requested Active Timer) 186
PU (Requested Tracking Area Update Timer) 186
Command mode options 187
CC (Command Sequence Character) 187
CT (Command Mode Timeout) 187
CN (Exit Command mode) 187
GT (Guard Times) 187
MicroPython commands 189
PS (Python Startup) 189
PY (MicroPython Command) 189
Firmware version/information commands 191
VR (Firmware Version) 191
VL (Verbose Firmware Version) 191
HV (Hardware Version) 191
AI (Association Indication) 191
HS (Hardware Series) 192
CK (Configuration CRC) 192
Diagnostic interface commands 193
DI (Remote Manager Indicator) 193
CI (Protocol/Connection Indication) 193
AS (Active scan for network environment data) 195
Execution commands 196
NR (Network Reset) 196
!R (Modem Reset) 196
File system commands 197
Error responses 197
ATFS (File System) 197
ATFS PWD 197
ATFS CDdirectory 197
ATFS MDdirectory 197
ATFS LS [directory] 197
ATFS PUTfilename 198
ATFS XPUTfilename 198
ATFS HASHfilename 198

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 11
ATFS GETfilename 198
ATFS MVsource_pathdest_path 198
ATFS RMfile_or_directory 198
ATFS INFO 198
ATFSFORMAT confirm 199
BLE commands 200
BL (Bluetooth MAC address) 200
BT (Bluetooth enable) 200
$S (SRPSalt) 200
$V, $W, $X, $Y (SRPpassword verifier) 201
Remote Manager commands 202
DF (Remote Manager Status Check Interval) 202
EQ (Remote Manager FQDN) 202
K1 (Remote Manager Server Send Keepalive) 202
K2 (Remote Manager Device Send Keepalive) 202
MO (Remote Manager Options) 203
$D (Remote Manager certificate) 203
RI (Remote Manager Service ID) 203
DP (Remote Manager Phone Number) 204
HF (Health Metrics Reporting Frequency) 204
HM (Health Metrics) 204
System commands 205
KL (Device Location) 205
KP (Device Description) 205
KC (Contact Information) 205
Operate in API mode
API mode overview 207
Use the AP command to set the operation mode 207
API frame format 207
API operation (AP parameter = 1) 207
API operation with escaped characters (AP parameter = 2) 208
API frames
AT Command - 0x08 212
AT Command: Queue Parameter Value - 0x09 213
Transmit (TX) SMS - 0x1F 214
Transmit (TX) Request: IPv4 - 0x20 215
Tx Request with TLS Profile - 0x23 217
AT Command Response - 0x88 219
Transmit (TX) Status - 0x89 220
Modem Status - 0x8A 222
Receive (RX) Packet: SMS - 0x9F 223
Receive (RX) Packet: IPv4 - 0xB0 224
User Data Relay - 0x2D 225
Example use cases 225
User Data Relay Output - 0xAD 227
BLE Unlock API - 0x2C 228
Example sequence to perform AT Command XBee API frames over BLE 230
BLEUnlock Response - 0xAC 232

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 12
Packaged firmware updates
About packaged firmware updates 234
Module firmware update 234
Cellular component firmware update 234
Packaged firmware update 234
FW Update - 0x2B 235
FW Update Response - 0xAB 235
Important notes 236
Perform a cellular component firmware update 236
Error recovery 237
Corrupted firmware on the cellular component 237
Error 237
Host initiated cancellation 237
Troubleshooting
Cannot find the serial port for the device 239
Condition 239
Solution 239
Other possible issues 240
Enable Virtual COM port (VCP) on the driver 240
Correct a macOS Java error 241
Condition 241
Solution 241
Unresponsive cellular component in Bypass mode 242
Condition 242
Solution 242
Syntax error at line 1 242
Solution 242
Error Failed to send SMS 242
Solution 242
Network connection issues 243
Condition 243
Solution 243
Brownout issue 243
Voltage brownout 243
Power-on discontinuities 243
How to distinguish revision B parts 243
Hardware flow control in Bypass mode 244
Socket leaks 244
Condition 244
Solution 245
Regulatory information
United States (FCC) 247
OEM labeling requirements 247
FCC notices 247
FCC-approved antennas 248
RF exposure 248
FCC publication 996369 related information 249
Innovation, Science and Economic Development Canada (ISED) 250
Labeling requirements 250

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 13
RF Exposure 250
CE mark (Europe) 251

Digi XBee3 Cellular LTE-M/NB-IoT 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
nManage and configure with XCTU and Digi Remote Manager®
nAvailable with Digi provided SIM cards and data plans
nDigital I/O support
nAnalog input support
nAPI and Transparent mode
nCommand mode
nBypass to the raw cellular modem
nSMS: Some carriers do not support SMS on LTE-M and/or NB-IoT. Check with your carrier for
details.
nTCP/UDP (up to six sockets)
nTLS (up to six sockets)
nIncoming connections
nMicroPython
lOn-module programmability to add local intelligence
lMany examples in the Digi MicroPython Programming Guide
lAT commands for managing run-time behavior
nLow power modes
nLTE power save mode (PSM)
nDeep sleep mode
nPin sleep support
nCyclic sleep support
nAirplane mode support
nDigi TrustFence secure boot
nMulti-network capability (Verizon, AT&T)
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 14

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide Applicable firmware and hardware
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 15
Applicable firmware and hardware
This manual supports the following firmware:
n114xx
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.
NB-IoT network
NB-IoT network is supported by XBee3 Cellular. Note the following:
nNB-IoT does not support roaming. You cannot roam between networks.
nFor NB-IoT, TCP support is dependent on the network. Contact your network provider for
details.
nFor NB-IoT, SMSsupport is dependent on the network. Contact your network provider for
details.
nDigi Remote Manager® requires TCPand will not work with NB-IoT unless the network
supports TCP.
nThe SIM card in the device determines whether the device supports NB-IoT, LTE-M, or both.

Get 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.
You should perform all of the steps below in the order shown.
1. Identify the kit contents
2. Acquire a SIM card
3. Connect the hardware
4. Review the development board
5. Set up cellular service
6. Configure and update your XBee
7. Use one of the following methods to verify your cellular connection:
nConnect to the Echo server
nConnect to the ELIZA server
nConnect to the Daytime server
Optional steps
You can review the information in these steps for more XBee connection examples and examples of
how to use MicroPython.
1. Review additional connection examples to help you learn how to use the device. See XBee
connection examples.
2. Review introductory MicroPython examples. You can use MicroPython to enhance the
intelligence of the XBee to enable you to do edge-computing by adding business logic in
MicroPython, rather than using external components.
nExample: hello world
nExample: turn on an LED
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 16

Get started with the XBee Smart Modem Development Kit Identify the kit contents
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 17
Identify the kit contents
The Developer's kit includes the following:
One XBIB-U-DEV board
One 12 V power supply
One cellular antenna with U.FL connector
One Bluetooth Low Energy (BLE) antenna
One USB cable
One XBee Smart Modem
Note The XBee Smart Modem comes
attached to the board in ESDwrap.
One SIMcard
Note NB-IoT kits (Digi product number
XK3-C-N1-UT-E) do not include a SIM card.
Contact your NB-IoT mobile carrier
provider to obtain a SIM card and service.
See Acquire a SIM card.

Get started with the XBee Smart Modem Development Kit Acquire a SIM card
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 18
Acquire a SIM card
NB-IoT kits (Digi product number XK3-C-N1-UT-E) do not include a SIM card. The sections below
explain how to purchase an NB-IoT SIMcard in the US and Europe.
UScustomers
In the US, Digi XBee3® Cellular LTE-M/NB-IoT works with AT&T, Verizon, and. T-Mobile. You must
purchase a SIM card before you can connect the hardware. Contact Digi Sales at
www.digi.com/contactus for information about obtaining a SIM card and activating cellular service.
After you have purchased your SIMcard, you must get the APN from the carrier. You will need this
information when you get service. See Configure your module for cellular connectivity.
The APN for NB-IoT on T-Mobile may be "iot.nb". You should confirm the APN when you set up service.
You can contact Digi Sales at www.digi.com/contactus for information about obtaining NB-IoT service.
European customers
If you are using the NB-IoT European kit, you must purchase a SIM card before you can connect the
hardware. Contact your NB-IoT mobile carrier provider to obtain a SIM card and service.
nVodafone: www.vodafone.com
nDeutsche Telekom: www.telekom.com/en
After you have purchased your SIMcard, you can get the APN (if needed by your carrier), network
bands, and supported channels from the carrier. You will need this information when configuring the
device from the SIM card and service you have selected. See Configure your module for cellular
connectivity.
Note Some carriers in Europe do not use the APN with NB-IoT.

Get started with the XBee Smart Modem Development Kit Connect the hardware
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 19
Connect the hardware
1. The XBee Smart Modem should already be plugged into the XBIB-U-DEV board.
2. If a SIM card is included with the kit, the card is inserted into the XBee Smart Modem. If a SIM
card is not included, install the SIMcard into the XBee Smart Modem before attaching the XBee
device to the board.
Note NB-IoT kits (Digi product number XK3-C-N1-UT-E) do not include a SIM card. Contact your
NB-IoT mobile carrier provider to obtain a SIM card and service. See Acquire a SIM card.
WARNING! Never insert or remove the SIM card while the device is powered!
3. Attach the XBee device to the board.
4. Connect the antennas.
a. Connect the cellular antenna.
b. Connect the BLE antenna if you are using BLE functionality. If you are not, you do
not have to connect the BLEantenna.

Get started with the XBee Smart Modem Development Kit Connect the hardware
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 20
Note Align the U.FL connectors carefully, then firmly press straight down to seat the
connector. You should hear a snap when the antenna attaches correctly. U.FL is fragile and is
not designed for multiple insertions, so exercise caution when connecting or removing the
antennas. We recommend using a U.FL removal tool.
5. Plug the 12 V power supply to the power jack on the development board. The LED indicator
blinks when the board is powered.
6. Connect the USB cable from a PC to the USB port on the development board. The computer
searches for a driver, which can take a few minutes to install. If you have trouble downloading
the USB driver, see Other possible issues.