Digi XBee3 XB3M1 - Page 211

To Next Page

To Previous Page

API frames

The following sections describe the API frames.

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

User Data Relay Output - 0xAD 227

BLE Unlock API - 0x2C 228

BLEUnlock Response - 0xAC 232

Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide

211

Main Page

Default Chapter4
- Table of Contents4
Digixbee3Cellularlte-M/NB-Iotglobalsmartmodemuserguide15
- Applicable Firmware and Hardware15
- NB-Iot Network15
- SIM Cards15
Get Started with the Xbee Smart Modem Development Kit16
- Identify the Kit Contents17
- Acquire a SIM Card18
  - US Customers18
  - European Customers18
- Connect the Hardware19
- XBIB-U-DEV Reference21
- XBIB-CU-TH Reference23
- XBIB-C-GPS Reference26
- Interface with the XBIB-C-GPS Module27
- Cellular Service29
- Configure and Update Your Xbee30
- Xbee Bootloader39
Xbee Connection Examples41
- Connect to the Echo Server42
- Connect to the ELIZA Server44
- Connect to the Daytime Server46
- Perform a (GET) HTTP Request48
- Get Started with Coap50
- Connect to a TCP/IP Address54
- Get Started with MQTT55
- Debugging63
- Software Libraries63
Get Started with Micropython64
- About Micropython65
  - Why Use Micropython65
- Micropython on the Xbee Smart Modem65
- Use XCTU to Enter the Micropython Environment65
- Use the Micropython Terminal in XCTU66
  - Troubleshooting66
- Example: Hello World66
- Example: Turn on an LED66
- Example: Debug the Secondary UART67
- Exit Micropython Mode68
- Other Terminal Programs68
  - Tera Term for Windows69
- Use Picocom in Linux70
Get Started with BLE72
- Enable BLE on an Xbee Device72
- Enable BLE and Configure the BLE Password Using XCTU72
- Get the Digi Xbee Mobile Phone Application73
- Connect with BLE and Configure Your Xbee Device74
- BLE Reference74
Get Started with Digi Remote Manager77
- Create a Remote Manager Account and Add Devices77
- Configure Remote Manager Features by Scheduling Tasks79
- Manage Data in Remote Manager88
- Remote Manager Reference95
Technical Specifications99
- Interface and Hardware Specifications100
- Cellular RF Characteristics100
- Bluetooth RF Characteristics100
- Cellular Networking Specifications100
- Power Requirements101
- Power Consumption102
- Electrical Specifications103
- Regulatory Approvals104
Hardware105
- Mechanical Drawings106
- Pin Signals106
  - Pin Connection Recommendations107
- Rssi Pwm108
- SIM Card108
- Associate LED Functionality108
Antenna Recommendations110
- Antenna Placement111
Design Recommendations112
- Cellular Component Firmware Updates113
- Power Supply Considerations113
- Minimum Connection Diagram113
- Heat Considerations and Testing114
- Custom Configuration: Create a New Factory Default114
  - Set a Custom Configuration115
  - Clear All Custom Configurations on a Device115
- Clean Shutdown115
Cellular Connection Process117
- Connecting118
  - Cellular Network118
  - Data Network Connection118
- Data Communication with Remote Servers (TCP/UDP)118
- Disconnecting119
Modes120
- Select an Operating Mode121
- Transparent Operating Mode122
- API Operating Mode122
- Command Mode122
- Micropython Mode124
- USB Direct Mode125
  - Configure the Data Pins125
  - Enable USB Direct Mode125
- Bypass Operating Mode (DEPRECATED)125
Sleep Modes127
- About Sleep Modes128
- Normal Mode128
- Pin Sleep Mode128
- Cyclic Sleep Mode128
- Cyclic Sleep with Pin Wake up Mode128
- SPI Mode and Sleep Pin Functionality128
- The Sleep Timer129
- Micropython Sleep Behavior129
Power Saving Features130
- Airplane Mode131
- Power Saving Mode (PSM)131
- PSM Behavior131
- Deep Sleep Mode131
Serial Communication133
- Serial Interface134
- Serial Data134
- UART Data Flow134
- Serial Buffers135
- CTS Flow Control135
- RTS Flow Control135
- Enable UART or SPI Ports135
- I2C136
SPI Operation137
- SPI Communications138
- Full Duplex Operation139
- Low Power Operation140
- Select the SPI Port140
- Force UART Operation141
- Data Format141
File System142
- Overview of the File System143
- XCTU Interface144
- Encrypt Files144
Socket Behavior145
- Supported Sockets146
- Best Practices When Using Sockets146
  - Sockets and Remote Manager146
  - Sockets and API Mode146
- Socket Timeouts146
- Socket Limits in API Mode147
- Enable Incoming TCP Sockets in API Mode147
- API Mode Behavior for Outgoing TCP and SSL Connections147
- API Mode Behavior for Outgoing UDP Data148
- API Mode Behavior for Incoming TCP Connections148
- API Mode Behavior for Incoming UDP Data149
- Transparent Mode Behavior for Outgoing TCP and SSL Connections149
- Transparent Mode Behavior for Outgoing UDP Data150
- Transparent Mode Behavior for Incoming TCP Connections150
- Transparent Mode Behavior for Incoming UDP Connections150
Transport Layer Security (TLS)151
- TLS at Commands152
- Transparent Mode and TLS153
- API Mode and TLS153
- Key Formats153
- Certificate Formats153
- Certificate Limitations153
- Cipher Suites154
- Server Name Indication (SNI)154
- Secure the Connection between an Xbee and Remote Manager with Server Authentication154
Atcommands158
- Special Commands158
- Cellular Commands160
- Network Commands165
- Addressing Commands169
- Serial Interfacing Commands172
- I/O Settings Commands175
- I/O Sampling Commands183
  - TP (Temperature)183
  - IS (Force Sample)183
- Sleep Commands185
- Command Mode Options187
- Micropython Commands189
  - PS (Python Startup)189
  - PY (Micropython Command)189
- Firmware Version/Information Commands191
- Diagnostic Interface Commands193
- Execution Commands196
  - NR (Network Reset)196
  - R (Modem Reset)196
- File System Commands197
- BLE Commands200
- Remote Manager Commands202
- System Commands205
Operate in API Mode206
- API Mode Overview207
- Use the AP Command to Set the Operation Mode207
- API Frame Format207
  - API Operation (AP Parameter = 1)207
  - API Operation with Escaped Characters (AP Parameter = 2)208
API Frames212
- AT Command - 0X08212
- AT Command: Queue Parameter Value - 0X09213
- Transmit (TX) SMS - 0X1F214
- Transmit (TX) Request: Ipv4 - 0X20215
- Tx Request with TLS Profile - 0X23217
- AT Command Response - 0X88219
- Transmit (TX) Status - 0X89220
- Modem Status - 0X8A222
- Receive (RX) Packet: SMS - 0X9F223
- Receive (RX) Packet: Ipv4 - 0Xb0224
- User Data Relay - 0X2D225
  - Example Use Cases225
- User Data Relay Output - 0Xad227
- BLE Unlock API - 0X2C228
  - Example Sequence to Perform at Command Xbee API Frames over BLE230
- BLE Unlock Response - 0Xac232
Packaged Firmware Updates234
- About Packaged Firmware Updates234
- FW Update - 0X2B235
- FW Update Response - 0Xab235
- Important Notes236
- Perform a Cellular Component Firmware Update236
- Error Recovery237
Troubleshooting238
- Cannot Find the Serial Port for the Device239
- Correct a Macos Java Error241
  - Condition241
  - Solution241
- Unresponsive Cellular Component in Bypass Mode242
  - Condition242
  - Solution242
- Syntax Error at Line 1242
- Error Failed to Send SMS242
- Network Connection Issues243
  - Condition243
  - Solution243
- Brownout Issue243
- Hardware Flow Control in Bypass Mode244
- Socket Leaks244
  - Condition244
  - Solution245
Regulatory Information246
- United States (FCC)247
- Innovation, Science and Economic Development Canada (ISED)250
  - Labeling Requirements250

Digi XBee3 XB3M1 - Page 211

Table of Contents

Related product manuals