Digi LTE Cat User Manual

Digi XBee® Cellular LTE Cat 1

Embedded Modem

User Guide

Revision history—90001525

Revision Date Description

W March 2020

X September 2020

Y October 2020

Z November 2020

AA January 2021

Added cellular firmware update information.

Added information about XBee header connectors. Added new CLI commands:

n ER (Remote Manager TCP Port Override)

n ES (Remote Manager UDP Port Override)

n MT (Remote Manager Idle Timeout)

n PG (Ping)

Updated existing CLI commands:

n AI (Association Indication)

n P# (Destination Phone Number)

n TP (Temperature)

n VR (Firmware Version)

Updated Transmit (TX) Status - 0x89.

Added information for File system APIframes. Updated Software libraries.

Updated Socket Connect - 0x42. Updated Socket Connect Response - 0xC2. Added design recommendations for SIM cards.

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.

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

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

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)

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

techcomm@digi.com

Include the document title and part number (Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide, 90001525 X) in the subject line of your email.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Contents

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Applicable firmware and hardware 15 SIM cards 15 Cellular service 16

Get started with the XBee Cellular Modem

Identify the kit contents 18 Connect the hardware 19 Install and upgrade XCTU 20

Add a device to XCTU 20 Update the device and cellular firmware using XCTU 21 Check for cellular registration and connection 21

XBee connection examples

Connect to the Echo server 23 Connect to the ELIZA server 25 Connect to the Daytime server 27 Send an SMS message to a phone 29 Perform a (GET) HTTP request 31 Connect to a TCP/IP address 33 Software libraries 33 Debugging 34

Get started with MicroPython

About MicroPython 36

Why use MicroPython 36 MicroPython on the XBee Cellular Modem 36 Use XCTU to enter the MicroPython environment 36 Use the MicroPython Terminal in XCTU 37

Troubleshooting 37 Example: hello world 37 Example: turn on an LED 37 Example: code a request help button 38

Enter MicroPython paste mode 39

Catch a button press 39

Send a text (SMS) when the button is pressed 41

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Add the time the button was pressed 42 Example: debug the secondary UART 43 Exit MicroPython mode 43 Other terminal programs 44

Tera Term for Windows 44 Use picocom in Linux 45

Get started with Digi Remote Manager

Create a Remote Manager account and add devices 47

Create a Remote Manager account 48

Add an XBee Cellular Modem to Remote Manager 48

Verify the connection between a device and Remote Manager 49 Configure Remote Manager features by scheduling tasks 49

Overview: Create a schedule for a set of tasks 49

Examples 50

Example: Read settings and state using Remote Manager 50

Example: Configure a device from Remote Manager using XML 51

Example: Schedule a task to update the device firmware using Remote Manager 52

Example: Update MicroPython from Remote Manager using XML 53 Manage data in Remote Manager 57

Review device status information from Remote Manager 57

Manage secure files in Remote Manager 58 Remote Manager reference 59

Enable SM/UDP 59

TCP connection 59

Disconnect 61

Configure XBee settings within Remote Manager 61

Examples: IOT protocols with transparent mode

Get started with CoAP 64

CoAP terms 64

CoAP quick start example 64

Configure the device 65

Example: manually perform a CoAPrequest 65

Example: use Python to generate a CoAP message 66 Get started with MQTT 68

Example: MQTT connect 68

Send a connect packet 70

Example: send messages (publish) with MQTT 71

Example: receive messages (subscribe) with MQTT 72

Use MQTT over the XBee Cellular Modem with a PC 73

Update the firmware

Create a plan for device and cellular component firmware updates 78 Update the device and the cellular firmware using XCTU 79

Update the device and cellular firmware using XCTU 79 Update the device firmware 81

Update the firmware from the Devices page in Remote Manager 81

Update the firmware using web services in Remote Manager 82

Use a host processor to update the modem firmware for XBee devices over UART 84

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Update the cellular firmware 87

Update the cellular component firmware using Remote Manager 87

Update the cellular firmware using the API 90

Technical specifications

Interface and hardware specifications 94 RF characteristics 94 Networking specifications 95 Power requirements 96 Power consumption 96 Electrical specifications 96 Regulatory approvals 97

Hardware

Mechanical drawings 100 Pin signals 100

Pin connection recommendations 102 XBee header connector requirements 102 RSSI PWM 102 SIM card 102 Associate LED functionality 102 Development boards 104

XBIB-U-DEV reference 104

XBIB-CU-TH reference 106

XBIB-C-GPS reference 109

Interface with the XBIB-C-GPS module 110

Antenna recommendations

Antenna specifications 112 Antenna connections 112 Antenna placement 113 RF exposure 113

Design recommendations

Power supply considerations 115 Add a capacitor to the RESET line 115 Heat considerations and testing 115 Heat sink guidelines 117

Bolt-down style 117

Adhesive style heat sink 117 Add a fan to provide active cooling 118 Custom configuration: Create a new factory default 118

Set a custom configuration 119

Clear all custom configurations on a device 119 Clean shutdown 119

SD (Shutdown) command 119

Sleep feature 120

Airplane mode 120 SIMcards 120

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Cellular connection process

Connecting 122

Cellular network 122

Data network connection 122 Data communication with remote servers (TCP/UDP) 122 Disconnecting 122

Modes

Select an operating mode 125 Transparent operating mode 126 API operating mode 126 Bypass operating mode (DEPRECATED) 126

Enter Bypass operating mode 127

Leave Bypass operating mode 127

Restore cellular settings to default in Bypass operating mode 127 Command mode 127

Enter Command mode 127

Troubleshooting 128

Send AT commands 128

Response to AT commands 129

Apply command changes 129

Make command changes permanent 129

Exit Command mode 129 MicroPython mode 129

Sleep modes

About sleep modes 132 Normal mode 132 Pin sleep mode 132 Cyclic sleep mode 132 Cyclic sleep with pin wake up mode 132 Airplane mode 132 Connected sleep mode 132 The sleep timer 133 MicroPython sleep behavior 133

Serial communication

Serial interface 135 Serial data 135 UART data flow 135 Serial buffers 136 CTS flow control 136 RTS flow control 136

SPI operation

SPI communications 138 Full duplex operation 139

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

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

SMS behaviors

SMS encoding 145

Socket behavior

Supported sockets 147 Best practices when using sockets 147

Sockets and Remote Manager 147

Sockets and API mode 147 Socket timeouts 147 Socket limits in API mode 147 Enable incoming TCP connections 148 API mode behavior for outgoing TCP and TLS connections 148 API mode behavior for outgoing UDP data 149 API mode behavior for incoming TCP connections 149 API mode behavior for incoming UDP data 150 Transparent mode behavior for outgoing TCP and TLS connections 150 Transparent mode behavior for outgoing UDP data 150 Transparent mode behavior for incoming TCP connections 150 Transparent mode behavior for incoming UDP connections 151

Extended Socket frames

Examples 152 Available Extended Socket frames 153 Extended Socket example: Single HTTP Connection 153

Send a Socket Create frame 153

Receive a Socket Create response 154

Send Socket Connect 154

Receive a Socket Connect Response 154

Receive a Socket Status 155

Send HTTP Request using Socket Send frame 155

Receive TX Status 156

Receive one or more Receive Data frames 156

Receive Socket Status indicating closed connection 157 Extended Socket example: UDP 157

Send a Socket Create frame 157

Receive a Socket Create response 158

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Bind local source addres 158

Receive Bind/Listen Response 158

Send to Digi echo server 159

Receive TX Status 159

Receive echoed data 159

Send to Digi time server 160

Receive TX Status 160

Receive daytime value 160

Close the socket 161

Receive close response 161 Extended Socket example: TCPListener 162

Send a Socket Create frame 162

Receive a Socket Create response 162

Designate the socket as a listener 162

Receive a Socket Bind/Listen Response 163

Making a connection to the listener socket 163

Receiving Data from the new socket 164

Receive a Socket Status indicating closed connection 164

Transport Layer Security (TLS)

Specifying TLS keys and certificates 167 Transparent mode and TLS 168 API mode and TLS 168 Key formats 168 Certificate limitations 168 Cipher suites 168 Server Name Indication (SNI) 169 Secure the connection between an XBee and Remote Manager with server authentication 169

Step 1: Get the certificate 169

Step 2: Configure device 169

Step 3: Verify that authentication is being performed 169

AT commands

Special commands 172

AC (Apply Changes) 172

FR (Force Reset) 172

RE command 172

SD (Shutdown) 173

WR (Write) 173

HI (Hardware Identity) 173 Cellular commands 175

PH (Phone Number) 175

S# (ICCID) 175

IM (IMEI) 175

II (Subscriber identity) 175

MN (Operator) 175

MV (Modem Firmware Version) 176

MU (Modem firmware revision number) 176

DB (Cellular Signal Strength) 176

DT (Cellular Network Time) 176

AN (Access Point Name) 177

AM (Airplane Mode) 177

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

OA (Operating APN) 178

DV (Secondary Antenna Function Switch) 178

SQ (Reference Signal Received Quality) 178

SW (Reference Signal Received POWER) 179

PN (SIMPIN) 179

PK (SIMPUK) 179

CU (Cellular user name) 180

CW (Cellular password) 180 Network commands 181

IP (IP Protocol) 181

TL (TLS Protocol Version) 181

$0 (TLS Profile 0) 181

$1 (TLS Profile 1) 182

$2 (TLS Profile 2) 182

TM (IP Client Connection Timeout) 182

TS (IP Server Connection Timeout) 183

DO (Device Options) 183

PG (Ping) 183 Addressing commands 185

SH (Serial Number High) 185

SL (Serial Number Low) 185

MY (Module IP Address) 185

P# (Destination Phone Number) 185

N1 (DNS Address) 186

N2 (DNS Address) 186

DL (Destination Address) 186

OD (Operating Destination Address) 186

DE (Destination port) 187

C0 (Source Port) 187

LA (Lookup IP Address of FQDN) 187 Serial interfacing commands 189

BD (Baud Rate) 189

NB (Parity) 189

SB (Stop Bits) 190

RO (Packetization Timeout) 190

TD (Text Delimiter) 190

FT (Flow Control Threshold) 190

AP (API Enable) 191 I/O settings commands 192

D0 (DIO0/AD0) 192

D1 (DIO1/AD1) 192

D2 (DIO2/AD2) 193

D3 (DIO3/AD3) 193

D4 (DIO4) 193

D5 (DIO5/ASSOCIATED_INDICATOR) 194

D6 (DIO6/RTS) 194

D7 (DIO7/CTS) 195

D8 (DIO8/SLEEP_REQUEST) 195

D9 (DIO9/ON_SLEEP) 196

P0 (DIO10/PWM0 Configuration) 196

P1 (DIO11/PWM1 Configuration) 196

P2 (DIO12 Configuration) 197

PD (Pull Direction) 197

PR (Pull-up/down Resistor Enable) 198

M0 (PWM0 Duty Cycle) 199

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

I/O sampling commands 200

TP (Temperature) 200

IS (Force Sample) 200 Sleep commands 202

SM (Sleep Mode) 202

SP (Sleep Period) 202

ST (Wake Time) 202

SO (Sleep Options) 203 Command mode options 204

CC (Command Sequence Character) 204

CT (Command Mode Timeout) 204

CN (Exit Command mode) 204

GT (Guard Times) 204 MicroPython commands 206

PS (Python Startup) 206

PY (MicroPython Command) 206 Firmware version/information commands 208

VR (Firmware Version) 208

VL (Verbose Firmware Version) 208

HV (Hardware Version) 208

HS (Hardware Series) 208

CK (Configuration CRC) 208

AI (Association Indication) 209

FI(FTP OTA Update Indication) 209

FO (FTP OTA command) 210 Diagnostic interface commands 212

DI (Remote Manager Indicator) 212

CI (Protocol/Connection Indication) 212

AS (Active scan for network environment data) 214 Execution commands 216

NR (Network Reset) 216

!R (Modem Reset) 216 File system commands 217

Error responses 217

ATFS (File System) 217

ATFS PWD 217

ATFS CDdirectory 217

ATFS MDdirectory 217

ATFS LS [directory] 217

ATFS PUTfilename 218

ATFS XPUTfilename 218

ATFS HASHfilename 218

ATFS GETfilename 218

ATFS MVsource_pathdest_path 218

ATFS RMfile_or_directory 218

ATFS INFO 218

ATFSFORMAT confirm 219 Remote Manager commands 220

MO (Remote Manager Options) 220

DF (Remote Manager Status Check Interval) 220

EQ (Remote Manager FQDN) 220

K1 (Remote Manager Server Send Keepalive) 220

K2 (Remote Manager Device Send Keepalive) 221

$D (Remote Manager certificate) 221

ER (Remote Manager TCP Port Override) 221

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

ES (Remote Manager UDP Port Override) 222

MT (Remote Manager Idle Timeout) 222 System commands 223

KL (Device Location) 223

KC (Contact Information) 223

KP (Device Description) 223 Socket commands 224

SI (Socket Info) 224

Operate in API mode

API mode overview 227 Use the AP command to set the operation mode 227 API frame format 227

API operation (AP parameter = 1) 227

API operation with escaped characters (AP parameter = 2) 228

API frames

AT Command - 0x08 232 AT Command: Queue Parameter Value - 0x09 233 Transmit (TX) SMS - 0x1F 234 Transmit (TX) Request: IPv4 - 0x20 235 Tx Request with TLS Profile - 0x23 237 AT Command Response - 0x88 239 Transmit (TX) Status - 0x89 240 Modem Status - 0x8A 242 Receive (RX) Packet: SMS - 0x9F 243 Receive (RX) Packet: IPv4 - 0xB0 244 User Data Relay - 0x2D 245

Example use cases 245 User Data Relay Output - 0xAD 246 FW Update - 0x2B 247 FW Update Response - 0xAB 248 Socket Create - 0x40 249 Socket Create Response - 0xC0 250 Socket Option Request - 0x41 251 Socket Option Response - 0xC1 252 Socket Connect - 0x42 253 Socket Connect Response - 0xC2 254 Socket Close - 0x43 255 Socket Close Response - 0xC3 256 Socket Send (Transmit) - 0x44 257 Socket SendTo (Transmit Explicit Data): IPv4 - 0x45 258 Socket Bind/Listen - 0x46 259 Socket Listen Response - 0xC6 260 Socket New IPv4 Client - 0xCC 261 Socket Receive - 0xCD 262 Socket Receive From: IPv4 - 0xCE 263 Socket Status - 0xCF 264

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

File system APIframes

Local File System Request - 0x3B 266

File Open - 0x01 268

File Close - 0x02 269

File Read - 0x03 270

File Write - 0x04 271

File Hash - 0x08 272

Directory Create - 0x10 273

Directory Open - 0x11 274

Directory Close - 0x12 276

Directory Read - 0x13 277

Get Path ID - 0x1C 278

Rename - 0x21 280

Delete - 0x2F 281

Volume Info - 0x40 282

Volume Format - 0x4F 283 Local File System Response - 0xBB 284

Troubleshooting

Cannot find the serial port for the device 287

Condition 287

Solution 287

Other possible issues 288

Enable Virtual COM port (VCP) on the driver 288 Correct a macOS Java error 289

Condition 289

Solution 289 Unresponsive cellular component in Bypass mode 290

Condition 290

Solution 290 Not on expected network after APN change 291

Condition 291

Solution 291 Syntax error at line 1 291

Solution 291 Error Failed to send SMS 291

Solution 291

Regulatory information

Modification statement 293 Interference statement 293 FCC notices 293 FCC Class B digital device notice 293 Labeling requirements for the host device 294 FCC publication 996369 related information 294

2.1 General 294

2.2 List of applicable FCC rules 294

2.3 Summarize the specific operational use conditions 295

2.4 Limited module procedures 295

2.5 Trace antenna designs 295

2.6 RF exposure considerations 295

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

2.7 Antennas 295

2.8 Label and compliance information 295

2.9 Information on test modes and additional testing requirements 295

2.10 Additional testing, Part 15 Subpart B disclaimer 295

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.

You can read some frequently asked questions here.

Applicable firmware and hardware

This manual supports the following firmware:

n 100A 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:

n XBC-V1-UT-xxx

SIM cards

If you order the wrong type of SIM card it will not work with the XBee Cellular Modem.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide Cellular service

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/IoT are available from:

Phone

National distributor Network Contact

number Email

Reliance Communications

Ingram Micro - Sales

Ice Mobility

KORE

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:

n By phone: 1-877-890-4014 (USA/toll free) or +1-952-912-3456 (International). Select the

Wireless Plan Support or Activation option in the menu.

n By email: Data.Plan.QuoteDesk@digi.com.

Verizon direct

Verizon MVNO

Raja Ali 917-517-

7282

Lesli Reeves 317-707-

2371

Steve Kreiger 317-707-

2474

Tom Puchala 847-876-

1768

Genesis Crowder

Mike Basso 877-710-

877-7105673

5673

raja.ali@reliance.us

lesli.reeves@ingrammicro.com

steve.kreiger@ingrammicro.com

tom.puchala@icemobility.com

gcrowder@korewireless.com

mbasso@korewireless.com

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.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

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:

n Connect to the Echo server

n Connect to the ELIZA server

n Connect 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.

n Example: hello world

n Example: turn on an LED

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Get started with the XBee Cellular Modem Identify the kit contents

Identify the kit contents

The Developer's kit includes the following:

One XBIB-U-DEV board

One 12 V power supply

Two cellular antennas with U.FL connectors

One USB cable

One XBee Cellular Modem

Note The XBee Cellular Modem comes

attached to the board in ESDwrap.

One SIMcard

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Get started with the XBee Cellular Modem Connect the hardware

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!

3. Connect the antennas to the XBee Cellular Modem. 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.

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.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Get started with the XBee Cellular Modem Install and upgrade XCTU

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, and if needed, XCTU will attempt to update your cellular firmware. Firmware is the program code stored in the device's persistent memory that provides the control program for the 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.

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.

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.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Get started with the XBee Cellular Modem Update the device and cellular firmware using XCTU

Update the device and cellular 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. XCTU will update the device firmware, and if needed, XCTU will attempt to update your cellular firmware.

Update the device and cellular firmware using XCTU.

Check for cellular registration and connection

The cellular network registration and address assignment must occur successfully. To verify the network connection, you can view the LED on the development board or check the status of the relevant commands in XCTU.

Registration can take several minutes.

Before you begin

n Make sure you have added the device to XCTU. See Add a device to XCTU.

n Make sure you are in an area with adequate cellular network reception.

n Verify that the antennas are connected properly to the device.

View LED action

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.

View commands in SCTU

Launch XCTU .

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. Verify the status of your network connection using the following commands:

n AI (Association Indication) reads 0 when the device successfully registers to the

cellular network and the LED is blinking. If it reads 23 it is connecting to the Internet; 22 means it is registering to the cellular network.

n MY (Module IP Address) should display a valid IPaddress. If it reads 0.0.0.0, it has not

registered yet.

Hints

To search for an ATcommand in XCTU, use the search box .

To read a command's value, click the Read button next to the command.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

XBee connection examples

The following examples provide some additional scenarios you can try to get familiar with the XBee. These examples are focused on inter-operating with a host processor to drive the XBee.

If you are interested in using the intelligence built into the XBee, see Get started with MicroPython.

Note Some carriers restrict your internet access. If access is restricted, running some of these

examples may not be possible. Check with your carrier provider to determine whether internet access is restricted.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

XBee connection examples Connect to the Echo server

Connect to the Echo server

This server echoes back the messages you type.

Note For help with debugging, see Debugging.

The following table explains the AT commands that you use in this example.

At command Value Description

IP (IP

Protocol)

(Text

Delimiter)

(Destination Address)

(Destination Port)

1 Set the expected

transmission mode to TCP communications.

D (0x0D)

52.43.121.77 The target IPaddress of

2329 (0x2329) The target port number of

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 0 to disable text delimiter checking. Set to D for a carriage return.

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 Add a device to XCTU.

Click the Configuration working mode button.

4. Select a device from the Radio Modules list. XCTU displays the current firmware settings for

that device.

To switch to TCP communication, in the IP field, select 1 and click the Write button .

6. To enable the XBee to recognize carriage return as a message delimiter, in the TD field, type D

and click the Write button.

7. To enter the destination address of the echo server, 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 2329 and click the Write button.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

XBee connection examples Connect to the Echo server

Note XCTU does not follow the standard hexadecimal numbering convention. The leading 0x is

not needed in XCTU.

Click the Consoles working mode button on the toolbar to open a serial console to the device. For instructions on using the Console, see the AT console topic in the XCTU User Guide.

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 echo server. The following screenshot provides an example of this chat.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

XBee connection examples Connect to the ELIZA server

Connect to the ELIZA server

You can use the XBee to chat with the ELIZA Therapist Bot. ELIZAis an artificial intelligence (AI) bot that emulates a therapist and can perform simple conversations.

Note For help with debugging, see Debugging.

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)

DE (Destination Port)

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 Add a device to XCTU.

Click the Configuration working mode button.

4. Select a device from the Radio Modules list. XCTU displays the current firmware settings for that device.

To switch to TCP communication, in the IP field, select 1 and click the Write button .

6. To enter the destination address of the ELIZATherapist Bot, in the DL field, type 52.43.121.77 and click the Write button.

7. To enter the destination IP port number, in the DE field, type 2328 and click the Write button.

Click the Consoles working mode button on the toolbar to open a serial console to the device. For instructions on using the Console, see the AT console topic in the XCTU User Guide.

52.43.121.77 The target IP address of the ELIZA server.

2328 (0x2328) The target port number of

the ELIZA server.

Click the Open button to open a serial connection to the device.

10. 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 with the user's text in blue.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

XBee connection examples Connect to the ELIZA server

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

XBee connection examples Connect to the Daytime server

Connect to the Daytime server

The Daytime server reports the current Coordinated Universal Time (UTC) value responding to any user input.

Note For help with debugging, see Debugging.

The following table explains the AT commands that you use in this example.

At command Value Description

IP (IP

Protocol)

(Destination Address)

(Destination Port)

TD (Text Delimiter)

To communicate with the Daytime 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 Add a device to XCTU.

1 Set the expected transmission

mode to TCP communications.

52.43.121.77 The target IP of the Daytime server.

232A (0x232A) The target port number of the

Daytime server.

Click the Configuration working mode button.

4. Select a device from the Radio Modules list. XCTU displays the current firmware settings for that device.

To switch to TCP communication, in the IP field, select 1 and click the Write button .

6. To enter the destination address of the daytime server, in the DL field, type 52.43.121.77 and click the Write button.

7. To enter the destination IP port number, in the DE field, type 232A and click the Write button.

8. To disable text delimiter checking, in the TD field, type 0 and click the Write button.

Click the Consoles working mode button on the toolbar to open a serial console to the device. For instructions on using the Console, see the AT console topic in the XCTU User Guide.

10.

Click the Open button to open a serial connection to the device.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

XBee connection examples Connect to the Daytime server

11. Click in the left pane of the Console log, then type in the Console to query the Daytime server. The following screenshot provides an example of this chat.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

XBee connection examples Send an SMS message to a phone

Send an SMS message to a phone

The XBee Cellular Modem can send and receive Short Message Service (SMS) transmissions (text messages) 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.

Note For help with debugging, see Debugging.

The following table explains the AT commands that you use in this example.

Command Value Description

AP (APIEnable)

IP (IP Protocol)

(DestinationPhone Number)

TD (Text Delimiter)

PH (Module's SIM

phone number)

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 Add a device to XCTU.

Click the Configuration working mode button.

4. Select a device from the Radio Modules list. XCTU displays the current firmware settings for that device.

0 Set the device's API mode to Transparent mode.

2 Set the expected transmission mode to SMScommunication.

D (0x0D)

Read only

The target phone number that you send to, for example, your cellular phone. See P# (Destination Phone Number) for instructions on using this command.

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.

To switch to SMS communication, in the IP field, select 2 and click the Write button .

6. 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.

7. In the TD field, type D and click the Write button.

8. 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.

Click the Consoles working mode button on the toolbar to open a serial console to the device. For instructions on using the Console, see the AT console topic in the XCTU User Guide.

10.

Click the Open button to open a serial connection to the device.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

XBee connection examples Send an SMS message to a phone

11. 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.

Note If you are receiving individual characters, verify that you set TD correctly.

12. 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.

13. On the phone, reply with the text connect with confidence and the XBee Cellular Modem outputs this reply from the UART.

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

+ 265 hidden pages

Digi LTE Cat User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

Applicable firmware and hardware

SIM cards

Cellular service

Get started with the XBee Cellular Modem

Identify the kit contents

Connect the hardware

Install and upgrade XCTU

Add a device to XCTU

Update the device and cellular firmware using XCTU

Check for cellular registration and connection

XBee connection examples

Connect to the Echo server

Connect to the ELIZA server

Connect to the Daytime server

Send an SMS message to a phone