Digi XBee Cellular 3G Global User Manual

Digi XBee® Cellular 3G Global

Embedded Modem

User Guide

Revision history—90001541

Revision Date Description

P February 2020 Reorganized device and cellular firmware update information.

R September 2020

S October 2020

T November 2020

U January 2021

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 MU (Modem firmware revision number)

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.

Added Regulatory Firmware documentation. 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:

Digi XBee Cellular 3G Global Embedded Modem User Guide

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)

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 3G Global Embedded Modem User Guide, 90001541 R) in the subject line of your email.

Digi XBee Cellular 3G Global Embedded Modem User Guide

Contents

Digi XBee Cellular 3G Global 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 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 24 Connect to the Daytime server 25 Perform a (GET) HTTP request 27 Connect to a TCP/IP address 28 Debugging 29 Software libraries 29

Get started with Digi Remote Manager

Create a Remote Manager account and add devices 30

Create a Remote Manager account 31

Add an XBee Cellular Modem to Remote Manager 31

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

Overview: Create a schedule for a set of tasks 32

Examples 33

Example: Read settings and state using Remote Manager 33

Example: Configure a device from Remote Manager using XML 34

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

Example: Update MicroPython from Remote Manager using XML 36 Manage data in Remote Manager 40

Review device status information from Remote Manager 40

Digi XBee Cellular 3G Global Embedded Modem User Guide

Manage secure files in Remote Manager 41 Remote Manager reference 42

Enable SM/UDP 42

TCP connection 42

Disconnect 44

Configure XBee settings within Remote Manager 44

Examples: IOT protocols with transparent mode

Get started with CoAP 47

CoAP terms 47

CoAP quick start example 47

Configure the device 48

Example: manually perform a CoAPrequest 48

Example: use Python to generate a CoAP message 49 Get started with MQTT 51

Example: MQTT connect 51

Send a connect packet 53

Example: send messages (publish) with MQTT 54

Example: receive messages (subscribe) with MQTT 55

Use MQTT over the XBee Cellular Modem with a PC 56

Get started with MicroPython

About MicroPython 61

Why use MicroPython 61 MicroPython on the XBee Cellular Modem 61 Use XCTU to enter the MicroPython environment 61 Use the MicroPython Terminal in XCTU 62

Troubleshooting 62 Example: hello world 62 Example: turn on an LED 62 Example: debug the secondary UART 63 Exit MicroPython mode 64 Other terminal programs 64

Tera Term for Windows 65 Use picocom in Linux 66

Update the firmware

Create a plan for device component firmware updates 69 Update the device firmware 70

Update the device firmware using XCTU 70

Update the firmware from the Devices page in Remote Manager 71

Update the firmware using web services in Remote Manager 71

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

Technical specifications

Interface and hardware specifications 77 RF characteristics 77 Networking specifications 77 Power requirements 79

Digi XBee Cellular 3G Global Embedded Modem User Guide

Power consumption 79 Electrical specifications 80 Regulatory approvals 81

Hardware

Mechanical drawings 83 Pin signals 83

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

XBIB-U-DEV reference 87

XBIB-CU-TH reference 89

XBIB-C-GPS reference 92

Interface with the XBIB-C-GPS module 93

Antenna recommendations

Antenna placement 95

Design recommendations

Power supply considerations 97 Add a capacitor to the RESET line 97 Heat considerations 97

Add a fan to provide active cooling 98 Custom configuration: Create a new factory default 98

Set a custom configuration 99

Clear all custom configurations on a device 99 Clean shutdown 99

SD (Shutdown) command 99

Sleep feature 100

Airplane mode 100 SIMcards 100

Cellular connection process

Connecting 102

Cellular network 102

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

Modes

Select an operating mode 105 Transparent operating mode 106 API operating mode 106 Bypass operating mode (DEPRECATED) 106

Digi XBee Cellular 3G Global Embedded Modem User Guide

Enter Bypass operating mode 107

Leave Bypass operating mode 107

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

Enter Command mode 107

Troubleshooting 108

Send AT commands 108

Response to AT commands 109

Apply command changes 109

Make command changes permanent 109

Exit Command mode 109 MicroPython mode 109

Sleep modes

About sleep modes 112 Normal mode 112 Pin sleep mode 112 Cyclic sleep mode 112 Cyclic sleep with pin wake up mode 112 Airplane mode 112 The sleep timer 112 MicroPython sleep behavior 113

Serial communication

Serial interface 115 Serial data 115 UART data flow 115 Serial buffers 116 CTS flow control 116 RTS flow control 116

SPI operation

SPI communications 118 Full duplex operation 119 Low power operation 120 Select the SPI port 120 Force UART operation 121 Data format 121

File system

Overview of the file system 123

Directory structure 123

Paths 123

Secure files 123 XCTU interface 124 Encrypt files 124

Digi XBee Cellular 3G Global Embedded Modem User Guide

SMS behaviors

SMS encoding 125

Socket behavior

Supported sockets 127 Best practices when using sockets 127

Sockets and Remote Manager 127

Sockets and API mode 127 Socket timeouts 127 Socket limits in API mode 127 Enable incoming TCP sockets in API mode 128 API mode behavior for outgoing TCP and TLS connections 128 API mode behavior for outgoing UDP data 128 API mode behavior for incoming TCP connections 129 API mode behavior for incoming UDP data 129 Transparent mode behavior for outgoing TCP and TLS connections 130 Transparent mode behavior for outgoing UDP data 130 Transparent mode behavior for incoming TCP connections 130 Transparent mode behavior for incoming UDP connections 131

Extended Socket frames

Examples 132 Available Extended Socket frames 133 Extended Socket example: Single HTTP Connection 133

Send a Socket Create frame 133

Receive a Socket Create response 134

Send Socket Connect 134

Receive a Socket Connect Response 134

Receive a Socket Status 135

Send HTTP Request using Socket Send frame 135

Receive TX Status 136

Receive one or more Receive Data frames 136

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

Send a Socket Create frame 137

Receive a Socket Create response 138

Bind local source addres 138

Receive Bind/Listen Response 138

Send to Digi echo server 139

Receive TX Status 139

Receive echoed data 139

Send to Digi time server 140

Receive TX Status 140

Receive daytime value 140

Close the socket 141

Receive close response 141 Extended Socket example: TCPListener 142

Send a Socket Create frame 142

Receive a Socket Create response 142

Designate the socket as a listener 142

Receive a Socket Bind/Listen Response 143

Digi XBee Cellular 3G Global Embedded Modem User Guide

Making a connection to the listener socket 143

Receiving Data from the new socket 144

Receive a Socket Status indicating closed connection 144

Transport Layer Security (TLS)

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

Step 1: Get the certificate 149

Step 2: Configure device 149

Step 3: Verify that authentication is being performed 150

AT commands

Special commands 152

AC (Apply Changes) 152

FR (Force Reset) 152

RE (Restore Defaults) 152

SD (Shutdown) 153

WR (Write) 153 Cellular commands 154

PH (Phone Number) 154

S# (ICCID) 154

IM (IMEI) 154

II (Subscriber identity) 154

MN (Operator) 154

MV (Modem Firmware Version) 155

MU (Modem firmware revision number) 155

DB (Cellular Signal Strength) 155

DT (Cellular Network Time) 155

AN (Access Point Name) 156

AM (Airplane Mode) 156

PN (SIMPIN) 156

PK (SIMPUK) 157

CU (Cellular user name) 157

CW (Cellular password) 157 Network commands 158

IP (IP Protocol) 158

TL (TLS Protocol Version) 158

$0 (TLS Profile 0) 158

$1 (TLS Profile 1) 159

$2 (TLS Profile 2) 159

TM (IP Client Connection Timeout) 159

TS (IP Server Connection Timeout) 160

DO (Device Options) 160

PG (Ping) 161 Addressing commands 162

Digi XBee Cellular 3G Global Embedded Modem User Guide

SH (Serial Number High) 162

SL (Serial Number Low) 162

MY (Module IP Address) 162

P# (Destination Phone Number) 162

N1 (DNS Address) 163

N2 (DNS Address) 163

DL (Destination Address) 163

OD (Operating Destination Address) 164

DE (Destination port) 164

C0 (Source Port) 164

LA (Lookup IP Address of FQDN) 165 Serial interfacing commands 166

BD (Baud Rate) 166

NB (Parity) 166

SB (Stop Bits) 167

RO (Packetization Timeout) 167

TD (Text Delimiter) 167

FT (Flow Control Threshold) 167

AP (API Enable) 168 I/O settings commands 169

D0 (DIO0/AD0) 169

D1 (DIO1/AD1) 169

D2 (DIO2/AD2) 170

D3 (DIO3/AD3) 170

D4 (DIO4) 170

D5 (DIO5/ASSOCIATED_INDICATOR) 171

D6 (DIO6/RTS) 171

D7 (DIO7/CTS) 172

D8 (DIO8/SLEEP_REQUEST) 172

D9 (DIO9/ON_SLEEP) 173

P0 (DIO10/PWM0 Configuration) 173

P1 (DIO11/PWM1 Configuration) 173

P2 (DIO12 Configuration) 174

PD (Pull Direction) 174

PR (Pull-up/down Resistor Enable) 175

M0 (PWM0 Duty Cycle) 176 I/O sampling commands 177

TP (Temperature) 177

IS (Force Sample) 177 Sleep commands 179

SM (Sleep Mode) 179

SP (Sleep Period) 179

ST (Wake Time) 179 Command mode options 180

CC (Command Sequence Character) 180

CT (Command Mode Timeout) 180

CN (Exit Command mode) 180

GT (Guard Times) 180 MicroPython commands 182

PS (Python Startup) 182

PY (MicroPython Command) 182 Firmware version/information commands 184

VR (Firmware Version) 184

VL (Verbose Firmware Version) 184

HV (Hardware Version) 184

Digi XBee Cellular 3G Global Embedded Modem User Guide

AI (Association Indication) 184

HS (Hardware Series) 185

CK (Configuration CRC) 185 Diagnostic interface commands 186

DI (Remote Manager Indicator) 186

CI (Protocol/Connection Indication) 186 Execution commands 189

NR (Network Reset) 189

!R (Modem Reset) 189 File system commands 190

Error responses 190

ATFS (File System) 190

ATFS PWD 190

ATFS CDdirectory 190

ATFS MDdirectory 190

ATFS LS [directory] 190

ATFS PUTfilename 191

ATFS XPUTfilename 191

ATFS HASHfilename 191

ATFS GETfilename 191

ATFS MVsource_pathdest_path 191

ATFS RMfile_or_directory 191

ATFS INFO 191

ATFSFORMAT confirm 192 Remote Manager commands 193

DF (Remote Manager Status Check Interval) 193

EQ (Remote Manager FQDN) 193

K1 (Remote Manager Server Send Keepalive) 193

K2 (Remote Manager Device Send Keepalive) 193

MO (Remote Manager Options) 194

$D (Remote Manager certificate) 194

ER (Remote Manager TCP Port Override) 194

ES (Remote Manager UDP Port Override) 195

MT (Remote Manager Idle Timeout) 195 System commands 196

KL (Device Location) 196

KC (Contact Information) 196

KP (Device Description) 196 Socket commands 197

SI (Socket Info) 197

Operate in API mode

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

API operation (AP parameter = 1) 200

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

API frames

AT Command - 0x08 205 AT Command: Queue Parameter Value - 0x09 206 Transmit (TX) SMS - 0x1F 207

Digi XBee Cellular 3G Global Embedded Modem User Guide

Transmit (TX) Request: IPv4 - 0x20 208 Tx Request with TLS Profile - 0x23 210 AT Command Response - 0x88 212 Transmit (TX) Status - 0x89 213 Modem Status - 0x8A 215 Receive (RX) Packet: SMS - 0x9F 216 Receive (RX) Packet: IPv4 - 0xB0 217 User Data Relay - 0x2D 218

Example use cases 218 User Data Relay Output - 0xAD 219 Socket Create - 0x40 220 Socket Create Response - 0xC0 221 Socket Option Request - 0x41 222 Socket Option Response - 0xC1 223 Socket Connect - 0x42 224 Socket Connect Response - 0xC2 225 Socket Close - 0x43 226 Socket Close Response - 0xC3 227 Socket Send (Transmit) - 0x44 228 Socket SendTo (Transmit Explicit Data): IPv4 - 0x45 229 Socket Bind/Listen - 0x46 230 Socket Listen Response - 0xC6 231 Socket New IPv4 Client - 0xCC 232 Socket Receive - 0xCD 233 Socket Receive From: IPv4 - 0xCE 234 Socket Status - 0xCF 235

File system APIframes

Local File System Request - 0x3B 237

File Open - 0x01 239

File Close - 0x02 240

File Read - 0x03 241

File Write - 0x04 242

File Hash - 0x08 243

Directory Create - 0x10 244

Directory Open - 0x11 245

Directory Close - 0x12 247

Directory Read - 0x13 248

Get Path ID - 0x1C 249

Rename - 0x21 251

Delete - 0x2F 252

Volume Info - 0x40 253

Volume Format - 0x4F 254 Local File System Response - 0xBB 255

Regulatory firmware

Install the regulatory firmware 257

Install regulatory firmware using XCTU 257

Install regulatory firmware using Remote Manager 258 Configure regulatory firmware for testing the cellular component 258 Regulatory testing commands 259

%# (Enable/disable test mode) 259

Digi XBee Cellular 3G Global Embedded Modem User Guide

%1 (Start test mode) 260

%2 (Stop test mode) 260

%5 (Start modulated transmit) 260

%6 (Stop transmit) 261

%7 (Set the EARFCN) 261

%8 (Get the EARFCN) 261

%9 (Set transmit power) 261

%A (Get transmit power) 262

%D (Start receive mode) 262

%? (Query test state) 262

Troubleshooting

Cannot find the serial port for the device 265

Condition 265

Solution 265

Other possible issues 266

Enable Virtual COM port (VCP) on the driver 266 Correct a macOS Java error 267

Condition 267

Solution 267 Unresponsive cellular component in Bypass mode 268

Condition 268

Solution 268 Not on expected network after APN change 269

Condition 269

Solution 269 Syntax error at line 1 269

Solution 269 Error Failed to send SMS 269

Solution 269

Regulatory information

Modification statement 271 Interference statement 271 FCC notices 271 FCC Class B digital device notice 271 FCC publication 996369 related information 272

2.1 General 272

2.2 List of applicable FCC rules 272

2.3 Summarize the specific operational use conditions 272

2.4 Limited module procedures 272

2.5 Trace antenna designs 272

2.6 RF exposure considerations 272

2.7 Antennas 272

2.8 Label and compliance information 273

2.9 Information on test modes and additional testing requirements 273

2.10 Additional testing, Part 15 Subpart B disclaimer 273

Antennas 273

FCC (USA) exposure notice 273

ISED (Canada) exposure notice 273 Labeling requirements for the host device 274 Europe (CE) 274

Digi XBee Cellular 3G Global Embedded Modem User Guide

Maximum power and frequency specifications 275

Declarations of conformity 275 ACMA (Australia) 275 RSM (New Zealand) 275

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:

n 113xx 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-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

Digi XBee Cellular 3G Global Embedded Modem User Guide Cellular service

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.

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 3G Global 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 3G Global 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

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

Digi XBee Cellular 3G Global 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!

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.

Digi XBee Cellular 3G Global 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. 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.

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 3G Global Embedded Modem User Guide

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

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

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 3G Global 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.

Connect to the Echo server 23 Connect to the ELIZA server 24 Connect to the Daytime server 25 Perform a (GET) HTTP request 27 Connect to a TCP/IP address 28 Debugging 29 Software libraries 29

Digi XBee Cellular 3G Global 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 3G Global Embedded Modem User Guide

XBee connection examples Connect to the ELIZA 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.

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

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.

52.43.121.77 The target IP address of the

2328 (0x2328) The target port number of

transmission mode to TCP communications.

ELIZA server.

the ELIZA server.

Digi XBee Cellular 3G Global Embedded Modem User Guide

XBee connection examples Connect to 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 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.

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.

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.

Digi XBee Cellular 3G Global Embedded Modem User Guide

XBee connection examples Connect to the Daytime server

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.

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 3G Global Embedded Modem User Guide

XBee connection examples Perform a (GET) HTTP request

Perform a (GET) HTTP request

You can use the XBee to perform a GET Hypertext Transfer Protocol (HTTP) request using XCTU. HTTP is an application-layer protocol that runs over TCP. This example uses httpbin.org/ as the target website that responds to the HTTP request.

Note For help with debugging, see Debugging.

To perform a GETrequest:

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.

5. To enter the destination address of the target website, in the DL field, type httpbin.org and

click the Write button .

6. To enter the HTTP request port number, in the DE field, type 50 and click the Write button. Hexadecimal 50 is 80 in decimal.

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

8. To move into Transparent mode, in the APfield, select 0 and click the Write button.

9. Wait for the AI (Association Indication) value to change to 0 (Connected to the Internet).

10.

Click the Consoles working mode button on the toolbar.

11.

From the AT console, click the Add new packet button in the Send packets dialog. The Add new packet dialog appears.

12. Enter the name of the data packet.

13. Type the following data in the ASCII input tab:

GET /ip HTTP/1.1

Digi XBee Cellular 3G Global Embedded Modem User Guide

XBee connection examples Connect to a TCP/IP address

Host: httpbin.org

14. Click the HEX input tab and add 0A (zero A) after each 0D (zero D), and add an additional 0D 0A at the end of the message body. For example, copy and past the following text into the HEX input tab:

47 45 54 20 2F 69 70 20 48 54 54 50 2F 31 2E 31 0D 0A 48 6F 73 74 3A 20 68 74 74 70 62 69 6E 2E 6F 72 67 0D 0A 0D 0A

Note The HTTP protocol requires an empty line (a line with nothing preceding the CRLF) to terminate

the request.

15. Click Add packet.

16.

Click the Open button .

17. Click Send selected packet.

18. A GETHTTP response from httpbin.org appears in the Console log.

Connect to a TCP/IP address

The XBee Cellular Modem can send and receive TCP messages while in Transparent mode; see

Transparent operating mode.

Note You can use this example as a template for sending and receiving data to or from any

TCP/IPserver.

Note For help with debugging, see Debugging.

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

Command Value Description

IP (IP

Protocol)

(Destination IPAddress)

(Destination Port)

To connect to a TCP/IP address:

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

The target IP address that you send and receive from. For example, a data logging server’s IP address that you want to send measurements to.

The target port number that the device sends the transmission to. This is represented as a hexadecimal value.

Click the Configuration working mode button.

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

Digi XBee Cellular 3G Global Embedded Modem User Guide

XBee connection examples Debugging

In the IP field, select 1 and click the Write button .

6. In the DL field, type the <target IP address> and click the Write button. The target IP address is the IPaddress that you send and receive from.

7. In the DE field, type the <target port number>, converted to hexadecimal, and click the Write button.

8. Exit Command mode.

After exiting Command mode, any UART data sent to the device is sent to the destination IP address and port number after the RO (Packetization Timeout) occurs.

Debugging

If you experience problems with the settings in the examples, you can load the default settings in XCTU.

Note If you load the default settings, you will need to reapply any configuration settings that you have

previously made.

On the Configuration toolbar, click the Default button to load the default values established by the firmware, and click Yes to confirm.

2. Factory settings are loaded but not written to the device. To write them, click the Write button

on the toolbar.

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:

n XBee Java library

n XBee Python library

n XBee ANSI C library

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.

The XBee Python Library is a Python API that dramatically reduces the time to market of XBee projects developed in Python and facilitates the development of these types of applications, making it an easy process.

The XBee ANSI C Library project is a collection of portable ANSI C code for communicating with the devices in API mode.

Digi XBee Cellular 3G Global Embedded Modem User Guide

Get started with Digi Remote Manager

Digi Remote Manager® is a cloud-based device and data management platform that you can use to configure and update a device, and view and manage device data.

The sections below describe how to create a Remote Manager account, upgrading your device, configure your device, and manage data in Remote Manager.

1. Create a Remote Manager account and add devices

2. To ensure that all Remote Manager features are available, you should upgrade your device to the latest firmware. See Update the firmware from the Devices page in Remote Manager or

Update the firmware using web services in Remote Manager.

3. Configure your device in Remote Manager

To be able to configure your device in Remote Manager, the device must be connected to Remote Manager. You can connect to and configure your device in Remote Manager using one of the following methods:

Scheduled connection: In this method, you create a list of tasks that you want to perform on the device, and then start the operation. This is the recommended method, and is the best choice for low data usage. See Configure Remote Manager features by

scheduling tasks.

Always connected: This method can be used for initial configuration, or when you are not concerned with low data usage. See Configure XBee settings within Remote

Manager.

4. Secure the connection between an XBee and Remote Manager with server authentication.

5. Manage data in Remote Manager

6. Remote Manager reference

Create a Remote Manager account and add devices

To be able to use Remote Manager, you must create a Remote Manager account and add your XBee devices to the device list. You should also verify that the device is enabled to connect to Remote Manager.

1. Create a Remote Manager account.

2. Add an XBee Cellular Modem to Remote Manager.

3. Verify the connection between a device and Remote Manager

Digi XBee Cellular 3G Global Embedded Modem User Guide

+ 245 hidden pages

Digi XBee Cellular 3G Global User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Digi XBee Cellular 3G Global 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 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

Perform a (GET) HTTP request

Connect to a TCP/IP address

Debugging

Software libraries

Get started with Digi Remote Manager

Create a Remote Manager account and add devices