Digi XBee3 - Operate in API Mode

172 pages

To Next Page

To Next Page

To Previous Page

To Previous Page

Loading...

Operate in API mode

API mode overview 138

Use the AP command to set the operation mode 138

API frame format 138

Digi XBee3 Cellular LTE-M Global Smart Modem User Guide

137

Table of Contents

Default Chapter1
- Syntax Error at Line1
  - Customer Support2
  - Table of Contents3
Digi Xbee3 Cellular LTE-M Global Smart Modem User Guide10
- Applicable Firmware and Hardware11
- SIM Cards11
Getting Started with the Xbee Smart Modem Development Kit12
- Identify the Kit Contents13
- Connect the Hardware14
- XBIB-U-DEV Reference16
- Cellular Service17
- Configure the Device Using XCTU18
- Connect to the ELIZA Server21
  - Debugging22
- Connect to the Echo Server23
  - Debugging24
- Connect to the Daytime Server25
  - Debugging26
- Get Started with Micropython26
- More Examples32
- Software Libraries48
Technical Specifications50
- Interface and Hardware Specifications51
- Cellular RF Characteristics51
- Bluetooth RF Characteristics51
- Cellular Networking Specifications51
- Power Requirements52
- Power Consumption53
- Electrical Specifications54
- Regulatory Approvals55
Hardware56
- Mechanical Drawings57
- Pin Signals57
  - Pin Connection Recommendations59
- Rssi Pwm59
- SIM Card59
- The Associate LED60
Antenna Recommendations61
- Antenna Placement62
Design Recommendations63
- Cellular Component Firmware Updates64
- USB Direct Design64
- Power Supply Considerations64
- Minimum Connection Diagram65
- Heat Considerations and Testing65
Cellular Connection Process67
- Connecting68
  - Cellular Network68
  - Data Network Connection68
- Data Communication with Remote Servers (TCP/UDP)68
- Disconnecting68
Modes70
- Select an Operating Mode71
- Transparent Operating Mode72
- API Operating Mode72
- Bypass Operating Mode72
- USB Direct Mode73
  - Configure the Data Pins73
  - Enable USB Direct Mode73
- Command Mode74
- Micropython Mode76
Sleep Modes77
- About Sleep Modes78
- Normal Mode78
- Pin Sleep Mode78
- Cyclic Sleep Mode78
- Cyclic Sleep with Pin Wake up Mode78
- SPI Mode and Sleep Pin Functionality78
- The Sleep Timer79
- Micropython Sleep Behavior79
Power Saving Features80
- Airplane Mode81
- Power Saving Mode (PSM)81
- PSM Behavior81
- Deep Sleep Mode81
Serial Communication82
- Serial Interface83
- Serial Data83
- UART Data Flow83
- Serial Buffers84
- CTS Flow Control84
- RTS Flow Control84
- Enable UART or SPI Ports84
SPI Operation86
- SPI Communications87
- Full Duplex Operation88
- Low Power Operation89
- Select the SPI Port89
- Force UART Operation90
- Data Format90
File System91
- Overview of the File System92
- XCTU Interface93
- Encrypt Files93
Socket Behavior95
- Supported Sockets95
- Socket Timeouts95
- Socket Limits in API Mode95
- Enable Incoming TCP Sockets in API Mode95
- API Mode Behavior for Outgoing TCP and SSL Connections95
- API Mode Behavior for Outgoing UDP Data96
- API Mode Behavior for Incoming TCP Connections96
- API Mode Behavior for Incoming UDP Data97
- Transparent Mode Behavior for Outgoing TCP and SSL Connections97
- Transparent Mode Behavior for Outgoing UDP Data97
- Transparent Mode Behavior for Incoming TCP Connections98
- Transparent Mode Behavior for Incoming UDP Connections98
Transport Layer Security (TLS)99
TLS at Commands100
- Transparent Mode and TLS101
- API Mode and TLS101
- Key Formats101
- Certificate Formats101
- Certificate Limitations101
- Cipher Suites102
- Server Name Indication (SNI)102
- AT Commands103
- Special Commands104
  - AC (Apply Changes)104
  - FR (Force Reset)104
  - RE (Restore Defaults)104
  - WR (Write)104
- Cellular Commands105
  - PH (Phone Number)105
  - S# (ICCID)105
  - IM (Imei)105
  - MN (Operator)105
  - MV (Modem Firmware Version)106
  - DB (Cellular Signal Strength)106
  - AN (Access Point Name)106
  - CP (Carrier Profile)106
  - AM (Airplane Mode)107
- Network Commands107
  - IP (IP Protocol)107
  - TL (SSL/TLS Protocol Version)108
  - SSL/TLS Profile 0)108
  - SSL/TLS Profile 1)108
  - SSL/TLS Profile 2)109
  - TM (IP Client Connection Timeout)109
  - TS (IP Server Connection Timeout)109
  - DO (Device Options)109
  - EQ (Remote Manager FQDN)110
- Addressing Commands110
  - SH (Serial Number High)111
  - SL (Serial Number Low)111
  - MY (Module IP Address)111
  - P# (Destination Phone Number)111
  - N1 (DNS Address)111
  - N2 (DNS Address)112
  - DL (Destination Address)112
  - OD (Operating Destination Address)112
  - DE (Destination Port)112
  - C0 (Source Port)113
  - LA (Lookup IP Address of FQDN)113
- Serial Interfacing Commands113
  - BD (Baud Rate)113
  - NB (Parity)114
  - SB (Stop Bits)114
  - RO (Packetization Timeout)115
  - TD (Text Delimiter)115
  - FT (Flow Control Threshold)115
  - AP (API Enable)115
- I/O Settings Commands116
  - D0 (Dio0/Ad0)116
  - D1 (Dio1/Ad1)116
  - D2 (Dio2/Ad2)117
  - D3 (Dio3/Ad3)117
  - D4 (Dio4)118
  - D5 (Dio5/Associated_Indicator)118
  - D6 (Dio6/Rts)118
  - D7 (Dio7/Cts)119
  - D8 (Dio8/Sleep_Request)119
  - P0 (DIO10/PWM0 Configuration)120
  - P1 (DIO11/PWM1 Configuration)121
  - P2 (DIO12 Configuration)121
  - P3 (Dio13/Dout)122
  - P4 (Dio14/Din)122
  - PD (Pull Direction)122
  - PR (Pull-Up/Down Resistor Enable)123
  - M0 (PWM0 Duty Cycle)124
- I/O Sampling Commands124
  - TP (Temperature)124
  - IS (Force Sample)124
- Sleep Commands125
  - SM (Sleep Mode)125
  - SP (Sleep Period)126
  - ST (Wake Time)126
  - PA (Requested Active Timer)126
  - PU (Requested Tracking Area Update Timer)126
- Command Mode Options127
  - CC (Command Sequence Character)127
  - CT (Command Mode Timeout)127
  - CN (Exit Command Mode)127
  - GT (Guard Times)128
- Micropython Commands128
  - PS (Python Startup)128
  - PY (Micropython Command)128
- Firmware Version/Information Commands129
  - VR (Firmware Version)129
  - VL (Verbose Firmware Version)129
  - HV (Hardware Version)130
  - AI (Association Indication)130
  - HS (Hardware Series)130
  - CK (Configuration CRC)131
- Diagnostic Interface Commands131
  - DI (Remote Manager Indicator)131
  - CI (Protocol/Connection Indication)131
- Execution Commands133
  - NR (Network Reset)133
  - R (Modem Reset)133
- File System Commands133
  - Error Responses134
  - ATFS (File System)134
  - Atfs Pwd134
  - ATFS CD Directory134
  - ATFS MD Directory135
  - ATFS LS [Directory]135
  - ATFS PUT Filename135
  - ATFS XPUT Filename135
  - ATFS HASH Filename135
  - ATFS GET Filename135
  - ATFS MV Source_Path Dest_Path135
  - ATFS RM File_Or_Directory136
  - Atfs Info136
  - ATFS FORMAT Confirm136
Operate in API Mode137
- API Mode Overview138
- Use the AP Command to Set the Operation Mode138
- API Frame Format138
  - API Operation (AP Parameter = 1)138
  - API Operation with Escaped Characters (AP Parameter = 2)139
API Frames143
- AT Command - 0X08143
- Transmit (TX) SMS - 0X1F144
- Transmit (TX) Request: Ipv4 - 0X20145
- Tx Request with TLS Profile - 0X23147
- AT Command Response - 0X88149
- Transmit (TX) Status - 0X89150
- Modem Status - 0X8A152
- Receive (RX) Packet: SMS - 0X9F153
- Receive (RX) Packet: Ipv4 - 0Xb0154
Configure the Xbee Smart Modem Using Digi Remote Manager155
- Create a Remote Manager Account156
- Get the Xbee Smart Modem IMEI Number156
- Add a Xbee Smart Modem to Remote Manager156
- Update the Firmware157
- Update the Firmware Using Web Services157
  - Example: Update the Xbee Firmware Synchronously with Python 3.0157
  - Example: Use the Device's Firmware Image to Update the Xbee Firmware Synchronously158
Troubleshooting160
- Cannot Find the Serial Port for the Device161
- Correct a Macos Java Error163
  - Condition163
  - Solution163
- Unresponsive Cellular Component in Bypass Mode164
  - Condition164
  - Solution164
- Error Failed to Send SMS164
- Network Connection Issues165
  - Condition165
  - Solution165
- Brownout Issue165
- Hardware Flow Control in Bypass Mode166
- Socket Leaks166
  - Condition166
  - Solution167
Regulatory Information168
- United States (FCC)169
- Innovation, Science and Economic Development Canada (ISED)171
  - Labeling Requirements171

Related product manuals

Preview: Digi XBee 3

Preview: Digi XBee3 XB3M1

Digi XBee3 XB3M1

Preview: Digi XStream-PKG

Digi XStream-PKG

Preview: Digi XTP9B-PKC-UA

Digi XTP9B-PKC-UA

Digi XBee3 802.15.4

Preview: Digi XBee

Preview: Digi XBEE2

Preview: Digi XBee SX

Preview: Digi XBee-PRO S3

Digi XBee-PRO S3

Preview: Digi XBee SX 868

Digi XBee SX 868

Preview: Digi XBee-PRO XSC

Digi XBee-PRO XSC

Digi XBEE-PRO S3B