diff --git a/adafruit_esp32spi/__init__.py b/adafruit_esp32spi/__init__.py index e69de29..d959cd5 100644 --- a/adafruit_esp32spi/__init__.py +++ b/adafruit_esp32spi/__init__.py @@ -0,0 +1,13 @@ +# SPDX-FileCopyrightText: Copyright (c) 2025 Dan Halbert for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +# Allow +# import adafruit_esp32spi +# from adafruit_esp32spi.ESP_SPIcontrol +# etc. +# instead of the more verbose +# import adafruit_esp32pi.adafruit_esp32spi +# etc. + +from .adafruit_esp32spi import * diff --git a/adafruit_esp32spi/socketpool.py b/adafruit_esp32spi/socketpool.py new file mode 100644 index 0000000..d32be0a --- /dev/null +++ b/adafruit_esp32spi/socketpool.py @@ -0,0 +1,10 @@ +# SPDX-FileCopyrightText: Copyright (c) 2025 Dan Halbert for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +# Allow +# from adafruit_esp32pi.socketpool import SocketPool +# instead of the more verbose +# from adafruit_esp32pi.adafruit_esp32spi_socketpool import SocketPool + +from .adafruit_esp32spi_socketpool import * diff --git a/adafruit_esp32spi/wifimanager.py b/adafruit_esp32spi/wifimanager.py new file mode 100644 index 0000000..4a57b7f --- /dev/null +++ b/adafruit_esp32spi/wifimanager.py @@ -0,0 +1,10 @@ +# SPDX-FileCopyrightText: Copyright (c) 2025 Dan Halbert for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +# Allow imports like +# from adafruit_esp32pi.wifimanager import WiFiManager +# instead of the more verbose +# from adafruit_esp32pi.adafruit_esp32spi_wifimanager import WiFiManager + +from .adafruit_esp32spi_wifimanager import * diff --git a/docs/api.rst b/docs/api.rst index 4ac85a9..4a0705e 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,19 +1,68 @@ - -.. If you created a package, create one automodule per module in the package. - -.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) -.. use this format as the module name: "adafruit_foo.foo" - API Reference ############# .. automodule:: adafruit_esp32spi.adafruit_esp32spi + +.. note:: + As of version 11.0.0, it simpler to import this library and its submodules + The examples in this documentation use the new import names. + The old import names are still available, but are deprecated and may be removed in a future release. + +Before version 11.0.0, the library was structured like this (not all components are shown): + +* ``adafruit_esp32spi`` + + * ``adafruit_esp32spi`` + + * ``ESP32_SPIcontrol`` + + * ``adafruit_esp32spi_socketpool`` + + * ``SocketPool`` + + * ``adafruit_esp32spi_wifimanager`` + + * ``WiFiManager`` + +.. code:: python + + # Old import scheme + from adafruit_esp32spi import adafruit_esp32spi + from adafruit_esp32spi.adafruit_esp32spi_socketpool import SocketPool + from adafruit_esp32spi.adafruit_esp32spi_wifimanager import WiFiManager + +Now, the duplicated top-most name is not needed, and there are shorter names for the submodules. + +* ``adafruit_esp32spi`` + + * ``ESP32_SPIcontrol`` + + * ``socketpool`` + + * ``SocketPool`` + + * ``wifimanager`` + + * ``WiFiManager`` + +.. code:: python + + # New import scheme + import adafruit_esp32spi + from adafruit_esp32spi.socketpool import SocketPool + from adafruit_esp32spi.wifimanager import WiFiManager + + +.. automodule:: adafruit_esp32spi + :imported-members: :members: -.. automodule:: adafruit_esp32spi.adafruit_esp32spi_socketpool +.. automodule:: adafruit_esp32spi.socketpool + :imported-members: :members: -.. automodule:: adafruit_esp32spi.adafruit_esp32spi_wifimanager +.. automodule:: adafruit_esp32spi.wifimanager + :imported-members: :members: .. automodule:: adafruit_esp32spi.digitalio diff --git a/examples/esp32spi_aio_post.py b/examples/esp32spi_aio_post.py index 8be7e35..1a18670 100644 --- a/examples/esp32spi_aio_post.py +++ b/examples/esp32spi_aio_post.py @@ -9,8 +9,8 @@ import neopixel from digitalio import DigitalInOut -from adafruit_esp32spi import adafruit_esp32spi -from adafruit_esp32spi.adafruit_esp32spi_wifimanager import WiFiManager +import adafruit_esp32spi +from adafruit_esp32spi.wifimanager import WiFiManager print("ESP32 SPI webclient test") diff --git a/examples/esp32spi_cheerlights.py b/examples/esp32spi_cheerlights.py index ca74e90..43a76d1 100644 --- a/examples/esp32spi_cheerlights.py +++ b/examples/esp32spi_cheerlights.py @@ -10,8 +10,8 @@ import neopixel from digitalio import DigitalInOut -from adafruit_esp32spi import adafruit_esp32spi -from adafruit_esp32spi.adafruit_esp32spi_wifimanager import WiFiManager +import adafruit_esp32spi +from adafruit_esp32spi.wifimanager import WiFiManager # Get wifi details and more from a settings.toml file # tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD diff --git a/examples/esp32spi_ipconfig.py b/examples/esp32spi_ipconfig.py index 36b8b8b..19cf494 100644 --- a/examples/esp32spi_ipconfig.py +++ b/examples/esp32spi_ipconfig.py @@ -8,8 +8,8 @@ import busio from digitalio import DigitalInOut -import adafruit_esp32spi.adafruit_esp32spi_socketpool as socketpool -from adafruit_esp32spi import adafruit_esp32spi +import adafruit_esp32spi +from adafruit_esp32spi import socketpool # Get wifi details and more from a settings.toml file # tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD diff --git a/examples/esp32spi_localtime.py b/examples/esp32spi_localtime.py index 0157864..45b4a17 100644 --- a/examples/esp32spi_localtime.py +++ b/examples/esp32spi_localtime.py @@ -10,8 +10,8 @@ import rtc from digitalio import DigitalInOut -from adafruit_esp32spi import adafruit_esp32spi -from adafruit_esp32spi.adafruit_esp32spi_wifimanager import WiFiManager +adafruit_esp32spi +from adafruit_esp32spi.wifimanager import WiFiManager # Get wifi details and more from a settings.toml file # tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD diff --git a/examples/esp32spi_simpletest.py b/examples/esp32spi_simpletest.py index 2124991..6c8b203 100644 --- a/examples/esp32spi_simpletest.py +++ b/examples/esp32spi_simpletest.py @@ -9,7 +9,7 @@ import busio from digitalio import DigitalInOut -from adafruit_esp32spi import adafruit_esp32spi +import adafruit_esp32spi # Get wifi details and more from a settings.toml file # tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD diff --git a/examples/esp32spi_simpletest_rp2040.py b/examples/esp32spi_simpletest_rp2040.py index aab6776..40b5e68 100644 --- a/examples/esp32spi_simpletest_rp2040.py +++ b/examples/esp32spi_simpletest_rp2040.py @@ -9,7 +9,7 @@ import busio from digitalio import DigitalInOut -from adafruit_esp32spi import adafruit_esp32spi +import adafruit_esp32spi # Get wifi details and more from a settings.toml file # tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD diff --git a/examples/esp32spi_tcp_client.py b/examples/esp32spi_tcp_client.py index f781cb9..6d1883a 100644 --- a/examples/esp32spi_tcp_client.py +++ b/examples/esp32spi_tcp_client.py @@ -7,8 +7,8 @@ import busio from digitalio import DigitalInOut -import adafruit_esp32spi.adafruit_esp32spi_socketpool as socketpool -from adafruit_esp32spi import adafruit_esp32spi +import adafruit_esp32spi +from adafruit_esp32spi import socketpool # Get wifi details and more from a settings.toml file # tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD diff --git a/examples/esp32spi_udp_client.py b/examples/esp32spi_udp_client.py index b1226f9..ada7da1 100644 --- a/examples/esp32spi_udp_client.py +++ b/examples/esp32spi_udp_client.py @@ -9,8 +9,8 @@ import busio from digitalio import DigitalInOut -import adafruit_esp32spi.adafruit_esp32spi_socketpool as socketpool -from adafruit_esp32spi import adafruit_esp32spi +import adafruit_esp32spi +from adafruit_esp32spi import socketpool # Get wifi details and more from a settings.toml file # tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD diff --git a/examples/esp32spi_wpa2ent_aio_post.py b/examples/esp32spi_wpa2ent_aio_post.py index 78e56a2..7661001 100644 --- a/examples/esp32spi_wpa2ent_aio_post.py +++ b/examples/esp32spi_wpa2ent_aio_post.py @@ -9,8 +9,8 @@ import neopixel from digitalio import DigitalInOut -from adafruit_esp32spi import adafruit_esp32spi -from adafruit_esp32spi.adafruit_esp32spi_wifimanager import WiFiManager +import adafruit_esp32spi +from adafruit_esp32spi.wifimanager import WiFiManager print("ESP32 SPI WPA2 Enterprise webclient test") diff --git a/examples/esp32spi_wpa2ent_simpletest.py b/examples/esp32spi_wpa2ent_simpletest.py index f4b648e..69f4afa 100644 --- a/examples/esp32spi_wpa2ent_simpletest.py +++ b/examples/esp32spi_wpa2ent_simpletest.py @@ -18,7 +18,7 @@ import busio from digitalio import DigitalInOut -from adafruit_esp32spi import adafruit_esp32spi +import adafruit_esp32spi # Version number comparison code. Credit to gnud on stackoverflow diff --git a/examples/gpio/esp32spi_gpio.py b/examples/gpio/esp32spi_gpio.py index 91a0fd0..d6df6d1 100644 --- a/examples/gpio/esp32spi_gpio.py +++ b/examples/gpio/esp32spi_gpio.py @@ -9,7 +9,7 @@ import pulseio from digitalio import DigitalInOut, Direction -from adafruit_esp32spi import adafruit_esp32spi +import adafruit_esp32spi # ESP32SPI Digital and Analog Pin Reads & Writes