Digi XBee Cellular LTE Cat 1Embedded Modem

User Guide

Revision history90001525

Revision Date Description

E June2017

Added support for incoming TCP connections. Update the AN command to adefinition and added OA. Added information on the serial interface.

F June2017

Updated the cellular service information and the maximum ambienttemperature.

G January2018

Added the TS, N1 and N2 commands and information on socket limits. Addedsupport for RSSIPWM, SPIand I2C. Updated the heat considerations. Addedpackaged firmware updates. Indicated the number of supported sockets.

H January2018

Corrected the applicable software version to 100A.

J February2018

Added instructions for sending an SCI request to Remote Manager.

Trademarks and copyrightDigi, Digi International, and the Digi logo are trademarks or registered trademarks in the UnitedStates and other countries worldwide. All other trademarks mentioned in this document are theproperty of their respective owners. 2018 Digi International Inc. All rights reserved.

DisclaimersInformation in this document is subject to change without notice and does not represent acommitment on the part of Digi International. Digi provides this document as is, without warranty ofany kind, expressed or implied, including, but not limited to, the implied warranties of fitness ormerchantability for a particular purpose. Digi may make improvements and/or changes in this manualor in the product(s) and/or the program(s) described in this manual at any time.

WarrantyTo view product warranty information, go to the following website:www.digi.com/howtobuy/terms

Send commentsDocumentation feedback: To provide feedback on this document, send your comments totechcomm@digi.com.

Customer supportDigi Technical Support: Digi offers multiple technical support plans and service packages to help ourcustomers 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

http://www.digi.com/howtobuy/termsmailto:techcomm@digi.com

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

http://www.digi.com/support

Contents

Digi XBee Cellular LTE Cat 1 Embedded Modem User GuideApplicable firmware and hardware 11SIM cards 11

Getting started with the XBee Cellular Modem Development KitIdentify the kit contents 14XBIB-U-DEV reference 15Cellular service 16Connect the hardware 17Configure the device using XCTU 18

Add a device 18Check for cellular registration and connection 19Update to the latest firmware 19

Send an SMS message to a phone 21Debugging 22

Connect to the ELIZA server 23Debugging 24

Connect to the echo server 25Debugging 26

Connect to the Daytime server 27Debugging 28

Connect to a TCP/IP address 29Debugging 30

Perform a (GET) HTTP request 31Debugging 32

Get started with MQTT 33Example: MQTT connect 33Send a connect packet 35Example: send messages (publish) with MQTT 37Example: receive messages (subscribe) with MQTT 37Use MQTT over the XBee Cellular Modem with a PC 38

Get started with CoAP 42CoAP terms 42CoAP quick start example 42Configure the device 43Example: manually perform a CoAPrequest 43Example: use Python to generate a CoAP message 44

Software libraries 46

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 4

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 5

Get started with MicroPythonAbout MicroPython 48

Why use MicroPython 48MicroPython on the XBee Cellular Modem 48Use XCTU to enter the MicroPython environment 48Use the MicroPython Terminal in XCTU 49Example: hello world 49Example: turn on an LED 49Example: code a request help button 50

Enter MicroPython paste mode 51Catch a button press 51Send a text (SMS) when the button is pressed 53Add the time the button was pressed 54

Exit MicroPython mode 55Other terminal programs 55

Tera Term for Windows 55Use picocom in Linux 56

Technical specificationsInterface and hardware specifications 59RF characteristics 59Networking specifications 59Power requirements 59Power consumption 60Electrical specifications 60Regulatory approvals 61

HardwareMechanical drawings 63Pin signals 63

Pin connection recommendations 65RSSI PWM 65SIM card 65The Associate LED 65

Antenna recommendationsAntenna specifications 68Antenna connections 68Antenna placement 69

Design recommendationsPower supply considerations 71Add a capacitor to the RESET line 71Heat considerations and testing 71Heat sink guidelines 73

Bolt-down style 73Adhesive style heat sink 73

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 6

Add a fan to provide active cooling 74

Cellular connection processConnecting 76Cellular network 76Data network connection 76Data communication with remote servers (TCP/UDP) 76Disconnecting 76SMS encoding 77

ModesSelect an operating mode 79Transparent operating mode 80API operating mode 80Bypass operating mode 80

Enter Bypass operating mode 80Leave Bypass operating mode 81Restore cellular settings to default in Bypass operating mode 81

Command mode 81Enter Command mode 81Send AT commands 82Apply command changes 83Make command changes permanent 83Exit Command mode 83

Sleep modesAbout sleep modes 85Normal mode 85Pin sleep mode 85Cyclic sleep mode 85Cyclic sleep with pin wake up mode 85Airplane mode 85The sleep timer 85MicroPython sleep behavior 86

Serial communicationSerial interface 88Serial data 88UART data flow 88Serial buffers 89CTS flow control 89RTS flow control 89

SPI operationSPI communications 91Full duplex operation 92Low power operation 93

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 7

Select the SPI port 93Force UART operation 94Data format 94

AT commandsMicroPython commands 96

PS (Python Startup) 96PY (MicroPython Command) 96

Special commands 97AC (Apply Changes) 97FR (Force Reset) 97RE command 98WR command 98

Cellular commands 98PH (Phone Number) 98S# (ICCID) 98IM (IMEI) 99MN (Operator) 99MV (Modem Firmware Version) 99DB (Cellular Signal Strength) 99AN (Access Point Name) 99OA (Operating APN) 100AM (Airplane Mode) 100DV (Antenna Diversity) 100

Network commands 101IP (IP Protocol) 101TL (SSL/TLS Protocol Version) 101TM (IP Client Connection Timeout) 102TS (IP Server Connection Timeout) 102DO (Device Options) 102EQ (Device Cloud FQDN) 103

Addressing commands 103SH (Serial Number High) 103SL (Serial Number Low) 103DL (Destination Address) 104P# (Destination Phone Number) 104N1 (DNS Address) 104N2 (DNS Address) 104DE (Destination Port) 104TD (Text Delimiter) 105MY (Module IP Address) 105LA (Lookup IP Address of FQDN) 105OD (Operating Destination Address) 105C0 (Source Port) 106

Serial interfacing commands 106BD (Baud Rate) 106NB (Parity) 107SB (Stop Bits) 107RO (Packetization Timeout) 108FT (Flow Control Threshold) 108AP (API Enable) 108

I/O settings commands 109D0 (DIO0/AD0) 109D1 (DIO1/AD1) 109

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 8

D2 (DIO2/AD2) 110D3 (DIO3/AD3) 110D4 (DIO4) 110D5 (DIO5/ASSOCIATED_INDICATOR) 111D6 (DIO6/RTS) 111D7 (DIO7/CTS) 112D8 (DIO8/SLEEP_REQUEST) 112D9 (DIO9/ON_SLEEP) 113P0 (DIO10/PWM0 Configuration) 113P1 (DIO11/PWM1 Configuration) 114P2 (DIO12 Configuration) 114PD (Pull Direction) 115PR (Pull-up/down Resistor Enable) 115M0 (PWM0 Duty Cycle) 116

I/O sampling commands 116TP (Temperature) 116

Sleep commands 116SM (Sleep Mode) 117SP (Sleep Period) 117ST (Wake Time) 117

Command mode options 117CC (Command Sequence Character) 118CT (Command Mode Timeout) 118GT (Guard Times) 118

Firmware version/information commands 118VR (Firmware Version) 118VL (Verbose Firmware Version) 119HV (Hardware Version) 119AI (Association Indication) 119HS (Hardware Series) 120CK (Configuration CRC) 120

Diagnostic interface commands 120DI (Device Cloud Indicator) 120CI (Protocol/Connection Indication) 120

Execution commands 122NR (Network Reset) 122!R (Modem Reset) 123IS (Force Sample) 123

Operate in API modeAPI mode overview 126Use the AP command to set the operation mode 126API frame format 126

API operation (AP parameter = 1) 126API operation with escaped characters (AP parameter = 2) 127

Frame descriptions 130AT Command - 0x08 130Transmit (TX) SMS - 0x1F 131Transmit (TX) Request: IPv4 - 0x20 132AT Command Response - 0x88 133Transmit (TX) Status - 0x89 134Modem Status - 0x8A 135Receive (RX) Packet: SMS - 0x9F 136Receive (RX) Packet: IPv4 - 0xB0 137

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 9

Packaged firmware updatesAbout packaged firmware updates 139

Module firmware update 139Cellular component firmware update 139Packaged firmware update 139

FW Update - 0x2B 140Description 140Format 140

FW Update Response - 0xAB 140Description 140Format 140

Important notes 141Perform a cellular component firmware update 141Error recovery 142

Corrupted firmware on the cellular component 142Negativeacknowledgment 143Host initiated cancellation 143General case 143

Socket behaviorSupported sockets 145Secure Sockets Layer (SSL)/Transport Layer Security (TLS) certificate checking 145Socket timeouts 145Socket limits in API mode 145Enable incoming TCP connections 145API mode behavior for outgoing TCP and SSL connections 146API mode behavior for outgoing UDP data 146API mode behavior for incoming TCP connections 147API mode behavior for incoming UDP data 147Transparent mode behavior for outgoing TCP and SSL connections 147Transparent mode behavior for outgoing UDP data 148Transparent mode behavior