Digi XBee 3 User Manual

Socket behavior API mode behavior for incoming UDP data
Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide
163
API mode behavior for incoming UDP data
When the IP (IP Protocol) setting is UDP, any data sent from a remote host to the XBee Smart
Modem's network port specified by the C0 (Source Port) setting is sent out the XBee Smart Modem's
serial port as a Receive (RX) Packet: IPv4 - 0xB0 frame.
To send data from the XBee Smart Modem to the remote destination, use the Transmit (TX) Request:
IPv4 - 0x20 frame with the corresponding address fields received from the Receive RX frame. In other
words take the source address, source port, and destination port fields from the Receive (RX) frame
and use those respectively as the destination address, destination port, and source port fields for the
Transmit (TX) Request frame.
Transparent mode behavior for outgoing TCP and TLS
connections
For Transparent mode, the IP (IP Protocol) setting specifies the protocol and the DL (Destination
Address) and DE (Destination port) settings specify the destination address used for outgoing data
(UDP) and outgoing connections (TCP and TLS).
To initiate an outgoing TCP or TLS connection to a remote host, send data to the XBee Smart
Modem's serial port. If CI (Protocol/Connection Indication) reports a value of 0, then the connection
was successfully established, otherwise the value of CI indicates why the connection attempt failed.
Any data received over the connection is sent out the XBee Smart Modem's serial port.
A connection is closed when:
n The remote end closes the connection.
n No data has been sent or received for longer than the socket timeout set by TM (IP Client
Connection Timeout).
n You make and apply a change to the IP, DL, or DE.
Transparent mode behavior for outgoing UDP data
To send outgoing UDP data to a remote host, send data to the XBee Smart Modem's serial port. If CI
(Protocol/Connection Indication) reports a value of 0, the data was successfully sent; otherwise, the
value of CI indicates why the data failed to be sent.
The RO (Packetization Timeout) setting provides some control in how the serial data gets packetized
before being sent to the remote host. The first send opens up a UDP socket used to send and receive
data. Any data received by this socket is sent out the XBee Smart Modem's serial port.
Note Set RO to FF for realtime typing by humans. Also, see TD (Text Delimiter).
Transparent mode behavior for incoming TCP connections
The C0 (Source Port) and IP (IP Protocol) settings specify the listening port and protocol used for
incoming connections (TCP) and incoming data (UDP) in Transparent mode. TLS is not currently
supported for incoming connections.
When the IP setting is TCP and there is no existing connection to or from the XBee Smart Modem, the
device accepts one incoming connection. Any data received on the connection is sent out the XBee
Smart Modem's serial port. Any data sent to the XBee Smart Modem's serial port is sent over the
connection. If the connection is disconnected, it discards pending data.

Digi XBee 3 Specifications

General

Brand	Digi
Model	XBee 3
Category	Modem
Language	English