Name: Digi XBee 3
Brand: Digi
Rating: 4 (1 reviews)

To Next Page

To Previous Page

API frames Socket Option Response - 0xC1

Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide

269

Socket Option Response - 0xC1

Description

Reports the status of requests made with the Socket Option Request (0x41) frame.

Format

The following table provides the contents of the frame. For details on frame structure, see API frame

format.

Field name

Field

value Data type Description

Frame type 0xC1 Byte

Frame ID Byte Identifier provided in request.

Socket ID Byte The socket IDfor which modification was

requested.

Option ID Byte Identifier of the parameter requested.

Status Byte

0x00: Success

0x01: Invalid parameters

0x02: Failed to retrieve option value

0x20: Bad socket ID

Option Data Variable Current effective value of the option. This

field is only present if the corresponding

request was a query (empty value).

Default Chapter2
- Customer Support2
- Table of Contents4
Digi Xbee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide15
- Applicable Firmware and Hardware15
- SIM Cards15
Get Started with the Xbee Smart Modem16
- Identify the Kit Contents17
- Connect the Hardware18
- Install and Upgrade XCTU19
  - Add a Device to XCTU19
- Update the Device and Cellular Firmware Using XCTU20
- Check for Cellular Registration and Connection20
- Cellular Service20
Xbee Connection Examples23
- Connect to the Echo Server23
- Connect to the ELIZA Server25
- Connect to the Daytime Server27
- Send an SMS Message to a Phone29
- Perform a (GET) HTTP Request31
- Connect to a TCP/IP Address33
- Software Libraries33
Get Started with Micropython36
- About Micropython36
  - Why Use Micropython36
- Micropython on the Xbee Smart Modem36
- Use XCTU to Enter the Micropython Environment36
- Use the Micropython Terminal in XCTU37
  - Troubleshooting37
- Example: Hello World37
- Example: Turn on an LED37
- Example: Code a Request Help Button38
- Example: Debug the Secondary UART43
- Exit Micropython Mode43
- Other Terminal Programs44
  - Tera Term for Windows44
- Use Picocom in Linux45
Get Started with BLE47
- On Xbee 3 Cellular Firmware Ending in X15 or Newer47
- On Xbee 3 Cellular Firmware Ending in X14 or Older47
- Enable BLE on an Xbee Device48
- Enable BLE and Configure the BLE Password Using XCTU48
- Get the Digi Xbee Mobile Phone Application49
- Connect with BLE and Configure Your Xbee Device49
- BLE Reference50
Get Started with Digi Remote Manager52
- Create a Remote Manager Account and Add Devices52
- Configure Remote Manager Features by Scheduling Tasks54
- Manage Data in Remote Manager62
  - Review Device Status Information from Remote Manager62
  - Manage Secure Files in Remote Manager63
- Remote Manager Reference64
Examples: IOT Protocols with Transparent Mode69
- Get Started with Coap70
- Get Started with MQTT74
Updatethefirmware84
- Create a Plan for Device and Cellular Component Firmware Updates84
- Update the Device and the Cellular Firmware Using XCTU85
  - Update the Device and Cellular Firmware Using XCTU and USB Direct Access85
- Update the Device Firmware87
- Update the Cellular Firmware94
  - Update the Cellular Component Firmware Using Remote Manager94
  - Update the Telit Modem Firmware Using the XFP Utility97
Technical Specifications101
- Interface and Hardware Specifications102
- RF Characteristics102
- Networking Specifications102
- Power Requirements102
- Power Consumption103
- Electrical Specifications103
- Regulatory Approvals104
Hardware106
- Mechanical Drawings107
- Pin Signals107
  - Pin Connection Recommendations108
- Rssi Pwm109
- SIM Card109
- Associate LED Functionality109
- Development Boards111
Antenna Recommendations119
- Antenna Connections119
- Keepout Area120
  - Through-Hole Keepout121
- Antenna Placement121
Design Recommendations123
- Cellular Component Firmware Updates123
- Power Supply Considerations123
- Recommended Application Circuit123
- Heat Considerations and Testing124
- Heat Sink Guidelines125
- Add a Fan to Provide Active Cooling126
- Custom Configuration: Create a New Factory Default126
  - Set a Custom Configuration127
  - Clear All Custom Configurations on a Device127
- Clean Shutdown127
Cellular Connection Process129
- Connecting130
  - Cellular Network130
  - Data Network Connection130
- Data Communication with Remote Servers (TCP/UDP)130
- Disconnecting130
Modes132
- Select an Operating Mode133
- Transparent Operating Mode134
- API Operating Mode134
- Bypass Operating Mode (DEPRECATED)134
- USB Direct Mode135
  - Enable USB Direct Mode135
  - Configure and Use PPP with a Digi Xbee 3 Cellular CAT 1 AT&T Modem136
- Command Mode139
- Micropython Mode141
Sleep Modes142
- About Sleep Modes143
- Normal Mode143
- Pin Sleep Mode143
- Cyclic Sleep Mode143
- Cyclic Sleep with Pin Wake up Mode143
- The Sleep Timer143
- Micropython Sleep Behavior143
Power Saving Features and Design Recommendations145
- Airplane Mode146
Serial Communication147
- Serial Interface148
- Serial Data148
- UART Data Flow148
- Serial Buffers148
- CTS Flow Control149
- RTS Flow Control149
- Enable UART or SPI Ports149
SPI Operation150
- SPI Communications151
- Full Duplex Operation152
- Low Power Operation153
- Select the SPI Port153
- Force UART Operation154
- Data Format154
File System155
- Overview of the File System156
- XCTU Interface157
- Encrypt Files157
SMS Behaviors158
- SMS Encoding158
Socket Behavior159
- Supported Sockets160
- Best Practices When Using Sockets160
  - Sockets and Remote Manager160
  - Sockets and API Mode160
- Socket Timeouts160
- Socket Limits in API Mode160
- Enable Incoming TCP Connections161
- API Mode Behavior for Outgoing TCP and TLS Connections161
- API Mode Behavior for Outgoing UDP Data162
- API Mode Behavior for Incoming TCP Connections162
- API Mode Behavior for Incoming UDP Data163
- Transparent Mode Behavior for Outgoing TCP and TLS Connections163
- Transparent Mode Behavior for Outgoing UDP Data163
- Transparent Mode Behavior for Incoming TCP Connections163
- Transparent Mode Behavior for Incoming UDP Connections164
Extended Socket Frames165
- Examples165
- Available Extended Socket Frames166
- Extended Socket Example: Single HTTP Connection166
- Extended Socket Example: UDP170
- Extended Socket Example: TCP Listener175
Transport Layer Security (TLS)179
- Specifying TLS Keys and Certificates180
- Transparent Mode and TLS181
- API Mode and TLS181
- Key Formats181
- Certificate Limitations181
- Cipher Suites181
- Server Name Indication (SNI)182
- Secure the Connection between an Xbee and Remote Manager with Server Authentication182
Atcommands185
- Special Commands185
- Cellular Commands187
- Network Commands193
- Addressing Commands196
- Serial Interfacing Commands199
- I/O Settings Commands203
- I/O Sampling Commands212
  - TP (Temperature)212
  - IS (Force Sample)212
- Sleep Commands214
- Command Mode Options215
- Micropython Commands217
  - PS (Python Startup)217
  - PY (Micropython Command)217
- Firmware Version/Information Commands219
- Diagnostic Interface Commands223
- Execution Commands227
  - NR (Network Reset)227
  - R (Modem Reset)227
- File System Commands228
- BLE Commands231
- Remote Manager Commands233
- System Commands236
- Socket Commands237
  - Socket Info)237
Operate in API Mode239
- API Mode Overview240
- Use the AP Command to Set the Operation Mode240
- API Frame Format240
  - API Operation (AP Parameter = 1)240
  - API Operation with Escaped Characters (AP Parameter = 2)241
API Frames244
- AT Command - 0X08245
- AT Command: Queue Parameter Value - 0X09246
- Transmit (TX) SMS - 0X1F247
- Transmit (TX) Request: Ipv4 - 0X20248
- Tx Request with TLS Profile - 0X23250
- AT Command Response - 0X88252
- Transmit (TX) Status - 0X89253
- Modem Status - 0X8A255
- Receive (RX) Packet: SMS - 0X9F256
- Receive (RX) Packet: Ipv4 - 0Xb0257
- User Data Relay - 0X2D258
  - Example Use Cases258
- User Data Relay Output - 0Xad260
- BLE Unlock API - 0X2C261
  - Example Sequence to Perform at Command Xbee API Frames over BLE263
- BLE Unlock Response - 0Xac265
- Socket Create - 0X40266
- Socket Create Response - 0Xc0267
- Socket Option Request - 0X41268
- Socket Option Response - 0Xc1269
- Socket Connect - 0X42270
- Socket Connect Response - 0Xc2271
- Socket Close - 0X43272
- Socket Close Response - 0Xc3273
- Socket Send (Transmit) - 0X44274
- Socket Sendto (Transmit Explicit Data): Ipv4 - 0X45275
- Socket Bind/Listen - 0X46276
- Socket Listen Response - 0Xc6277
- Socket New Ipv4 Client - 0Xcc278
- Socket Receive - 0Xcd279
- Socket Receive From: Ipv4 - 0Xce280
- Socket Status - 0Xcf281
Troubleshooting282
- Cannot Find the Serial Port for the Device283
- Correct a Macos Java Error285
  - Condition285
  - Solution285
- Unresponsive Cellular Component in Bypass Mode286
  - Condition286
  - Solution286
- Not on Expected Network after APN Change287
  - Condition287
  - Solution287
- Syntax Error at Line 1287
- Error Failed to Send SMS287
- Baud Rate in Bypass Mode287
Regulatory Information288
- Modification Statement289
- Interference Statement289
- FCC Class B Digital Device Notice289
- RF Exposure290
- FCC Notices290
  - Cellular Antennas291
- Labeling Requirements for the Host Device292

Digi XBee 3 User Manual

Table of Contents

Other manuals for Digi XBee 3

Questions and Answers:

Digi XBee 3 Specifications

Related product manuals

Brand	Digi
Model	XBee 3
Category	Modem
Language	English