Sign In
Upload
Manuals
Brands
Digi Manuals
Modem
XBee 3 Cellular NB-IoT
Digi XBee 3 Cellular NB-IoT Manuals
Manuals and User Guides for Digi XBee 3 Cellular NB-IoT. We have
1
Digi XBee 3 Cellular NB-IoT manual available for free PDF download: User Manual
Digi XBee 3 Cellular NB-IoT User Manual (331 pages)
Smart Modem
Brand:
Digi
| Category:
Modem
| Size: 7 MB
Table of Contents
Table of Contents
4
Digixbee®3Cellularlte-M/NB-Iotglobalsmartmodemuserguide
17
Applicable Firmware and Hardware
17
NB-Iot Network
17
SIM Cards
17
Get Started with the Xbee Smart Modem
18
Identify the Kit Contents
19
Determine Cellular Service and Acquire a SIM Card
21
US Customers
21
European Customers
21
Cellular Service
21
Connect the Hardware
22
Install and Upgrade XCTU
23
Add a Device to XCTU
23
Update the Device and Cellular Firmware Using XCTU
24
Configure Your Module for Cellular Connectivity
24
US Customers
24
European Customers
25
Check for Cellular Registration and Connection
25
Xbee Connection Examples
28
Connect to the Echo Server
28
Connect to the ELIZA Server
30
Connect to the Daytime Server
32
Perform a (GET) HTTP Request
34
Connect to a TCP/IP Address
35
Debugging
35
Software Libraries
36
Get Started with Micropython
38
About Micropython
38
Why Use Micropython
38
Micropython on the Xbee Smart Modem
38
Use XCTU to Enter the Micropython Environment
38
Use the Micropython Terminal in XCTU
39
Troubleshooting
39
Example: Hello World
39
Example: Turn on an LED
39
Example: Debug the Secondary UART
40
Exit Micropython Mode
41
Other Terminal Programs
41
Tera Term for Windows
41
Use Picocom in Linux
42
Get Started with BLE
44
On Xbee 3 Cellular Firmware Ending in X16 or Newer
44
On Xbee 3 Cellular Firmware Ending in X15 or Newer
44
On Xbee 3 Cellular Firmware Ending in X14 or Older
45
Enable BLE on an Xbee Device
45
Enable BLE and Configure the BLE Password Using XCTU
45
Get the Digi Xbee Mobile Phone Application
46
Connect with BLE and Configure Your Xbee Device
47
BLE Reference
47
BLE Advertising Behavior and Services
47
Device Information Service
47
Xbee API BLE Service
47
API Request Characteristic
48
API Response Characteristic
48
Get Started with Digi Remote Manager
49
Create a Remote Manager Account and Add Devices
49
Create a Remote Manager Account
50
Add an Xbee Smart Modem to Remote Manager
50
Verify the Connection between a Device and Remote Manager
51
Configure Remote Manager Features by Scheduling Tasks
51
Overview: Create a Schedule for a Set of Tasks
52
Examples
52
Example: Read Settings and State Using Remote Manager
52
Example: Configure a Device from Remote Manager Using XML
53
Example: Schedule a Task to Update the Device Firmware Using Remote Manager
54
Example: Update Micropython from Remote Manager Using XML
56
Manage Data in Remote Manager
59
Review Device Status Information from Remote Manager
60
Manage Secure Files in Remote Manager
60
Remote Manager Reference
61
Enable SM/UDP
61
TCP Connection
62
Disconnect
63
Configure Xbee Settings Within Remote Manager
63
Examples: IOT Protocols with Transparent Mode
66
Get Started with Coap
67
Coap Terms
67
Coap Quick Start Example
67
Configure the Device
68
Example: Manually Perform a Coap Request
68
Example: Use Python to Generate a Coap Message
69
Get Started with MQTT
71
Example: MQTT Connect
71
Send a Connect Packet
73
Example: Send Messages (Publish) with MQTT
74
Example: Receive Messages (Subscribe) with MQTT
75
Use MQTT over the Xbee Cellular Modem with a PC
76
Update the Firmware
81
Create a Plan for Device and Cellular Component Firmware Updates
81
Update the Device and the Cellular Firmware Using XCTU
82
Update the Device and Cellular Firmware Using XCTU and USB Direct Access
82
Update the Device Firmware
84
Update the Firmware from the Devices Page in Remote Manager
84
Update the Firmware Using Web Services in Remote Manager
85
Update the Cellular Firmware
91
Update an Xbee Module Cellular Component Using FOTA (over the Air)
91
Update an Xbee Module Cellular Component Using API Mode (over the Wire)
93
Update the Cellular Module from a PC Using the Easyflash Firmware Update
96
Technical Specifications
98
Interface and Hardware Specifications
98
Cellular RF Characteristics
98
Bluetooth RF Characteristics
98
Cellular Networking Specifications
98
Power Requirements
99
Power Consumption
100
Electrical Specifications
101
Regulatory Approvals
102
Hardware
103
Mechanical Drawings
104
Pin Signals
104
Pin Connection Recommendations
106
Xbee Header Connector Requirements
106
Rssi Pwm
106
SIM Card
107
Associate LED Functionality
107
Development Boards
109
XBIB-CU-TH Reference
109
XBIB-C-GPS Reference
113
Interface with the XBIB-C-GPS Module
114
Antenna Recommendations
116
Antenna Placement
116
Design Recommendations
118
Cellular Component Firmware Updates
118
Power Supply Considerations
118
Minimum Connection Diagram
118
Heat Considerations and Testing
119
Custom Configuration: Create a New Factory Default
119
Set a Custom Configuration
120
Clear All Custom Configurations on a Device
120
Clean Shutdown
120
SD (Shutdown) Command
120
Sleep Feature
121
Airplane Mode
121
SIM Cards
121
Cellular Connection Process
122
Connecting
123
Cellular Network
123
Data Network Connection
123
Data Communication with Remote Servers (TCP/UDP)
123
Disconnecting
124
Modes
125
Select an Operating Mode
126
Transparent Operating Mode
127
API Operating Mode
127
Command Mode
127
Enter Command Mode
127
Troubleshooting
128
Send at Commands
128
Response to at Commands
128
Apply Command Changes
129
Make Command Changes Permanent
129
Exit Command Mode
129
Micropython Mode
129
USB Direct Mode
130
Connect the Hardware for USB Direct Mode
130
Configure the Data Pins
131
Enable USB Direct Mode
131
Configure and Use PPP with a Digi Xbee 3 Cellular LTE-M/NB-Iot Modem
132
Bypass Operating Mode (DEPRECATED)
135
Enter Bypass Operating Mode
135
Leave Bypass Operating Mode
136
Restore Cellular Settings to Default in Bypass Operating Mode
136
Sleep Modes
137
About Sleep Modes
138
Normal Mode
138
Pin Sleep Mode
138
Cyclic Sleep Mode
138
Cyclic Sleep with Pin Wake up Mode
138
SPI Mode and Sleep Pin Functionality
138
The Sleep Timer
139
Micropython Sleep Behavior
139
Power Saving Features and Design Recommendations
141
Airplane Mode
141
Power Saving Mode (PSM)
141
Enable PSM
141
Overview of PSM Functionality on Xbee 3 Cellular
141
PSM Behavior
143
Low Voltage Shutdown
143
Deep Sleep Mode
144
Serial Communication
145
Serial Interface
146
Serial Data
146
UART Data Flow
146
Serial Buffers
147
CTS Flow Control
147
RTS Flow Control
147
Enable UART or SPI Ports
147
I2C
148
SPI Operation
150
SPI Communications
150
Full Duplex Operation
150
Low Power Operation
151
Select the SPI Port
152
Force UART Operation
153
Data Format
153
File System
155
Overview of the File System
155
Directory Structure
155
Paths
155
Secure Files
155
XCTU Interface
156
Encrypt Files
156
Socket Behavior
158
Supported Sockets
158
Best Practices When Using Sockets
158
Sockets and Remote Manager
158
Sockets and API Mode
158
Socket Timeouts
158
Socket Limits in API Mode
159
Enable Incoming TCP Sockets in API Mode
159
API Mode Behavior for Outgoing TCP and TLS Connections
159
API Mode Behavior for Outgoing UDP Data
160
API Mode Behavior for Incoming TCP Connections
160
API Mode Behavior for Incoming UDP Data
161
Transparent Mode Behavior for Outgoing TCP and TLS Connections
161
Transparent Mode Behavior for Outgoing UDP Data
162
Transparent Mode Behavior for Incoming TCP Connections
162
Transparent Mode Behavior for Incoming UDP Connections
162
Extended Socket Frames
163
Examples
163
Available Extended Socket Frames
164
Extended Socket Example: Single HTTP Connection
164
Send a Socket Create Frame
164
Receive a Socket Create Response
165
Send Socket Connect
165
Receive a Socket Connect Response
165
Receive a Socket Status
166
Send HTTP Request Using Socket Send Frame
166
Receive TX Status
167
Receive One or more Receive Data Frames
167
Receive Socket Status Indicating Closed Connection
168
Extended Socket Example: UDP
168
Send a Socket Create Frame
168
Receive a Socket Create Response
169
Bind Local Source Addres
169
Receive Bind/Listen Response
169
Send to Digi Echo Server
170
Receive TX Status
170
Receive Echoed Data
170
Send to Digi Time Server
171
Receive TX Status
171
Receive Daytime Value
171
Close the Socket
172
Receive Close Response
172
Extended Socket Example: TCP Listener
173
Send a Socket Create Frame
173
Receive a Socket Create Response
173
Designate the Socket as a Listener
173
Receive a Socket Bind/Listen Response
174
Making a Connection to the Listener Socket
174
Receiving Data from the New Socket
175
Receive a Socket Status Indicating Closed Connection
175
Transport Layer Security (TLS)
177
Specifying TLS Keys and Certificates
178
Transparent Mode and TLS
179
API Mode and TLS
179
Key Formats
179
Certificate Formats
179
Certificate Limitations
179
Cipher Suites
180
Server Name Indication (SNI)
180
Secure the Connection between an Xbee and Remote Manager with Server Authentication
180
Step 1: Get the Certificate
181
Step 2: Configure Device
181
Step 3: Verify that Authentication Is Being Performed
181
Atcommands
184
Special Commands
184
AC (Apply Changes)
184
Force Reset)
184
RE (Restore Defaults)
184
SD (Shutdown)
185
WR (Write)
185
Cellular Commands
186
PH (Phone Number)
186
S# (ICCID)
186
IM (Imei)
186
Subscriber Identity)
186
MN (Operator)
186
MV (Modem Firmware Version)
187
DB (Cellular Signal Strength)
187
DT (Cellular Network Time)
187
AN (Access Point Name)
188
CP (Carrier Profile)
188
BM (Bandmask) (LTE-M)
189
BN (Bandmask) (NB-Iot)
189
AM (Airplane Mode)
190
N# (Preferred Network Technology)
190
SQ (Reference Signal Received Quality)
190
SW (Reference Signal Received POWER)
191
Pn (Sim Pin)
191
Pk (Sim Puk)
192
CU (Cellular User Name)
192
CW (Cellular Password)
192
FC (Frequency Channel Number)
192
Network Commands
193
IP (IP Protocol)
193
TL (TLS Protocol Version)
193
TLS Profile 0)
194
TLS Profile 1)
194
TLS Profile 2)
194
TM (IP Client Connection Timeout)
195
TS (IP Server Connection Timeout)
195
DO (Device Options)
195
DX (Requested Edrx Cycle Length)
196
D? (Network-Provided Edrx Cycle Length)
197
PG (Ping)
197
Addressing Commands
198
SH (Serial Number High)
198
Serial Number Low)
198
MY (Module IP Address)
198
P# (Destination Phone Number)
198
N1 (DNS Address)
199
N2 (DNS Address)
199
DL (Destination Address)
199
OD (Operating Destination Address)
200
Destination Port)
200
C0 (Source Port)
200
LA (Lookup IP Address of FQDN)
201
Serial Interfacing Commands
202
BD (Baud Rate)
202
NB (Parity)
202
SB (Stop Bits)
203
Packetization Timeout)
203
TD (Text Delimiter)
203
FT (Flow Control Threshold)
204
AP (API Enable)
204
IB (Cellular Component Baud Rate)
204
I/O Settings Commands
206
D0 (Dio0/Ad0)
206
D1 (Dio1/Ad1)
206
D2 (Dio2/Ad2)
207
D3 (Dio3/Ad3)
207
D4 (Dio4)
208
D5 (Dio5/Associated_Indicator)
208
D6 (Dio6/Rts)
208
D7 (Dio7/Cts)
209
D8 (Dio8/Sleep_Request)
209
D9 (Dio9/On_Sleep)
209
P0 (DIO10/PWM0 Configuration)
210
P1 (DIO11/PWM1 Configuration)
210
P2 (DIO12 Configuration)
211
P3 (Dio13/Dout)
211
P4 (Dio14/Din)
212
PD (Pull Direction)
212
PR (Pull-Up/Down Resistor Enable)
212
M0 (PWM0 Duty Cycle)
213
M1 Command
214
I/O Sampling Commands
215
TP (Temperature)
215
IS (Force Sample)
215
Sleep Commands
217
SM (Sleep Mode)
217
SP (Sleep Period)
217
ST (Wake Time)
217
PA (Requested Active Timer)
218
PU (Requested Tracking Area Update Timer)
218
Command Mode Options
219
CC (Command Sequence Character)
219
CT (Command Mode Timeout)
219
CN (Exit Command Mode)
219
GT (Guard Times)
219
Micropython Commands
221
PS (Python Startup)
221
PY (Micropython Command)
221
Firmware Version/Information Commands
223
VR (Firmware Version)
223
VL (Verbose Firmware Version)
223
HV (Hardware Version)
223
HS (Hardware Series)
223
CK (Configuration CRC)
223
AI (Association Indication)
224
FTP OTA Update Indication)
224
FO (FTP OTA Command)
225
Diagnostic Interface Commands
227
DI (Remote Manager Indicator)
227
CI (Protocol/Connection Indication)
227
AS (Active Scan for Network Environment Data)
229
Execution Commands
231
NR (Network Reset)
231
R (Modem Reset)
231
File System Commands
232
Error Responses
232
ATFS (File System)
232
Atfs Pwd
232
ATFS CD Directory
232
ATFS MD Directory
232
ATFS LS [Directory]
232
ATFS PUT Filename
233
ATFS XPUT Filename
233
ATFS HASH Filename
233
ATFS GET Filename
233
ATFS MV Source_Path Dest_Path
233
ATFS RM File_Or_Directory
233
Atfs Info
233
ATFS FORMAT Confirm
234
BLE Commands
235
BI (Bluetooth Identifier)
235
BL (Bluetooth MAC Address)
235
BP (Bluetooth Advertisement Power Level)
235
BT (Bluetooth Enable)
235
S (SRP Salt)
236
V, $W, $X, $Y (SRP Password Verifier)
236
Remote Manager Commands
237
DF (Remote Manager Status Check Interval)
237
EQ (Remote Manager FQDN)
237
K1 (Remote Manager Server Send Keepalive)
237
K2 (Remote Manager Device Send Keepalive)
237
MO (Remote Manager Options)
238
D (Remote Manager Certificate)
238
RI (Remote Manager Service ID)
238
DP (Remote Manager Phone Number)
239
HF (Health Metrics Reporting Frequency)
239
HM (Health Metrics)
239
ER (Remote Manager TCP Port Override)
240
Remote Manager UDP Port Override)
241
MT (Remote Manager Idle Timeout)
241
System Commands
242
KL (Device Location)
242
KP (Device Description)
242
KC (Contact Information)
242
Socket Commands
243
Socket Info)
243
Power Measurement Commands
244
Command
244
L (Low Voltage Shutdown Base Threshold)
244
M (Low Voltage Shutdown Reset Offset)
245
Operate in API Mode
247
API Mode Overview
247
Use the AP Command to Set the Operation Mode
247
API Frame Format
247
API Operation (AP Parameter = 1)
247
API Operation with Escaped Characters (AP Parameter = 2)
248
API Frames
251
AT Command - 0X08
252
AT Command: Queue Parameter Value - 0X09
253
Transmit (TX) SMS - 0X1F
254
Transmit (TX) Request: Ipv4 - 0X20
255
Tx Request with TLS Profile - 0X23
257
AT Command Response - 0X88
259
Transmit (TX) Status - 0X89
260
Modem Status - 0X8A
262
Receive (RX) Packet: SMS - 0X9F
263
Receive (RX) Packet: Ipv4 - 0Xb0
264
User Data Relay - 0X2D
265
Example Use Cases
265
User Data Relay Output - 0Xad
267
BLE Unlock API - 0X2C
268
Example Sequence to Perform at Command Xbee API Frames over BLE
270
BLE Unlock Response - 0Xac
272
Socket Create - 0X40
273
Socket Create Response - 0Xc0
274
Socket Option Request - 0X41
275
Socket Option Response - 0Xc1
276
Socket Connect - 0X42
277
Socket Connect Response - 0Xc2
278
Socket Close - 0X43
279
Socket Close Response - 0Xc3
280
Socket Send (Transmit) - 0X44
281
Socket Sendto (Transmit Explicit Data): Ipv4 - 0X45
282
Socket Bind/Listen - 0X46
283
Socket Listen Response - 0Xc6
284
Socket New Ipv4 Client - 0Xcc
285
Socket Receive - 0Xcd
286
Socket Receive From: Ipv4 - 0Xce
287
Socket Status - 0Xcf
288
File System API Frames
288
Local File System Request - 0X3B
288
File Open - 0X01
290
File Close - 0X02
291
File Read - 0X03
291
File Write - 0X04
292
File Hash - 0X08
293
Directory Create - 0X10
293
Directory Open - 0X11
294
Directory Close - 0X12
295
Directory Read - 0X13
296
Get Path ID - 0X1C
296
Delete - 0X2F
297
Volume Info - 0X40
297
Volume Format - 0X4F
298
Local File System Response - 0Xbb
298
Regulatory Firmware
301
Install the Regulatory Firmware
301
Install Regulatory Firmware Using XCTU
301
Install Regulatory Firmware Using Remote Manager
302
Configure Regulatory Firmware for Testing the Bluetooth Radio
303
Configure Regulatory Firmware for Testing the Cellular Component
303
Bluetooth DTM Protocol
304
Example
304
Regulatory Testing Commands
304
(Enable/Disable Test Mode)
305
Start Test Mode)
306
Stop Test Mode)
306
Start Modulated Transmit)
306
Stop Transmit)
306
Set the EARFCN)
306
Get the EARFCN)
307
Set Transmit Power)
307
A (Get Transmit Power)
308
D (Start Receive Mode)
308
(Query Test State)
308
Troubleshooting
309
Cannot Find the Serial Port for the Device
310
Condition
310
Solution
310
Other Possible Issues
311
Enable Virtual COM Port (VCP) on the Driver
311
Correct a Macos Java Error
312
Condition
312
Solution
312
Unresponsive Cellular Component in Bypass Mode
313
Condition
313
Solution
313
Syntax Error at Line 1
313
Error Failed to Send SMS
313
Network Connection Issues
314
Condition
314
Solution
314
Brownout Issue
314
Voltage Brownout
314
Power-On Discontinuities
314
How to Distinguish Revision B Parts
314
Hardware Flow Control in Bypass Mode
315
Baud Rate in Bypass Mode
315
Socket Leaks
315
Condition
315
Solution
316
Regulatoryinformation
318
United States (FCC)
318
OEM Labeling Requirements
318
FCC Notices
318
FCC-Approved Antennas
319
RF Exposure
320
FCC Publication 996369 Related Information
320
Innovation, Science and Economic Development Canada (ISED)
321
Labeling Requirements
321
RF Exposure
321
Mexico (IFETEL)
322
OEM Labeling Requirements
322
Brazil (ANATEL)
323
Deprecated Kit (PN XK3-C-A2-UT-U or XK3-C-N1-UT-E)
324
Identify the Kit Contents
325
Connect the Hardware
326
XBIB-U-DEV Reference
327
Example: Turn on an LED
330
Advertisement
Advertisement
Related Products
Digi XBee3 Cellular LTE-M
Digi XBee 3 Cellular LTE-M
Digi XBee3 Cellular LTE Cat 1
Digi XBee3 DigiMesh 2.4
Digi XBee3 XB3M1
Digi XBee3 Smart Modem
Digi XBee 3 Cat 1
Digi XBee 3 Global LTE-M/NB-IoT
Digi XBEE2
Digi Digi XBee SX
Digi Categories
Network Router
Control Unit
Modem
Gateway
Server
More Digi Manuals
Login
Sign In
OR
Sign in with Facebook
Sign in with Google
Upload manual
Upload from disk
Upload from URL