Merge pull request #45 from docmollo/docs_wpa2_wifimgr

Adding WPA2 Enterprise support to the WiFi manager library

Author: kattni

adafruit_esp32spi/adafruit_esp32spi_wifimanager.py

@@ -31,32 +31,55 @@
 
 # pylint: disable=no-name-in-module
 
+from time import sleep
+from micropython import const
 from adafruit_esp32spi import adafruit_esp32spi
 import adafruit_esp32spi.adafruit_esp32spi_requests as requests
 
 class ESPSPI_WiFiManager:
     """
     A class to help manage the Wifi connection
     """
-    def __init__(self, esp, secrets, status_pixel=None, attempts=2):
+    NORMAL = const(1)
+    ENTERPRISE = const(2)
+
+# pylint: disable=too-many-arguments
+    def __init__(self, esp, secrets, status_pixel=None, attempts=2, connection_type=NORMAL):
         """
         :param ESP_SPIcontrol esp: The ESP object we are using
         :param dict secrets: The WiFi and Adafruit IO secrets dict (See examples)
         :param status_pixel: (Optional) The pixel device - A NeoPixel, DotStar,
             or RGB LED (default=None)
         :type status_pixel: NeoPixel, DotStar, or RGB LED
         :param int attempts: (Optional) Failed attempts before resetting the ESP32 (default=2)
+        :param const connection_type: (Optional) Type of WiFi connection: NORMAL or ENTERPRISE
         """
         # Read the settings
         self.esp = esp
         self.debug = False
         self.ssid = secrets['ssid']
         self.password = secrets['password']
         self.attempts = attempts
+        self._connection_type = connection_type
         requests.set_interface(self.esp)
         self.statuspix = status_pixel
         self.pixel_status(0)
 
+        # Check for WPA2 Enterprise keys in the secrets dictionary and load them if they exist
+        if secrets.get('ent_ssid'):
+            self.ent_ssid = secrets['ent_ssid']
+        else:
+            self.ent_ssid = secrets['ssid']
+        if secrets.get('ent_ident'):
+            self.ent_ident = secrets['ent_ident']
+        else:
+            self.ent_ident = ''
+        if secrets.get('ent_user'):
+            self.ent_user = secrets['ent_user']
+        if secrets.get('ent_password'):
+            self.ent_password = secrets['ent_password']
+# pylint: enable=too-many-arguments
+
     def reset(self):
         """
         Perform a hard reset on the ESP32
@@ -76,6 +99,17 @@ def connect(self):
             print("MAC addr:", [hex(i) for i in self.esp.MAC_address])
             for access_pt in self.esp.scan_networks():
                 print("\t%s\t\tRSSI: %d" % (str(access_pt['ssid'], 'utf-8'), access_pt['rssi']))
+        if self._connection_type == ESPSPI_WiFiManager.NORMAL:
+            self.connect_normal()
+        elif self._connection_type == ESPSPI_WiFiManager.ENTERPRISE:
+            self.connect_enterprise()
+        else:
+            raise TypeError("Invalid WiFi connection type specified")
+
+    def connect_normal(self):
+        """
+        Attempt a regular style WiFi connection
+        """
         failure_count = 0
         while not self.esp.is_connected:
             try:
@@ -93,6 +127,33 @@ def connect(self):
                     self.reset()
                 continue
 
+    def connect_enterprise(self):
+        """
+        Attempt an enterprise style WiFi connection
+        """
+        failure_count = 0
+        self.esp.wifi_set_network(bytes(self.ent_ssid, 'utf-8'))
+        self.esp.wifi_set_entidentity(bytes(self.ent_ident, 'utf-8'))
+        self.esp.wifi_set_entusername(bytes(self.ent_user, 'utf-8'))
+        self.esp.wifi_set_entpassword(bytes(self.ent_password, 'utf-8'))
+        self.esp.wifi_set_entenable()
+        while not self.esp.is_connected:
+            try:
+                if self.debug:
+                    print("Waiting for the ESP32 to connect to the WPA2 Enterprise AP...")
+                self.pixel_status((100, 0, 0))
+                sleep(1)
+                failure_count = 0
+                self.pixel_status((0, 100, 0))
+                sleep(1)
+            except (ValueError, RuntimeError) as error:
+                print("Failed to connect, retrying\n", error)
+                failure_count += 1
+                if failure_count >= self.attempts:
+                    failure_count = 0
+                    self.reset()
+                continue
+
     def get(self, url, **kw):
         """
         Pass the Get request to requests and update status LED

examples/esp32spi_wpa2ent_aio_post.py

@@ -0,0 +1,59 @@
+import time
+import board
+import busio
+from digitalio import DigitalInOut
+import neopixel
+from adafruit_esp32spi import adafruit_esp32spi
+from adafruit_esp32spi.adafruit_esp32spi_wifimanager import ESPSPI_WiFiManager
+
+print("ESP32 SPI WPA2 Enterprise webclient test")
+
+# Get wifi details and more from a secrets.py file
+try:
+    from secrets import secrets
+except ImportError:
+    print("WiFi secrets are kept in secrets.py, please add them there!")
+    raise
+
+# ESP32 setup
+# If your board does define the three pins listed below,
+# you can set the correct pins in the second block
+try:
+    esp32_cs = DigitalInOut(board.ESP_CS)
+    esp32_ready = DigitalInOut(board.ESP_BUSY)
+    esp32_reset = DigitalInOut(board.ESP_RESET)
+except AttributeError:
+    esp32_cs = DigitalInOut(board.D9)
+    esp32_ready = DigitalInOut(board.D10)
+    esp32_reset = DigitalInOut(board.D5)
+
+spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
+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) # Uncomment for Most Boards
+"""Uncomment below for ItsyBitsy M4"""
+#status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
+wifi = ESPSPI_WiFiManager(esp, secrets, status_light, connection_type=ESPSPI_WiFiManager.ENTERPRISE)
+
+counter = 0
+
+while True:
+    try:
+        print("Posting data...", end='')
+        data = counter
+        feed = 'test'
+        payload = {'value':data}
+        response = wifi.post(
+            "https://io.adafruit.com/api/v2/"+secrets['aio_username']+"/feeds/"+feed+"/data",
+            json=payload,
+            headers={"X-AIO-KEY":secrets['aio_key']})
+        print(response.json())
+        response.close()
+        counter = counter + 1
+        print("OK")
+    except (ValueError, RuntimeError) as e:
+        print("Failed to get data, retrying\n", e)
+        wifi.reset()
+        continue
+    response = None
+    time.sleep(15)

examples/esp32spi_wpa2ent_simpletest.py

@@ -25,16 +25,17 @@ def normalize(v):
 
 print("ESP32 SPI WPA2 Enterprise test")
 
-# For running on the PyPortal, use this block
-esp32_cs = DigitalInOut(board.ESP_CS)
-esp32_ready = DigitalInOut(board.ESP_BUSY)
-esp32_reset = DigitalInOut(board.ESP_RESET)
-
-# For a board that doesn't have the ESP pin definitions, use this block and
-# set the pins as needed.
-#esp32_cs = DigitalInOut(board.D8)
-#esp32_ready = DigitalInOut(board.D5)
-#esp32_reset = DigitalInOut(board.D7)
+# ESP32 setup
+# If your board does define the three pins listed below,
+# you can set the correct pins in the second block
+try:
+    esp32_cs = DigitalInOut(board.ESP_CS)
+    esp32_ready = DigitalInOut(board.ESP_BUSY)
+    esp32_reset = DigitalInOut(board.ESP_RESET)
+except AttributeError:
+    esp32_cs = DigitalInOut(board.D9)
+    esp32_ready = DigitalInOut(board.D10)
+    esp32_reset = DigitalInOut(board.D5)
 
 spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
 esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)