Digi XB3-C-G1-UT-001 Manuals

Manuals and User Guides for Digi XB3-C-G1-UT-001. We have 2 Digi XB3-C-G1-UT-001 manuals available for free PDF download: User Manual

Digi XB3-C-G1-UT-001 User Manual (306 pages)

Smart Modem

Brand: Digi | Category: Modem | Size: 5 MB

Table of Contents
4
Digi Xbee® 3 Cat 1 Smart Modem User Guide

16
- Applicable Firmware and Hardware
  16
- SIM Cards
  17
- Safety Instructions
  17
  - Инструкции За Безопасност
    18
  - Sigurnosne Upute
    18
  - Bezpečnostní Instrukce
    19
  - Sikkerhedsinstruktioner
    19
  - Veiligheidsinstructies
    20
  - Ohutusjuhised
    20
  - Turvallisuusohjeet
    21
  - Consignes de Sécurité
    21
  - Sicherheitshinweise
    22
  - Οδηγίες Ασφαλείας
    22
  - Biztonsági Utasítások
    23
  - Istruzioni DI Sicurezza
    24
  - Drošības Instrukcijas
    24
  - Saugos Instrukcijos
    25
  - Sikkerhetsinstruksjoner
    25
  - Instrukcje Bezpieczeństwa
    26
  - Instruções de Segurança
    26
  - Instructiuni de Siguranta
    27
  - Bezpečnostné Inštrukcie
    27
  - Varnostna Navodila
    28
  - Las Instrucciones de Seguridad
    28
  - Säkerhets Instruktioner
    29
Get Started with the Xbee Smart Modem

30
Xbee Connection Examples

38
- Connect to the Echo Server
  38
- Connect to the ELIZA Server
  39
- Connect to the Daytime Server
  40
- Send an SMS Message to a Phone
  41
- Perform a (GET) HTTP Request
  43
- Connect to a TCP/IP Address
  44
- Software Libraries
  45
Get Started with Micropython

47
- About Micropython
  47
  - Why Use Micropython
    47
- Micropython on the Xbee Smart Modem
  47
- Use XCTU to Enter the Micropython Environment
  47
- Use the Micropython Terminal in XCTU
  48
  - Troubleshooting
    48
- Example: Hello World
  48
- Example: Turn on an LED
  48
- Example: Code a Request Help Button
  49
- Example: Debug the Secondary UART
  54
- Exit Micropython Mode
  54
- Other Terminal Programs
  55
  - Tera Term for Windows
    55
- Use Picocom in Linux
  56
Get Started with Bluetooth® Low Energy

58
Get Started with Digi Remote Manager

62
Examples: IOT Protocols with Transparent Mode

78
- Get Started with Coap
  79
- Get Started with MQTT
  83
Update the Firmware

92
Technical Specifications

106
- Interface and Hardware Specifications
  106
- RF Characteristics
  106
- Networking Specifications
  107
  - Bands
    107
- Power Requirements
  108
- Electrical Specifications
  108
- Regulatory Approvals
  110
Hardware

111
- Mechanical Drawings
  111
- Pin Signals
  111
  - Pin Connection Recommendations
    113
- Xbee Header Connector Requirements
  113
- Rssi Pwm
  114
- SIM Card
  114
- GNSS (Global Navigation Satellite System)
  114
- Associate LED Functionality
  115
- Development Boards
  116
  - XBIB-CU-TH Reference
    116
Antenna Recommendations

120
- Antenna Connections
  120
- Keepout Area and Design Recommendations
  120
  - Through-Hole Keepout
    122
- Antenna Placement
  123
- GNSS Antennas
  123
Design Recommendations

125
- Power Supply Considerations
  125
- Heat Considerations and Testing
  125
- Add a Fan to Provide Active Cooling
  126
- Clean Shutdown
  126
  - SD (Shutdown) Command
    126
- Cellular Component Firmware Updates
  127
- Recommended Application Circuit
  127
- Custom Configuration: Create a New Factory Default
  127
  - Set a Custom Configuration
    128
  - Clear All Custom Configurations on a Device
    128
- SIM Cards
  128
Cellular Connection Process

129
- Connecting
  130
  - Cellular Network
    130
  - Data Network Connection
    130
- Data Communication with Remote Servers (TCP/UDP)
  130
- Disconnecting
  131
Modes

132
- Select an Operating Mode
  133
- Transparent Operating Mode
  134
- API Operating Mode
  134
- Command Mode
  134
  - Enter Command Mode
    134
  - Troubleshooting
    135
  - Send at Commands
    135
  - Response to at Commands
    135
  - Apply Command Changes
    136
  - Make Command Changes Permanent
    136
  - Exit Command Mode
    136
- Micropython Mode
  136
  - USB Direct Mode
    137
  - Connect the Hardware for USB Direct Mode
    137
- Enable USB Direct Mode
  137
  - Configure and Use PPP with an Xbee 3 Modem
    138
Sleep Modes

142
- About Sleep Modes
  143
- Normal Mode
  143
- Pin Sleep Mode
  143
- Cyclic Sleep Mode
  143
- Cyclic Sleep with Pin Wake up Mode
  143
- Sleep Timer
  143
- Micropython Sleep Behavior
  143
Power Saving Features and Design Recommendations

145
- Airplane Mode
  146
- Low Voltage Shutdown
  146
Serial Communication

148
- Serial Interface
  148
- Serial Data
  148
- UART Data Flow
  149
- Serial Buffers
  149
- Flow Control (Output)
  149
- Flow Control (Input)
  149
- Enable UART or SPI Ports
  149
SPI Operation

151
- SPI Communications
  151
- Full Duplex Operation
  152
- Low Power Operation
  153
- Select the SPI Port
  153
- Force UART Operation
  154
- Data Format
  154
File System

155
- Overview of the File System
  155
  - Directory Structure
    155
  - Paths
    155
  - Secure Files
    156
- XCTU Interface
  156
- Encrypt Files
  156
SMS Behaviors

157
- SMS Encoding
  157
Socket Behavior

159
Available Extended Socket Frames

165
- Extended Socket Example: Single HTTP Connection
  165
  - Send a Socket Create Frame
    165
  - Receive a Socket Create Response
    166
  - Send Socket Connect
    166
  - Receive a Socket Connect Response
    166
  - Receive a Socket Status
    167
  - Send HTTP Request Using Socket Send Frame
    167
  - Receive TX Status
    168
  - Receive One or more Receive Data Frames
    168
  - Receive Socket Status Indicating Closed Connection
    169
- Extended Socket Example: UDP
  169
  - Send a Socket Create Frame
    169
  - Receive a Socket Create Response
    170
  - Bind Local Source Addres
    170
  - Receive Bind/Listen Response
    170
  - Send to Digi Echo Server
    171
  - Receive TX Status
    171
  - Receive Echoed Data
    171
  - Send to Digi Time Server
    172
  - Receive TX Status
    172
  - Receive Daytime Value
    172
  - Close the Socket
    173
  - Receive Close Response
    173
- Extended Socket Example: TCP Listener
  174
Transport Layer Security (TLS)

178
- Specifying TLS Keys and Certificates
  179
- Transparent Mode and TLS
  180
- API Mode and TLS
  180
- Key Formats
  180
- Certificate Limitations
  180
- Cipher Suites
  180
- Secure the Connection between an Xbee and Remote Manager with Server Authentication
  182
AT Commands

184
- Special Commands
  185
  - AC (Apply Changes)
    185
  - Force Reset)
    185
  - RE (Restore Defaults)
    185
  - SD (Shutdown)
    186
  - WR (Write)
    186
- Cellular Commands
  186
  - PH (Phone Number)
    186
  - S# (ICCID)
    187
  - IM (Imei)
    187
  - Subscriber Identity)
    187
  - MN (Operator)
    187
  - MV (Modem Firmware Version)
    187
  - MU (Modem Firmware Revision Number)
    188
  - DB (Cellular Signal Strength)
    188
  - DT (Cellular Network Time)
    188
  - AN (Access Point Name)
    189
  - OA (Operating APN)
    189
  - CP (Carrier Profile)
    189
  - BM (Bandmask)
    190
  - AM (Airplane Mode)
    190
  - DV (Secondary Antenna Function Switch)
    191
  - SQ (Reference Signal Received Quality)
    191
  - SW (Reference Signal Received Power)
    192
  - Pn (Sim Pin)
    192
  - Pk (Sim Puk)
    192
  - OT (Operating Technology)
    193
  - FC (Frequency Channel Number)
    193
- Network Commands
  193
  - IP (IP Protocol)
    193
  - TL (TLS Protocol Version)
    194
  - TLS Profile 0)
    194
  - TLS Profile 1)
    194
  - TLS Profile 2)
    195
  - TM (IP Client Connection Timeout)
    195
  - TS (IP Server Connection Timeout)
    195
  - DO (Device Options)
    196
  - PG (Ping)
    197
- Addressing Commands
  197
  - SH (Serial Number High)
    197
  - Serial Number Low)
    197
  - MY (Module IP Address)
    197
  - P# (Destination Phone Number)
    198
  - N1 (DNS Address)
    198
  - N2 (DNS Address)
    198
  - DL (Destination Address)
    198
  - OD (Operating Destination Address)
    199
  - Destination Port)
    199
  - C0 (Source Port)
    199
  - LA (Lookup IP Address of FQDN)
    200
  - NI (Node Identifier)
    200
- Serial Interfacing Commands
  200
  - BD (Baud Rate)
    200
  - NB (Parity)
    201
  - SB (Stop Bits)
    201
  - Packetization Timeout)
    202
  - TD (Text Delimiter)
    202
  - FT (Flow Control Threshold)
    202
  - AP (API Enable)
    202
  - IB (Cellular Component Baud Rate)
    203
- I/O Settings Commands
  204
  - D0 (Dio0/Ad0)
    204
  - D1 (Dio1/Ad1)
    204
  - D2 (Dio2/Ad2)
    205
  - D3 (Dio3/Ad3)
    205
  - D4 (Dio4)
    206
  - D5 (Dio5/Associated_Indicator)
    206
  - D6 (Dio6/Rts)
    206
  - D7 (Dio7/Cts)
    207
  - D8 (Dio8/Sleep_Request)
    207
  - D9 (Dio9/On_Sleep)
    208
  - P0 (DIO10/PWM0 Configuration)
    208
  - P1 (DIO11/PWM1 Configuration)
    209
  - P2 (DIO12 Configuration)
    209
  - P3 (Dio13/Dout)
    210
  - P4 (Dio14/Din)
    210
  - PD (Pull Direction)
    211
  - PR (Pull-Up/Down Resistor Enable)
    211
  - M0 (PWM0 Duty Cycle)
    212
  - M1 Command
    212
- I/O Sampling Commands
  212
  - TP (Temperature)
    212
  - IS (Force Sample)
    213
- Sleep Commands
  213
  - SM (Sleep Mode)
    214
  - SP (Sleep Period)
    214
  - ST (Wake Time)
    214
- Command Mode Options
  215
  - CC (Command Sequence Character)
    215
  - CT (Command Mode Timeout)
    215
  - CN (Exit Command Mode)
    215
  - GT (Guard Times)
    215
- Micropython Commands
  216
  - PS (Python Startup)
    216
  - PY (Micropython Command)
    216
- Firmware Version/Information Commands
  217
  - VR (Firmware Version)
    217
  - VL (Verbose Firmware Version)
    217
  - HV (Hardware Version)
    217
  - HS (Hardware Series)
    218
  - CK (Configuration CRC)
    218
  - AI (Association Indication)
    218
  - FTP OTA Update Indication)
    219
  - FO (FTP OTA Command)
    219
  - RJ (Network Reject Cause)
    220
- Diagnostic Interface Commands
  220
- Execution Commands
  224
  - NR (Network Reset)
    224
  - R (Modem Reset)
    224
- File System Commands
  225
  - Error Responses
    225
  - ATFS (File System)
    225
  - Atfs Pwd
    225
  - ATFS CD Directory
    225
  - ATFS MD Directory
    225
  - ATFS LS [Directory]
    225
  - ATFS PUT Filename
    226
  - ATFS XPUT Filename
    226
  - ATFS HASH Filename
    226
  - ATFS GET Filename
    226
  - ATFS MV Source_Path Dest_Path
    226
  - ATFS RM File_Or_Directory
    226
  - Atfs Info
    226
  - ATFS FORMAT Confirm
    227
- BLE Commands
  227
  - BI (Bluetooth Identifier)
    227
  - BL (Bluetooth MAC Address)
    227
  - BP (Bluetooth Advertisement Power Level)
    227
  - BT (Bluetooth Enable)
    228
  - S (SRP Salt)
    228
  - V, $W, $X, $Y (SRP Password Verifier)
    229
- Remote Manager Commands
  229
  - MO (Remote Manager Options)
    229
  - DF (Remote Manager Status Check Interval)
    229
  - EQ (Remote Manager FQDN)
    230
  - K1 (Remote Manager Server Send Keepalive)
    230
  - K2 (Remote Manager Device Send Keepalive)
    230
  - D (Remote Manager Certificate)
    231
  - RI (Remote Manager Service ID)
    231
  - DP (Remote Manager Phone Number)
    231
  - HF (Health Metrics Reporting Frequency)
    231
  - HM (Health Metrics)
    232
  - ER (Remote Manager TCP Port Override)
    233
  - Remote Manager UDP Port Override)
    233
  - MT (Remote Manager Idle Timeout)
    234
- System Commands
  234
  - KL (Device Location)
    234
  - KP (Device Description)
    234
  - KC (Contact Information)
    234
- Socket Commands
  235
  - Socket Info)
    235
- GNSS Commands
  236
  - Gp (Gps)
    236
  - GO (GPS Options)
    237
- Power Measurement Commands
  237
  - Command
    237
  - L (Low Voltage Shutdown Base Threshold)
    237
  - M (Low Voltage Shutdown Reset Offset)
    238
Operate in API Mode

239
API Frames

245
- AT Command - 0X08
  245
- AT Command: Queue Parameter Value - 0X09
  245
- Transmit (TX) SMS - 0X1F
  246
- Transmit (TX) Request: Ipv4 - 0X20
  246
- Tx Request with TLS Profile - 0X23
  248
- AT Command Response - 0X88
  249
- Transmit (TX) Status - 0X89
  250
- Modem Status - 0X8A
  251
- Receive (RX) Packet: SMS - 0X9F
  252
- Receive (RX) Packet: Ipv4 - 0Xb0
  252
- User Data Relay - 0X2D
  253
  - Example Use Cases
    254
- User Data Relay Output - 0Xad
  254
- BLE Unlock API - 0X2C
  255
  - Example Sequence to Perform at Command Xbee API Frames over BLE
    257
- BLE Unlock Response - 0Xac
  258
- Socket Create - 0X40
  258
- Socket Create Response - 0Xc0
  258
- Socket Option Request - 0X41
  259
- Socket Option Response - 0Xc1
  260
- Socket Connect - 0X42
  261
- Socket Connect Response - 0Xc2
  262
- Socket Close - 0X43
  263
- Socket Close Response - 0Xc3
  263
- Socket Send (Transmit) - 0X44
  264
- Socket Sendto (Transmit Explicit Data): Ipv4 - 0X45
  264
- Socket Bind/Listen - 0X46
  265
- Socket Listen Response - 0Xc6
  266
- Socket New Ipv4 Client - 0Xcc
  266
- Socket Receive - 0Xcd
  267
- Socket Receive From: Ipv4 - 0Xce
  267
- Socket Status - 0Xcf
  268
- GNSS Start Raw NMEA, Stop Raw NMEA, or One Shot Request - 0X3D
  269
- GNSS Start Raw NMEA, Stop Raw NMEA, or One Shot Response - 0Xbd
  270
- GNSS Raw NMEA Response - 0Xbe
  270
- GNSS One Shot Response - 0Xbf
  271
File System API Frames

272
- Local File System Request - 0X3B
  273
  - File Open - 0X01
    274
  - File Close - 0X02
    275
  - File Read - 0X03
    276
  - File Hash - 0X08
    276
  - File Write - 0X04
    277
  - Directory Create - 0X10
    277
  - Directory Open - 0X11
    278
  - Directory Close - 0X12
    279
  - Directory Read - 0X13
    280
  - Get Path ID - 0X1C
    280
  - Delete - 0X2F
    281
  - Volume Info - 0X40
    281
  - Volume Format - 0X4F
    282
- Local File System Response - 0Xbb
  282
Regulatory Firmware

285
- Install the Regulatory Firmware
  285
  - Install Regulatory Firmware Using XCTU
    285
  - Install Regulatory Firmware Using Remote Manager
    286
- Configure Regulatory Firmware for Testing the Bluetooth Radio
  287
- Configure Regulatory Firmware for Testing the Cellular Component
  287
- Bluetooth DTM Protocol
  287
  - Example
    288
- Regulatory Testing Commands
  288
  - (Enable/Disable Test Mode)
    289
  - Start Test Mode)
    289
  - Stop Test Mode)
    290
  - Start Modulated Transmit)
    290
  - Stop Transmit)
    290
  - Set EARFCN)
    290
  - Get the EARFCN)
    291
  - Set Transmit Power)
    291
  - A (Get Transmit Power)
    291
  - D (Start Receive Mode)
    292
  - H (Set Channel Mapping)
    292
  - I (Get Channel Mapping)
    292
  - (Query Test State)
    293
Troubleshooting

294
- Cannot Find the Serial Port for the Device
  294
  - Condition
    294
  - Solution
    294
  - Other Possible Issues
    295
  - Enable Virtual COM Port (VCP) on the Driver
    296
- Correct a Macos Java Error
  297
  - Condition
    297
  - Solution
    297
- Unresponsive Cellular Component in Bypass Mode
  298
  - Condition
    298
  - Solution
    298
- Not on Expected Network after APN Change
  299
  - Condition
    299
  - Solution
    299
- Syntax Error at Line 1
  299
- Error Failed to Send SMS
  299
- Baud Rate in Bypass Mode
  299
Regulatory Information

300
- Antenna Regulatory Information: FCC and ISED
  300
  - Bluetooth Antennas
    300
  - Cellular Antennas
    300
  - FCC Publication 996369 Related Information
    302
- Labeling Requirements for the Host Device: FCC and ISED
  303
- Regulatory Information
  304
  - Modification Statement
    304
  - Interference Statement
    304
  - FCC Class B Digital Device Notice
    304
  - RF Exposure
    305
  - FCC Notices
    305
- Regulatory Information: ISED
  305
  - Modification Statement: ISED
    305
  - Interference Statement: ISED
    305
  - RF Exposure: ISED
    306

Digi XB3-C-G1-UT-001 User Manual (38 pages)

XBee 3 Cat 1 Smart Modem

Brand: Digi | Category: Modem | Size: 0 MB

Digi Categories

Network Router Control Unit Modem Gateway Server

More Digi Manuals

Digi XB3-C-G1-UT-001 Manuals

Digi XB3-C-G1-UT-001 User Manual (306 pages)

Table of Contents

Digi Xbee® 3 Cat 1 Smart Modem User Guide

Get Started with the Xbee Smart Modem

Xbee Connection Examples

Get Started with Micropython

Get Started with Bluetooth® Low Energy

Get Started with Digi Remote Manager

Examples: IOT Protocols with Transparent Mode

Update the Firmware

Technical Specifications

Hardware

Antenna Recommendations

Design Recommendations

Cellular Connection Process

Modes

Sleep Modes

Power Saving Features and Design Recommendations

Serial Communication

SPI Operation

File System

SMS Behaviors

Socket Behavior

Available Extended Socket Frames

Transport Layer Security (TLS)

AT Commands

Operate in API Mode

API Frames

File System API Frames

Regulatory Firmware

Troubleshooting

Regulatory Information

Digi XB3-C-G1-UT-001 User Manual (38 pages)

Table of Contents

Related Products

Digi Categories