Digi XBee Cellular 3G Global Manual de usuario

Digi XBee® Cellular 3G Global

Embedded Modem

User Guide

Revision history—90001541

Revision Date Description

K April 2019 Added information for Digi Remote Manager®

L June 2019 Added information for Clean shutdown and securing the connection

between and XBee and Remote Manager. Added FCC publication 996369

related information.

M July 2019 Added socket information.

Additional edits.

N September

2019

Added firmware update information.

P February

2020

Reorganized device and cellular firmware update information.

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

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)

Digi XBee Cellular 3G Global Embedded Modem User Guide 2

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

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 L) in the subject line of your email.

Digi XBee Cellular 3G Global Embedded Modem User Guide 3

Contents

Digi XBee Cellular 3G Global Embedded Modem User Guide

Applicable firmware and hardware 14

SIM cards 14

Cellular service 15

Get started with the XBee Cellular Modem

Identify the kit contents 17

Connect the hardware 18

Install and upgrade XCTU 19

Add a device to XCTU 19

Update the device firmware using XCTU 20

Check for cellular registration and connection 20

XBee connection examples

Connect to the Echo server 22

Connect to the ELIZA server 23

Connect to the Daytime server 24

Perform a (GET) HTTP request 26

Connect to a TCP/IP address 27

Debugging 27

Software libraries 28

Get started with Digi Remote Manager

Create a Remote Manager account and add devices 29

Create a Remote Manager account 30

Add an XBee Cellular Modem to Remote Manager 30

Verify the connection between a device and Remote Manager 31

Configure Remote Manager features by scheduling tasks 31

Overview: Create a schedule for a set of tasks 31

Examples 32

Example: Read settings and state using Remote Manager 32

Example: Configure a device from Remote Manager using XML 33

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

Example: Update MicroPython from Remote Manager using XML 35

Manage data in Remote Manager 39

Review device status information from Remote Manager 39

Digi XBee Cellular 3G Global Embedded Modem User Guide 4

Digi XBee Cellular 3G Global Embedded Modem User Guide 5

Manage secure files in Remote Manager 40

Remote Manager reference 41

Enable SM/UDP 41

TCP connection 41

Disconnect 43

Configure XBee settings within Remote Manager 43

Examples: IOT protocols with transparent mode

Get started with CoAP 46

CoAP terms 46

CoAP quick start example 46

Configure the device 47

Example: manually perform a CoAPrequest 47

Example: use Python to generate a CoAP message 48

Get started with MQTT 50

Example: MQTT connect 50

Send a connect packet 52

Example: send messages (publish) with MQTT 53

Example: receive messages (subscribe) with MQTT 54

Use MQTT over the XBee Cellular Modem with a PC 55

Get started with MicroPython

About MicroPython 60

Why use MicroPython 60

MicroPython on the XBee Cellular Modem 60

Use XCTU to enter the MicroPython environment 60

Use the MicroPython Terminal in XCTU 61

Troubleshooting 61

Example: hello world 61

Example: turn on an LED 61

Example: debug the secondary UART 62

Exit MicroPython mode 63

Other terminal programs 63

Tera Term for Windows 64

Use picocom in Linux 65

Update the firmware

Create a plan for device component firmware updates 68

Update the device firmware 69

Update the device firmware using XCTU 69

Update the firmware from the Devices page in Remote Manager 69

Update the firmware using web services in Remote Manager 70

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

Technical specifications

Interface and hardware specifications 76

RF characteristics 76

Networking specifications 76

Power requirements 77

Digi XBee Cellular 3G Global Embedded Modem User Guide 6

Power consumption 77

Electrical specifications 77

Regulatory approvals 78

Hardware

Mechanical drawings 81

Pin signals 81

Pin connection recommendations 83

RSSI PWM 83

SIM card 83

Associate LED functionality 83

Development boards 85

XBIB-U-DEV reference 85

XBIB-CU-TH reference 87

XBIB-C-GPS reference 90

Interface with the XBIB-C-GPS module 91

Antenna recommendations

Antenna placement 93

Design recommendations

Power supply considerations 95

Add a capacitor to the RESET line 95

Heat considerations 95

Add a fan to provide active cooling 96

Custom configuration: Create a new factory default 96

Set a custom configuration 97

Clear all custom configurations on a device 97

Clean shutdown 97

SD (Shutdown) command 97

Sleep feature 98

Airplane mode 98

Cellular connection process

Connecting 100

Cellular network 100

Data network connection 100

Data communication with remote servers (TCP/UDP) 100

Disconnecting 100

Modes

Select an operating mode 103

Transparent operating mode 104

API operating mode 104

Bypass operating mode (DEPRECATED) 104

Enter Bypass operating mode 105

Leave Bypass operating mode 105

Digi XBee Cellular 3G Global Embedded Modem User Guide 7

Restore cellular settings to default in Bypass operating mode 105

Command mode 105

Enter Command mode 105

Troubleshooting 106

Send AT commands 106

Response to AT commands 107

Apply command changes 107

Make command changes permanent 107

Exit Command mode 107

MicroPython mode 107

Sleep modes

About sleep modes 110

Normal mode 110

Pin sleep mode 110

Cyclic sleep mode 110

Cyclic sleep with pin wake up mode 110

Airplane mode 110

The sleep timer 110

MicroPython sleep behavior 111

Serial communication

Serial interface 113

Serial data 113

UART data flow 113

Serial buffers 114

CTS flow control 114

RTS flow control 114

SPI operation

SPI communications 116

Full duplex operation 117

Low power operation 118

Select the SPI port 118

Force UART operation 119

Data format 119

File system

Overview of the file system 121

Directory structure 121

Paths 121

Secure files 121

XCTU interface 122

Encrypt files 122

SMS behaviors

SMS encoding 123

Digi XBee Cellular 3G Global Embedded Modem User Guide 8

Socket behavior

Supported sockets 125

Best practices when using sockets 125

Sockets and Remote Manager 125

Sockets and API mode 125

Socket timeouts 125

Socket limits in API mode 125

Enable incoming TCP sockets in API mode 126

API mode behavior for outgoing TCP and TLS connections 126

API mode behavior for outgoing UDP data 126

API mode behavior for incoming TCP connections 127

API mode behavior for incoming UDP data 127

Transparent mode behavior for outgoing TCP and TLS connections 128

Transparent mode behavior for outgoing UDP data 128

Transparent mode behavior for incoming TCP connections 128

Transparent mode behavior for incoming UDP connections 129

Extended Socket frames

Examples 130

Available Extended Socket frames 131

Extended Socket example: Single HTTP Connection 131

Send a Socket Create frame 131

Receive a Socket Create response 132

Send Socket Connect 132

Receive a Socket Connect Response 132

Receive a Socket Status 133

Send HTTP Request using Socket Send frame 133

Receive TX Status 134

Receive one or more Receive Data frames 134

Receive Socket Status indicating closed connection 135

Extended Socket example: UDP 135

Send a Socket Create frame 135

Receive a Socket Create response 136

Bind local source addres 136

Receive Bind/Listen Response 136

Send to Digi echo server 137

Receive TX Status 137

Receive echoed data 137

Send to Digi time server 138

Receive TX Status 138

Receive daytime value 138

Close the socket 139

Receive close response 139

Extended Socket example: TCPListener 140

Send a Socket Create frame 140

Receive a Socket Create response 140

Designate the socket as a listener 140

Receive a Socket Bind/Listen Response 141

Making a connection to the listener socket 141

Receiving Data from the new socket 142

Receive a Socket Status indicating closed connection 142

Digi XBee Cellular 3G Global Embedded Modem User Guide 9

Transport Layer Security (TLS)

Specifying TLS keys and certificates 145

Transparent mode and TLS 146

API mode and TLS 146

Key formats 146

Certificate formats 146

Certificate limitations 146

Cipher suites 146

Server Name Indication (SNI) 147

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

Step 1: Get the certificate 147

Step 2: Configure device 147

Step 3: Verify that authentication is being performed 148

AT commands

Special commands 150

AC (Apply Changes) 150

FR (Force Reset) 150

RE (Restore Defaults) 150

SD (Shutdown) 151

WR (Write) 151

Cellular commands 152

PH (Phone Number) 152

S# (ICCID) 152

IM (IMEI) 152

II (Subscriber identity) 152

MN (Operator) 152

MV (Modem Firmware Version) 153

DB (Cellular Signal Strength) 153

DT (Cellular Network Time) 153

AN (Access Point Name) 154

AM (Airplane Mode) 154

PN (SIMPIN) 154

PK (SIMPUK) 154

CU (Cellular user name) 155

CW (Cellular password) 155

Network commands 156

IP (IP Protocol) 156

TL (TLS Protocol Version) 156

$0 (TLS Profile 0) 156

$1 (TLS Profile 1) 157

$2 (TLS Profile 2) 157

TM (IP Client Connection Timeout) 157

TS (IP Server Connection Timeout) 158

DO (Device Options) 158

Addressing commands 160

SH (Serial Number High) 160

SL (Serial Number Low) 160

MY (Module IP Address) 160

P# (Destination Phone Number) 160

N1 (DNS Address) 161

N2 (DNS Address) 161

Digi XBee Cellular 3G Global Embedded Modem User Guide 10

DL (Destination Address) 161

OD (Operating Destination Address) 161

DE (Destination port) 162

C0 (Source Port) 162

LA (Lookup IP Address of FQDN) 162

Serial interfacing commands 163

BD (Baud Rate) 163

NB (Parity) 163

SB (Stop Bits) 164

RO (Packetization Timeout) 164

TD (Text Delimiter) 164

FT (Flow Control Threshold) 164

AP (API Enable) 165

I/O settings commands 166

D0 (DIO0/AD0) 166

D1 (DIO1/AD1) 166

D2 (DIO2/AD2) 167

D3 (DIO3/AD3) 167

D4 (DIO4) 167

D5 (DIO5/ASSOCIATED_INDICATOR) 168

D6 (DIO6/RTS) 168

D7 (DIO7/CTS) 169

D8 (DIO8/SLEEP_REQUEST) 169

D9 (DIO9/ON_SLEEP) 170

P0 (DIO10/PWM0 Configuration) 170

P1 (DIO11/PWM1 Configuration) 170

P2 (DIO12 Configuration) 171

PD (Pull Direction) 171

PR (Pull-up/down Resistor Enable) 172

M0 (PWM0 Duty Cycle) 173

I/O sampling commands 174

TP (Temperature) 174

IS (Force Sample) 174

Sleep commands 176

SM (Sleep Mode) 176

SP (Sleep Period) 176

ST (Wake Time) 176

Command mode options 177

CC (Command Sequence Character) 177

CT (Command Mode Timeout) 177

CN (Exit Command mode) 177

GT (Guard Times) 177

MicroPython commands 179

PS (Python Startup) 179

PY (MicroPython Command) 179

Firmware version/information commands 181

VR (Firmware Version) 181

VL (Verbose Firmware Version) 181

HV (Hardware Version) 181

AI (Association Indication) 181

HS (Hardware Series) 182

CK (Configuration CRC) 182

Diagnostic interface commands 183

DI (Remote Manager Indicator) 183

CI (Protocol/Connection Indication) 183

Otros manuales para XBee Cellular 3G Global

Tabla de contenidos

Otros manuales de Módem de Digi

Digi

Digi XStream-PKG-E X09-001PK E Series Manual de usuario

Digi

Digi XBee Cellular 3G Global Manual de usuario

Digi

Digi Digi XBee SX Manual de usuario

Digi

Digi MF710M Manual de usuario

Digi

Digi XTP9B-PKC-UA Manual de usuario

Digi

Digi XBee-PRO XSC RF Modem Manual de usuario

Digi

Digi XBee3 DigiMesh 2.4 Manual de usuario

Digi

Digi XStream-PKG-R RS-232 Manual de usuario

Digi

Digi WAN 3G Manual de usuario

Digi

Digi XBee-PRO XM-M92-2P Series Manual de usuario

Digi

Digi XStream-PKG Guía del usuario

Digi

Digi XBee-PRO XSC RS-232 Manual de usuario

Digi

Digi E230 Manual de usuario

Digi

Digi XTend-PKG Manual de usuario

Digi

Digi Connect WAN 3G IA Manual de usuario

Digi

Digi TransPort WR11 Manual de usuario

Digi

Digi Rapidport Manual de usuario

Digi

Digi 9XTend-PKG-U Manual de usuario

Digi

Digi XBee 3 Cellular LTE-M Manual de usuario

Digi

Digi 9XTend-PKG-R RS-232 Manual de usuario

Digi

Digi 9XTend-PKG-R RS-232 Manual de usuario

Digi

Digi XStream-PKG-U Manual de usuario

Digi

Digi XBee3 Cellular LTE Cat 1 Manual de usuario

Digi

Digi XBee Cellular LTE Cat 1 Manual de usuario

Manuales populares de Módem de otras marcas

Davicom

Davicom DM562AP Manual de usuario

EpiValley

EpiValley TATA indicom SXC-1080 Manual de usuario

Zte

Zte WiMAX Manual de usuario

Intelimax

Intelimax MA-2060 Manual de usuario

SMC Networks

SMC Networks D3CM1604V Manual de uso y cuidado

Telstra

Telstra Wi-Fi 4G Advanced Pro X Manual de usuario

Thrane&Thrane

Thrane&Thrane imarsat EXPLORER 300 Manual de usuario

Samsung

Samsung AceLink SAM-335A Manual de usuario

Enfora

Enfora Enabler-G Guía de configuración rápida

iRZ

iRZ ATM2-232 Manual de usuario

Zhone

Zhone 6310 Manual de usuario

Paradyne

Paradyne Hotwire 7976 Manual de usuario

US Robotics

US Robotics 3453C Manual de usuario

MaxTech

MaxTech Plug & Play Internal Voice/FAX/Data/SVD... Manual de usuario

Zte

Zte MF823 Manual de usuario

Four-Faith

Four-Faith F1403 Manual de usuario

Sierra Wireless

Sierra Wireless AIRLINK MP595W Manual de usuario

Gemtek

Gemtek WiMAX WIXFBR-103 Manual de usuario