Digi XBee3 XB3M1 User Manual

Socket behavior Socket limits in API mode
Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide
147
Socket limits in API mode
Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for
details.
In API mode there are a fixed number of sockets available; see Supported sockets. When a Transmit
(TX) Request: IPv4 - 0x20 frame is sent to the XBee Smart Modem for a new destination, it creates a
new socket. The exception to this is when using the UDP protocol with the C0 source port, which
allows unlimited destinations on the socket created by C0 (Source Port). If no more sockets are
available, the device sends back a Transmit (TX) Status - 0x89 frame with a Resource Error. The
Resource Error resolves when an existing socket is closed. An existing socket may be closed when the
socket times out (see TM (IP Client Connection Timeout) and TS (IP Server Connection Timeout)) or
when the socket is closed via a TX request with the CLOSE flag set.
In API mode each socket has a maximum number of pending Transmit (TX) Requests allowed. When a
Transmit (TX) Request: IPv4 - 0x20 frame is sent to the XBee Smart Modem for an existing destination,
it sends that request using the socket for that destination. If the number of pending Transmit (TX)
Requests would be exceeded for the socket, the device sends back a Transmit (TX) Status - 0x89
frame with a Resource Error indicating that the device is not able to send the request and should retry
again later. The Resource Error resolves when a Transmit (TX) Request that is pending on the socket
is transmitted; this is indicated by the Transmit (TX) Status frame for the request.
Enable incoming TCP sockets in API mode
In API mode, you can enable incoming connections to the XBee Smart Modem.
Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for
details.
1. To enable listening, set C0 (Source Port) to the value of the listening port.
2. To use TCP for client and server socket connections, set IP (IP Protocol) to 0x01.
The listener allows multiple clients (incoming connections), up to the limit of the maximum number of
sockets on the system.
When the XBee Smart Modem receives RF data on the port defined by C0, you get a Receive (RX)
Packet: IPv4 - 0xB0 with the incoming address and port.
If you want to communicate back to the incoming connection, use the Transmit (TX) Request: IPv4 -
0x20 and enter the received address and port as the destination address and port, along with the
listening (C0) local source port.
API mode behavior for outgoing TCP and SSL connections
To initiate an outgoing TCP or SSL connection to a remote host, send a Transmit (TX) Request: IPv4 -
0x20 frame to the XBee Smart Modem's serial port specifying the destination address and destination
port for the remote host; the data is optional and the source port is 0.
Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for
details.
If the connection is disconnected at any time, send a Transmit TX Request frame to trigger a new
connection attempt.
To send data over this connection use the Transmit (TX) Request: IPv4 - 0x20.

Digi XBee3 XB3M1 Specifications

General

Brand	Digi
Model	XBee3 XB3M1
Category	Modem
Language	English

Summary

Customer Support and Feedback

Contact Digi Technical Support

Information on how to contact Digi for technical assistance, including phone and website.

Get Started with the XBee Smart Modem Development Kit

Connect the Hardware

Provides step-by-step instructions for connecting the XBee Smart Modem and antennas to the development board.

Configure and Update Your XBee

Update Device Firmware

Guides on using XCTU to update the XBee module to the latest firmware version.

Configure Cellular Connectivity

Instructions on setting up the module for cellular connectivity and configuring the APN.

Check Cellular Registration

Steps to verify proper cellular network registration and IP address assignment using AT commands.

Update u-blox Module

Instructions for updating the u-blox cellular module using ATMV, API mode, or FOTA.

XBee Connection Examples

Connect to TCP/IP Address

Provides instructions for connecting to any TCP/IP server using Transparent mode.

Get Started with MQTT

Explains the MQ Telemetry Transport (MQTT) protocol and its use with XBee devices.

Get Started with MicroPython

Use XCTU for MicroPython

Guides on entering the MicroPython environment and using the MicroPython Terminal in XCTU.

Get Started with BLE

Enable BLE on XBee

Explains how to enable and configure Bluetooth Low Energy (BLE) on XBee devices.

Connect and Configure via BLE

Instructions on connecting to XBee devices via BLE and configuring them using the mobile app.

Get Started with Digi Remote Manager

Create Remote Manager Account

Steps to create a Digi Remote Manager account and add XBee devices to the inventory.

Configure Remote Manager Features

Explains how to configure device settings and schedule tasks for remote management.

Update Firmware via Remote Manager

Guides on updating XBee firmware remotely using Digi Remote Manager.

Technical Specifications

Interface and Hardware Specifications

Details the physical and interface specifications of the XBee Smart Modem.

Power Requirements

Specifies the voltage and current requirements for operating the XBee Smart Modem.

Power Consumption

Details the current draw of the XBee Smart Modem in various operating states.

Electrical Specifications

Lists the electrical parameters such as voltage, current, and timing for the XBee Smart Modem.

Hardware

Mechanical Drawings

Shows the physical dimensions and pin layout of the XBee Smart Modem.

Pin Signals

Details the function and assignment of each pin on the XBee Smart Modem.

Antenna Recommendations

Antenna Placement Guidelines

Offers suggestions for optimal antenna placement to ensure performance and avoid interference.

Design Recommendations

Cellular Component Firmware Updates

Stresses the importance of providing access for cellular component firmware updates via USB.

Power Supply Considerations

Provides design practices for ensuring a stable and adequate power supply for the XBee Smart Modem.

Clean Shutdown Procedures

Details methods for safely shutting down the XBee modem to prevent data corruption.

Cellular Connection Process

Connecting to Cellular Network

Describes the sequence of steps the XBee Smart Modem takes to establish a cellular and data network connection.

Data Communication with Servers

Explains how communication with remote servers is initiated after establishing a data network connection.

Modes

Select Operating Mode

Introduces the different operating modes (Transparent, API, Bypass) and how to select them using the AP command.

API Operating Mode

Explains API mode for structured, packet-based communication via serial or SPI.

Command Mode

Details how to enter and use Command mode to configure the device using AT commands.

MicroPython Mode

Covers accessing and using the MicroPython environment on the XBee Smart Modem.

Power Saving Features

Power Saving Mode (PSM)

Details enabling PSM via DO bit 3 for low-power operation, with network-dependent support.

Deep Sleep Mode

Covers Deep Sleep mode where the cellular component is shut off and the processor sleeps.

Socket Behavior

Best Practices for Sockets

API Mode Behavior for Data Transmissions

Transparent Mode Behavior for Data Transmissions

Transport Layer Security (TLS)

TLS AT Commands

Lists AT commands used for interacting with TLS features like file system and protocol versions.

Secure Connection with Server Authentication

Guides on securing TLS connections to Digi Remote Manager with server authentication.

AT Commands

Special Commands

Cellular Commands

Details AT commands for cellular configuration, such as PH, S#, IM, MN, MV, DB, AN, CP, BM, BN, AM, N#.

Network Commands

Covers AT commands related to network settings like IP, TL, $, TM, TS, and DO.

Addressing Commands

Serial Interfacing Commands

I/O Settings Commands

Sleep Commands

MicroPython Commands

Execution Commands

File System Commands

BLE Commands

Remote Manager Commands

Explains AT commands for configuring Remote Manager interaction, such as DF, EQ, K1, K2, MO, $D, RI, DP, HF, HM.

Regulatory Information

United States (FCC)