Sign In
Upload
Manuals
Brands
Digi Manuals
Modem
XBee3 XB3M1
Digi XBee3 XB3M1 Manuals
Manuals and User Guides for Digi XBee3 XB3M1. We have
1
Digi XBee3 XB3M1 manual available for free PDF download: User Manual
Digi XBee3 XB3M1 User Manual (252 pages)
Cellular LTE-M/NB-IoT Smart Modem
Brand:
Digi
| Category:
Modem
| Size: 6 MB
Table of Contents
Table of Contents
4
Digixbee3Cellularlte-M/NB-Iotglobalsmartmodemuserguide
15
Applicable Firmware and Hardware
15
NB-Iot Network
15
SIM Cards
15
Get Started with the Xbee Smart Modem Development Kit
16
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
41
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
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
64
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
72
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
77
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
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
99
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
105
Mechanical Drawings
106
Pin Signals
106
Pin Connection Recommendations
107
Rssi Pwm
108
SIM Card
108
Associate LED Functionality
108
Antenna Recommendations
110
Antenna Placement
111
Design Recommendations
112
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
117
Connecting
118
Cellular Network
118
Data Network Connection
118
Data Communication with Remote Servers (TCP/UDP)
118
Disconnecting
119
Modes
120
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
127
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
130
Airplane Mode
131
Power Saving Mode (PSM)
131
PSM Behavior
131
Deep Sleep Mode
131
Serial Communication
133
Serial Interface
134
Serial Data
134
UART Data Flow
134
Serial Buffers
135
CTS Flow Control
135
RTS Flow Control
135
Enable UART or SPI Ports
135
I2C
136
SPI Operation
137
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
142
Overview of the File System
143
Directory Structure
143
Paths
143
Secure Files
143
XCTU Interface
144
Encrypt Files
144
Socket Behavior
145
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)
151
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
Atcommands
158
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
SSL/TLS Profile 0)
166
SSL/TLS Profile 1)
166
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
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
ATFS GET Filename
198
ATFS MV Source_Path Dest_Path
198
ATFS RM File_Or_Directory
198
Atfs Info
198
ATFS FORMAT Confirm
199
BLE Commands
200
BL (Bluetooth MAC Address)
200
BT (Bluetooth Enable)
200
S (SRP Salt)
200
V, $W, $X, $Y (SRP Password Verifier)
201
Remote Manager Commands
202
DF (Remote Manager Status Check Interval)
202
EQ (Remote Manager FQDN)
202
K1 (Remote Manager Server Send Keepalive)
202
K2 (Remote Manager Device Send Keepalive)
202
MO (Remote Manager Options)
203
D (Remote Manager Certificate)
203
RI (Remote Manager Service ID)
203
DP (Remote Manager Phone Number)
204
HF (Health Metrics Reporting Frequency)
204
HM (Health Metrics)
204
System Commands
205
KL (Device Location)
205
KP (Device Description)
205
KC (Contact Information)
205
Operate in API Mode
206
API Mode Overview
207
Use the AP Command to Set the Operation Mode
207
API Frame Format
207
API Operation (AP Parameter = 1)
207
API Operation with Escaped Characters (AP Parameter = 2)
208
API Frames
212
AT Command - 0X08
212
AT Command: Queue Parameter Value - 0X09
213
Transmit (TX) SMS - 0X1F
214
Transmit (TX) Request: Ipv4 - 0X20
215
Tx Request with TLS Profile - 0X23
217
AT Command Response - 0X88
219
Transmit (TX) Status - 0X89
220
Modem Status - 0X8A
222
Receive (RX) Packet: SMS - 0X9F
223
Receive (RX) Packet: Ipv4 - 0Xb0
224
User Data Relay - 0X2D
225
Example Use Cases
225
User Data Relay Output - 0Xad
227
BLE Unlock API - 0X2C
228
Example Sequence to Perform at Command Xbee API Frames over BLE
230
BLE Unlock Response - 0Xac
232
Packaged Firmware Updates
234
About Packaged Firmware Updates
234
Module Firmware Update
234
Cellular Component Firmware Update
234
Packaged Firmware Update
234
FW Update - 0X2B
235
FW Update Response - 0Xab
235
Important Notes
236
Perform a Cellular Component Firmware Update
236
Error Recovery
237
Corrupted Firmware on the Cellular Component
237
Error
237
Host Initiated Cancellation
237
Troubleshooting
238
Cannot Find the Serial Port for the Device
239
Condition
239
Solution
239
Other Possible Issues
240
Enable Virtual COM Port (VCP) on the Driver
240
Correct a Macos Java Error
241
Condition
241
Solution
241
Unresponsive Cellular Component in Bypass Mode
242
Condition
242
Solution
242
Syntax Error at Line 1
242
Error Failed to Send SMS
242
Network Connection Issues
243
Condition
243
Solution
243
Brownout Issue
243
Voltage Brownout
243
Power-On Discontinuities
243
How to Distinguish Revision B Parts
243
Hardware Flow Control in Bypass Mode
244
Socket Leaks
244
Condition
244
Solution
245
Regulatory Information
246
United States (FCC)
247
OEM Labeling Requirements
247
FCC Notices
247
FCC-Approved Antennas
248
RF Exposure
248
FCC Publication 996369 Related Information
249
Innovation, Science and Economic Development Canada (ISED)
250
Labeling Requirements
250
Advertisement
Advertisement
Related Products
Digi XBee3 DigiMesh 2.4
Digi XBee3 Cellular LTE-M
Digi XBee3 Smart Modem
Digi XBee 3 Cellular LTE-M
Digi XBee 3 Cellular NB-IoT
Digi XBee3 Cellular LTE Cat 1
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