Sign In
Upload
Manuals
Brands
Digi Manuals
Modem
XB3-C-GM1-UT-102
Digi XB3-C-GM1-UT-102 Manuals
Manuals and User Guides for Digi XB3-C-GM1-UT-102. We have
1
Digi XB3-C-GM1-UT-102 manual available for free PDF download: User Manual
Digi XB3-C-GM1-UT-102 User Manual (308 pages)
Smart Modem (including Low Power variant)
Brand:
Digi
| Category:
Modem
| Size: 8 MB
Table of Contents
Trademarks and Copyright
2
Warranty
2
Customer Support
2
Country of Manufacture
3
Table of Contents
4
Digi Xbee®3 Global LTE-M/NB-Iot User Guide
16
Applicable Firmware and Hardware
17
Safety Instructions
17
Xbee Modules
17
SIM Cards
18
NB-Iot Network
18
Get Started with the Xbee
19
Identify the Kit Contents
20
Determine Cellular Service and Acquire a SIM Card
22
US Customers
22
European Customers
22
Cellular Service
22
Connect the Hardware
23
Install and Upgrade XCTU
24
Add a Device to XCTU
24
Update the Device Firmware Using XCTU
25
Configure Your Module for Cellular Connectivity
25
US Customers
25
European Customers
25
Check for Cellular Registration and Connection
26
Xbee Connection Examples
28
Connect to the Echo Server
29
Connect to the ELIZA Server
30
Connect to the Daytime Server
31
Send an SMS Message to a Phone
33
Perform a (GET) HTTP Request
34
Connect to a TCP/IP Address
35
Debugging
36
Software Libraries
36
Get Started with Micropython
38
About Micropython
39
Why Use Micropython
39
Micropython on the Xbee
39
Use XCTU to Enter the Micropython Environment
39
Use the Micropython Terminal in XCTU
40
Troubleshooting
40
Example: Hello World
40
Example: Turn on an LED
41
Example: Debug the Secondary UART
41
Exit Micropython Mode
42
Other Terminal Programs
42
Tera Term for Windows
42
Use Picocom in Linux
43
Get Started with Bluetooth® Low Energy
45
Enable BLE on an Xbee Device
45
Connect with BLE and Configure Your Xbee Device
45
Enable BLE and Configure the BLE Password Using XCTU
46
Get the Digi Xbee Mobile Phone Application
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 to Remote Manager
50
Verify the Connection between a Device and Remote Manager
51
Configure Remote Manager Features Using Automations
51
Overview: Create an Automation
52
Automation Examples
52
Example: Read Settings and State Using Remote Manager
53
Example: Configure a Device from Remote Manager Using XML
54
Example: Schedule an Automation to Update the Device Firmware Using Remote Manager
55
Example: Update Micropython from Remote Manager Using an Automation
56
Manage Data in Remote Manager
58
Review Device Status Information from Remote Manager
58
Manage Secure Files in Remote Manager
59
Remote Manager Reference
59
Enable SM/UDP
59
TCP Connection
60
Determine the Location of the Firmware Version
61
Configure Xbee Settings Within Remote Manager
62
Device Requests in Remote Manager
64
Format an Xbee Module
64
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
70
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
80
Create a Plan for Device and Cellular Component Firmware Updates
80
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 Modem Firmware
87
Transfer the Firmware to the Device
88
Use a Host Processor to Update the Device Firmware for Xbee 3 Devices over UART
89
Update the Cellular Firmware
90
Update the Cellular Component Firmware Using Remote Manager
90
Update the Telit Modem Firmware Using the TFI Utility
93
Update the Cellular Firmware Using the API
96
LWM2M Firmware Updates and the Xbee Module
96
Hardware
97
Technical Specifications
97
Interface and Hardware Specifications
97
Cellular RF Characteristics
97
Bluetooth RF Characteristics
98
Cellular Networking Specifications
98
Power Requirements
100
Power Consumption
101
Electrical Specifications
101
Regulatory Approvals
104
Mechanical Drawings
104
Pin Signals
105
Pin Connection Recommendations
106
Xbee Header Connector Requirements
106
SIM Card
107
Antenna Recommendations
107
Antenna Placement
107
GNSS Antennas
108
GNSS (Global Navigation Satellite System)
109
Design Recommendations
110
Cellular Component Firmware Updates
110
Power Supply Considerations
110
Minimum Connection Diagram
110
Heat Considerations and Testing
111
Custom Configuration: Create a New Factory Default
111
Clean Shutdown
112
SIM Cards
113
Development Boards
113
XBIB-CU-TH Reference
113
Interface with the XBIB-C-GPS Module
117
UART Communication
118
Associate LED Functionality
119
Rssi Pwm
119
Connecting
122
Cellular Network
122
Data Network Connection
122
Data Communication with Remote Servers (TCP/UDP)
122
Disconnecting
123
Select an Operating Mode
125
Transparent Operating Mode
126
API Operating Mode
126
Command Mode
126
Enter Command Mode
126
Troubleshooting
127
Send at Commands
127
Parameter Format
127
Response to at Commands
128
Apply Command Changes
128
Make Command Changes Permanent
128
Exit Command Mode
128
Micropython Mode
128
USB Direct Mode
128
Connect the Hardware for USB Direct Mode
129
Enable USB Direct Mode
130
Configure and Use PPP with an Xbee 3 Modem
131
Bypass Operating Mode (DEPRECATED)
134
Enter Bypass Operating Mode
134
Leave Bypass Operating Mode
134
Restore Cellular Settings to Default in Bypass Operating Mode
135
Sleep Modes
136
About Sleep Modes
137
Normal Mode
137
Pin Sleep Mode
137
Cyclic Sleep Mode
137
Cyclic Sleep with Pin Wake up Mode
137
SPI Mode and Sleep Pin Functionality
137
Sleep Timer
138
Micropython Sleep Behavior
138
Airplane Mode
140
Power Saving Mode (PSM)
140
Enable PSM
140
Overview of PSM Functionality on Xbee 3 Cellular
140
PSM Behavior
142
Low Voltage Shutdown
142
Deep Sleep Mode
143
Serial Communication
144
Serial Interface
144
Serial Data
144
UART Data Flow
145
Serial Buffers
145
Flow Control (Output)
145
Flow Control (Input)
145
Enable UART or SPI Ports
145
I2C
146
SPI Operation
147
SPI Communications
147
Full Duplex Operation
148
Low Power Operation
149
Select the SPI Port
149
Force UART Operation
150
Data Format
150
File System
151
Overview of the File System
151
Directory Structure
151
Paths
151
Secure Files
152
XCTU Interface
152
Encrypt Files
152
Socket Behavior
153
Supported Sockets
154
Best Practices When Using Sockets
154
Sockets and Remote Manager
154
Sockets and API Mode
154
Socket Timeouts
154
Socket Limits in API Mode
155
UDP Datagram Size Limits
155
Enable Incoming TCP Connections
155
API Mode Behavior for Outgoing TCP and TLS Connections
156
API Mode Behavior for Outgoing UDP Data
156
API Mode Behavior for Incoming TCP Connections
157
API Mode Behavior for Incoming UDP Data
157
Transparent Mode Behavior for Outgoing TCP and TLS Connections
157
Transparent Mode Behavior for Outgoing UDP Data
158
Transparent Mode Behavior for Incoming TCP Connections
158
Transparent Mode Behavior for Incoming UDP Connections
158
Extended Socket Frames
159
Examples
159
Available Extended Socket Frames
160
Extended Socket Example: Single HTTP Connection
160
Send a Socket Create Frame
160
Receive a Socket Create Response
161
Send Socket Connect
161
Receive a Socket Connect Response
161
Receive a Socket Status
162
Send HTTP Request Using Socket Send Frame
162
Receive TX Status
163
Receive One or more Receive Data Frames
163
Receive Socket Status Indicating Closed Connection
164
Extended Socket Example: UDP
164
Send a Socket Create Frame
164
Receive a Socket Create Response
165
Bind Local Source Address
165
Receive Bind/Listen Response
165
Send to Digi Echo Server
166
Receive TX Status
166
Receive Echoed Data
166
Send to Digi Time Server
167
Receive TX Status
167
Receive Daytime Value
167
Close the Socket
168
Receive Close Response
168
Extended Socket Example: TCP Listener
168
Send a Socket Create Frame
169
Receive a Socket Create Response
169
Designate the Socket as a Listener
169
Receive a Socket Bind/Listen Response
170
Making a Connection to the Listener Socket
170
Receiving Data from the New Socket
171
Receive a Socket Status Indicating Closed Connection
171
Transport Layer Security (TLS)
172
Specifying TLS Keys and Certificates
173
Transparent Mode and TLS
174
API Mode and TLS
174
Key Formats
174
Certificate Limitations
174
Secure the Connection between an Xbee and Remote Manager with Server Authentication
175
Step 1: Get the Certificate
175
Step 2: Configure Device
175
Step 3: Verify that Authentication Is Being Performed
175
Special Commands
178
AC (Apply Changes)
178
Force Reset)
178
RE (Restore Defaults)
178
SD (Shutdown)
179
WR (Write)
179
Cellular Commands
179
PH (Phone Number)
179
S# (ICCID)
180
IM (Imei)
180
Subscriber Identity)
180
MN (Operator)
180
MV (Modem Firmware Version)
180
MU (Modem Firmware Revision Number)
181
DB (Cellular Signal Strength)
181
DT (Cellular Network Time)
181
AN (Access Point Name)
182
OA (Operating APN)
182
CP (Carrier Profile)
182
BM (Bandmask) (LTE-M/NB-Iot)
183
AM (Airplane Mode)
184
N# (Preferred Network Technology)
184
SQ (Reference Signal Received Quality)
185
SW (Reference Signal Received Power)
185
Pn (Sim Pin)
186
Pk (Sim Puk)
186
CU (Cellular User Name)
186
CW (Cellular Password)
186
OT (Operating Technology)
187
FC (Frequency Channel Number)
187
Network Commands
187
IP (IP Protocol)
187
TL (TLS Protocol Version)
188
TLS Profile 0)
188
TLS Profile 1)
189
TLS Profile 2)
189
TM (IP Client Connection Timeout)
189
TS (IP Server Connection Timeout)
190
DO (Device Options)
190
DX (Requested Edrx Cycle Length)
191
D? (Network-Provided Edrx Cycle Length)
192
DW (Requested Edrx Paging Time Window Length)
192
W? (Network-Provided Edrx Paging Time Window Length)
192
PG (Ping)
192
Addressing Commands
193
SH (Serial Number High)
193
Serial Number Low)
193
MY (Module IP Address)
193
P# (Destination Phone Number)
193
N1 (DNS Address)
194
N2 (DNS Address)
194
DL (Destination Address)
194
OD (Operating Destination Address)
194
Destination Port)
195
C0 (Source Port)
195
LA (Lookup IP Address of FQDN)
195
NI (Node Identifier)
196
Serial Interfacing Commands
196
BD (Baud Rate)
196
NB (Parity)
197
SB (Stop Bits)
197
Packetization Timeout)
197
TD (Text Delimiter)
198
FT (Flow Control Threshold)
198
AP (API Enable)
198
IB (Cellular Component Baud Rate)
199
I/O Settings Commands
199
D0 (Dio0/Ad0)
199
D1 (Dio1/Ad1)
200
D2 (Dio2/Ad2)
200
D3 (Dio3/Ad3)
201
D4 (Dio4)
201
D5 (Dio5/Associated_Indicator)
202
D6 (Dio6/Rts)
202
D7 (Dio7/Cts)
203
D8 (Dio8/Sleep_Request)
203
D9 (Dio9/On_Sleep)
204
P0 (DIO10/PWM0 Configuration)
204
P1 (DIO11/PWM1 Configuration)
205
P2 (DIO12 Configuration)
205
P3 (Dio13/Dout)
206
P4 (Dio14/Din)
206
PD (Pull Direction)
207
PR (Pull-Up/Down Resistor Enable)
207
M0 (PWM0 Duty Cycle)
208
M1 Command
208
I/O Sampling Commands
208
TP (Temperature)
208
IS (Force Sample)
209
Sleep Commands
209
SM (Sleep Mode)
210
SP (Sleep Period)
210
ST (Wake Time)
210
PA (Requested Active Timer)
211
PU (Requested Tracking Area Update Timer)
211
A? (Network-Provided PSM Active Timer Value)
211
U? (Network-Provided PSM Tracking Area Update Timer Value)
211
Command Mode Options
212
CC (Command Sequence Character)
212
CT (Command Mode Timeout)
212
CN (Exit Command Mode)
212
GT (Guard Times)
213
Micropython Commands
213
PS (Python Startup)
213
PY (Micropython Command)
213
Firmware Version/Information Commands
214
VR (Firmware Version)
214
VL (Verbose Firmware Version)
214
HV (Hardware Version)
215
HS (Hardware Series)
215
C (Hardware/Software Compatibility)
215
CK (Configuration CRC)
215
AI (Association Indication)
216
FTP OTA Update Indication)
216
FO (FTP OTA Command)
217
RJ (Network Reject Cause)
218
Diagnostic Interface Commands
218
DI (Remote Manager Indicator)
218
CI (Protocol/Connection Indication)
219
AS (Active Scan for Network Environment Data)
221
Execution Commands
222
NR (Network Reset)
222
R (Modem Reset)
222
File System Commands
222
Error Responses
222
ATFS (File System)
223
Atfs Pwd
223
ATFS CD Directory
223
ATFS MD Directory
223
ATFS LS [Directory]
223
ATFS PUT Filename
223
ATFS XPUT Filename
223
ATFS HASH Filename
224
ATFS GET Filename
224
ATFS MV Source_Path Dest_Path
224
ATFS RM File_Or_Directory
224
Atfs Info
224
ATFS FORMAT Confirm
224
BLE Commands
224
BI (Bluetooth Identifier)
224
BL (Bluetooth MAC Address)
225
BP (Bluetooth Advertisement Power Level)
225
BT (Bluetooth Enable)
225
S (SRP Salt)
226
V, $W, $X, $Y (SRP Password Verifier)
226
Remote Manager Commands
227
MO (Remote Manager Options)
227
DF (Remote Manager Status Check Interval)
227
EQ (Remote Manager FQDN)
227
K1 (Remote Manager Server Send Keepalive)
228
K2 (Remote Manager Device Send Keepalive)
228
D (Remote Manager Certificate)
228
RI (Remote Manager Service ID)
228
DP (Remote Manager Phone Number)
229
HF (Health Metrics Reporting Frequency)
229
HM (Health Metrics)
229
ER (Remote Manager TCP Port Override)
231
Remote Manager UDP Port Override)
231
MT (Remote Manager Idle Timeout)
231
System Commands
232
KL (Device Location)
232
KP (Device Description)
232
KC (Contact Information)
232
Socket Commands
232
Socket Info)
232
GNSS Commands
234
Gp (Gps)
234
GO (GPS Options)
234
Power Measurement Commands
235
Command
235
L (Low Voltage Shutdown Base Threshold)
235
M (Low Voltage Shutdown Reset Offset)
235
Operate in API Mode
236
API Mode Overview
237
Use the AP Command to Set the Operation Mode
237
API Frame Format
237
API Operation (AP Parameter = 1)
237
API Operation with Escaped Characters (AP Parameter = 2)
238
Length Field
239
Frame Data
239
Calculate and Verify Checksums
240
API Frames
241
AT Command - 0X08
242
AT Command: Queue Parameter Value - 0X09
242
Transmit (TX) SMS - 0X1F
243
Transmit (TX) Request: Ipv4 - 0X20
244
Tx Request with TLS Profile - 0X23
245
AT Command Response - 0X88
246
Transmit (TX) Status - 0X89
247
Modem Status - 0X8A
248
Receive (RX) Packet: SMS - 0X9F
249
Receive (RX) Packet: Ipv4 - 0Xb0
249
User Data Relay - 0X2D
250
Error Cases
251
Example Use Cases
251
User Data Relay Output - 0Xad
251
FW Update - 0X2B
252
FW Update Response - 0Xab
253
BLE Unlock API - 0X2C
253
Example Sequence to Perform at Command Xbee API Frames over BLE
256
BLE Unlock Response - 0Xac
256
Socket Create - 0X40
256
Socket Create Response - 0Xc0
257
Socket Option Request - 0X41
258
Socket Option Response - 0Xc1
259
Socket Connect - 0X42
259
Socket Connect Response - 0Xc2
260
Socket Close - 0X43
261
Socket Close Response - 0Xc3
261
Socket Send (Transmit) - 0X44
262
Socket Sendto (Transmit Explicit Data): Ipv4 - 0X45
263
Socket Bind/Listen - 0X46
263
Socket Listen Response - 0Xc6
264
Socket New Ipv4 Client - 0Xcc
265
Socket Receive - 0Xcd
265
Socket Receive From: Ipv4 - 0Xce
266
Socket Status - 0Xcf
266
GNSS Start Raw NMEA, Stop Raw NMEA, or One Shot Request - 0X3D
267
GNSS Start Raw NMEA, Stop Raw NMEA, or One Shot Response - 0Xbd
268
GNSS Raw NMEA Response - 0Xbe
268
GNSS One Shot Response - 0Xbf
269
File System API Frames
270
Local File System Request - 0X3B
271
File Open - 0X01
272
File Close - 0X02
273
File Read - 0X03
274
File Hash - 0X08
274
File Write - 0X04
275
Directory Create - 0X10
276
Directory Open - 0X11
276
Directory Close - 0X12
278
Directory Read - 0X13
278
Get Path ID - 0X1C
278
Delete - 0X2F
279
Volume Info - 0X40
280
Volume Format - 0X4F
280
Local File System Response - 0Xbb
281
Status Values
282
Regulatory Firmware
283
Install the Regulatory Firmware
283
Install Regulatory Firmware Using XCTU
283
Install Regulatory Firmware Using Remote Manager
284
Configure Regulatory Firmware for Testing the Bluetooth Radio
285
Configure Regulatory Firmware for Testing the Cellular Component
285
Bluetooth DTM Protocol
285
Bluetooth DTM Protocol with X1C and Later
285
Bluetooth DTM Protocol with X1B and Earlier
286
Regulatory Testing Commands
287
(Enable/Disable Test Mode)
287
Start Test Mode)
288
Stop Test Mode)
288
Start Modulated Transmit)
288
Stop Transmit)
289
Set EARFCN)
289
Get the EARFCN)
289
Set Transmit Power)
289
A (Get Transmit Power)
290
D (Start Receive Mode)
290
H (Set Channel Mapping)
290
I (Get Channel Mapping)
291
(Query Test State)
291
Troubleshooting
292
Cannot Find the Serial Port for the Device
292
Condition
292
Solution
292
Other Possible Issues
293
Enable Virtual COM Port (VCP) on the Driver
294
Correct a Macos Java Error
295
Condition
295
Solution
295
Unresponsive Cellular Component in Bypass Mode
296
Condition
296
Solution
296
Syntax Error at Line 1
296
Error Failed to Send SMS
296
Network Connection Issues
297
Condition
297
Solution
297
Baud Rate in Bypass Mode
297
Verify that Radio Channels Match Your Carrier
297
Regulatory Information
298
United States (FCC)
298
FCC Requirements
298
OEM Labeling Requirements
298
FCC Notices
298
Antenna Regulatory Information: FCC and ISED
300
RF Exposure
301
FCC Publication 996369 Related Information
302
Innovation, Science and Economic Development Canada (ISED)
303
Labeling Requirements
303
RF Exposure
303
Transmitters with Detachable Antennas
304
Antenna Regulatory Information: IC (Canada)
304
European Union (EU)
306
Antenna Regulatory Information: EU (European Union)
306
United Kingdom (UKCA)
308
Cellular Antenna Max Gain: UKCA (United Kingdom)
308
Brazil (ANATEL)
308
Advertisement
Advertisement
Related Products
Digi XB3-C-GMS-UT-001
Digi XB3-C-GM2-UG-101
Digi XB3-C-GM2-UT-102
Digi XB3-C-GM1-UT-001
Digi XB3-C-GM1-UT-101
Digi XB3-C-G1-UT-001
Digi XB3-C-G1-UT-101
Digi XB3-C-G1-UT-102
Digi XB3-C-N1-UT-001
Digi XB3-C-N1-UT-101
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