Adding WPA2 Enterprise support to the WiFi manager library

[docmollo]

This is my first attempt to add support for WPA2 Enterprise to the WiFi Manager library. It all works in my testing environment. The one thing I was thinking about, but didn't add, was support to check the NINA firmware version and bail out if the ESP32 isn't running a compatible version.

NOTE: Pylint returns some not-happy results, but I'm not sure if they are going to be issues. If so, I'm not sure how to go about resolving them. Some guideance would be appreciated.

[ladyada]

nice, please make :param int con_type an enum or at least a named constant!

[docmollo]

So...I thought I could just google this and figure it out, but this is getting into actual CS stuff that I haven't dealt with before. Is the fix as simple as just changing the "param int" to "param enum"?

[ladyada]

ok make them named constants then!

[docmollo]

Ah ha! I think I figured out what you're asking for. Are you suggesting something like this class in the MAX31856 library?

https://github.com/adafruit/Adafruit_CircuitPython_MAX31856/blob/master/adafruit_max31856.py#L95

[ladyada]

yes!

[docmollo]

Just a heads-up - I took @kattni up on her offer to assist with the pylint issues. We're scheduled to chat about this on Thursday (5/23) evening, so there are other commits coming.

[docmollo]

Had my meeting with @kattni this evening. I'm going to refactor the connect() function into two different functions for the two different types of connections. As part of that work, I'm also going to work on the ideas @brentru and I have been discussing. It's probably going to take me a week or two to get to all the changes complete, so if you would like a status, feel free to ping me here or on Discord.

[jerryneedell]

ok -- now relevant to this PR - I tried my often used "cherlights" test with this PR and there appears to have been some breaking change -- this code worked on the previous release

Press any key to enter the REPL. Use CTRL-D to reload.
Adafruit CircuitPython 4.1.0-beta.0 on 2019-06-14; Adafruit Metro M4 Airlift Lite with samd51j19
>>> 
>>> import cheer_ring
ESP32 SPI webclient test
Fetching json from https://api.thingspeak.com/channels/1417/feeds.json?results=1
Failed to connect, retrying
 ('No such ssid', b'Needell Airport')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "cheer_ring.py", line 55, in <module>
  File "cheer_ring.py", line 45, in <module>
  File "adafruit_esp32spi/adafruit_esp32spi_wifimanager.py", line 170, in get
  File "adafruit_esp32spi/adafruit_esp32spi_wifimanager.py", line 105, in connect
  File "adafruit_esp32spi/adafruit_esp32spi_wifimanager.py", line 129, in connect_normal
  File "adafruit_esp32spi/adafruit_esp32spi_wifimanager.py", line 125, in connect_normal
NameError: local variable referenced before assignment
>>> 

code

import time
import board
import busio
from digitalio import DigitalInOut

from adafruit_esp32spi import adafruit_esp32spi
from adafruit_esp32spi import adafruit_esp32spi_wifimanager

import neopixel
import adafruit_fancyled.adafruit_fancyled as fancy

# 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

print("ESP32 SPI webclient test")

DATA_SOURCE = "https://api.thingspeak.com/channels/1417/feeds.json?results=1"
DATA_LOCATION = ["feeds", 0, "field2"]

esp32_cs = DigitalInOut(board.ESP_CS)
esp32_ready = DigitalInOut(board.ESP_BUSY)
esp32_reset = DigitalInOut(board.ESP_RESET)
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 = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light)

# neopixels
pixels = neopixel.NeoPixel(board.A1, 16, brightness=0.3)
pixels.fill(0)

# we'll save the value in question
last_value = value = None

while True:
    try:
        print("Fetching json from", DATA_SOURCE)
        response = wifi.get(DATA_SOURCE)
        print(response.json())
        value = response.json()
        for key in DATA_LOCATION:
            value = value[key]
            print(value)
        response.close()
    except (ValueError, RuntimeError) as e:
        print("Failed to get data, retrying\n", e)
        wifi.reset()
        continue

    if not value:
        continue
    if last_value != value:
        color = int(value[1:], 16)
        red = color >> 16 & 0xFF
        green = color >> 8 & 0xFF
        blue = color& 0xFF
        gamma_corrected = fancy.gamma_adjust(fancy.CRGB(red, green, blue)).pack()

        pixels.fill(gamma_corrected)

[jerryneedell]

hmmm -- on a second run -- it ran ok -- looking further into it.

ah -- it fails only after the conection failure -- in the past, wifimanager would recover gracefully and retry -- something has changed in wifimanager

found it -- the line initializing failure_count was moved so it is not initialized before the exception and then fails the increment at line 125
the error is only present if the initial connection fails -- which is very common for me!

[jerryneedell]

a simple fix -- just have to move the line taht initializes failure_cunt up before the attempt to connect or else it throws the exception before it gets initialized

diff --git a/adafruit_esp32spi/adafruit_esp32spi_wifimanager.py b/adafruit_esp32spi/adafruit_esp32spi_wifimanager.py
index 6f7c944..0ba847c 100755
--- a/adafruit_esp32spi/adafruit_esp32spi_wifimanager.py
+++ b/adafruit_esp32spi/adafruit_esp32spi_wifimanager.py
@@ -117,8 +117,8 @@ class ESPSPI_WiFiManager:
                 if self.debug:
                     print("Connecting to AP...")
                 self.pixel_status((100, 0, 0))
-                self._esp.connect_AP(bytes(self.ssid, 'utf-8'), bytes(self.password, 'utf-8'))
                 failure_count = 0
+                self._esp.connect_AP(bytes(self.ssid, 'utf-8'), bytes(self.password, 'utf-8'))
                 self.pixel_status((0, 100, 0))
             except (ValueError, RuntimeError) as error:
                 print("Failed to connect, retrying\n", error)

[jerryneedell]

oops - the proposed fix above is not correct -- it will circumvent the maximum number of retries.
failure_count must be initialized to 0 before the try/except loop stars -- it also should be reset to 0 after a successful connection.
Sorry for the confusion.

this should work better

diff --git a/adafruit_esp32spi/adafruit_esp32spi_wifimanager.py b/adafruit_esp32spi/adafruit_esp32spi_wifimanager.py
index 6f7c944..f5ac570 100755
--- a/adafruit_esp32spi/adafruit_esp32spi_wifimanager.py
+++ b/adafruit_esp32spi/adafruit_esp32spi_wifimanager.py
@@ -112,6 +112,7 @@ class ESPSPI_WiFiManager:
         """
         Attempt a regular style WiFi connection
         """
+        failure_count = 0
         while not self._esp.is_connected:
             try:
                 if self.debug:

[jerryneedell]

see additional comment/concern in connect_enterprise

[docmollo]

Thanks @jerryneedell and @nevercast for poking at the nina-fw, but I'm going to ignore those issues mentioned above since they are unrelated to this PR. I'll follow-up on the issue opened on the nina-fw repo when I get a chance (probably later this week or weekend).

With regards to the failure_count issue, yeah, that's my fault. As soon as you mentioned it, I knew what had happened. Work suddenly got very busy yesterday after the CP weekly meeting, so I'm only going to have time after work this week to work on fixing the issue. Worst case, I'll definitely have time this weekend.

Thanks again!

[docmollo]

@jerryneedell if you could give this fix a try, I'd appreciate it

[docmollo]

OK....I think this will do it, @kattni. Much hacking of code and poking at git, and I think I have it. Let me know if you catch something I missed....totally possible at this point ;)

[kattni]

Thanks for fixing this up!