Digi XBee Cellular LTE Cat 1 User manual

Digi XBee® Cellular LTE Cat 1
Embedded Modem
User Guide

Revision history—90001525
Revision Date Description
ASeptember
2016
Baseline release of the document.
B December
2016
Added API functionality. Many changes to reflect the initial production
release.
C February
2017
Added sleep support. Added SMSencoding information. Added D6,D7,DV,
AM,LA,SH,SL,SM,SP,ST and P1 commands. Noted that ANis not case-
sensitive.
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 XBee Cellular LTE Cat 1 Embedded Modem User Guide 2

Contents
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide
Applicable firmware and hardware 7
Purchase the correct SIM cards 7
Getting started with the XBee Cellular Modem Development Kit
Identify the kit contents 10
Cellular service 10
Connect the hardware 11
Configure the device using XCTU 12
Add a device 12
Update to the latest firmware 12
Software libraries 12
XBIB-U_DEV reference 14
XBee Cellular Modem examples 16
Check for cellular registration and connection 16
Send an SMS message to a phone 16
Connect to the ELIZA server 18
Connect to the echo server 19
Connect to the Daytime server 21
Connect to a TCP/IP address 23
Perform a (GET) HTTP request 24
Configure the XBee Cellular Modem using Device Cloud 25
Create a Device Cloud account 25
Get the XBee Cellular Modem IMEI number 25
Add a Digi XBee to Device Cloud 25
Update the firmware 26
Technical specifications
Interface and hardware specifications 28
RF characteristics 28
Networking and carrier 28
Power requirements 28
Power consumption 29
Electrical specifications 29
Regulatory approvals 30
Hardware
Mechanical drawings 32
Pin signals 32
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 3

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 4
Pin connection recommendations 33
Antenna connections 33
Antenna placement 34
SIM card 34
The Associate LED 34
Heat considerations 35
Heat sink considerations 35
Power supply considerations 36
Add a capacitor to the RESET line 36
Add a fan to provide active cooling 37
Cellular connection process
Connecting 39
Cellular network 39
Data network connection 39
Data communication with remote servers (TCP/UDP) 39
Disconnecting 39
SMS encoding 40
Modes
Select an operating mode 42
Transparent operating mode 42
API operating mode 43
Bypass operating mode 43
Enter Bypass operating mode 43
Leave Bypass operating mode 43
Boot the XBee Cellular Modem in Bypass operating mode 44
Restore cellular settings to default in Bypass operating mode 44
Command mode 44
Enter Command mode 44
Send AT commands 45
Apply command changes 45
Make command changes permanent 45
Exit Command mode 45
Sleep modes
About sleep modes 48
Normal mode 48
Pin sleep mode 48
Cyclic sleep mode 48
Cyclic sleep with pin wake up mode 48
Airplane mode 48
The sleep timer 48
AT commands
Special commands 50
AC (Apply Changes) 50
FR (Force Reset) 50
RE (Restore Defaults) 50

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 5
WR (Write) 50
Cellular commands 51
PH (Phone Number) 51
S# (ICCID) 51
IM (IMEI) 51
MN (Operator) 51
MV (Modem Firmware Version) 52
DB (Cellular Signal Strength) 52
AM (Airplane Mode) 52
DV (Antenna Diversity) 52
Network commands 53
IP (IP Protocol) 53
TL (SSL/TLS Protocol Version) 53
TM (TCP Client Connection Timeout) 54
DO (Device Options) 54
EQ (Device Cloud FQDN) 54
Addressing commands 54
SH (Serial Number High) 54
SL (Serial Number Low) 55
DL (Destination Address) 55
P# (Destination Phone Number) 55
DE (Destination Port) 55
TD (Text Delimiter) 56
MY (Module IP Address) 56
LA (Lookup IP Address of FQDN) 56
OD (Operating Destination Address) 56
Serial interfacing commands 57
BD (Baud Rate) 57
NB (Parity) 57
SB (Stop Bits) 58
RO (Packetization Timeout) 58
FT (Flow Control Threshold) 58
AP (API Enable) 59
I/O settings commands 59
D8 (DIO8/SLEEP_REQUEST) 59
D9 (DIO9/ON_SLEEP) 60
P1 (DIO11/PWM1 Configuration) 60
I/O sampling commands 61
TP (Temperature) 61
SM (Sleep Mode) 61
SP (Sleep Period) 62
ST (Wake Time) 62
Command mode options 62
CC (Command Sequence Character) 62
CT (Command Mode Timeout) 62
GT (Guard Times) 63
Firmware version/information commands 63
VR (Firmware Version) 63
VL (Version Long) 63
HV (Hardware Version) 63
HS (Hardware Series) 64
CK (Configuration CRC) 64
Diagnostic interface commands 64
DI (Device Cloud Indicator) 64
CI (Protocol/Connection Indication) 65

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 6
Execution commands 66
AN (APN) 67
NR (Network Reset) 67
!R (Modem Reset) 67
Operate in API mode
API frame specifications 70
API operation (AP parameter = 1) 70
API operation-with escaped characters (AP parameter = 2) 70
Start delimiter 71
Length 71
Frame data 71
Checksum 72
Calculate and verify checksums 72
Frame descriptions 73
AT Command - 0x08 73
AT Command: Queue Parameter Value - 0x09 74
Transmit (TX) SMS - 0x1F 75
Transmit (TX) Request: IPv4 - 0x20 76
AT Command Response - 0x88 77
Transmit (TX) Status - 0x89 78
Modem Status - 0x8A 79
Receive (RX) Packet: SMS - 0x9F 80
Receive (RX) Packet: IPv4 - 0xB0 81
Socket behavior
Secure Sockets Layer (SSL) certificate checking 83
Socket timeouts 83
Troubleshooting
Cannot find the serial port for the device 85
Correct a macOS Java error 86
Unresponsive cellular component in Bypass mode 87
Not on expected network after APN change 88
Certifications
Modification statement 90
Interference statement 90
Wireless notice 90
FCC Class B digital device notice 91
Labelling requirements for the host device 91

Digi XBee Cellular LTE Cat 1 Embedded Modem User
Guide
The XBee Cellular Modem is an embedded Long-Term Evolution (LTE) Category 1 cellular module that
provides original equipment manufacturers (OEMs) with a simple way to integrate cellular
connectivity into their devices.
The XBee Cellular Modem enables OEMs to quickly integrate cutting edge 4G cellular technology into
their devices and applications without dealing with the 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.
Applicable firmware and hardware
This manual supports the following firmware:
n1005
It supports the following hardware:
nXBC-V1-UT-xxx
Purchase the correct SIM cards
If you order the wrong type of SIM card it will not work with the XBee Cellular Modem.
Verizon recommends SIM SKU: M2MTRI-NONRUG-GT-A or an equivalent that must include a 4FF
punch out. This SKU is in triple punch, so devices with 2FF/3FF or 4FF can use this SIM SKU.
Bulk SIMs for M2M/Io are available from:
National distributor Network Contact
Phone
number Email
Reliance
Communications
Verizon
direct
Raja Ali 917-517-
7282
[e-mail]
Ingram Micro - Sales Verizon
direct
Lesli Reeves 317-707-
2371
[e-mail]
Ingram Micro - Sales Verizon
direct
Steve Kreiger 317-707-
2474
[e-mail]
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 7

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide Purchase the correct SIM cards
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 8
National distributor Network Contact
Phone
number Email
Ice Mobility Verizon
direct
Tom Puchala 847-876-
1768
[e-mail]
KORE Verizon
MVNO
Genesis
Crowder
877-710-
5673
[e-mail]
KORE Verizon
MVNO
Mike Basso 877-710-
5673
[e-mail]

Getting started with the XBee Cellular Modem
Development Kit
This section describes how to set up an XBee network and adjust the XBee Cellular Modem settings.
This section describes how to connect the hardware in the XBee Cellular Modem Development Kit, and
provides some examples you can use to communicate with the device.
Identify the kit contents 10
Cellular service 10
Connect the hardware 11
Configure the device using XCTU 12
Software libraries 12
XBIB-U_DEV reference 14
XBee Cellular Modem examples 16
Configure the XBee Cellular Modem using Device Cloud 25
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 9

Getting started with the XBee Cellular Modem Development Kit Identify the kit contents
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 10
Identify the kit contents
The Developer's kit includes the following:
One XBIB-U-DEV board
One 12 V power supply
Two antennas with U.FL connectors
One USB cable
One XBee Cellular Modem
One SIMcard
Cellular service
The XBIB-U-DEV board comes in an anti-static bag. There is a label on the bag that provides the date
that cellular service expires for the SIM card in the XBee Cellular Modem.
Note the expiration date and when cellular service expires, contact us at 1.877.890.4014 for further
instructions on renewing cellular service for the device.

Getting started with the XBee Cellular Modem Development Kit Connect the hardware
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 11
Connect the hardware
1. Plug one XBee Cellular Modem into the XBIB-U-DEV board.
2. The SIMcard should be inserted into the XBee Cellular Modem already. If not, install the
SIMcard into the XBee Cellular Modem.
WARNING! Never insert or remove the SIM card while the device is powered!
3. Connect the antennas to the XBee Cellular Modem by aligning the U.FL connectors carefully,
then firmly pressing straight down to seat the connector. U.FL is fragile and is not designed for
multiple insertions, so be careful when connecting or removing the antennas.
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.

Getting started with the XBee Cellular Modem Development Kit Configure the device using XCTU
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 12
Configure the device using XCTU
XBee Configuration and Test Utility (XCTU) is a multi-platform program 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.
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.
Add a device
These instructions show you how to add the XBee Cellular Modem to XCTU. If XCTU does not find your
serial port, see Cannot find the serial port for the device.
1. Launch XCTU .
2. Click the Discover radio modules button .
3. In the Discover radio devices dialog, select the serial ports where you want to look for XBee
modules, and click Next.
4. In the Set port parameters window, maintain the default values and click Finish.
5. As XCTU locates radio modules, they appear in the Discovering radio modules dialog box.
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.
Update to the latest firmware
Firmware is the program code stored in the device's persistent memory that provides the control
program for the device. Use XCTU to update the firmware.
1. Click the Configuration working modes button .
2. Select a local or remote XBee module from the Radio Modules list.
3. Click the Update firmware button .
The Update firmware dialog displays the available and compatible firmware for the selected
XBee module.
4. Select the product family of the XBee module, the function set, and the latest firmware version.
5. Click Update. A dialog displays update progress.
See How to update the firmware of your modules in the XCTU User Guide for more information.
Software libraries
One way to communicate with the XBee device is by using a software library. The libraries available
for use with the XBee Cellular Modem include:
nXBee Java library

Getting started with the XBee Cellular Modem Development Kit Software libraries
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 13
The XBee Java Library is a Java API. The package includes the XBee library, its source code and a
collection of samples that help you develop Java applications to communicate with your XBee devices.

Getting started with the XBee Cellular Modem Development Kit XBIB-U_DEV reference
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 14
XBIB-U_DEV reference
This picture shows the XBIB-U development board and the table that follows explains the callouts in
the picture.
Number Item Description
1 Programmingheader Header used to program XBee Programmable devices.

Getting started with the XBee Cellular Modem Development Kit XBIB-U_DEV reference
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 15
Number Item Description
2 Self power module Advanced users only—voids the warranty. Depopulate R31 to
power the device using V+ and GND from J2 and J5. You can
connect sense lines to S+ and S- for sensing power supplies.
CAUTION: Voltage is not regulated. Applying the incorrect
voltage can cause fire and serious injury.1
3 Current testing Depopulating R31 allows a current probe to be inserted across P6
terminals. The current though P6/R31 powers the device only.
Other supporting circuitry is powered by a different trace.
4 Loopback jumper Populating P8 with a loopback jumper causes serial transmissions
both from the device and from the USB to loopback.
5 DC barrel plug: 6-20V Greater than 500 mA loads require a DC supply for correct
operation. Plug in the external power supply prior to the USB
connector to ensure that proper USB communications are not
interrupted.
6 LED indicator Yellow: Modem sending serial/UART data to host.
Green: Modem receiving serial/UART data from host.
Red: Associate.
7 USB
8 RSSI indicator
9 User buttons Connected to DIO lines for user implementation.
10 Reset button
11 SPI power Connect to the power board from 3.3 V.
12 SPI Only used for surface-mount devices.
13 Indicator LEDs DS5: ON/SLEEP
DS2: DIO12, the LED illuminates when driven low.
DS3: DIO11, the LED illuminates when driven low.
DS4: DIO4, the LED illuminates when driven low.
14 Through-hole XBee
sockets
15 20-pin header Maps to standard through-hole XBee pins.
1Powering the board with J2 and J5 without R31 removed can cause shorts if the USB or barrel plug power are
connected. Applying too high a voltage destroys electronic circuitry in the device and other board components
and/or can cause injury.

Getting started with the XBee Cellular Modem Development Kit XBee Cellular Modem examples
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 16
XBee Cellular Modem examples
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 Cellular Modem registers to the
cellular network; see The Associate LED. 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 Cellular
Modem will not make the connection.
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 and click the Configuration working mode button.
2. Select a device from the Radio Modules list. XCTU displays the current firmware settings for
that device.
3. On the Configuration toolbar, click the Default button to load the default values
established by the firmware, and click Yes to confirm.
The relevant commands are:
Note To search for an ATcommand in XCTU, use the search box.
nAI (Association Indication) reads zero when the device successfully registers to the cellular
network. If it reads 0x23 it is connecting to the Internet; 0x22 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.
nAN is not visible on the standard settings interface, it is an advanced command. See AN (APN).
Send an SMS message to a phone
The XBee Cellular Modem can send and receive Short Message Service (SMS) transmissions (texts)
while in Transparent mode. This allows you to send and receive text messages to and from an SMS
capable device such as a mobile phone.
The following table explains the AT commands that you use in this example.

Getting started with the XBee Cellular Modem Development Kit XBee Cellular Modem examples
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 17
Command Value Description
AP (APIEnable) 0 Set the device's API mode to Transparent mode.
IP (IP Protocol) 2 Set the expected transmission mode to SMScommunication.
P#
(DestinationPhone
Number)
<Target
phone
number>
The target phone number that you send to, for example, your
cellular phone. See P# (Destination Phone Number) for instructions
on using this command.
TD (Text Delimiter) D (0x0D) The text delimiter to be used for Transparent mode, as an ASCII hex
code. No information is sent until this character is entered, unless
the maximum number of characters has been reached. Set to zero
to disable text delimiter checking. Set to D for a carriage return.
PH (Module's SIM
phone number)
Read
only
The value that represents your device's phone number as supplied
by the SIM card. This is used to send text messages to the device
from another cellular device.
1. Ensure that the device is set up correctly with the SIM card installed and the antennas
connected as described in Connect the hardware.
2. Open XCTU and click the Configuration working mode button.
3. Select a device from the Radio Modules list. XCTU displays the current firmware settings for
that device.
4. On the Configuration toolbar, click the Default button to load the default values
established by the firmware, and click Yes to confirm.
5. Factory settings are loaded but not written to the device. To write them, click the Write button
on the toolbar.
6. To switch to SMS communication, in the IP field, select 2 and click the Write button .
7. To enter your cell phone number, in the P# field, type the <target phone number> and click
the Write button. Type the phone number using only numbers, with no dashes. You can use the
+prefix if necessary. The target phone number is the phone number you wish to send a text to.
8. In the TD field, type Dand click the Write button.
9. Note the number in the PH field; it is the XBee Cellular Modem phone number, which you see
when it sends an SMS to your phone.

Getting started with the XBee Cellular Modem Development Kit XBee Cellular Modem examples
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 18
10. Click the Consoles working mode button on the toolbar to open a serial console to the
device. For instructions on using the Console, see
http://www.digi.com/resources/documentation/digidocs/90001458-
13/default.htm#reference/r_at_console.htm
11. Click the Open button to open a serial connection to the device.
12. Click in the left pane of the Console log, type hello world and press Enter. The XBee Cellular
Modem sends the message to the destination phone number set by the P# command.
13. When the phone receives the text, you can see that the sender's phone number matches the
value reported by the XBee Cellular Modem with the PH command.
14. On the phone, reply with the text connect with confidence and the XBee Cellular Modem
outputs this reply from the UART.
Connect to the ELIZA server
You can use the XBee Cellular Modem to chat with the ELIZA Therapist Bot. ELIZAis an artificial
intelligence (AI) bot that emulates a therapist and can perform simple conversations.
The following table explains the AT commands that you use in this example.
At command Value Description
IP (IP Protocol) 1 Set the expected transmission mode to TCP
communications.
DL (Destination
Address)
52.43.121.77 The target IP address of the Eliza server.
DE (Destination Port) 0x2328 The target port number of the Eliza server.
To communicate with the ELIZA Therapist Bot:
1. Ensure that the device is set up correctly with the SIM card installed and the antennas
connected as described in Connect the hardware.
2. Open XCTU and click the Configuration working mode button.
3. Select a device from the Radio Modules list. XCTU displays the current firmware settings for
that device.

Getting started with the XBee Cellular Modem Development Kit XBee Cellular Modem examples
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 19
4. On the Configuration toolbar, click the Default button to load the default values
established by the firmware, and click Yes to confirm.
5. Factory settings are loaded but not written to the device. To write them, click the Write button
on the toolbar.
6. To switch to TCP communication, in the IP field, select 1 and click the Write button .
7. To enter the destination address of the ELIZATherapist Bot, in the DL field, type 52.43.121.77
and click the Write button.
8. To enter the destination IP port number, in the DE field, type 2328 and click the Write button.
9. Click the Consoles working mode button on the toolbar to open a serial console to the
device. For instructions on using the Console, see
http://www.digi.com/resources/documentation/digidocs/90001458-
13/default.htm#reference/r_at_console.htm
10. Click the Open button to open a serial connection to the device.
11. Click in the left pane of the Console log, then type in the Console to talk to the ELIZA Therapist
Bot. The following screenshot provides an example of this chat.
Connect to the echo server
This server echoes back the messages you type.
The following table explains the AT commands that you use in this example.

Getting started with the XBee Cellular Modem Development Kit XBee Cellular Modem examples
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 20
At
command Value Description
IP (IP
Protocol)
1 Set the expected transmission mode to TCP communications.
TD (Text
Delimiter)
D (0x0D) The text delimiter to be used for Transparent mode, as an ASCII hex
code. No information is sent until this character is entered, unless the
maximum number of characters has been reached. Set to zero to
disable text delimiter checking. Set to Dfor a carriage return.
DL
(Destination
Address)
52.43.121.77 The target IPaddress of the echo server.
DE
(Destination
Port)
0x2329 The target port number of the echo server.
To communicate with the echo server:
1. Ensure that the device is set up correctly with the SIM card installed and the antennas
connected as described in Connect the hardware.
2. Open XCTU and click the Configuration working mode button.
3. Select a device from the Radio Modules list. XCTU displays the current firmware settings for
that device.
4. On the Configuration toolbar, click the Default button to load the default values
established by the firmware, and click Yes to confirm.
5. Factory settings are loaded but not written to the device. To write them, click the Write button
on the toolbar.
6. To switch to TCP communication, in the IP field, select 1 and click the Write button .
7. To enable the XBee Cellular Modem to recognize carriage return as a message delimiter, in the
TD field, type Dand click the Write button.
8. To enter the destination address of the echo server, in the DL field, type 52.43.121.77 and click
the Write button.
9. To enter the destination IP port number, in the DE field, type 2329 and click the Write button.