-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from makermelissa/master
Added WiFi Manager and changed examples
- Loading branch information
Showing
4 changed files
with
174 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| # 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 | ||
|
|
||
| import neopixel | ||
| 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, settings, status_neopixel=None): | ||
| """ | ||
| :param ESP_SPIcontrol esp: The ESP object we are using | ||
| :param dict settings: The WiFi and Adafruit IO Settings (See examples) | ||
| :param status_neopixel: (Pptional) The neopixel pin - Usually board.NEOPIXEL (default=None) | ||
| :type status_neopixel: Pin | ||
| """ | ||
| # Read the settings | ||
| self._esp = esp | ||
| self.debug = False | ||
| self.ssid = settings['ssid'] | ||
| self.password = settings['password'] | ||
| requests.set_interface(self._esp) | ||
| if status_neopixel: | ||
| self.neopix = neopixel.NeoPixel(status_neopixel, 1, brightness=0.2) | ||
| else: | ||
| self.neopix = None | ||
| self.neo_status(0) | ||
|
|
||
| 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'])) | ||
| while not self._esp.is_connected: | ||
| try: | ||
| if self.debug: | ||
| print("Connecting to AP...") | ||
| self.neo_status((100, 0, 0)) | ||
| self._esp.connect_AP(bytes(self.ssid, 'utf-8'), bytes(self.password, 'utf-8')) | ||
| self.neo_status((0, 100, 0)) | ||
| except (ValueError, RuntimeError) as error: | ||
| print("Failed to connect, retrying\n", error) | ||
| continue | ||
|
|
||
| def get(self, url, **kw): | ||
| """ | ||
| Pass the Get request to requests and update Status NeoPixel | ||
| :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.neo_status((100, 100, 0)) | ||
| return_val = requests.get(url, **kw) | ||
| self.neo_status(0) | ||
| return return_val | ||
|
|
||
| def post(self, url, **kw): | ||
| """ | ||
| Pass the Post request to requests and update Status NeoPixel | ||
| :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.neo_status((100, 100, 0)) | ||
| return_val = requests.post(url, **kw) | ||
| self.neo_status(0) | ||
| return return_val | ||
|
|
||
| def ping(self, host, ttl=250): | ||
| """ | ||
| Pass the Ping request to the ESP32, update Status NeoPixel, 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.neo_status((100, 100, 0)) | ||
| response_time = self._esp.ping(host, ttl=ttl) | ||
| self.neo_status(0) | ||
| return response_time | ||
|
|
||
| def neo_status(self, value): | ||
| """ | ||
| Change Status NeoPixel if it was defined | ||
| :param value: The value to set the Board's Status NeoPixel to | ||
| :type value: int or 3-value tuple | ||
| """ | ||
| if self.neopix: | ||
| self.neopix.fill(value) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters