Add Server creation and management support

adafruit_esp32spi/adafruit_esp32spi.py

@@ -64,6 +64,7 @@
 _GET_CURR_ENCT_CMD     = const(0x26)
 
 _SCAN_NETWORKS         = const(0x27)
+_START_SERVER_TCP_CMD  = const(0x28)
 _GET_SOCKET_CMD        = const(0x3F)
 _GET_STATE_TCP_CMD     = const(0x29)
 _DATA_SENT_TCP_CMD     = const(0x2A)
@@ -622,6 +623,25 @@ def socket_close(self, socket_num):
         if resp[0][0] != 1:
             raise RuntimeError("Failed to close socket")
 
+    def start_server(self, port, socket_num, conn_mode=TCP_MODE, ip=None): # pylint: disable=invalid-name
+        """Opens a server on the specified port, using the ESP32's internal reference number"""
+        if self._debug:
+            print("*** starting server")
+        self._socknum_ll[0][0] = socket_num
+        params = [struct.pack('>H', port), self._socknum_ll[0], (conn_mode,)]
+        if ip:
+            params.insert(0, ip)
+        resp = self._send_command_get_response(_START_SERVER_TCP_CMD, params)
+
+        if resp[0][0] != 1:
+            raise RuntimeError("Could not start server")
+
+    def server_state(self, socket_num):
+        """Get the state of the ESP32's internal reference server socket number"""
+        self._socknum_ll[0][0] = socket_num
+        resp = self._send_command_get_response(_GET_STATE_TCP_CMD, self._socknum_ll)
+        return resp[0][0]
+
     def set_esp_debug(self, enabled):
         """Enable/disable debug mode on the ESP32. Debug messages will be
         written to the ESP32's UART."""

adafruit_esp32spi/adafruit_esp32spi_requests.py

@@ -204,23 +204,11 @@ def request(method, url, data=None, json=None, headers=None, stream=False, timeo
         reason = ""
         if len(line) > 2:
             reason = line[2].rstrip()
-        while True:
-            line = sock.readline()
-            if not line or line == b"\r\n":
-                break
-
-            #print("**line: ", line)
-            title, content = line.split(b': ', 1)
-            if title and content:
-                title = str(title.lower(), 'utf-8')
-                content = str(content, 'utf-8')
-                resp.headers[title] = content
-
-            if line.startswith(b"Transfer-Encoding:"):
-                if b"chunked" in line:
-                    raise ValueError("Unsupported " + line)
-            elif line.startswith(b"Location:") and not 200 <= status <= 299:
-                raise NotImplementedError("Redirects not yet supported")
+        resp.headers = parse_headers(sock)
+        if "chunked" in resp.headers.get("transfer-encoding"):
+            raise ValueError("Unsupported " + line)
+        elif resp.headers.get("location") and not 200 <= status <= 299:
+            raise NotImplementedError("Redirects not yet supported")
 
     except:
         sock.close()
@@ -232,6 +220,27 @@ def request(method, url, data=None, json=None, headers=None, stream=False, timeo
 # pylint: enable=too-many-branches, too-many-statements, unused-argument
 # pylint: enable=too-many-arguments, too-many-locals
 
+def parse_headers(sock):
+    """
+    Parses the header portion of an HTTP request/response from the socket.
+    Expects first line of HTTP request/response to have been read already
+    return: header dictionary
+    rtype: Dict
+    """
+    headers = {}
+    while True:
+        line = sock.readline()
+        if not line or line == b"\r\n":
+            break
+
+        #print("**line: ", line)
+        title, content = line.split(b': ', 1)
+        if title and content:
+            title = str(title.lower(), 'utf-8')
+            content = str(content, 'utf-8')
+            headers[title] = content
+    return headers
+
 def head(url, **kw):
     """Send HTTP HEAD request"""
     return request("HEAD", url, **kw)

adafruit_esp32spi/adafruit_esp32spi_socket.py

@@ -42,6 +42,7 @@ def set_interface(iface):
 
 SOCK_STREAM = const(1)
 AF_INET = const(2)
+NO_SOCKET_AVAIL = const(255)
 
 MAX_PACKET = const(4000)
 
@@ -59,14 +60,16 @@ def getaddrinfo(host, port, family=0, socktype=0, proto=0, flags=0):
 class socket:
     """A simplified implementation of the Python 'socket' class, for connecting
     through an interface to a remote device"""
-    def __init__(self, family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None):
+    # pylint: disable=too-many-arguments
+    def __init__(self, family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None, socknum=None):
         if family != AF_INET:
             raise RuntimeError("Only AF_INET family supported")
         if type != SOCK_STREAM:
             raise RuntimeError("Only SOCK_STREAM type supported")
         self._buffer = b''
-        self._socknum = _the_interface.get_socket()
+        self._socknum = socknum if socknum else _the_interface.get_socket()
         self.settimeout(0)
+    # pylint: enable=too-many-arguments
 
     def connect(self, address, conntype=None):
         """Connect the socket to the 'address' (which can be 32bit packed IP or
@@ -90,7 +93,7 @@ def readline(self):
         stamp = time.monotonic()
         while b'\r\n' not in self._buffer:
             # there's no line already in there, read some more
-            avail = min(_the_interface.socket_available(self._socknum), MAX_PACKET)
+            avail = self.available()
             if avail:
                 self._buffer += _the_interface.socket_read(self._socknum, avail)
             elif self._timeout > 0 and time.monotonic() - stamp > self._timeout:
@@ -106,7 +109,7 @@ def read(self, size=0):
         #print("Socket read", size)
         if size == 0:   # read as much as we can at the moment
             while True:
-                avail = min(_the_interface.socket_available(self._socknum), MAX_PACKET)
+                avail = self.available()
                 if avail:
                     self._buffer += _the_interface.socket_read(self._socknum, avail)
                 else:
@@ -122,7 +125,7 @@ def read(self, size=0):
         received = []
         while to_read > 0:
             #print("Bytes to read:", to_read)
-            avail = min(_the_interface.socket_available(self._socknum), MAX_PACKET)
+            avail = self.available()
             if avail:
                 stamp = time.monotonic()
                 recv = _the_interface.socket_read(self._socknum, min(to_read, avail))
@@ -148,6 +151,39 @@ def settimeout(self, value):
         """Set the read timeout for sockets, if value is 0 it will block"""
         self._timeout = value
 
+    def available(self):
+        """Returns how many bytes of data are available to be read (up to the MAX_PACKET length)"""
+        if self.socknum != NO_SOCKET_AVAIL:
+            return min(_the_interface.socket_available(self._socknum), MAX_PACKET)
+        return 0
+
+    def connected(self):
+        """Whether or not we are connected to the socket"""
+        if self.socknum == NO_SOCKET_AVAIL:
+            return False
+        elif self.available():
+            return True
+        else:
+            status = _the_interface.socket_status(self.socknum)
+            # TODO: why is esp.<ConstantName> not defined? using magic numbers in mean time
+            result = status not in (1,
+                                    0,
+                                    5,
+                                    6,
+                                    10,
+                                    2,
+                                    3,
+                                    7)
+            if not result:
+                self.close()
+                self._socknum = NO_SOCKET_AVAIL
+            return result
+
+    @property
+    def socknum(self):
+        """The socket number"""
+        return self._socknum
+
     def close(self):
         """Close the socket, after reading whatever remains"""
         _the_interface.socket_close(self._socknum)

adafruit_esp32spi/adafruit_esp32spi_wifimanager.py

@@ -43,8 +43,8 @@ class ESPSPI_WiFiManager:
     NORMAL = const(1)
     ENTERPRISE = const(2)
 
-# pylint: disable=too-many-arguments
-    def __init__(self, esp, secrets, status_pixel=None, attempts=2, connection_type=NORMAL):
+    # pylint: disable=too-many-arguments, line-too-long
+    def __init__(self, esp, secrets, status_pixel=None, attempts=2, connection_type=NORMAL, debug=False):
         """
         :param ESP_SPIcontrol esp: The ESP object we are using
         :param dict secrets: The WiFi and Adafruit IO secrets dict (See examples)
@@ -56,7 +56,7 @@ def __init__(self, esp, secrets, status_pixel=None, attempts=2, connection_type=
         """
         # Read the settings
         self.esp = esp
-        self.debug = False
+        self.debug = debug
         self.ssid = secrets['ssid']
         self.password = secrets['password']
         self.attempts = attempts
@@ -78,7 +78,7 @@ def __init__(self, esp, secrets, status_pixel=None, attempts=2, connection_type=
             self.ent_user = secrets['ent_user']
         if secrets.get('ent_password'):
             self.ent_password = secrets['ent_password']
-# pylint: enable=too-many-arguments
+    # pylint: enable=too-many-arguments, line-too-long
 
     def reset(self):
         """