chore: import upstream snapshot with attribution

examples/protocols/sockets/scripts/run_tcp_client.py

@@ -0,0 +1,50 @@
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+import argparse
+import os
+import socket
+
+DEF_PORT = 3333
+DEF_MESSAGE = 'Data to ESP'
+
+
+def tcp_client(address: str, port: int, payload: str) -> str:
+    for res in socket.getaddrinfo(address, port, socket.AF_UNSPEC,
+                                  socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
+        family_addr, _, _, _, addr = res
+    try:
+        sock = socket.socket(family_addr, socket.SOCK_STREAM)
+        sock.settimeout(60.0)
+    except socket.error as msg:
+        print('Could not create socket')
+        print(os.strerror(msg.errno))
+        raise
+    try:
+        sock.connect(addr)
+    except socket.error as e:
+        print('Could not open socket: ' + str(e))
+        sock.close()
+        raise
+    sock.sendall(payload.encode())
+    data = sock.recv(1024)
+    if not data:
+        return ''
+    print('Reply : ' + data.decode())
+    sock.close()
+    return data.decode()
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('remote_ip', help='TCP server ip address, eg: 192.168.1.1, fe80::2%%eth0')
+    parser.add_argument('--port', default=DEF_PORT, type=int, help='TCP server port')
+    parser.add_argument('--message', default=DEF_MESSAGE, help='Message to send to the server.')
+    args = parser.parse_args()
+
+    print(f'Send message to the server: {args.remote_ip}')
+    data = tcp_client(args.remote_ip, args.port, args.message)
+    print(f'Received From server: {data}')
+
+
+if __name__ == '__main__':
+    main()

examples/protocols/sockets/scripts/run_tcp_server.py

@@ -0,0 +1,85 @@
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+import argparse
+import socket
+from threading import Event, Thread
+
+DEF_PORT = 3333
+
+
+class TcpServer(object):
+    def __init__(self, port, family_addr, persist=False, timeout=60):  # type: ignore
+        self.port = port
+        self.socket = socket.socket(family_addr, socket.SOCK_STREAM)
+        self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        self.socket.settimeout(timeout)
+        self.shutdown = Event()
+        self.persist = persist
+        self.family_addr = family_addr
+        self.server_thread = None
+
+    def __enter__(self):  # type: ignore
+        try:
+            self.socket.bind(('', self.port))
+        except socket.error as e:
+            print('Bind failed:{}'.format(e))
+            raise
+        self.socket.listen(1)
+
+        print('Starting server on port={} family_addr={}'.format(self.port, self.family_addr))
+        self.server_thread = Thread(target=self.run_server)
+        self.server_thread.start()
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback) -> None:  # type: ignore
+        if self.persist:
+            sock = socket.socket(self.family_addr, socket.SOCK_STREAM)
+            sock.connect(('localhost', self.port))
+            sock.sendall(b'Stop', )
+            sock.close()
+            self.shutdown.set()
+        self.shutdown.set()
+        self.server_thread.join()
+        self.socket.close()
+
+    def run_server(self) -> None:
+        while not self.shutdown.is_set():
+            try:
+                conn, address = self.socket.accept()  # accept new connection
+                print('Connection from: {}'.format(address))
+                conn.setblocking(1)
+                data = conn.recv(1024)
+                if not data:
+                    return
+                data = data.decode()
+                print('Received data: ' + data)
+                reply = 'OK: ' + data
+                conn.send(reply.encode())
+                conn.close()
+            except socket.timeout:
+                print(f'socket accept timeout ({self.socket.timeout}s)')
+            except socket.error as e:
+                print('Running server failed:{}'.format(e))
+                raise
+            if not self.persist:
+                break
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--port', default=DEF_PORT, type=int, help='TCP server port')
+    parser.add_argument('--ipv6', action='store_true', help='Create IPv6 server.')
+    parser.add_argument('--timeout', default=10, type=int, help='socket accept/recv timeout.')
+    args = parser.parse_args()
+
+    if args.ipv6:
+        family = socket.AF_INET6
+    else:
+        family = socket.AF_INET
+
+    with TcpServer(args.port, family, persist=True, timeout=args.timeout):
+        input('Server Running. Press Enter or CTRL-C to exit...\n')
+
+
+if __name__ == '__main__':
+    main()

examples/protocols/sockets/scripts/run_udp_client.py

@@ -0,0 +1,52 @@
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+import argparse
+import os
+import socket
+
+DEF_PORT = 3333
+DEF_MESSAGE = 'Data to ESP'
+
+
+def udp_client(address: str, port: int, payload: str) -> str:
+    for res in socket.getaddrinfo(address, port, socket.AF_UNSPEC,
+                                  socket.SOCK_DGRAM, 0, socket.AI_PASSIVE):
+        family_addr, _, _, _, addr = res
+    try:
+        sock = socket.socket(family_addr, socket.SOCK_DGRAM)
+        sock.settimeout(20.0)
+    except socket.error as msg:
+        print('Could not create socket')
+        print(os.strerror(msg.errno))
+        raise
+    try:
+        sock.sendto(payload.encode(), addr)
+        reply, addr = sock.recvfrom(128)
+        if not reply:
+            return ''
+        print('Reply[' + addr[0] + ':' + str(addr[1]) + '] - ' + str(reply))
+    except socket.timeout:
+        print('Socket operation timeout')
+        return ''
+    except socket.error as msg:
+        print('Error while sending or receiving data from the socket')
+        print(os.strerror(msg.errno))
+        sock.close()
+        raise
+    return reply.decode()
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('remote_ip', help='UDP server ip address, eg: 192.168.1.1, fe80::2%%eth0')
+    parser.add_argument('--port', default=DEF_PORT, type=int, help='UDP server port')
+    parser.add_argument('--message', default=DEF_MESSAGE, help='Message to send to the server.')
+    args = parser.parse_args()
+
+    print(f'Send message to the server: {args.remote_ip}')
+    data = udp_client(args.remote_ip, args.port, args.message)
+    print(f'Received From server: {data}')
+
+
+if __name__ == '__main__':
+    main()

examples/protocols/sockets/scripts/run_udp_server.py

@@ -0,0 +1,80 @@
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+import argparse
+import socket
+from threading import Event, Thread
+
+DEF_PORT = 3333
+
+
+class UdpServer:
+
+    def __init__(self, port, family_addr, persist=False, timeout=60):  # type: ignore
+        self.port = port
+        self.family_addr = family_addr
+        self.socket = socket.socket(family_addr, socket.SOCK_DGRAM)
+        self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        self.socket.settimeout(timeout)
+        self.shutdown = Event()
+        self.persist = persist
+        self.server_thread = None
+
+    def __enter__(self):  # type: ignore
+        try:
+            self.socket.bind(('', self.port))
+        except socket.error as e:
+            print('Bind failed:{}'.format(e))
+            raise
+
+        print('Starting server on port={} family_addr={}'.format(self.port, self.family_addr))
+        self.server_thread = Thread(target=self.run_server)
+        self.server_thread.start()
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):  # type: ignore
+        if self.persist:
+            sock = socket.socket(self.family_addr, socket.SOCK_DGRAM)
+            sock.sendto(b'Stop', ('localhost', self.port))
+            sock.close()
+            self.shutdown.set()
+        self.server_thread.join()
+        self.socket.close()
+
+    def run_server(self) -> None:
+        while not self.shutdown.is_set():
+            try:
+                data, addr = self.socket.recvfrom(1024)
+                print(addr)
+                if not data:
+                    return
+                data = data.decode()
+                print('Reply[' + addr[0] + ':' + str(addr[1]) + '] - ' + data)
+                reply = 'OK: ' + data
+                self.socket.sendto(reply.encode(), addr)
+            except socket.timeout:
+                print(f'socket recvfrom timeout ({self.socket.timeout}s)')
+            except socket.error as e:
+                print('Running server failed:{}'.format(e))
+                raise
+            if not self.persist:
+                break
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--port', default=DEF_PORT, type=int, help='UDP server port')
+    parser.add_argument('--ipv6', action='store_true', help='Create IPv6 server.')
+    parser.add_argument('--timeout', default=10, type=int, help='socket recvfrom timeout.')
+    args = parser.parse_args()
+
+    if args.ipv6:
+        family = socket.AF_INET6
+    else:
+        family = socket.AF_INET
+
+    with UdpServer(args.port, family, persist=True, timeout=args.timeout):
+        input('Server Running. Press Enter or CTRL-C to exit...\n')
+
+
+if __name__ == '__main__':
+    main()