Digi XBee User manual

Digi XBee® Cellular LTE Cat 1
Embedded Modem
User Guide

Revision history—90001525
Revision Date Description
G January
2018
Added the TS,N1 and N2 commands and information on socket limits. Added
support for RSSIPWM, SPIand I2C. Updated the heat considerations. Added
packaged firmware updates. Indicated the number of supported sockets.
H January
2018
Corrected the applicable software version to 100A.
J February
2018
Added instructions for sending an SCI request to Remote Manager.
K June
2018
0B software release. Added file system and TLS sections, ATcommands and
related changes.
L August
2018
Updated ADC hardware specification table. Updated list of cipher suites.
Updated Get Started section.
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.
© 2018 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
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 2

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 3

Contents
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide
Applicable firmware and hardware 12
SIM cards 12
Get started with the XBee Cellular Modem Development Kit
Identify the kit contents 15
Connect the hardware 16
XBIB-U-DEV reference 18
Cellular service 19
Configure the device using XCTU 20
Add a device 20
Check for cellular registration and connection 21
Update to the latest firmware 21
Connection examples
Connect to the Echo server 24
Debugging 25
Connect to the ELIZA server 26
Debugging 27
Connect to the Daytime server 28
Debugging 29
Send an SMS message to a phone 30
Debugging 31
Perform a (GET) HTTP request 32
Debugging 33
Get started with CoAP 34
CoAP terms 34
CoAP quick start example 34
Configure the device 35
Example: manually perform a CoAPrequest 35
Example: use Python to generate a CoAP message 36
Connect to a TCP/IP address 39
Debugging 39
Get started with MQTT 41
Example: MQTT connect 41
Send a connect packet 43
Example: send messages (publish) with MQTT 44
Example: receive messages (subscribe) with MQTT 45
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 4

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 5
Use MQTT over the XBee Cellular Modem with a PC 46
Software libraries 49
Get started with MicroPython
About MicroPython 50
Why use MicroPython 50
MicroPython on the XBee Cellular Modem 50
Use XCTU to enter the MicroPython environment 51
Use the MicroPython Terminal in XCTU 51
Troubleshooting 51
Example: hello world 52
Example: turn on an LED 52
Example: code a request help button 53
Enter MicroPython paste mode 53
Catch a button press 54
Send a text (SMS) when the button is pressed 55
Add the time the button was pressed 56
Exit MicroPython mode 57
Other terminal programs 57
Tera Term for Windows 58
Use picocom in Linux 59
Technical specifications
Interface and hardware specifications 62
RF characteristics 62
Networking specifications 62
Power requirements 62
Power consumption 63
Electrical specifications 63
Regulatory approvals 64
Hardware
Mechanical drawings 66
Pin signals 66
Pin connection recommendations 68
RSSI PWM 68
SIM card 68
The Associate LED 68
Antenna recommendations
Antenna specifications 71
Antenna connections 71
Antenna placement 72
Design recommendations
Power supply considerations 74
Add a capacitor to the RESET line 74

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 6
Heat considerations and testing 74
Heat sink guidelines 76
Bolt-down style 76
Adhesive style heat sink 76
Add a fan to provide active cooling 77
Cellular connection process
Connecting 79
Cellular network 79
Data network connection 79
Data communication with remote servers (TCP/UDP) 79
Disconnecting 79
SMS encoding 80
Modes
Select an operating mode 82
Transparent operating mode 83
API operating mode 83
Bypass operating mode 83
Enter Bypass operating mode 83
Leave Bypass operating mode 84
Restore cellular settings to default in Bypass operating mode 84
Command mode 84
Enter Command mode 84
Troubleshooting 85
Send AT commands 85
Response to AT commands 86
Apply command changes 86
Make command changes permanent 86
Exit Command mode 86
MicroPython mode 86
Sleep modes
About sleep modes 89
Normal mode 89
Pin sleep mode 89
Cyclic sleep mode 89
Cyclic sleep with pin wake up mode 89
Airplane mode 89
The sleep timer 89
MicroPython sleep behavior 90
Serial communication
Serial interface 92
Serial data 92
UART data flow 92
Serial buffers 93
CTS flow control 93
RTS flow control 93

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 7
SPI operation
SPI communications 95
Full duplex operation 96
Low power operation 97
Select the SPI port 97
Force UART operation 98
Data format 98
File system
Overview of the file system 100
Directory structure 100
Paths 100
Secure files 100
XCTU interface 101
Encrypt files 101
Socket behavior
Supported sockets 103
Socket timeouts 103
Socket limits in API mode 103
Enable incoming TCP connections 103
API mode behavior for outgoing TCP and SSL connections 104
API mode behavior for outgoing UDP data 104
API mode behavior for incoming TCP connections 104
API mode behavior for incoming UDP data 105
Transparent mode behavior for outgoing TCP and SSL connections 105
Transparent mode behavior for outgoing UDP data 106
Transparent mode behavior for incoming TCP connections 106
Transparent mode behavior for incoming UDP connections 106
Transport Layer Security (TLS)
TLS AT commands 108
Transparent mode and TLS 109
API mode and TLS 109
Key formats 109
Certificate formats 109
Certificate limitations 109
Cipher suites 109
Server Name Indication (SNI) 110
AT commands
Special commands 112
AC (Apply Changes) 112
FR (Force Reset) 112
RE command 112
WR (Write) 112
Cellular commands 113

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 8
PH (Phone Number) 113
S# (ICCID) 113
IM (IMEI) 113
MN (Operator) 113
MV (Modem Firmware Version) 114
DB (Cellular Signal Strength) 114
AN (Access Point Name) 114
CP (Carrier Profile) 115
AM (Airplane Mode) 115
OA (Operating APN) 115
DV (Antenna Diversity) 115
Network commands 116
IP (IP Protocol) 116
TL (SSL/TLS Protocol Version) 116
$0 (SSL/TLS Profile 0) 117
$1 (SSL/TLS Profile 1) 117
$2 (SSL/TLS Profile 2) 117
TM (IP Client Connection Timeout) 118
TS (IP Server Connection Timeout) 118
DO (Device Options) 118
EQ (Remote Manager FQDN) 119
Addressing commands 119
SH (Serial Number High) 119
SL (Serial Number Low) 119
MY (Module IP Address) 119
P# (Destination Phone Number) 120
N1 (DNS Address) 120
N2 (DNS Address) 120
DL (Destination Address) 120
OD (Operating Destination Address) 121
DE (Destination Port) 121
C0 (Source Port) 121
LA (Lookup IP Address of FQDN) 122
Serial interfacing commands 122
BD (Baud Rate) 122
NB (Parity) 123
SB (Stop Bits) 123
RO (Packetization Timeout) 123
TD (Text Delimiter) 123
FT (Flow Control Threshold) 124
AP (API Enable) 124
I/O settings commands 124
D0 (DIO0/AD0) 124
D1 (DIO1/AD1) 125
D2 (DIO2/AD2) 125
D3 (DIO3/AD3) 126
D4 (DIO4) 126
D5 (DIO5/ASSOCIATED_INDICATOR) 127
D6 (DIO6/RTS) 127
D7 (DIO7/CTS) 128
D8 (DIO8/SLEEP_REQUEST) 128
D9 (DIO9/ON_SLEEP) 129
P0 (DIO10/PWM0 Configuration) 129
P1 (DIO11/PWM1 Configuration) 129
P2 (DIO12 Configuration) 130

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 9
PD (Pull Direction) 130
PR (Pull-up/down Resistor Enable) 131
M0 (PWM0 Duty Cycle) 131
I/O sampling commands 132
TP (Temperature) 132
IS (Force Sample) 132
Sleep commands 133
SM (Sleep Mode) 133
SP (Sleep Period) 134
ST (Wake Time) 134
Command mode options 134
CC (Command Sequence Character) 134
CT (Command Mode Timeout) 134
CN (Exit Command mode) 135
GT (Guard Times) 135
MicroPython commands 135
PS (Python Startup) 135
PY (MicroPython Command) 135
Firmware version/information commands 136
VR (Firmware Version) 136
VL (Verbose Firmware Version) 137
HV (Hardware Version) 137
AI (Association Indication) 137
HS (Hardware Series) 138
CK (Configuration CRC) 138
Diagnostic interface commands 138
DI (Remote Manager Indicator) 138
CI (Protocol/Connection Indication) 139
Execution commands 141
NR (Network Reset) 141
!R (Modem Reset) 141
File system commands 141
Error responses 141
ATFS (File System) 142
ATFS PWD 142
ATFS CDdirectory 142
ATFS MDdirectory 142
ATFS LS [directory] 142
ATFS PUTfilename 142
ATFS XPUTfilename 143
ATFS HASHfilename 143
ATFS GETfilename 143
ATFS MVsource_pathdest_path 143
ATFS RMfile_or_directory 143
ATFS INFO 143
ATFSFORMAT confirm 143
Operate in API mode
API mode overview 145
Use the AP command to set the operation mode 145
API frame format 145
API operation (AP parameter = 1) 145
API operation with escaped characters (AP parameter = 2) 146

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 10
API frames
AT Command - 0x08 150
Transmit (TX) SMS - 0x1F 151
Transmit (TX) Request: IPv4 - 0x20 152
Tx Request with TLS Profile - 0x23 154
AT Command Response - 0x88 156
Transmit (TX) Status - 0x89 157
Modem Status - 0x8A 159
Receive (RX) Packet: SMS - 0x9F 160
Receive (RX) Packet: IPv4 - 0xB0 161
Packaged firmware updates
About packaged firmware updates 163
Module firmware update 163
Cellular component firmware update 163
Packaged firmware update 163
FW Update - 0x2B 164
FW Update Response - 0xAB 164
Important notes 165
Perform a cellular component firmware update 165
Error recovery 166
Corrupted firmware on the cellular component 166
Negativeacknowledgment 167
Host initiated cancellation 167
General case 167
Configure the XBee Cellular Modem using Digi Remote Manager
Create a Remote Manager account 169
Get the XBee Cellular Modem IMEI number 169
Add a XBee Cellular Modem to Remote Manager 169
Update the firmware 170
Update the firmware using web services 170
Example: update the XBee firmware synchronously with Python 3.0 170
Example: use the device's firmware image to update the XBee firmware synchronously 171
Troubleshooting
Cannot find the serial port for the device 174
Condition 174
Solution 174
Other possible issues 175
Enable Virtual COM port (VCP) on the driver 175
Correct a macOS Java error 176
Condition 176
Solution 176
Unresponsive cellular component in Bypass mode 177
Condition 177
Solution 177
Not on expected network after APN change 178
Condition 178