313 lines
12 KiB
Python
Executable file
313 lines
12 KiB
Python
Executable file
# The MIT License (MIT)
|
|
#
|
|
# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
# THE SOFTWARE.
|
|
|
|
"""
|
|
`adafruit_esp32spi_wifimanager`
|
|
================================================================================
|
|
|
|
WiFi Manager for making ESP32 SPI as WiFi much easier
|
|
|
|
* Author(s): Melissa LeBlanc-Williams, ladyada
|
|
"""
|
|
|
|
# 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 WiFiConnType: # pylint: disable=too-few-public-methods
|
|
"""An enum-like class representing the different types of WiFi connections
|
|
that can be made. The values can be referenced like ``WiFiConnType.normal``.
|
|
Possible values are
|
|
- ``ThermocoupleType.normal``
|
|
- ``ThermocoupleType.enterprise``
|
|
"""
|
|
# pylint: disable=invalid-name
|
|
normal = 1
|
|
enterprise = 2
|
|
|
|
class ESPSPI_WiFiManager:
|
|
"""
|
|
A class to help manage the Wifi connection
|
|
"""
|
|
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 con_type: (Optional) Type of WiFi connection: normal=1, WPA2 Enterprise=2
|
|
:param ~adafruit_esp32spi_wifimanager.WiFiConnType wificonntype: The type of WiFi \
|
|
connection to make. The default is "normal".
|
|
"""
|
|
# Read the settings
|
|
self.esp = esp
|
|
self.debug = False
|
|
self.ssid = secrets['ssid']
|
|
self.password = secrets['password']
|
|
self.ent_ssid = secrets['ent_ssid']
|
|
self.ent_ident = secrets['ent_ident']
|
|
self.ent_user = secrets['ent_user']
|
|
self.ent_passwd = secrets['ent_passwd']
|
|
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
|
|
"""
|
|
if self.debug:
|
|
print("Resetting ESP32")
|
|
self.esp.reset()
|
|
|
|
def connect(self):
|
|
"""
|
|
Attempt to connect to WiFi using the current settings
|
|
"""
|
|
if self.debug:
|
|
if self.esp.status == adafruit_esp32spi.WL_IDLE_STATUS:
|
|
print("ESP32 found and in idle mode")
|
|
print("Firmware vers.", self.esp.firmware_version)
|
|
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:
|
|
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.pixel_status((0, 100, 0))
|
|
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 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
|
|
|
|
:param str url: The URL to retrieve data from
|
|
:param dict data: (Optional) Form data to submit
|
|
:param dict json: (Optional) JSON data to submit. (Data must be None)
|
|
:param dict header: (Optional) Header data to include
|
|
:param bool stream: (Optional) Whether to stream the Response
|
|
:return: The response from the request
|
|
:rtype: Response
|
|
"""
|
|
if not self.esp.is_connected:
|
|
self.connect()
|
|
self.pixel_status((0, 0, 100))
|
|
return_val = requests.get(url, **kw)
|
|
self.pixel_status(0)
|
|
return return_val
|
|
|
|
def post(self, url, **kw):
|
|
"""
|
|
Pass the Post request to requests and update status LED
|
|
|
|
:param str url: The URL to post data to
|
|
:param dict data: (Optional) Form data to submit
|
|
:param dict json: (Optional) JSON data to submit. (Data must be None)
|
|
:param dict header: (Optional) Header data to include
|
|
:param bool stream: (Optional) Whether to stream the Response
|
|
:return: The response from the request
|
|
:rtype: Response
|
|
"""
|
|
if not self.esp.is_connected:
|
|
self.connect()
|
|
self.pixel_status((0, 0, 100))
|
|
return_val = requests.post(url, **kw)
|
|
return return_val
|
|
|
|
def put(self, url, **kw):
|
|
"""
|
|
Pass the put request to requests and update status LED
|
|
|
|
:param str url: The URL to PUT data to
|
|
:param dict data: (Optional) Form data to submit
|
|
:param dict json: (Optional) JSON data to submit. (Data must be None)
|
|
:param dict header: (Optional) Header data to include
|
|
:param bool stream: (Optional) Whether to stream the Response
|
|
:return: The response from the request
|
|
:rtype: Response
|
|
"""
|
|
if not self.esp.is_connected:
|
|
self.connect()
|
|
self.pixel_status((0, 0, 100))
|
|
return_val = requests.put(url, **kw)
|
|
self.pixel_status(0)
|
|
return return_val
|
|
|
|
def patch(self, url, **kw):
|
|
"""
|
|
Pass the patch request to requests and update status LED
|
|
|
|
:param str url: The URL to PUT data to
|
|
:param dict data: (Optional) Form data to submit
|
|
:param dict json: (Optional) JSON data to submit. (Data must be None)
|
|
:param dict header: (Optional) Header data to include
|
|
:param bool stream: (Optional) Whether to stream the Response
|
|
:return: The response from the request
|
|
:rtype: Response
|
|
"""
|
|
if not self.esp.is_connected:
|
|
self.connect()
|
|
self.pixel_status((0, 0, 100))
|
|
return_val = requests.patch(url, **kw)
|
|
self.pixel_status(0)
|
|
return return_val
|
|
|
|
def delete(self, url, **kw):
|
|
"""
|
|
Pass the delete request to requests and update status LED
|
|
|
|
:param str url: The URL to PUT data to
|
|
:param dict data: (Optional) Form data to submit
|
|
:param dict json: (Optional) JSON data to submit. (Data must be None)
|
|
:param dict header: (Optional) Header data to include
|
|
:param bool stream: (Optional) Whether to stream the Response
|
|
:return: The response from the request
|
|
:rtype: Response
|
|
"""
|
|
if not self.esp.is_connected:
|
|
self.connect()
|
|
self.pixel_status((0, 0, 100))
|
|
return_val = requests.delete(url, **kw)
|
|
self.pixel_status(0)
|
|
return return_val
|
|
|
|
def ping(self, host, ttl=250):
|
|
"""
|
|
Pass the Ping request to the ESP32, update status LED, return response time
|
|
|
|
:param str host: The hostname or IP address to ping
|
|
:param int ttl: (Optional) The Time To Live in milliseconds for the packet (default=250)
|
|
:return: The response time in milliseconds
|
|
:rtype: int
|
|
"""
|
|
if not self.esp.is_connected:
|
|
self.connect()
|
|
self.pixel_status((0, 0, 100))
|
|
response_time = self.esp.ping(host, ttl=ttl)
|
|
self.pixel_status(0)
|
|
return response_time
|
|
|
|
def ip_address(self):
|
|
"""
|
|
Returns a formatted local IP address, update status pixel.
|
|
"""
|
|
if not self.esp.is_connected:
|
|
self.connect()
|
|
self.pixel_status((0, 0, 100))
|
|
self.pixel_status(0)
|
|
return self.esp.pretty_ip(self.esp.ip_address)
|
|
|
|
def pixel_status(self, value):
|
|
"""
|
|
Change Status Pixel if it was defined
|
|
|
|
:param value: The value to set the Board's status LED to
|
|
:type value: int or 3-value tuple
|
|
"""
|
|
if self.statuspix:
|
|
if hasattr(self.statuspix, 'color'):
|
|
self.statuspix.color = value
|
|
else:
|
|
self.statuspix.fill(value)
|
|
|
|
def signal_strength(self):
|
|
"""
|
|
Returns receiving signal strength indicator in dBm
|
|
"""
|
|
if not self.esp.is_connected:
|
|
self.connect()
|
|
return self.esp.rssi()
|