Merge pull request #20 from justmobilize/remove-secrets-usage

Remove secrets usage

Author: dhalbert

README.rst

@@ -43,12 +43,11 @@ Usage Example
 .. code :: python3
 
     import time
-    import ssl
     import board
     from digitalio import DigitalInOut, Direction, Pull
     import touchio
-    import socketpool
     import wifi
+    import adafruit_connection_manager
     import adafruit_minimqtt.adafruit_minimqtt as MQTT
     from adafruit_io.adafruit_io import IO_MQTT
     from adafruit_dash_display import Hub
@@ -68,34 +67,30 @@ Usage Example
     back = touchio.TouchIn(board.CAP7)
     submit = touchio.TouchIn(board.CAP8)
 
-    try:
-        from secrets import secrets
-    except ImportError:
-        print("WiFi secrets are kept in secrets.py, please add them there!")
-        raise
+    # Get WiFi details and Adafruit IO keys, ensure these are setup in settings.toml
+    # (visit io.adafruit.com if you need to create an account, or if you need your Adafruit IO key.)
+    ssid = getenv("CIRCUITPY_WIFI_SSID")
+    password = getenv("CIRCUITPY_WIFI_PASSWORD")
+    aio_username = getenv("ADAFRUIT_AIO_USERNAME")
+    aio_key = getenv("ADAFRUIT_AIO_KEY")
 
     display = board.DISPLAY
 
-    # Set your Adafruit IO Username and Key in secrets.py
-    # (visit io.adafruit.com if you need to create an account,
-    # or if you need your Adafruit IO key.)
-    aio_username = secrets["aio_username"]
-    aio_key = secrets["aio_key"]
-
-    print("Connecting to %s" % secrets["ssid"])
-    wifi.radio.connect(secrets["ssid"], secrets["password"])
-    print("Connected to %s!" % secrets["ssid"])
+    print(f"Connecting to {ssid}")
+    wifi.radio.connect(ssid, password)
+    print(f"Connected to {ssid}!")
 
     # Create a socket pool
-    pool = socketpool.SocketPool(wifi.radio)
+    pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)
+    ssl_context = adafruit_connection_manager.get_radio_ssl_context(wifi.radio)
 
     # Initialize a new MQTT Client object
     mqtt_client = MQTT.MQTT(
         broker="io.adafruit.com",
-        username=secrets["aio_username"],
-        password=secrets["aio_key"],
+        username=aio_username,
+        password=aio_key,
         socket_pool=pool,
-        ssl_context=ssl.create_default_context(),
+        ssl_context=ssl_context,
     )
 
     # Initialize an Adafruit IO MQTT Client

examples/dash_display_advancedtest.py

@@ -2,16 +2,15 @@
 # SPDX-License-Identifier: MIT
 
 import time
-import ssl
 from os import getenv
 import displayio
 import board
 from digitalio import DigitalInOut, Direction, Pull
 from adafruit_display_text.label import Label
 import terminalio
 import touchio
-import socketpool
 import wifi
+import adafruit_connection_manager
 import adafruit_minimqtt.adafruit_minimqtt as MQTT
 from adafruit_io.adafruit_io import IO_MQTT
 from adafruit_dash_display import Hub
@@ -31,24 +30,12 @@
 back = touchio.TouchIn(board.CAP7)
 submit = touchio.TouchIn(board.CAP8)
 
-# Get wifi details and more from a settings.toml file
-# tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD
-#                           CIRCUITPY_AIO_USERNAME, CIRCUITPY_AIO_KEY
-secrets = {}
-for token in ["SSID", "PASSWORD"]:
-    if getenv("CIRCUITPY_WIFI_" + token):
-        secrets[token.lower()] = getenv("CIRCUITPY_WIFI_" + token)
-for token in ["AIO_USERNAME", "AIO_KEY"]:
-    if getenv("CIRCUITPY_" + token):
-        secrets[token.lower()] = getenv("CIRCUITPY_" + token)
-
-if not secrets:
-    try:
-        # Fallback on secrets.py until depreciation is over and option is removed
-        from secrets import secrets
-    except ImportError:
-        print("WiFi secrets are kept in settings.toml, please add them there!")
-        raise
+# Get WiFi details and Adafruit IO keys, ensure these are setup in settings.toml
+# (visit io.adafruit.com if you need to create an account, or if you need your Adafruit IO key.)
+ssid = getenv("CIRCUITPY_WIFI_SSID")
+password = getenv("CIRCUITPY_WIFI_PASSWORD")
+aio_username = getenv("ADAFRUIT_AIO_USERNAME")
+aio_key = getenv("ADAFRUIT_AIO_KEY")
 
 rgb_group = displayio.Group()
 R_label = Label(
@@ -185,26 +172,21 @@ def pub_lamp(lamp):
 
 display = board.DISPLAY
 
-# Set your Adafruit IO Username and Key in settings.toml
-# (visit io.adafruit.com if you need to create an account,
-# or if you need your Adafruit IO key.)
-aio_username = secrets["aio_username"]
-aio_key = secrets["aio_key"]
+print(f"Connecting to {ssid}")
+wifi.radio.connect(ssid, password)
+print(f"Connected to {ssid}!")
 
-print("Connecting to %s" % secrets["ssid"])
-wifi.radio.connect(secrets["ssid"], secrets["password"])
-print("Connected to %s!" % secrets["ssid"])
-
-# Create a socket pool
-pool = socketpool.SocketPool(wifi.radio)
+# Create a socket pool and ssl_context
+pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)
+ssl_context = adafruit_connection_manager.get_radio_ssl_context(wifi.radio)
 
 # Initialize a new MQTT Client object
 mqtt_client = MQTT.MQTT(
     broker="io.adafruit.com",
-    username=secrets["aio_username"],
-    password=secrets["aio_key"],
+    username=aio_username,
+    password=aio_key,
     socket_pool=pool,
-    ssl_context=ssl.create_default_context(),
+    ssl_context=ssl_context,
 )
 
 # Initialize an Adafruit IO MQTT Client

examples/dash_display_client_examples/battery_daughter.py

@@ -21,26 +21,14 @@
 
 displayio.release_displays()
 
-### WiFi ###
+# Get WiFi details and Adafruit IO keys, ensure these are setup in settings.toml
+# (visit io.adafruit.com if you need to create an account, or if you need your Adafruit IO key.)
+ssid = getenv("CIRCUITPY_WIFI_SSID")
+password = getenv("CIRCUITPY_WIFI_PASSWORD")
+aio_username = getenv("ADAFRUIT_AIO_USERNAME")
+aio_key = getenv("ADAFRUIT_AIO_KEY")
 
-# Get wifi details and more from a settings.toml file
-# tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD
-#                           CIRCUITPY_AIO_USERNAME, CIRCUITPY_AIO_KEY
-secrets = {}
-for token in ["SSID", "PASSWORD"]:
-    if getenv("CIRCUITPY_WIFI_" + token):
-        secrets[token.lower()] = getenv("CIRCUITPY_WIFI_" + token)
-for token in ["AIO_USERNAME", "AIO_KEY"]:
-    if getenv("CIRCUITPY_" + token):
-        secrets[token.lower()] = getenv("CIRCUITPY_" + token)
-
-if not secrets:
-    try:
-        # Fallback on secrets.py until depreciation is over and option is removed
-        from secrets import secrets
-    except ImportError:
-        print("WiFi secrets are kept in settings.toml, please add them there!")
-        raise
+### WiFi ###
 
 # If you are using a board with pre-defined ESP32 Pins:
 esp32_cs = DigitalInOut(board.ESP_CS)
@@ -60,18 +48,20 @@
 esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)
 
 """Use below for Most Boards"""
-status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
+status_pixel = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
 """Uncomment below for ItsyBitsy M4"""
-# status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
+# status_pixel = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
 """Uncomment below for an externally defined RGB LED (including Arduino Nano Connect)"""
 # import adafruit_rgbled
 # from adafruit_esp32spi import PWMOut
 # RED_LED = PWMOut.PWMOut(esp, 26)
 # GREEN_LED = PWMOut.PWMOut(esp, 27)
 # BLUE_LED = PWMOut.PWMOut(esp, 25)
-# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
+# status_pixel = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
 
-wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light)
+wifi = adafruit_esp32spi_wifimanager.WiFiManager(
+    esp, ssid, password, status_pixel=status_pixel
+)
 
 
 # Define callback functions which will be called when certain events happen.
@@ -100,8 +90,8 @@ def message(client, feed_id, payload):
 # Initialize a new MQTT Client object
 mqtt_client = MQTT.MQTT(
     broker="io.adafruit.com",
-    username=secrets["aio_username"],
-    password=secrets["aio_key"],
+    username=aio_username,
+    password=aio_key,
     socket_pool=pool,
     ssl_context=ssl_context,
 )

examples/dash_display_client_examples/door_daughter.py

@@ -13,32 +13,20 @@
 from digitalio import DigitalInOut, Direction, Pull
 from adafruit_debouncer import Debouncer
 
-### WiFi ###
-
-# Get wifi details and more from a settings.toml file
-# tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD
-#                           CIRCUITPY_AIO_USERNAME, CIRCUITPY_AIO_KEY
-secrets = {}
-for token in ["SSID", "PASSWORD"]:
-    if getenv("CIRCUITPY_WIFI_" + token):
-        secrets[token.lower()] = getenv("CIRCUITPY_WIFI_" + token)
-for token in ["AIO_USERNAME", "AIO_KEY"]:
-    if getenv("CIRCUITPY_" + token):
-        secrets[token.lower()] = getenv("CIRCUITPY_" + token)
-
-if not secrets:
-    try:
-        # Fallback on secrets.py until depreciation is over and option is removed
-        from secrets import secrets
-    except ImportError:
-        print("WiFi secrets are kept in settings.toml, please add them there!")
-        raise
+# Get WiFi details and Adafruit IO keys, ensure these are setup in settings.toml
+# (visit io.adafruit.com if you need to create an account, or if you need your Adafruit IO key.)
+ssid = getenv("CIRCUITPY_WIFI_SSID")
+password = getenv("CIRCUITPY_WIFI_PASSWORD")
+aio_username = getenv("ADAFRUIT_AIO_USERNAME")
+aio_key = getenv("ADAFRUIT_AIO_KEY")
 
 switch_pin = DigitalInOut(board.D10)
 switch_pin.direction = Direction.INPUT
 switch_pin.pull = Pull.UP
 switch = Debouncer(switch_pin)
 
+### WiFi ###
+
 # If you are using a board with pre-defined ESP32 Pins:
 esp32_cs = DigitalInOut(board.ESP_CS)
 esp32_ready = DigitalInOut(board.ESP_BUSY)
@@ -57,18 +45,20 @@
 esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)
 
 """Use below for Most Boards"""
-status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
+status_pixel = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
 """Uncomment below for ItsyBitsy M4"""
-# status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
+# status_pixel = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
 """Uncomment below for an externally defined RGB LED (including Arduino Nano Connect)"""
 # import adafruit_rgbled
 # from adafruit_esp32spi import PWMOut
 # RED_LED = PWMOut.PWMOut(esp, 26)
 # GREEN_LED = PWMOut.PWMOut(esp, 27)
 # BLUE_LED = PWMOut.PWMOut(esp, 25)
-# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
+# status_pixel = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
 
-wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light)
+wifi = adafruit_esp32spi_wifimanager.WiFiManager(
+    esp, ssid, password, status_pixel=status_pixel
+)
 
 # Connect to WiFi
 print("Connecting to WiFi...")
@@ -81,8 +71,8 @@
 # Initialize a new MQTT Client object
 mqtt_client = MQTT.MQTT(
     broker="io.adafruit.com",
-    username=secrets["aio_username"],
-    password=secrets["aio_key"],
+    username=aio_username,
+    password=aio_key,
     socket_pool=pool,
     ssl_context=ssl_context,
 )

examples/dash_display_client_examples/neopixel_daughter.py

@@ -12,29 +12,17 @@
 from adafruit_io.adafruit_io import IO_MQTT
 from digitalio import DigitalInOut
 
-### WiFi ###
-
-# Get wifi details and more from a settings.toml file
-# tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD
-#                           CIRCUITPY_AIO_USERNAME, CIRCUITPY_AIO_KEY
-secrets = {}
-for token in ["SSID", "PASSWORD"]:
-    if getenv("CIRCUITPY_WIFI_" + token):
-        secrets[token.lower()] = getenv("CIRCUITPY_WIFI_" + token)
-for token in ["AIO_USERNAME", "AIO_KEY"]:
-    if getenv("CIRCUITPY_" + token):
-        secrets[token.lower()] = getenv("CIRCUITPY_" + token)
-
-if not secrets:
-    try:
-        # Fallback on secrets.py until depreciation is over and option is removed
-        from secrets import secrets
-    except ImportError:
-        print("WiFi secrets are kept in settings.toml, please add them there!")
-        raise
+# Get WiFi details and Adafruit IO keys, ensure these are setup in settings.toml
+# (visit io.adafruit.com if you need to create an account, or if you need your Adafruit IO key.)
+ssid = getenv("CIRCUITPY_WIFI_SSID")
+password = getenv("CIRCUITPY_WIFI_PASSWORD")
+aio_username = getenv("ADAFRUIT_AIO_USERNAME")
+aio_key = getenv("ADAFRUIT_AIO_KEY")
 
 pixels = neopixel.NeoPixel(board.D5, 300)
 
+### WiFi ###
+
 # If you are using a board with pre-defined ESP32 Pins:
 esp32_cs = DigitalInOut(board.ESP_CS)
 esp32_ready = DigitalInOut(board.ESP_BUSY)
@@ -53,18 +41,20 @@
 esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)
 
 """Use below for Most Boards"""
-status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
+status_pixel = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
 """Uncomment below for ItsyBitsy M4"""
-# status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
+# status_pixel = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
 """Uncomment below for an externally defined RGB LED (including Arduino Nano Connect)"""
 # import adafruit_rgbled
 # from adafruit_esp32spi import PWMOut
 # RED_LED = PWMOut.PWMOut(esp, 26)
 # GREEN_LED = PWMOut.PWMOut(esp, 27)
 # BLUE_LED = PWMOut.PWMOut(esp, 25)
-# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
+# status_pixel = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
 
-wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light)
+wifi = adafruit_esp32spi_wifimanager.WiFiManager(
+    esp, ssid, password, status_pixel=status_pixel
+)
 
 
 # Define callback functions which will be called when certain events happen.
@@ -98,8 +88,8 @@ def on_neopixel(client, topic, message):
 # Initialize a new MQTT Client object
 mqtt_client = MQTT.MQTT(
     broker="io.adafruit.com",
-    username=secrets["aio_username"],
-    password=secrets["aio_key"],
+    username=aio_username,
+    password=aio_key,
     socket_pool=pool,
     ssl_context=ssl_context,
 )