
API frames
Transmit (TX) Request: IPv4 - 0x20
Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide
255
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.
When you specify protocol
4
(TLS), the profile configuration specified by
is used to
form the TLS connection.
Note
For NB-IoT, TCP support is dependent on the network. Contact your network provider for
details.
Format
The following table provides the contents of the frame. For details on frame structure, see
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, the TX Status
frame returns an error.