Skip to content

Commit 59203bc

Browse files
authored
Merge pull request #45 from docmollo/docs_wpa2_wifimgr
Adding WPA2 Enterprise support to the WiFi manager library
2 parents 8f964cc + c89d13e commit 59203bc

File tree

3 files changed

+132
-11
lines changed

3 files changed

+132
-11
lines changed

adafruit_esp32spi/adafruit_esp32spi_wifimanager.py

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,32 +31,55 @@
3131

3232
# pylint: disable=no-name-in-module
3333

34+
from time import sleep
35+
from micropython import const
3436
from adafruit_esp32spi import adafruit_esp32spi
3537
import adafruit_esp32spi.adafruit_esp32spi_requests as requests
3638

3739
class ESPSPI_WiFiManager:
3840
"""
3941
A class to help manage the Wifi connection
4042
"""
41-
def __init__(self, esp, secrets, status_pixel=None, attempts=2):
43+
NORMAL = const(1)
44+
ENTERPRISE = const(2)
45+
46+
# pylint: disable=too-many-arguments
47+
def __init__(self, esp, secrets, status_pixel=None, attempts=2, connection_type=NORMAL):
4248
"""
4349
:param ESP_SPIcontrol esp: The ESP object we are using
4450
:param dict secrets: The WiFi and Adafruit IO secrets dict (See examples)
4551
:param status_pixel: (Optional) The pixel device - A NeoPixel, DotStar,
4652
or RGB LED (default=None)
4753
:type status_pixel: NeoPixel, DotStar, or RGB LED
4854
:param int attempts: (Optional) Failed attempts before resetting the ESP32 (default=2)
55+
:param const connection_type: (Optional) Type of WiFi connection: NORMAL or ENTERPRISE
4956
"""
5057
# Read the settings
5158
self.esp = esp
5259
self.debug = False
5360
self.ssid = secrets['ssid']
5461
self.password = secrets['password']
5562
self.attempts = attempts
63+
self._connection_type = connection_type
5664
requests.set_interface(self.esp)
5765
self.statuspix = status_pixel
5866
self.pixel_status(0)
5967

68+
# Check for WPA2 Enterprise keys in the secrets dictionary and load them if they exist
69+
if secrets.get('ent_ssid'):
70+
self.ent_ssid = secrets['ent_ssid']
71+
else:
72+
self.ent_ssid = secrets['ssid']
73+
if secrets.get('ent_ident'):
74+
self.ent_ident = secrets['ent_ident']
75+
else:
76+
self.ent_ident = ''
77+
if secrets.get('ent_user'):
78+
self.ent_user = secrets['ent_user']
79+
if secrets.get('ent_password'):
80+
self.ent_password = secrets['ent_password']
81+
# pylint: enable=too-many-arguments
82+
6083
def reset(self):
6184
"""
6285
Perform a hard reset on the ESP32
@@ -76,6 +99,17 @@ def connect(self):
7699
print("MAC addr:", [hex(i) for i in self.esp.MAC_address])
77100
for access_pt in self.esp.scan_networks():
78101
print("\t%s\t\tRSSI: %d" % (str(access_pt['ssid'], 'utf-8'), access_pt['rssi']))
102+
if self._connection_type == ESPSPI_WiFiManager.NORMAL:
103+
self.connect_normal()
104+
elif self._connection_type == ESPSPI_WiFiManager.ENTERPRISE:
105+
self.connect_enterprise()
106+
else:
107+
raise TypeError("Invalid WiFi connection type specified")
108+
109+
def connect_normal(self):
110+
"""
111+
Attempt a regular style WiFi connection
112+
"""
79113
failure_count = 0
80114
while not self.esp.is_connected:
81115
try:
@@ -93,6 +127,33 @@ def connect(self):
93127
self.reset()
94128
continue
95129

130+
def connect_enterprise(self):
131+
"""
132+
Attempt an enterprise style WiFi connection
133+
"""
134+
failure_count = 0
135+
self.esp.wifi_set_network(bytes(self.ent_ssid, 'utf-8'))
136+
self.esp.wifi_set_entidentity(bytes(self.ent_ident, 'utf-8'))
137+
self.esp.wifi_set_entusername(bytes(self.ent_user, 'utf-8'))
138+
self.esp.wifi_set_entpassword(bytes(self.ent_password, 'utf-8'))
139+
self.esp.wifi_set_entenable()
140+
while not self.esp.is_connected:
141+
try:
142+
if self.debug:
143+
print("Waiting for the ESP32 to connect to the WPA2 Enterprise AP...")
144+
self.pixel_status((100, 0, 0))
145+
sleep(1)
146+
failure_count = 0
147+
self.pixel_status((0, 100, 0))
148+
sleep(1)
149+
except (ValueError, RuntimeError) as error:
150+
print("Failed to connect, retrying\n", error)
151+
failure_count += 1
152+
if failure_count >= self.attempts:
153+
failure_count = 0
154+
self.reset()
155+
continue
156+
96157
def get(self, url, **kw):
97158
"""
98159
Pass the Get request to requests and update status LED

examples/esp32spi_wpa2ent_aio_post.py

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
import time
2+
import board
3+
import busio
4+
from digitalio import DigitalInOut
5+
import neopixel
6+
from adafruit_esp32spi import adafruit_esp32spi
7+
from adafruit_esp32spi.adafruit_esp32spi_wifimanager import ESPSPI_WiFiManager
8+
9+
print("ESP32 SPI WPA2 Enterprise webclient test")
10+
11+
# Get wifi details and more from a secrets.py file
12+
try:
13+
from secrets import secrets
14+
except ImportError:
15+
print("WiFi secrets are kept in secrets.py, please add them there!")
16+
raise
17+
18+
# ESP32 setup
19+
# If your board does define the three pins listed below,
20+
# you can set the correct pins in the second block
21+
try:
22+
esp32_cs = DigitalInOut(board.ESP_CS)
23+
esp32_ready = DigitalInOut(board.ESP_BUSY)
24+
esp32_reset = DigitalInOut(board.ESP_RESET)
25+
except AttributeError:
26+
esp32_cs = DigitalInOut(board.D9)
27+
esp32_ready = DigitalInOut(board.D10)
28+
esp32_reset = DigitalInOut(board.D5)
29+
30+
spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
31+
esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)
32+
"""Use below for Most Boards"""
33+
status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards
34+
"""Uncomment below for ItsyBitsy M4"""
35+
#status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
36+
wifi = ESPSPI_WiFiManager(esp, secrets, status_light, connection_type=ESPSPI_WiFiManager.ENTERPRISE)
37+
38+
counter = 0
39+
40+
while True:
41+
try:
42+
print("Posting data...", end='')
43+
data = counter
44+
feed = 'test'
45+
payload = {'value':data}
46+
response = wifi.post(
47+
"https://io.adafruit.com/api/v2/"+secrets['aio_username']+"/feeds/"+feed+"/data",
48+
json=payload,
49+
headers={"X-AIO-KEY":secrets['aio_key']})
50+
print(response.json())
51+
response.close()
52+
counter = counter + 1
53+
print("OK")
54+
except (ValueError, RuntimeError) as e:
55+
print("Failed to get data, retrying\n", e)
56+
wifi.reset()
57+
continue
58+
response = None
59+
time.sleep(15)

examples/esp32spi_wpa2ent_simpletest.py

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,17 @@ def normalize(v):
2525

2626
print("ESP32 SPI WPA2 Enterprise test")
2727

28-
# For running on the PyPortal, use this block
29-
esp32_cs = DigitalInOut(board.ESP_CS)
30-
esp32_ready = DigitalInOut(board.ESP_BUSY)
31-
esp32_reset = DigitalInOut(board.ESP_RESET)
32-
33-
# For a board that doesn't have the ESP pin definitions, use this block and
34-
# set the pins as needed.
35-
#esp32_cs = DigitalInOut(board.D8)
36-
#esp32_ready = DigitalInOut(board.D5)
37-
#esp32_reset = DigitalInOut(board.D7)
28+
# ESP32 setup
29+
# If your board does define the three pins listed below,
30+
# you can set the correct pins in the second block
31+
try:
32+
esp32_cs = DigitalInOut(board.ESP_CS)
33+
esp32_ready = DigitalInOut(board.ESP_BUSY)
34+
esp32_reset = DigitalInOut(board.ESP_RESET)
35+
except AttributeError:
36+
esp32_cs = DigitalInOut(board.D9)
37+
esp32_ready = DigitalInOut(board.D10)
38+
esp32_reset = DigitalInOut(board.D5)
3839

3940
spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
4041
esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)

0 commit comments

Comments
 (0)