Digi XBee 3 User Manual

API frames Tx Request with TLS Profile - 0x23
Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide
250
Tx Request with TLS Profile - 0x23
Description
The frame gives greater control to the application over the TLS settings used for a connection.
A TX Request with TLS Profile frame implies the use of TLS and behaves similar to the TX Request
(0x20) frame, with the protocol field replaced with a TLS Profile field to choose from the profiles
configured with the $0, $1, and $2 configuration commands.
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 0x23 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, the TX Status frame returns an error.
TLS profile Byte Zero-indexed number that indicates the profile as specified
by the corresponding $<num> command.
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

Brand	Digi
Model	XBee 3
Category	Modem
Language	English