sgwireless.com
Firmware & API Reference
MicroPython Modules
usocket

usocket

This module provides access to the BSD socket interface.

See corresponding CPython module for comparison.

Socket Address Format(s)

Functions below which expect a network address, accept it in the format of (ipv4_address, port), where ipv4_address is a string with dot-notation numeric IPv4 address, e.g. 8.8.8.8, and port is integer port number in the range 1-65535. Note the domain names are not accepted as ipv4_address, they should be resolved first using socket.getaddrinfo().

Methods

socket.socket([socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP])

Create a new socket using the given address family, socket type and protocol number. The initialiser takes the following arguments: Family type:

  • socket.AF_INET: For use with Internet protocols (WiFi, LTE, Ethernet)
  • socket.AF_LORA: For use with LoRa RAW or LoRaWAN.
  • socket.AF_SIGFOX: For use with Sigfox. Socket type:
  • socket.SOCK_STREAM: Creates a stream socket (INET socket only, UDP protocol only).
  • socket.SOCK_DGRAM: Creates a datagram socket (INET socket only, TCP protocol only).
  • socket.SOCK_RAW: A raw socket receives or sends the raw datagram not including link level headers (INET, LoRa and Sigfox) Socket protocol options:
  • socket.IPPROTO_IP
  • socket.IPPROTO_ICMP
  • socket.IPPROTO_UDP
  • socket.IPPROTO_TCP
  • socket.IPPROTO_IPV6
  • socket.IP_ADD_MEMBERSHIP
  • socket.IPPROTO_RAW: Only option for LoRa and Sigfox.

By default, sockets are set to be blocking.

socket.setsockopt(level, optname, value)

Set the value of the given socket option. The needed symbolic constants are defined in the socket module (SO_* etc.). The value can be an integer or a bytes-like object representing a buffer. This function takes the following arguments:

  • level: The socket type, can take the following values. Select the socket option layer for the socket you’re using:
    • socket.SOL_SOCKET
    • socket.SOL_LORA
    • socket.SOL_SIGFOX
  • optname: The option name, can take the following values, depending on the chosen socket level.
    • IP socket options:
      • socket.SO_REUSEADDR: Enable address reusing (Enabled by default)
    • LoRa socket options:
      • socket.SO_CONFIRMED: Request a LoRa packet to be acknowledged by the network.
      • socket.SO_DR: Set the datarate, see the LoRa Socket API for more information.
    • Sigfox socket options:
      • socket.SO_RX: Wait for a downlink after sending the uplink packet
      • socket.SO_TX_REPEAT: Repeat the transmitted packet
      • socket.SO_OOB: Use the socket to send a Sigfox Out Of Band (OOB) message
      • socket.SO_BIT: Select the bit value when sending bit-only packets

socket.getaddrinfo(host, port)

Translate the host/port argument into a sequence of 5-tuples that contain all the necessary arguments for creating a socket connected to that service. The list of 5-tuples has following structure:

(family, type, proto, canonname, sockaddr) The following example shows how to connect to a given url:

s = socket.socket()
s.connect(socket.getaddrinfo('www.micropython.org', 80)[0][-1])

Socket methods

s.close()

Mark the socket closed. Once that happens, all future operations on the socket object will fail. The remote end will receive no more data (after queued data is flushed).

Sockets are automatically closed when they are garbage-collected, but it is recommended to close() them explicitly, or to use a with statement around them.

s.bind(address)

Bind the socket to address. The socket must not already be bound. The address parameter must be a tuple containing the IP address and the port.

In the case of LoRa sockets, the address parameter is simply an integer with the port number, for instance: s.bind(1)

s.listen([backlog])

Enable a server to accept connections. If backlog is specified, it must be at least 0 (if it’s lower, it will be set to 0); and specifies the number of unaccepted connections that the system will allow before refusing new connections. If not specified, a default reasonable value is chosen.

s.accept()

Accept a connection. The socket must be bound to an address and listening for connections. The return value is a pair (conn, address) where connis a new socket object usable to send and receive data on the connection, and address is the address bound to the socket on the other end of the connection.

s.connect(address)

Connect to a remote socket at address.

s.send(bytes)

Send data to the socket. The socket must be connected to a remote socket.

s.sendall(bytes)

Alias of s.send(bytes).

s.recv(bufsize)

Receive data from the socket. The return value is a bytes object representing the data received. The maximum amount of data to be received at once is specified by bufsize.

s.sendto(bytes, address)

Send data to the socket. The socket should not be connected to a remote socket, since the destination socket is specified by address.

s.recvfrom(bufsize)

Receive data from the socket. The return value is a pair (bytes, address) where bytes is a bytes object representing the data received and addressis the address of the socket sending the data.

s.settimeout(value)

Set a timeout on blocking socket operations. The value argument can be a nonnegative floating point number expressing seconds, or None. If a non-zero value is given, subsequent socket operations will raise a timeout exception if the timeout period value has elapsed before the operation has completed. If zero is given, the socket is put in non-blocking mode. If None is given, the socket is put in blocking mode.

s.setblocking(flag)

Set blocking or non-blocking mode of the socket: if flag is false, the socket is set to non-blocking, else to blocking mode. This will override the timeout setting

This method is a shorthand for certain settimeout() calls:

s.setblocking(True) # is equivalent to s.settimeout(None)
s.setblocking(False) #is equivalent to s.settimeout(0.0)

s.makefile(mode=’rb’)

Return a file object associated with the socket. The exact returned type depends on the arguments given to makefile(). The support is limited to binary modes only (rb and wb). CPython’s arguments: encoding, errors, and newline are not supported.

The socket must be in blocking mode; it can have a timeout, but the file object’s internal buffer may end up in a inconsistent state if a timeout occurs.

Difference to CPython Closing the file object returned by makefile() WILL close the original socket as well.

s.read(size)

Read up to size bytes from the socket. Return a bytes object. If size is not given, it behaves just like socket.readall(), see below.

s.readall()

Read all data available from the socket until EOF. This function will not return until the socket is closed.

s.readinto(buf[, nbytes])

Read bytes into the buf. If nbytes is specified then read at most that many bytes. Otherwise, read at most len(buf) bytes.

Return value: number of bytes read and stored into buf.

s.readline()

Read a line, ending in a newline character.

Return value: the line read.

s.write(buf)

Write the buffer of bytes to the socket.

Return value: number of bytes written.

s.do_handshake()

Perform the SSL handshake on the previously “wrapped” socket with ssl.wrap_socket(). could be used when the socket is non-blocking and the SSL handshake is not performed during connect().

Example:

from network import WLAN
import time
import socket
import ssl
import uselect as select

wlan = WLAN(mode=WLAN.STA)
wlan.connect(ssid='', auth=(WLAN.WPA2, ''))
while not wlan.isconnected():
    time.sleep(1)
    print("Wifi .. Connecting")

print ("Wifi Connected")

a = socket.getaddrinfo('www.postman-echo.com', 443)[0][-1]
s = socket.socket()
s.setblocking(False)
s = ssl.wrap_socket(s)
try:
    s.connect(a)
except OSError as e:
    if str(e) == '119': # For non-Blocking sockets 119 is EINPROGRESS
        print("In Progress")
    else:
        raise e
poller = select.poll()
poller.register(s, select.POLLOUT | select.POLLIN)
while True:
    res = poller.poll(1000)
    if res:
        if res[0][1] & select.POLLOUT:
            print("Doing Handshake")
            s.do_handshake()
            print("Handshake Done")
            s.send(b"GET / HTTP/1.0\r\n\r\n")
            poller.modify(s,select.POLLIN)
            continue
        if res[0][1] & select.POLLIN:
            print(s.recv(4092))
            break
    break

socket.dnsserver([dnsIndex, ip_addr])

When no arguments are passed this function returns the configured DNS servers Primary (Index=0) and backup (Index = 1) to set primary and Backup DNS servers specify the Index and Ip Address.

Example:

>>> socket.dnsserver()
('10.0.0.1', '8.8.8.8')

Setting DNS servers:

>>> socket.dnsserver(1, '0.0.0.0')
>>> socket.dnsserver()
('10.0.0.1', '0.0.0.0')

Exceptions

socket.error, socket.timeout

Constants

  • Family types: socket.AF_INET, socket.AF_LORA, socket.AF_SIGFOX
  • Socket types: socket.SOCK_STREAM, socket.SOCK_DGRAM, socket.SOCK_RAW
  • Socket protocols: socket.IPPROTO_IP, socket.IPPROTO_ICMP, socket.IPPROTO_UDP, socket.IPPROTO_TCP, socket.IPPROTO_IPV6, socket.IP_ADD_MEMBERSHIP, socket.IPPROTO_RAW
  • Socket options layers: socket.SOL_SOCKET, socket.SOL_LORA, socket.SOL_SIGFOX
    • IP socket options: socket.SO_REUSEADDR
    • LoRa socket options: socket.SO_CONFIRMED, socket.SO_DR
    • Sigfox socket options: socket.SO_RX, socket.SO_TX_REPEAT, socket.SO_OOB, socket.SO_BIT