Digi XBee3 XB3M1 Manuale utente

Digi XBee3® Cellular LTE-M/NB-IoT

Smart Modem

User Guide

Revision history—90002258

Revision Date Description

F November

2018

Added information for BLE

G February

2019

Added information for XBIB-C-TH and XBIB-C-GPS development boards

H April 2019 Added information for Digi Remote Manager®

I May 2019 Added information for Clean shutdown and securing the connection

between and XBee and Remote Manager.

J June 2019 Added FCC publication 996369 related information.

Added 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)

Logs (from time of reported issue)

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 2

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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem

User Guide, 90002258 I) in the subject line of your email.

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 3

Contents

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide

Applicable firmware and hardware 15

SIM cards 15

NB-IoT network 15

Get started with the XBee Smart Modem Development Kit

Identify the kit contents 17

Acquire a SIM card 18

UScustomers 18

European customers 18

Connect the hardware 19

XBIB-U-DEV reference 21

XBIB-CU-TH reference 23

XBIB-C-GPS reference 26

Interface with the XBIB-C-GPS module 27

I2C communication 28

UART communication 28

Run the MicroPython GPSdemo 28

Cellular service 29

Configure and update your XBee 30

Add a device 30

Update to the latest firmware from XCTU 31

Configure your module for cellular connectivity 31

Check for cellular registration and connection 33

Update an XBee module from A2.00 to A2.01 using APImode 34

Update an XBee module from A2.00 to A2.01 using FOTA 37

XBee bootloader 39

XBee connection examples

Connect to the Echo server 42

Connect to the ELIZA server 44

Connect to the Daytime server 46

Perform a (GET) HTTP request 48

Get started with CoAP 50

CoAP terms 50

CoAP quick start example 50

Configure the device 51

Example: manually perform a CoAPrequest 51

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 4

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 5

Example: use Python to generate a CoAP message 52

Connect to a TCP/IP address 54

Get started with MQTT 55

Example: MQTT connect 55

Send a connect packet 57

Example: send messages (publish) with MQTT 58

Example: receive messages (subscribe) with MQTT 59

Use MQTT over the XBee Cellular Modem with a PC 60

Debugging 63

Software libraries 63

Get started with MicroPython

About MicroPython 65

Why use MicroPython 65

MicroPython on the XBee Smart Modem 65

Use XCTU to enter the MicroPython environment 65

Use the MicroPython Terminal in XCTU 66

Troubleshooting 66

Example: hello world 66

Example: turn on an LED 66

Example: debug the secondary UART 67

Exit MicroPython mode 68

Other terminal programs 68

Tera Term for Windows 69

Use picocom in Linux 70

Get started with BLE

Enable BLE on an XBee device 72

Enable BLEand configure the BLEpassword using XCTU 72

Get the Digi XBeeMobile phone application 73

Connect with BLEand configure your XBee device 74

BLE reference 74

BLE advertising behavior and services 74

Device Information Service 74

XBee API BLEService 75

API Request characteristic 75

API Response characteristic 75

Get started with Digi Remote Manager

Create a Remote Manager account and add devices 77

Create a Remote Manager account 78

Add an XBee Smart Modem to Remote Manager 78

Verify the connection between a device and Remote Manager 79

Configure Remote Manager features by scheduling tasks 79

Overview: Create a schedule for a set of tasks 80

Examples 80

Example: Read settings and state using Remote Manager 80

Example: Configure a device from Remote Manager using XML 81

Example: Update XBee firmware using Remote Manager 82

Example: Update MicroPython from Remote Manager using XML 83

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 6

Restore persistent connection to a remote XBee 87

Manage data in Remote Manager 88

Review device status information from Remote Manager 89

Update the firmware from Remote Manager 89

Update the firmware using web services in Remote Manager 91

Manage secure files in Remote Manager 94

Remote Manager reference 95

Enable SM/UDP 95

Disconnect 96

Configure XBee settings within Remote Manager 96

Technical specifications

Interface and hardware specifications 100

Cellular RF characteristics 100

Bluetooth RF characteristics 100

Cellular networking specifications 100

Power requirements 101

Power consumption 102

Electrical specifications 103

Regulatory approvals 104

Hardware

Mechanical drawings 106

Pin signals 106

Pin connection recommendations 107

RSSI PWM 108

SIM card 108

Associate LED functionality 108

Antenna recommendations

Antenna placement 111

Design recommendations

Cellular component firmware updates 113

Power supply considerations 113

Minimum connection diagram 113

Heat considerations and testing 114

Custom configuration: Create a new factory default 114

Set a custom configuration 115

Clear all custom configurations on a device 115

Clean shutdown 115

SD (Shutdown) command 115

Sleep feature 116

Airplane mode 116

Cellular connection process

Connecting 118

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 7

Cellular network 118

Data network connection 118

Data communication with remote servers (TCP/UDP) 118

Disconnecting 119

Modes

Select an operating mode 121

Transparent operating mode 122

API operating mode 122

Command mode 122

Enter Command mode 122

Troubleshooting 123

Send AT commands 123

Response to AT commands 123

Apply command changes 124

Make command changes permanent 124

Exit Command mode 124

MicroPython mode 124

USB direct mode 125

Configure the data pins 125

Enable USB direct mode 125

Bypass operating mode (DEPRECATED) 125

Enter Bypass operating mode 126

Leave Bypass operating mode 126

Restore cellular settings to default in Bypass operating mode 126

Sleep modes

About sleep modes 128

Normal mode 128

Pin sleep mode 128

Cyclic sleep mode 128

Cyclic sleep with pin wake up mode 128

SPI mode and sleep pin functionality 128

The sleep timer 129

MicroPython sleep behavior 129

Power saving features

Airplane mode 131

Power Saving Mode (PSM) 131

PSM behavior 131

Deep Sleep mode 131

Serial communication

Serial interface 134

Serial data 134

UART data flow 134

Serial buffers 135

CTS flow control 135

RTS flow control 135

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 8

Enable UART or SPI ports 135

I2C 136

SPI operation

SPI communications 138

Full duplex operation 139

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

Socket behavior

Supported sockets 146

Best practices when using sockets 146

Sockets and Remote Manager 146

Sockets and API mode 146

Socket timeouts 146

Socket limits in API mode 147

Enable incoming TCP sockets in API mode 147

API mode behavior for outgoing TCP and SSL connections 147

API mode behavior for outgoing UDP data 148

API mode behavior for incoming TCP connections 148

API mode behavior for incoming UDP data 149

Transparent mode behavior for outgoing TCP and SSL connections 149

Transparent mode behavior for outgoing UDP data 150

Transparent mode behavior for incoming TCP connections 150

Transparent mode behavior for incoming UDP connections 150

Transport Layer Security (TLS)

TLS AT commands 152

Transparent mode and TLS 153

API mode and TLS 153

Key formats 153

Certificate formats 153

Certificate limitations 153

Cipher suites 154

Server Name Indication (SNI) 154

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

Step 1: Get the certificate 155

Step 2: Configure device 155

Step 3: Verify that authentication is being performed 155

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 9

AT commands

Special commands 158

AC (Apply Changes) 158

FR (Force Reset) 158

RE (Restore Defaults) 158

WR (Write) 158

Cellular commands 160

PH (Phone Number) 160

S# (ICCID) 160

IM (IMEI) 160

MN (Operator) 160

MV (Modem Firmware Version) 160

DB (Cellular Signal Strength) 161

AN (Access Point Name) 161

CP (Carrier Profile) 161

BM (Bandmask) (LTE-M) 162

BN (Bandmask) (NB-IoT) 162

AM (Airplane Mode) 163

N# (Preferred Network Technology) 163

Network commands 165

IP (IP Protocol) 165

TL (SSL/TLS Protocol Version) 165

$0 (SSL/TLS Profile 0) 166

$1 (SSL/TLS Profile 1) 166

$2 (SSL/TLS Profile 2) 166

TM (IP Client Connection Timeout) 167

TS (IP Server Connection Timeout) 167

DO (Device Options) 167

DT (Cellular Network Time) 168

Addressing commands 169

SH (Serial Number High) 169

SL (Serial Number Low) 169

MY (Module IP Address) 169

P# (Destination Phone Number) 169

N1 (DNS Address) 170

N2 (DNS Address) 170

DL (Destination Address) 170

OD (Operating Destination Address) 170

DE (Destination port) 171

C0 (Source Port) 171

LA (Lookup IP Address of FQDN) 171

Serial interfacing commands 172

BD (Baud Rate) 172

NB (Parity) 172

SB (Stop Bits) 173

RO (Packetization Timeout) 173

TD (Text Delimiter) 173

FT (Flow Control Threshold) 173

AP (API Enable) 174

I/O settings commands 175

D0 (DIO0/AD0) 175

D1 (DIO1/AD1) 175

D2 (DIO2/AD2) 176

D3 (DIO3/AD3) 176

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 10

D4 (DIO4) 176

D5 (DIO5/ASSOCIATED_INDICATOR) 177

D6 (DIO6/RTS) 177

D7 (DIO7/CTS) 177

D8 (DIO8/SLEEP_REQUEST) 178

D9 (DIO9/ON_SLEEP) 178

P0 (DIO10/PWM0 Configuration) 179

P1 (DIO11/PWM1 Configuration) 179

P2 (DIO12 Configuration) 180

P3 (DIO13/DOUT) 180

P4 (DIO14/DIN) 181

PD (Pull Direction) 181

PR (Pull-up/down Resistor Enable) 181

M0 (PWM0 Duty Cycle) 182

I/O sampling commands 183

TP (Temperature) 183

IS (Force Sample) 183

Sleep commands 185

SM (Sleep Mode) 185

SP (Sleep Period) 185

ST (Wake Time) 185

PA (Requested Active Timer) 186

PU (Requested Tracking Area Update Timer) 186

Command mode options 187

CC (Command Sequence Character) 187

CT (Command Mode Timeout) 187

CN (Exit Command mode) 187

GT (Guard Times) 187

MicroPython commands 189

PS (Python Startup) 189

PY (MicroPython Command) 189

Firmware version/information commands 191

VR (Firmware Version) 191

VL (Verbose Firmware Version) 191

HV (Hardware Version) 191

AI (Association Indication) 191

HS (Hardware Series) 192

CK (Configuration CRC) 192

Diagnostic interface commands 193

DI (Remote Manager Indicator) 193

CI (Protocol/Connection Indication) 193

AS (Active scan for network environment data) 195

Execution commands 196

NR (Network Reset) 196

!R (Modem Reset) 196

File system commands 197

Error responses 197

ATFS (File System) 197

ATFS PWD 197

ATFS CDdirectory 197

ATFS MDdirectory 197

ATFS LS [directory] 197

ATFS PUTfilename 198

ATFS XPUTfilename 198

ATFS HASHfilename 198

Indice

Altri manuali Digi Modem

Digi

Digi XBee-PRO PKG-U Manuale utente

Digi

Digi XB3-C-A2-UT series Manuale utente

Digi

Digi XBEE2 Manuale utente

Digi

Digi Digi XBee SX Manuale utente

Digi

Digi XTend-PKG Manuale utente

Digi

Digi XTend-PKG-R Manuale utente

Digi

Digi XStream-PKG Guida utente

Digi

Digi TransPort WR11 Manuale utente

Digi

Digi M10 Technical overview and Manuale operativo e di manutenzione

Digi

Digi 9XTend-PKG-R RS-232 Manuale utente

Digi

Digi XStream-PKG-U Manuale utente

Digi

Digi XBee-PRO 900HP Manuale utente

Digi

Digi M10 Technical overview and Manuale utente

Digi

Digi XBee3 Cellular LTE Cat 1 Manuale utente

Digi

Digi XLR PRO Manuale utente

Digi

Digi XBee Manuale utente

Digi

Digi Rapidport Manuale utente

Digi

Digi XB3-C-G1-UT-001 Manuale utente

Digi

Digi XBee-PRO XSC RS-232 Manuale utente

Digi

Digi 9XTend-PKG-U Manuale utente

Digi

Digi XBee Cellular 3G Global Manuale utente

Digi

Digi XStream-PKG-R RS-232 Manuale utente

Digi

Digi E230 Manuale utente

Digi

Digi XTP9B-PKC-UA Manuale utente

Manuali Modem popolari di altre marche

Davicom

Davicom DM562AP Manuale utente

EpiValley

EpiValley TATA indicom SXC-1080 Manuale utente

Zte

Zte WiMAX Manuale utente

Intelimax

Intelimax MA-2060 Manuale utente

SMC Networks

SMC Networks D3CM1604V Manuale per l'uso e la cura

Telstra

Telstra Wi-Fi 4G Advanced Pro X Manuale utente

Thrane&Thrane

Thrane&Thrane imarsat EXPLORER 300 Manuale utente

Samsung

Samsung AceLink SAM-335A Manuale utente

Enfora

Enfora Enabler-G Guida rapida alla configurazione

iRZ

iRZ ATM2-232 Manuale utente

Zhone

Zhone 6310 Manuale utente

Paradyne

Paradyne Hotwire 7976 Manuale utente

US Robotics

US Robotics 3453C Manuale utente

MaxTech

MaxTech Plug & Play Internal Voice/FAX/Data/SVD... Manuale utente

Zte

Zte MF823 Manuale utente

Four-Faith

Four-Faith F1403 Manuale utente

Sierra Wireless

Sierra Wireless AIRLINK MP595W Manuale utente

Gemtek

Gemtek WiMAX WIXFBR-103 Manuale utente