Digi XBee Cellular 3G Global User manual

Digi XBee® Cellular 3G Global
Embedded Modem
User Guide

Revision history—90001541
Revision Date Description
K April 2019 Added information for Digi Remote Manager®
L June 2019 Added information for Clean shutdown and securing the connection
between and XBee and Remote Manager. Added FCC publication 996369
related information.
M July 2019 Added socket information.
Additional edits.
N September
2019
Added firmware update information.
P February
2020
Reorganized device and cellular 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.
© 2020 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)
Digi XBee Cellular 3G Global Embedded Modem User Guide 2

Logs (from time of reported issue)
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 XBee Cellular 3G Global Embedded Modem User
Guide, 90001541 L) in the subject line of your email.
Digi XBee Cellular 3G Global Embedded Modem User Guide 3

Contents
Digi XBee Cellular 3G Global Embedded Modem User Guide
Applicable firmware and hardware 14
SIM cards 14
Cellular service 15
Get started with the XBee Cellular Modem
Identify the kit contents 17
Connect the hardware 18
Install and upgrade XCTU 19
Add a device to XCTU 19
Update the device firmware using XCTU 20
Check for cellular registration and connection 20
XBee connection examples
Connect to the Echo server 22
Connect to the ELIZA server 23
Connect to the Daytime server 24
Perform a (GET) HTTP request 26
Connect to a TCP/IP address 27
Debugging 27
Software libraries 28
Get started with Digi Remote Manager
Create a Remote Manager account and add devices 29
Create a Remote Manager account 30
Add an XBee Cellular Modem to Remote Manager 30
Verify the connection between a device and Remote Manager 31
Configure Remote Manager features by scheduling tasks 31
Overview: Create a schedule for a set of tasks 31
Examples 32
Example: Read settings and state using Remote Manager 32
Example: Configure a device from Remote Manager using XML 33
Example: Schedule a task to update the device firmware using Remote Manager 34
Example: Update MicroPython from Remote Manager using XML 35
Manage data in Remote Manager 39
Review device status information from Remote Manager 39
Digi XBee Cellular 3G Global Embedded Modem User Guide 4

Digi XBee Cellular 3G Global Embedded Modem User Guide 5
Manage secure files in Remote Manager 40
Remote Manager reference 41
Enable SM/UDP 41
TCP connection 41
Disconnect 43
Configure XBee settings within Remote Manager 43
Examples: IOT protocols with transparent mode
Get started with CoAP 46
CoAP terms 46
CoAP quick start example 46
Configure the device 47
Example: manually perform a CoAPrequest 47
Example: use Python to generate a CoAP message 48
Get started with MQTT 50
Example: MQTT connect 50
Send a connect packet 52
Example: send messages (publish) with MQTT 53
Example: receive messages (subscribe) with MQTT 54
Use MQTT over the XBee Cellular Modem with a PC 55
Get started with MicroPython
About MicroPython 60
Why use MicroPython 60
MicroPython on the XBee Cellular Modem 60
Use XCTU to enter the MicroPython environment 60
Use the MicroPython Terminal in XCTU 61
Troubleshooting 61
Example: hello world 61
Example: turn on an LED 61
Example: debug the secondary UART 62
Exit MicroPython mode 63
Other terminal programs 63
Tera Term for Windows 64
Use picocom in Linux 65
Update the firmware
Create a plan for device component firmware updates 68
Update the device firmware 69
Update the device firmware using XCTU 69
Update the firmware from the Devices page in Remote Manager 69
Update the firmware using web services in Remote Manager 70
Use a host processor to update the modem firmware for XBee devices over UART 72
Technical specifications
Interface and hardware specifications 76
RF characteristics 76
Networking specifications 76
Power requirements 77

Digi XBee Cellular 3G Global Embedded Modem User Guide 6
Power consumption 77
Electrical specifications 77
Regulatory approvals 78
Hardware
Mechanical drawings 81
Pin signals 81
Pin connection recommendations 83
RSSI PWM 83
SIM card 83
Associate LED functionality 83
Development boards 85
XBIB-U-DEV reference 85
XBIB-CU-TH reference 87
XBIB-C-GPS reference 90
Interface with the XBIB-C-GPS module 91
Antenna recommendations
Antenna placement 93
Design recommendations
Power supply considerations 95
Add a capacitor to the RESET line 95
Heat considerations 95
Add a fan to provide active cooling 96
Custom configuration: Create a new factory default 96
Set a custom configuration 97
Clear all custom configurations on a device 97
Clean shutdown 97
SD (Shutdown) command 97
Sleep feature 98
Airplane mode 98
Cellular connection process
Connecting 100
Cellular network 100
Data network connection 100
Data communication with remote servers (TCP/UDP) 100
Disconnecting 100
Modes
Select an operating mode 103
Transparent operating mode 104
API operating mode 104
Bypass operating mode (DEPRECATED) 104
Enter Bypass operating mode 105
Leave Bypass operating mode 105

Digi XBee Cellular 3G Global Embedded Modem User Guide 7
Restore cellular settings to default in Bypass operating mode 105
Command mode 105
Enter Command mode 105
Troubleshooting 106
Send AT commands 106
Response to AT commands 107
Apply command changes 107
Make command changes permanent 107
Exit Command mode 107
MicroPython mode 107
Sleep modes
About sleep modes 110
Normal mode 110
Pin sleep mode 110
Cyclic sleep mode 110
Cyclic sleep with pin wake up mode 110
Airplane mode 110
The sleep timer 110
MicroPython sleep behavior 111
Serial communication
Serial interface 113
Serial data 113
UART data flow 113
Serial buffers 114
CTS flow control 114
RTS flow control 114
SPI operation
SPI communications 116
Full duplex operation 117
Low power operation 118
Select the SPI port 118
Force UART operation 119
Data format 119
File system
Overview of the file system 121
Directory structure 121
Paths 121
Secure files 121
XCTU interface 122
Encrypt files 122
SMS behaviors
SMS encoding 123

Digi XBee Cellular 3G Global Embedded Modem User Guide 8
Socket behavior
Supported sockets 125
Best practices when using sockets 125
Sockets and Remote Manager 125
Sockets and API mode 125
Socket timeouts 125
Socket limits in API mode 125
Enable incoming TCP sockets in API mode 126
API mode behavior for outgoing TCP and TLS connections 126
API mode behavior for outgoing UDP data 126
API mode behavior for incoming TCP connections 127
API mode behavior for incoming UDP data 127
Transparent mode behavior for outgoing TCP and TLS connections 128
Transparent mode behavior for outgoing UDP data 128
Transparent mode behavior for incoming TCP connections 128
Transparent mode behavior for incoming UDP connections 129
Extended Socket frames
Examples 130
Available Extended Socket frames 131
Extended Socket example: Single HTTP Connection 131
Send a Socket Create frame 131
Receive a Socket Create response 132
Send Socket Connect 132
Receive a Socket Connect Response 132
Receive a Socket Status 133
Send HTTP Request using Socket Send frame 133
Receive TX Status 134
Receive one or more Receive Data frames 134
Receive Socket Status indicating closed connection 135
Extended Socket example: UDP 135
Send a Socket Create frame 135
Receive a Socket Create response 136
Bind local source addres 136
Receive Bind/Listen Response 136
Send to Digi echo server 137
Receive TX Status 137
Receive echoed data 137
Send to Digi time server 138
Receive TX Status 138
Receive daytime value 138
Close the socket 139
Receive close response 139
Extended Socket example: TCPListener 140
Send a Socket Create frame 140
Receive a Socket Create response 140
Designate the socket as a listener 140
Receive a Socket Bind/Listen Response 141
Making a connection to the listener socket 141
Receiving Data from the new socket 142
Receive a Socket Status indicating closed connection 142

Digi XBee Cellular 3G Global Embedded Modem User Guide 9
Transport Layer Security (TLS)
Specifying TLS keys and certificates 145
Transparent mode and TLS 146
API mode and TLS 146
Key formats 146
Certificate formats 146
Certificate limitations 146
Cipher suites 146
Server Name Indication (SNI) 147
Secure the connection between an XBee and Remote Manager with server authentication 147
Step 1: Get the certificate 147
Step 2: Configure device 147
Step 3: Verify that authentication is being performed 148
AT commands
Special commands 150
AC (Apply Changes) 150
FR (Force Reset) 150
RE (Restore Defaults) 150
SD (Shutdown) 151
WR (Write) 151
Cellular commands 152
PH (Phone Number) 152
S# (ICCID) 152
IM (IMEI) 152
II (Subscriber identity) 152
MN (Operator) 152
MV (Modem Firmware Version) 153
DB (Cellular Signal Strength) 153
DT (Cellular Network Time) 153
AN (Access Point Name) 154
AM (Airplane Mode) 154
PN (SIMPIN) 154
PK (SIMPUK) 154
CU (Cellular user name) 155
CW (Cellular password) 155
Network commands 156
IP (IP Protocol) 156
TL (TLS Protocol Version) 156
$0 (TLS Profile 0) 156
$1 (TLS Profile 1) 157
$2 (TLS Profile 2) 157
TM (IP Client Connection Timeout) 157
TS (IP Server Connection Timeout) 158
DO (Device Options) 158
Addressing commands 160
SH (Serial Number High) 160
SL (Serial Number Low) 160
MY (Module IP Address) 160
P# (Destination Phone Number) 160
N1 (DNS Address) 161
N2 (DNS Address) 161

Digi XBee Cellular 3G Global Embedded Modem User Guide 10
DL (Destination Address) 161
OD (Operating Destination Address) 161
DE (Destination port) 162
C0 (Source Port) 162
LA (Lookup IP Address of FQDN) 162
Serial interfacing commands 163
BD (Baud Rate) 163
NB (Parity) 163
SB (Stop Bits) 164
RO (Packetization Timeout) 164
TD (Text Delimiter) 164
FT (Flow Control Threshold) 164
AP (API Enable) 165
I/O settings commands 166
D0 (DIO0/AD0) 166
D1 (DIO1/AD1) 166
D2 (DIO2/AD2) 167
D3 (DIO3/AD3) 167
D4 (DIO4) 167
D5 (DIO5/ASSOCIATED_INDICATOR) 168
D6 (DIO6/RTS) 168
D7 (DIO7/CTS) 169
D8 (DIO8/SLEEP_REQUEST) 169
D9 (DIO9/ON_SLEEP) 170
P0 (DIO10/PWM0 Configuration) 170
P1 (DIO11/PWM1 Configuration) 170
P2 (DIO12 Configuration) 171
PD (Pull Direction) 171
PR (Pull-up/down Resistor Enable) 172
M0 (PWM0 Duty Cycle) 173
I/O sampling commands 174
TP (Temperature) 174
IS (Force Sample) 174
Sleep commands 176
SM (Sleep Mode) 176
SP (Sleep Period) 176
ST (Wake Time) 176
Command mode options 177
CC (Command Sequence Character) 177
CT (Command Mode Timeout) 177
CN (Exit Command mode) 177
GT (Guard Times) 177
MicroPython commands 179
PS (Python Startup) 179
PY (MicroPython Command) 179
Firmware version/information commands 181
VR (Firmware Version) 181
VL (Verbose Firmware Version) 181
HV (Hardware Version) 181
AI (Association Indication) 181
HS (Hardware Series) 182
CK (Configuration CRC) 182
Diagnostic interface commands 183
DI (Remote Manager Indicator) 183
CI (Protocol/Connection Indication) 183

Digi XBee Cellular 3G Global Embedded Modem User Guide 11
Execution commands 186
NR (Network Reset) 186
!R (Modem Reset) 186
File system commands 187
Error responses 187
ATFS (File System) 187
ATFS PWD 187
ATFS CDdirectory 187
ATFS MDdirectory 187
ATFS LS [directory] 187
ATFS PUTfilename 188
ATFS XPUTfilename 188
ATFS HASHfilename 188
ATFS GETfilename 188
ATFS MVsource_pathdest_path 188
ATFS RMfile_or_directory 188
ATFS INFO 188
ATFSFORMAT confirm 189
Remote Manager commands 190
DF (Remote Manager Status Check Interval) 190
EQ (Remote Manager FQDN) 190
K1 (Remote Manager Server Send Keepalive) 190
K2 (Remote Manager Device Send Keepalive) 190
MO (Remote Manager Options) 191
$D (Remote Manager certificate) 191
System commands 192
KL (Device Location) 192
KC (Contact Information) 192
KP (Device Description) 192
Socket commands 193
SI (Socket Info) 193
Operate in API mode
API mode overview 196
Use the AP command to set the operation mode 196
API frame format 196
API operation (AP parameter = 1) 196
API operation with escaped characters (AP parameter = 2) 197
API frames
AT Command - 0x08 201
AT Command: Queue Parameter Value - 0x09 202
Transmit (TX) SMS - 0x1F 203
Transmit (TX) Request: IPv4 - 0x20 204
Tx Request with TLS Profile - 0x23 206
AT Command Response - 0x88 208
Transmit (TX) Status - 0x89 209
Modem Status - 0x8A 211
Receive (RX) Packet: SMS - 0x9F 212
Receive (RX) Packet: IPv4 - 0xB0 213
User Data Relay - 0x2D 214
Example use cases 214

Digi XBee Cellular 3G Global Embedded Modem User Guide 12
User Data Relay Output - 0xAD 215
Socket Create - 0x40 216
Socket Create Response - 0xC0 217
Socket Option Request - 0x41 218
Socket Option Response - 0xC1 219
Socket Connect - 0x42 220
Socket Connect Response - 0xC2 221
Socket Close - 0x43 222
Socket Close Response - 0xC3 223
Socket Send (Transmit) - 0x44 224
Socket SendTo (Transmit Explicit Data): IPv4 - 0x45 225
Socket Bind/Listen - 0x46 226
Socket Listen Response - 0xC6 227
Socket New IPv4 Client - 0xCC 228
Socket Receive - 0xCD 229
Socket Receive From: IPv4 - 0xCE 230
Socket Status - 0xCF 231
Troubleshooting
Cannot find the serial port for the device 233
Condition 233
Solution 233
Other possible issues 234
Enable Virtual COM port (VCP) on the driver 234
Correct a macOS Java error 235
Condition 235
Solution 235
Unresponsive cellular component in Bypass mode 236
Condition 236
Solution 236
Not on expected network after APN change 237
Condition 237
Solution 237
Syntax error at line 1 237
Solution 237
Error Failed to send SMS 237
Solution 237
Regulatory information
Modification statement 239
Interference statement 239
FCC notices 239
FCC Class B digital device notice 239
FCC publication 996369 related information 240
2.1 General 240
2.2 List of applicable FCC rules 240
2.3 Summarize the specific operational use conditions 240
2.4 Limited module procedures 240
2.5 Trace antenna designs 240
2.6 RF exposure considerations 240
2.7 Antennas 240
2.8 Label and compliance information 241

Digi XBee Cellular 3G Global Embedded Modem User Guide 13
2.9 Information on test modes and additional testing requirements 241
2.10 Additional testing, Part 15 Subpart B disclaimer 241
Antennas 241
FCC (USA) exposure notice 241
ISED (Canada) exposure notice 241
Labeling requirements for the host device 242
Europe (CE) 242
Maximum power and frequency specifications 243
OEM labeling requirements 243
Declarations of conformity 244
ACMA (Australia) 244
RSM (New Zealand) 244

Digi XBee Cellular 3G Global Embedded Modem User
Guide
The XBee Cellular Modem integrates an embedded Wideband Code Division Multiple Access (WCDMA)
cellular module and enables original equipment manufacturers (OEMs) to incorporate 3G cellular
technology into their devices and applications without painful, time-consuming, and expensive FCC
and carrier end-device certifications.
With the full suite of standard XBee API frames and AT commands, existing XBee customers can
seamlessly transition to this new device with only minor software adjustments. When OEMs add the
XBee Cellular Modem to their product, they create a future-proof design with flexibility to switch
between wireless protocols or frequencies as needed.
You can read some frequently asked questions here.
Applicable firmware and hardware
This manual supports the following firmware:
n113xx and above
Note This manual uses the placeholder value "xx" in the firmware versions listed above, as the
manual documents the released features as of the time of its writing. Digi International periodically
releases new firmware containing bug fixes and new features. As new firmware is released and
distributor stock is refreshed, the new firmware will gradually become available without the need to
update. However, no guarantees can be made that a specific version of the firmware will be populated
on any given XBee as delivered. If a specific revision is desired, it is the user's responsibility to ensure
that version is loaded onto all XBees purchased.
Note You must upgrade your device to the latest firmware for all features to be available. See Update
the firmware.
It supports the following hardware:
nXBC-M5-UT-xxx
SIM cards
The XBee Cellular Modem requires a 4FF (Nano) size SIM card. The SIM interface supports both 1.8 V
and 3 V SIM types.
Digi XBee Cellular 3G Global Embedded Modem User Guide 14

Digi XBee Cellular 3G Global Embedded Modem User Guide Cellular service
Digi XBee Cellular 3G Global Embedded Modem User Guide 15
Cellular service
Digi now offers Cellular Bundled Service plans. This service includes pre-configured cellular data
options that are ideal for IoT applications, bundled together with Digi Remote Manager for customers
who want to remotely monitor and manage their devices.
To learn more, or obtain the plan that is right for your needs, contact us:
nBy phone: [phone] (USA/toll free) or [phone] (International). Select the
Wireless Plan Support or Activation option in the menu.
nBy email: [e-mail].
The XBee Cellular kit includes six months of free cellular service. Six months of free cellular service
assumes a rate of 5 MB/month. If you exceed a limit of 30 MB during the six month period your SIM will
be deactivated.

Get started with the XBee Cellular Modem
This section describes how to connect the hardware in the XBee, 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. Connect the hardware
3. Install and upgrade XCTU
4. 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 XBee Cellular 3G Global Embedded Modem User Guide 16

Get started with the XBee Cellular Modem Identify the kit contents
Digi XBee Cellular 3G Global Embedded 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 USB cable
One XBee Cellular Modem
Note The XBee Cellular Modem comes
attached to the board in ESDwrap.
One SIMcard

Get started with the XBee Cellular Modem Connect the hardware
Digi XBee Cellular 3G Global Embedded Modem User Guide 18
Connect the hardware
1. The XBee Cellular Modem should already be plugged into the XBIB-U-DEV board. For more
information about development boards, see Development boards.
2. The SIMcard should be already be inserted into the XBee Cellular Modem. If not, install the
SIMcard into the XBee Cellular Modem.
WARNING! Never insert or remove the SIM card while the device is powered!
WARNING! The development board power supply only supports 3G mode. It does not
support 2G mode.
3. Connect the antenna to the XBee Cellular Modem by aligning the U.FL connector carefully, then
firmly pressing 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.
4. Plug the 12 V power supply to the power jack on the development board.
5. 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.

Get started with the XBee Cellular Modem Install and upgrade XCTU
Digi XBee Cellular 3G Global Embedded Modem User Guide 19
Install and upgrade XCTU
XBee Configuration and Test Utility (XCTU) is a multi-platform program developed by Digi that enables
users to interact with Digi radio frequency (RF) devices through a graphical interface. The application
includes built-in tools that make it easy to set up, configure, and test Digi RF devices.
XCTU does not work directly over an SPI interface.
You can use XCTU to update the device firmware. Firmware is the program code stored in the device's
persistent memory that provides the control program for the device.
Note You cannot update the cellular component on a 3G device.
For instructions on downloading and using XCTU, see the XCTU User Guide.
Note If you are on a macOS computer and encounter problems installing XCTU, see Correct a macOS
Java error.
Step 1: Install and upgrade XCTU
You can use XCTU to update the device firmware.
1. To use XCTU, you may need to install FTDI Virtual COMport (VCP)drivers onto your computer.
Click here to download the drivers for your operating system.
2. Upgrade XCTU to the latest version. This step is required.
Step 2: Add a device to XCTU
You must add a device to XCTU before you can update the device's firmware or configure the device
from XCTU.
Add a device to XCTU
These instructions show you how to add the XBee to XCTU.
If XCTU does not find your serial port, see Cannot find the serial port for the device and Enable Virtual
COM port (VCP) on the driver.
1. Launch XCTU .
Note XCTU's Update the radio module firmware dialog box may open and will not allow you
to continue until you click Update or Cancel on the dialog.
2. Click Help >Check for XCTUUpdates to ensure you are using the latest version of XCTU.
3. Click the Discover radio modules button in the upper left side of the XCTU screen.
4. In the Discover radio devices dialog, select the serial ports where you want to look for XBee
modules, and click Next.
5. In the Set port parameters window, maintain the default values and click Finish.
6. As XCTU locates radio modules, they appear in the Discovering radio modules dialog box.
7. Select the device(s) you want to add and click Add selected devices.
If your module could not be found, XCTU displays the Could not find any radio module dialog
providing possible reasons why the module could not be added.

Get started with the XBee Cellular Modem Update the device firmware using XCTU
Digi XBee Cellular 3G Global Embedded Modem User Guide 20
Update the device firmware using XCTU
You should use XCTU to update the device firmware on your XBee to the most recent version. This
ensures that you can take advantage of all the latest fixes and features.
Update the device firmware using XCTU.
Check for cellular registration and connection
In the following examples, proper cellular network registration and address assignment must occur
successfully. The LED on the development board blinks when the XBee is registered to the cellular
network; see Associate LED functionality. If the LEDremains solid, registration has not occurred
properly.
Registration can take several minutes.
Note Make sure you are in an area with adequate cellular network reception or the XBee will not
make the connection.
Note Check the antenna connections if the device has trouble connecting to the network.
In addition to the LED confirmation, you can check the AT commands below in XCTU to check the
registration and connection.
To view these commands:
1. Open XCTU.
2. Add a device to XCTU.
3. Click the Configuration working mode button.
4. Select a device from the Radio Modules list. XCTU displays the current firmware settings for
that device.
5. Update the device firmware using XCTU.
Note To search for an ATcommand in XCTU, use the search box .
The relevant commands are:
nAI (Association Indication) reads 0when the device successfully registers to the cellular
network. If it reads 23 it is connecting to the Internet; 22 means it is registering to the cellular
network.
nMY (Module IPAddress) should display a valid IPaddress. If it reads 0.0.0.0, it has not
registered yet.
Note To read a command's value, click the Read button next to the command.