10 Socket

Creates a socket and associates it with the specified protocol (TCP or UDP).

Successful creation of socket.

protocol

enumerator

IP protocol.

Valid values:
6: TCP
17: UDP

socket_handle

integer

Socket identifier be used for any operation on that socket.

Creates a persistent socket and associates it with the specified protocol (TCP or UDP).
A persistent socket will automatically re-connect when connection is lost.
It can also be stored so that the connection initiated on boot.


Notes:
Can be stored using AT&W.

Successful creation of persistent socket.

protocol

enumerator

IP protocol.

Valid values:
6: TCP
17: UDP

socket_handle

integer

Socket identifier be used for any operation on that socket.

Add a TLS context to a socket. This is only valid for TCP client sockets.

Successful response with the TLS context information for the specified socket. The response includes the TLS version, CA name, client certificate name, and client key name.

tls_version

enumerator

Minimum TLS version to use

Valid values:
0: Disable TLS
1: TLS 1.2 or up

client_cert_name

string

Name of the client certificate to use

Valid length: 1..32

socket_handle

integer

Socket identifier be used for any operation on that socket.

Establish a peer-to-peer connection to the specified remote host on the given remote port.

host_address

string

Remote host IP address or domain name of the remote host.

Valid length: 0..128

remote_port

integer

The port of the remote peer.

Valid values: 1..65535

Configure a TCP link with automatic re-connection. As opposed to AT+USOC, this command will not initiate
a connection directly but is used for configuring a link that is automatically setup on boot.


Notes:
Requires AT&W and a reboot before taking effect.

host_address

string

Remote host IP address or domain name.

Valid length: 0..128

remote_port

integer

The port of the remote peer.

Valid values: 1..65535

Removes an persistent socket configuration created by AT+USOPCR.


Notes:
Can be stored using AT&W.

config_id

integer

Configuration ID

List all persistent socket configurations.

The response for each persistent configuration.

config_id

integer

Configuration ID.

socket_handle

integer

Socket identifier be used for any operation on that socket.

Set the mode in which you would like to receive data in AT mode.


Notes:
Any created sockets or created persistent sockets will use the same receive mode as was configured when they were created
Requires AT&W and a reboot before taking effect.

Successful read response

read_mode

enumerator

Modes to read data in AT

Valid values:
0: Buffered mode
1: Direct String mode
2: Direct Binary Mode

Writes string data to the specified socket.
The command can be used for both TCP and UDP sockets after calling AT+USOC.
If socket is not ready to be written, generic negative error will be returned.
Check BSD errno (see BSD standard) by calling AT+USOE.

Successful write response.

written_length

integer

Data length that was written.

string_data

string

Data encoded as ascii chars.

Valid length: 0..1000

Writes binary data to the specified socket in binary mode.

Successful write response.

written_length

integer

Data length that was actually written to socket.

socket_handle

integer

Socket identifier be used for any operation on that socket.

Closes the specified socket.

The command blocks the AT command interface until the completion of the socket close operation.
When this function returns OK the socket is cleaned up and fully closed.

socket_handle

integer

Socket identifier to be used for any future operation on that socket.

Valid values: 0..256

Reads the specified amount of data from the specified socket.
Note that the data should include no null terminator characters.

Successful read response.

length

integer

Number of bytes to read.

Valid values: 1..1000

string_data

string

Data encoded as ascii chars.

Valid length: 0..1000

Reads the specified amount of data from the specified socket in binary mode.

Successful read response.

length

integer

Number of bytes to read.

Valid values: 1..1000

socket_handle

integer

Socket identifier be used for any operation on that socket.

Retrieves the last error that occurred in any socket operation, stored in the socket errno.

Successful response.

error_code

integer

BSD error code. See BSD standard for error code definitions.

Sets the specified socket in listening mode on the specified port of service, waiting for incoming connections (TCP) or data (UDP).

port

integer

Port of service, range 1-65535. Port numbers below 1024 are not recommended since they are usually reserved

Valid values: 1..65535

Reads the specified amount of data from the specified UDP socket.

Successful read response.

length

integer

Number of bytes to read.

Valid values: 1..900

remote_ip

ip_addr

The ip address of the remote peer.

string_data

string

Data encoded as ascii chars.

Valid length: 0..1000

Get the address of remote peer.

Successful read response.

socket_handle

integer

Socket identifier be used for any operation on that socket.

remote_port

integer

The port of the remote peer.

Valid values: 1..65535

List status for all created sockets.

Response for each created socket.

socket_status

enumerator

Valid values:
0: Not Connected
1: Listening
2: Connected

protocol

enumerator

IP protocol.

Valid values:
6: TCP
17: UDP

Set a socket option. See available options below.

Successful read response

option

enumerator

Available options to set

Valid values:
0: Turn on/off No delay feature for TCP sockets.
Integer flag: 0 = off (i.e. Nagle algorithm enabled), 1 = on (i.e. Nagle algorithm disabled)
Default: to 0

1: Set socket to be blocking or non blocking.
Integer flag: 0 = off, 1 = on.
Sockets are non-blocking by default (Note that read/write will always be non-blocking).
Can only be set while the socket is in a non connected state.
Note: Only valid for non-persistent TCP sockets, will have no effect on UDP sockets

2: Keep connections alive by sending keepalive probes.
Integer flag: 0 = off, 1 = on.
To calculate the keepalive time us this formula KeepIdle + (KeepIntvl * KeepCnt).
Defaults to 1.
Note: Only valid for TCP sockets.

3: Set Keep Idle value for the socket.
This specifies the amount of time (in sec) that the connection must be idle before sending keepalive probes (if keepalive is enabled).
Defaults to 3.
Note: Only valid for TCP sockets.

4: Set keep alive interval value for the socket. This is the time in seconds between two successive keepalive retransmissions.
Defaults to 3.
Note: Only valid for TCP sockets.

5: Set keep alive counter value for the socket.
The number of unanswered probes required to force closure of the socket.
Defaults to 3.
Note: Only valid for TCP sockets.

socket_handle

integer

Socket identifier be used for any operation on that socket.

Does a DNS lookup of a host name and returns the IP address.

Successful read response.

host_name

string

Name to lookup.

Valid length: 0..128

socket_handle

integer

Socket identifier be used for any operation on that socket.

number_bytes

integer

Number of bytes available to read. If socket is a UDP socket this number refers to the size of the next datagram.

socket_handle

integer

Socket identifier be used for any operation on that socket.

socket_handle

integer

Socket identifier be used for any operation on that socket.

remote_port

integer

The port of the remote peer.

Valid values: 1..65535

binary_data

binary

The received data.

binary_data

binary

The received data.

remote_ip

ip_addr

The ip address of the remote peer.

socket_handle

integer

Socket identifier be used for any operation on that socket.

listening_socket_handle

integer

The handle of the new connected socket. Use this for any further operations on the connection.

remote_ip

ip_addr

The ip address of the remote peer.