Merge branch 'adafruit:main' into patch-1

Author: dannystaple

.gitignore

@@ -1,15 +1,47 @@
-# SPDX-FileCopyrightText: 2019 ladyada for Adafruit Industries
+# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries
 #
-# SPDX-License-Identifier: Unlicense
+# SPDX-License-Identifier: MIT
 
+# Do not include files and directories created by your personal work environment, such as the IDE
+# you use, except for those already listed here. Pull requests including changes to this file will
+# not be accepted.
+
+# This .gitignore file contains rules for files generated by working with CircuitPython libraries,
+# including building Sphinx, testing with pip, and creating a virual environment, as well as the
+# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs.
+
+# If you find that there are files being generated on your machine that should not be included in
+# your git commit, you should create a .gitignore_global file on your computer to include the
+# files created by your personal setup. To do so, follow the two steps below.
+
+# First, create a file called .gitignore_global somewhere convenient for you, and add rules for
+# the files you want to exclude from git commits.
+
+# Second, configure Git to use the exclude file for all Git repositories by running the
+# following via commandline, replacing "path/to/your/" with the actual path to your newly created
+# .gitignore_global file:
+# git config --global core.excludesfile path/to/your/.gitignore_global
+
+# CircuitPython-specific files
 *.mpy
-.idea
+
+# Python-specific files
 __pycache__
-_build
 *.pyc
+
+# Sphinx build-specific files
+_build
+
+# This file results from running `pip -e install .` in a local repository
+*.egg-info
+
+# Virtual environment-specific files
 .env
-bundles
+
+# MacOS-specific files
 *.DS_Store
-.eggs
-dist
-**/*.egg-info
+
+# IDE-specific files
+.idea
+.vscode
+*~

.pre-commit-config.yaml

@@ -4,7 +4,7 @@
 
 repos:
 -   repo: https://github.com/python/black
-    rev: 20.8b1
+    rev: 22.3.0
     hooks:
     - id: black
 -   repo: https://github.com/fsfe/reuse-tool

README.rst

@@ -5,7 +5,7 @@ Introduction
     :target: https://docs.circuitpython.org/projects/esp32spi/en/latest/
     :alt: Documentation Status
 
-.. image:: https://img.shields.io/discord/327254708534116352.svg
+.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
     :target: https://adafru.it/discord
     :alt: Discord
 

adafruit_esp32spi/adafruit_esp32spi.py

@@ -29,14 +29,17 @@
 import struct
 import time
 from micropython import const
-from digitalio import Direction
 from adafruit_bus_device.spi_device import SPIDevice
+from digitalio import Direction
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI.git"
 
 _SET_NET_CMD = const(0x10)
 _SET_PASSPHRASE_CMD = const(0x11)
+_SET_IP_CONFIG = const(0x14)
+_SET_DNS_CONFIG = const(0x15)
+_SET_HOSTNAME = const(0x16)
 _SET_AP_NET_CMD = const(0x18)
 _SET_AP_PASSPHRASE_CMD = const(0x19)
 _SET_DEBUG_CMD = const(0x1A)
@@ -67,6 +70,7 @@
 _START_SCAN_NETWORKS = const(0x36)
 _GET_FW_VERSION_CMD = const(0x37)
 _SEND_UDP_DATA_CMD = const(0x39)
+_GET_REMOTE_DATA_CMD = const(0x3A)
 _GET_TIME = const(0x3B)
 _GET_IDX_BSSID_CMD = const(0x3C)
 _GET_IDX_CHAN_CMD = const(0x3D)
@@ -124,6 +128,8 @@
 ADC_ATTEN_DB_6 = const(2)
 ADC_ATTEN_DB_11 = const(3)
 
+# pylint: disable=too-many-lines
+
 
 class ESP_SPIcontrol:  # pylint: disable=too-many-public-methods, too-many-instance-attributes
     """A class that will talk to an ESP32 module programmed with special firmware
@@ -405,6 +411,46 @@ def scan_networks(self):
                 return APs
         return None
 
+    def set_ip_config(self, ip_address, gateway, mask="255.255.255.0"):
+        """Tells the ESP32 to set ip, gateway and network mask b"\xFF"
+
+        :param str ip_address: IP address (as a string).
+        :param str gateway: Gateway (as a string).
+        :param str mask: Mask, defaults to 255.255.255.0 (as a string).
+        """
+        resp = self._send_command_get_response(
+            _SET_IP_CONFIG,
+            params=[
+                b"\x00",
+                self.unpretty_ip(ip_address),
+                self.unpretty_ip(gateway),
+                self.unpretty_ip(mask),
+            ],
+            sent_param_len_16=False,
+        )
+        return resp
+
+    def set_dns_config(self, dns1, dns2):
+        """Tells the ESP32 to set DNS
+
+        :param str dns1: DNS server 1 IP as a string.
+        :param str dns2: DNS server 2 IP as a string.
+        """
+        resp = self._send_command_get_response(
+            _SET_DNS_CONFIG, [b"\x00", self.unpretty_ip(dns1), self.unpretty_ip(dns2)]
+        )
+        if resp[0][0] != 1:
+            raise RuntimeError("Failed to set dns with esp32")
+
+    def set_hostname(self, hostname):
+        """Tells the ESP32 to set hostname for DHCP.
+
+        :param str hostname: The new host name.
+        """
+        resp = self._send_command_get_response(_SET_HOSTNAME, [hostname.encode()])
+        if resp[0][0] != 1:
+            raise RuntimeError("Failed to set hostname with esp32")
+
     def wifi_set_network(self, ssid):
         """Tells the ESP32 to set the access point to the given ssid"""
         resp = self._send_command_get_response(_SET_NET_CMD, [ssid])
@@ -518,8 +564,7 @@ def connect(self, secrets):
         self.connect_AP(secrets["ssid"], secrets["password"])
 
     def connect_AP(self, ssid, password, timeout_s=10):  # pylint: disable=invalid-name
-        """
-        Connect to an access point with given name and password.
+        """Connect to an access point with given name and password.
         Will wait until specified timeout seconds and return on success
         or raise an exception on failure.
 
@@ -552,8 +597,7 @@ def connect_AP(self, ssid, password, timeout_s=10):  # pylint: disable=invalid-n
     def create_AP(
         self, ssid, password, channel=1, timeout=10
     ):  # pylint: disable=invalid-name
-        """
-        Create an access point with the given name, password, and channel.
+        """Create an access point with the given name, password, and channel.
         Will wait until specified timeout seconds and return on success
         or raise an exception on failure.
 
@@ -806,6 +850,14 @@ def server_state(self, socket_num):
         resp = self._send_command_get_response(_GET_STATE_TCP_CMD, self._socknum_ll)
         return resp[0][0]
 
+    def get_remote_data(self, socket_num):
+        """Get the IP address and port of the remote host"""
+        self._socknum_ll[0][0] = socket_num
+        resp = self._send_command_get_response(
+            _GET_REMOTE_DATA_CMD, self._socknum_ll, reply_params=2
+        )
+        return {"ip_addr": resp[0], "port": struct.unpack("<H", resp[1])[0]}
+
     def set_esp_debug(self, enabled):
         """Enable/disable debug mode on the ESP32. Debug messages will be
         written to the ESP32's UART."""
@@ -814,8 +866,7 @@ def set_esp_debug(self, enabled):
             raise RuntimeError("Failed to set debug mode")
 
     def set_pin_mode(self, pin, mode):
-        """
-        Set the io mode for a GPIO pin.
+        """Set the io mode for a GPIO pin.
 
         :param int pin: ESP32 GPIO pin to set.
         :param value: direction for pin, digitalio.Direction or integer (0=input, 1=output).
@@ -831,8 +882,7 @@ def set_pin_mode(self, pin, mode):
             raise RuntimeError("Failed to set pin mode")
 
     def set_digital_write(self, pin, value):
-        """
-        Set the digital output value of pin.
+        """Set the digital output value of pin.
 
         :param int pin: ESP32 GPIO pin to write to.
         :param bool value: Value for the pin.
@@ -844,8 +894,7 @@ def set_digital_write(self, pin, value):
             raise RuntimeError("Failed to write to pin")
 
     def set_analog_write(self, pin, analog_value):
-        """
-        Set the analog output value of pin, using PWM.
+        """Set the analog output value of pin, using PWM.
 
         :param int pin: ESP32 GPIO pin to write to.
         :param float value: 0=off 1.0=full on
@@ -858,8 +907,7 @@ def set_analog_write(self, pin, analog_value):
             raise RuntimeError("Failed to write to pin")
 
     def set_digital_read(self, pin):
-        """
-        Get the digital input value of pin. Returns the boolean value of the pin.
+        """Get the digital input value of pin. Returns the boolean value of the pin.
 
         :param int pin: ESP32 GPIO pin to read from.
         """
@@ -877,8 +925,7 @@ def set_digital_read(self, pin):
         )
 
     def set_analog_read(self, pin, atten=ADC_ATTEN_DB_11):
-        """
-        Get the analog input value of pin. Returns an int between 0 and 65536.
+        """Get the analog input value of pin. Returns an int between 0 and 65536.
 
         :param int pin: ESP32 GPIO pin to read from.
         :param int atten: attenuation constant
@@ -914,6 +961,7 @@ def get_time(self):
     def set_certificate(self, client_certificate):
         """Sets client certificate. Must be called
         BEFORE a network connection is established.
+
         :param str client_certificate: User-provided .PEM certificate up to 1300 bytes.
         """
         if self._debug:
@@ -936,6 +984,7 @@ def set_certificate(self, client_certificate):
     def set_private_key(self, private_key):
         """Sets private key. Must be called
         BEFORE a network connection is established.
+
         :param str private_key: User-provided .PEM file up to 1700 bytes.
         """
         if self._debug:

adafruit_esp32spi/digitalio.py

@@ -50,6 +50,7 @@ def __init__(self, esp_pin, esp):
 
     def init(self, mode=IN):
         """Initalizes a pre-defined pin.
+
         :param mode: Pin mode (IN, OUT, LOW, HIGH). Defaults to IN.
         """
         if mode is not None:
@@ -64,6 +65,7 @@ def init(self, mode=IN):
 
     def value(self, val=None):
         """Sets ESP32 Pin GPIO output mode.
+
         :param val: Pin output level (LOW, HIGH)
         """
         if val is not None:
@@ -133,6 +135,7 @@ def deinit(self):
 
     def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):
         """Set the drive mode and value and then switch to writing out digital values.
+
         :param bool value: Default mode to set upon switching.
         :param DriveMode drive_mode: Drive mode for the output.
         """
@@ -142,6 +145,7 @@ def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):
 
     def switch_to_input(self, pull=None):
         """Sets the pull and then switch to read in digital values.
+
         :param Pull pull: Pull configuration for the input.
         """
         raise NotImplementedError(
@@ -156,6 +160,7 @@ def direction(self):
     @direction.setter
     def direction(self, pin_dir):
         """Sets the direction of the pin.
+
         :param Direction dir: Pin direction (Direction.OUTPUT or Direction.INPUT)
         """
         self.__direction = pin_dir
@@ -176,6 +181,7 @@ def value(self):
     @value.setter
     def value(self, val):
         """Sets the digital logic level of the pin.
+
         :param type value: Pin logic level.
         :param int value: Pin logic level. 1 is logic high, 0 is logic low.
         :param bool value: Pin logic level. True is logic high, False is logic low.
@@ -195,8 +201,9 @@ def drive_mode(self):
     @drive_mode.setter
     def drive_mode(self, mode):
         """Sets the pin drive mode.
+
         :param DriveMode mode: Defines the drive mode when outputting digital values.
-            Either PUSH_PULL or OPEN_DRAIN
+                               Either PUSH_PULL or OPEN_DRAIN
         """
         if mode is DriveMode.OPEN_DRAIN:
             raise NotImplementedError(