Digi XBee 3 User Manual

API frames Transmit (TX) Request: IPv4 - 0x20
Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide
248
Transmit (TX) Request: IPv4 - 0x20
Description
A TX Request message causes the device to transmit data in IPv4 format. A TX request frame for a
new destination creates a network socket. After the network socket is established, data from the
network that is received on the socket is sent out the device's serial port in the form of a Receive (RX)
Packet 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 0x20 Byte
Frame ID Byte Reference identifier used to match status responses. 0
disables the TX Status frame.
Destination
address
32-bit big
endian
Destination port 16-bit
bigendian
Source port
16-bit
bigendian
If the source port is 0, the device attempts to send the frame
data using an existing open socket with a destination that
matches the destination address and destination port fields
of this frame. If there is no matching socket, then the device
attempts to open a new socket.
If the source port is non-zero, the device attempts to send
the frame data using an existing open socket with a source
and destination that matches the source port, destination
address, and destination port fields of this frame. If there is
no matching socket, it returns an error.
Protocol Byte 0 = UDP
1 = TCP
4 = SSL over TCP
Transmitoptions Byte
bitfield
Bit fields are offset 0
Bit field 0 - 7. Bits 0, and 2-7 are reserved, bit 1 is not.
BIT 1 =
1 - Terminate the TCP socket after transmission is complete
0 - Leave the socket open. Closed by timeout, see TM (IP
Client Connection Timeout).
Ignore this bit for UDP packets.
All other bits are reserved and should be 0.

Digi XBee 3 Specifications

General

Model	XBee 3
Category	Modem
Frequency Bands	2.4 GHz, 868 MHz, 900 MHz
Interface	UART, SPI, I2C
Operating Temperature	-40° C to +85° C
Power Supply	2.1V to 3.6V
Antenna	External or onboard
Transmit Power	up to 20 dBm
Security	AES encryption
Protocols	Zigbee, 802.15.4, DigiMesh

Summary

Getting Started with the XBee Smart Modem

Connect Hardware and Install XCTU

Step-by-step instructions for connecting hardware and installing XCTU utility.

Update Firmware and Check Connection

Procedures for updating device firmware and verifying cellular connection status.

XBee Connection Examples

Getting Started with MicroPython

MicroPython Basics and Setup

Introduction to MicroPython and setting up the environment using XCTU.

MicroPython Examples

Update the Firmware

Plan for Firmware Updates

Update Device and Cellular Firmware

Procedures for updating device and cellular firmware using XCTU.

Update Telit Modem Firmware with XFP Utility

Instructions for updating the Telit modem firmware using the XFP utility.

AT Commands Reference

Special, Cellular, and Network Commands

Reference for special, cellular, and network configuration AT commands.

I/O, Sleep, and Mode Commands

Configuration commands for I/O settings, sleep modes, and operating modes.

File System, BLE, Socket, and API Commands

Commands for file system, BLE, sockets, and API frame management.

Troubleshooting Guide

Serial Port and Driver Issues

macOS Java Errors and Bypass Mode Issues

Network, SMS, and Baud Rate Troubleshooting