diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0166a0d7..f81b0f64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,21 @@ -## Contributing to ESP_WiFiManager +## Contributing to ESP_AT_WiFiManager ### Reporting Bugs -Please report bugs in ESP_WiFiManager if you find them. +Please report bugs in ESP_AT_WiFiManager if you find them. However, before reporting a bug please check through the following: -* [Existing Open Issues](https://github.com/khoih-prog/ESP_WiFiManager/issues) - someone might have already encountered this. +* [Existing Open Issues](https://github.com/khoih-prog/ESP_AT_WiFiManager/issues) - someone might have already encountered this. -If you don't find anything, please [open a new issue](https://github.com/khoih-prog/ESP_WiFiManager/issues/new). +If you don't find anything, please [open a new issue](https://github.com/khoih-prog/ESP_AT_WiFiManager/issues/new). ### How to submit a bug report Please ensure to specify the following: -* Arduino IDE version (e.g. 1.8.11) or Platform.io version -* `ESP8266` or `ESP32` Core Version (e.g. ESP8266 core v2.6.3 or ESP32 v1.0.4) +* Arduino IDE version (e.g. 1.8.13) or Platform.io version +* Board Core Version (e.g. Arduino SAMDUE core v1.6.12, STM32 core v2.0.0, etc.) * Contextual information (e.g. what you were trying to achieve) * Simplest possible steps to reproduce * Anything that might be relevant in your opinion, such as: @@ -26,10 +26,10 @@ Please ensure to specify the following: ### Example ``` -Arduino IDE version: 1.8.11 -ESP8266 Core Version 2.6.3 -OS: Ubuntu 16.04 LTS -Linux Inspiron 4.4.0-170-generic #199-Ubuntu SMP Thu Nov 14 01:45:04 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux +Arduino IDE version: 1.8.13 +Arduino STM32 Core v2.0.0 +OS: Ubuntu 20.04 LTS +Linux xy-Inspiron-3593 5.4.0-72-generic #80-Ubuntu SMP Mon Apr 12 17:35:00 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux Context: I encountered an endless loop while trying to connect to Local WiFi. @@ -44,7 +44,7 @@ Steps to reproduce: Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful. -There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP_WiFiManager/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them. +There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP_AT_WiFiManager/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them. ### Sending Pull Requests diff --git a/README.md b/README.md index c47e9791..648b9484 100644 --- a/README.md +++ b/README.md @@ -9,26 +9,93 @@ --- --- -### New Version v1.0.3 +## Table of Contents + +* [Why do we need this ESP_AT_WiFiManager library](#why-do-we-need-this-esp_at_wifimanager-library) + * [Features](#features) + * [Currently supported Boards](#currently-supported-boards) +* [Changelog](#changelog) + * [Major Release v1.1.0](#major-release-v110) + * [Release v1.0.3](#release-v103) + * [Release v1.0.2](#release-v102) + * [Release v1.0.1](#release-v101) +* [Prerequisites](#prerequisites) +* [Important Notes about AT Firmwares](#important-notes-about-at-firmwares) + * [1. Firmwares tested OK with ESP8266 AT shields](#1-firmwares-tested-ok-with-esp8266-at-shields) + * [2. Firmwares tested OK with ESP32 AT shields](#2-firmwares-tested-ok-with-esp32-at-shields) +* [Installation](#installation) + * [Use Arduino Library Manager](#use-arduino-library-manager) + * [Manual Install](#manual-install) + * [VS Code & PlatformIO](#vs-code--platformio) +* [Packages' Patches](#packages-patches) + * [1. For Adafruit nRF52840 and nRF52832 boards](#1-for-adafruit-nRF52840-and-nRF52832-boards) + * [2. For Teensy boards](#2-for-teensy-boards) + * [3. For Arduino SAM DUE boards](#3-for-arduino-sam-due-boards) + * [4. For Arduino SAMD boards](#4-for-arduino-samd-boards) + * [For core version v1.8.10+](#for-core-version-v1810) + * [For core version v1.8.9-](#for-core-version-v189-) + * [5. For Adafruit SAMD boards](#5-for-adafruit-samd-boards) + * [6. For Seeeduino SAMD boards](#6-for-seeeduino-samd-boards) + * [7. For STM32 boards](#7-for-stm32-boards) + * [7.1 For STM32 boards to use LAN8720](#71-for-stm32-boards-to-use-lan8720) + * [7.2 For STM32 boards to use Serial1](#72-for-stm32-boards-to-use-serial1) +* [How It Works](#how-it-works) +* [How to use](#how-to-use) + * [1. Basic usage](#1-basic-usage) + * [2. To open Config Portal](#2-to-open-config-portal) + * [3. To use different AP WiFi Channel](#3-to-use-different-ap-wifi-channel) + * [4. To use different static AP IP from default](#4-to-use-different-static-ap-ip-from-default) + * [5. To use default AP SSID ESP_AT_XXXXXX](#5-to-use-default-ap-ssid-esp_at_xxxxxx) + * [6. To use personalized AP SSID and Password](#6-to-use-personalized-ap-ssid-and-password) +* [Examples](#examples) + * [ 1. ConfigOnSwitch](examples/ConfigOnSwitch) + * [ 2. ConfigOnStartup](examples/ConfigOnStartup) + * [ 3. AutoConnect](examples/AutoConnect) + * [ 4. AutoConnectWithFeedback](examples/AutoConnectWithFeedback) +* [So, how it works?](#so-how-it-works) +* [Documentation](#documentation) + * [1. Password protect the configuration Access Point](#1-password-protect-the-configuration-access-point) + * [2. Configuration Portal Timeout](#2-configuration-portal-timeout) +* [Custom Configuration](#custom-configuration) + * [1. Custom Parameters](#1-custom-parameters) + * [2. Custom IP Configuration](#2-custom-ip-configuration) + * [3. Custom Parameters](#3-custom-access-point-ip-configuration) + * [4. Custom Station (client) Static IP Configuration](#4-custom-station-client-static-ip-configuration) + * [5. Custom HTML, CSS, Javascript](#5-custom-html-css-javascript) + * [5.1 Inject custom head element](#51-inject-custom-head-element) + * [5.2 Inject a custom bit of html in the configuration form](#52-inject-a-custom-bit-of-html-in-the-configuration-form) + * [5.3 Inject a custom bit of html in a configuration form element](#53-inject-a-custom-bit-of-html-in-a-configuration-form-element) + * [6. Filter Networks](#6-filter-networks) +* [Example ConfigOnSwitch](#example-configonswitch) + * [1. File ConfigOnSwitch.ino](#1-file-configonswitchino) + * [2. File defines.h](#2-file-definesh) +* [Debug Terminal Output Samples](#debug-terminal-output-samples) + * [1. ConfigOnSwitch on Adafruit Itsy-Bitsy nRF52840 with ESP8266-AT shield](#1-configonswitch-on-adafruit-itsy-bitsy-nrf52840-with-esp8266-at-shield) + * [1.1 Enter Config Portal](#11-enter-config-portal) + * [1.2 Click `Save`](#12-click-save) + * [2. ConfigOnStartup on SAM-DUE with ESP32-AT shield](#2-configonstartup-on-sam-due-with-esp32-at-shield) + * [3. ConfigOnStartup on STM32 Nucleo-144 NUCLEO_F767ZI with ESP8266-AT shield](#3-configonstartup-on-stm32-nucleo-144-nucleo_f767zi-with-esp8266-at-shield) + * [4. ConfigOnStartup on Seeeduino SEEED_XIAO_M0 with ESP8266-AT shield](#1-configonstartup-on-seeeduino-seeed_xiao_m0-with-esp8266-at-shield) + * [5. ConfigOnStartup on STM32 Nucleo-144 NUCLEO_F767ZI with ESP8266-AT shield with invalid data](#5-configonstartup-on-stm32-nucleo-144-nucleo_f767zi-with-esp8266-at-shield-with-invalid-data) + * [5.1 Data OK => No Config Portal](#51-data-ok--no-config-portal) + * [5.2 Valid Data but no connection => Config Portal](#52-valid-data-but-no-connection--config-Portal) +* [Debug](#debug) +* [Troubleshooting](#troubleshooting) +* [Releases](#releases) +* [Issues](#issues) +* [TO DO](#to-do) +* [DONE](#done) +* [Contributions and Thanks](#contributions-and-thanks) +* [Contributing](#contributing) +* [License](#license) +* [Copyright](#copyright) -1. Add support to all **STM32F/L/H/G/WB/MP1 (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.)** -2. Add support to **Seeeduino SAMD21/SAMD51 boards (SEEED_WIO_TERMINAL, SEEED_FEMTO_M0, SEEED_XIAO_M0, Wio_Lite_MG126, WIO_GPS_BOARD, SEEEDUINO_ZERO, SEEEDUINO_LORAWAN, SEEED_GROVE_UI_WIRELESS, etc.)** -3. Add sample Packages_Patches for **STM32F/L/H/G/WB/MP1** (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8) -4. Add Packages_Patches for other boards. -5. Add instructions to use EspSerial/Serial1 on some **STM32F/L/H/G/WB/MP1** boards without Serial1 definition (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.) -6. Add Packages' Patches for Arduino SAMD21 to fix compiler error issue for **Nano-33-IoT, ZERO, MKR, etc.** - -### New Version v1.0.2 - -1. Add support to **ESP32-AT-command shield**. - -### New Version v1.0.1 +--- +--- -1. Add support to **nRF52 (AdaFruit Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B302_ublox, NINA_B112_ublox, etc.)**. Credentials to be saved **automatically in LittleFS**. -2. Improve support to **STM32F/L/H/G/WB/MP1**. Credentials to be saved **automatically in EEPROM**. -3. Drop support to **Teensy** boards. +### Why do we need this [ESP_AT_WiFiManager library](https://github.com/khoih-prog/ESP_AT_WiFiManager) ---- +#### Features This [**ESP_AT_WiFiManager library**](https://github.com/khoih-prog/ESP_AT_WiFiManager) is based on, modified, bug-fixed and improved from: @@ -44,7 +111,76 @@ This is a Credentials / WiFi Connection Manager with fallback web configuration The web configuration portal, served from the `ESP8266/ESP32-AT-command shields` is operating as an access point (AP) with configurable static IP address or use default IP Address of 192.168.4.1 -The configuration portal is captive, so it will present the configuration dialogue regardless of the web address selected, excluding https requests. +You can also specify static AP and STA IP. Config Portal will be auto-adjusted to match the number of dynamic custom parameters. Credentials are saved in EEPROM, [`FlashStorage_SAMD`](https://github.com/khoih-prog/FlashStorage_SAMD), [`FlashStorage_STM32`](https://github.com/khoih-prog/FlashStorage_STM32), [`DueFlashStorage`](https://github.com/sebnil/DueFlashStorage) or nRF52 LittleFS. + +--- + +#### Currently Supported Boards + +This [**ESP_AT_WiFiManager** library](https://github.com/khoih-prog/ESP_AT_WiFiManager) currently supports these following boards: + + 1. **nRF52 boards**, such as **AdaFruit Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B302_ublox, NINA_B112_ublox, etc.** + + 2. **SAM DUE** + + 3. **SAMD21** + - Arduino SAMD21: ZERO, MKRs, NANO_33_IOT, etc. + - Adafruit SAMD21 (M0): ItsyBitsy M0, Feather M0, Feather M0 Express, Metro M0 Express, Circuit Playground Express, Trinket M0, PIRkey, Hallowing M0, Crickit M0, etc. + - Seeeduino: LoRaWAN, Zero, Femto M0, XIAO M0, Wio GPS Board, etc. + + 4. **SAMD51** + - Adafruit SAMD51 (M4): Metro M4, Grand Central M4, ItsyBitsy M4, Feather M4 Express, Trellis M4, Metro M4 AirLift Lite, MONSTER M4SK Express, Hallowing M4, etc. + - Seeeduino: Wio Terminal, Grove UI Wireless + + 5. **Teensy (4.1, 4.0, 3.6, 3.5, 3,2, 3.1, 3.0, LC)** + + 6. **STM32F/L/H/G/WB/MP1 boards (with 64+K Flash)** + +- Nucleo-144 +- Nucleo-64 +- Discovery +- Generic STM32F0, STM32F1, STM32F2, STM32F3, STM32F4, STM32F7 (with 64+K Flash): x8 and up +- STM32L0, STM32L1, STM32L4, **STM32L5** +- STM32G0, STM32G4 +- STM32H7 +- STM32WB +- STM32MP1 +- LoRa boards +- 3-D printer boards +- Generic Flight Controllers +- Midatronics boards + +--- +--- + +## Changelog + +### Major Release v1.1.0 + +1. Use new efficient [**FlashStorage_STM32** library](https://github.com/khoih-prog/FlashStorage_STM32). +2. Add support to new **STM32 core v2.0.0** and STM32L5 +3. Permit auto-connect without waiting for Config Portal if stored data is valid and WiFi test connection is OK. +4. Update examples with new features + +### Release v1.0.3 + +1. Add support to all **STM32F/L/H/G/WB/MP1 (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.)** +2. Add support to **Seeeduino SAMD21/SAMD51 boards (SEEED_WIO_TERMINAL, SEEED_FEMTO_M0, SEEED_XIAO_M0, Wio_Lite_MG126, WIO_GPS_BOARD, SEEEDUINO_ZERO, SEEEDUINO_LORAWAN, SEEED_GROVE_UI_WIRELESS, etc.)** +3. Add sample Packages_Patches for **STM32F/L/H/G/WB/MP1** (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8) +4. Add Packages_Patches for other boards. +5. Add instructions to use EspSerial/Serial1 on some **STM32F/L/H/G/WB/MP1** boards without Serial1 definition (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.) +6. Add Packages' Patches for Arduino SAMD21 to fix compiler error issue for **Nano-33-IoT, ZERO, MKR, etc.** + +### Release v1.0.2 + +1. Add support to **ESP32-AT-command shield**. + +### Release v1.0.1 + +1. Add support to **nRF52 (AdaFruit Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B302_ublox, NINA_B112_ublox, etc.)**. Credentials to be saved **automatically in LittleFS**. +2. Improve support to **STM32F/L/H/G/WB/MP1**. Credentials to be saved **automatically in EEPROM**. +3. Drop support to **Teensy** boards. + --- --- @@ -53,26 +189,28 @@ The configuration portal is captive, so it will present the configuration dialog 1. [`Arduino IDE 1.8.13+` for Arduino](https://www.arduino.cc/en/Main/Software) 2. [`Arduino AVR core 1.8.3+`](https://github.com/arduino/ArduinoCore-avr) for Arduino (Use Arduino Board Manager) for AVR boards. [![GitHub release](https://img.shields.io/github/release/arduino/ArduinoCore-avr.svg)](https://github.com/arduino/ArduinoCore-avr/releases/latest) - 3. [`Arduino Core for STM32 v1.9.0+`](https://github.com/stm32duino/Arduino_Core_STM32) for STM32F/L/H/G/WB/MP1 boards (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.). [![GitHub release](https://img.shields.io/github/release/stm32duino/Arduino_Core_STM32.svg)](https://github.com/stm32duino/Arduino_Core_STM32/releases/latest) + 3. [`Arduino Core for STM32 v2.0.0+`](https://github.com/stm32duino/Arduino_Core_STM32) for STM32F/L/H/G/WB/MP1 boards (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.). [![GitHub release](https://img.shields.io/github/release/stm32duino/Arduino_Core_STM32.svg)](https://github.com/stm32duino/Arduino_Core_STM32/releases/latest) 4. [`Teensy core 1.53+`](https://www.pjrc.com/teensy/td_download.html) for Teensy (4.1, 4.0, 3.6, 3.5, 3,2, 3.1, 3.0, LC) boards 5. [`Arduino SAM DUE core v1.6.12+`](https://github.com/arduino/ArduinoCore-sam) for SAM DUE ARM Cortex-M3 boards. 6. [`Arduino SAMD core 1.8.11+`](https://github.com/arduino/ArduinoCore-samd) for SAMD ARM Cortex-M0+ boards. [![GitHub release](https://img.shields.io/github/release/arduino/ArduinoCore-samd.svg)](https://github.com/arduino/ArduinoCore-samd/releases/latest) - 7. [`Adafruit SAMD core 1.6.5+`](https://github.com/adafruit/ArduinoCore-samd) for SAMD ARM Cortex-M0+ and M4 boards (Nano 33 IoT, etc.). [![GitHub release](https://img.shields.io/github/release/adafruit/ArduinoCore-samd.svg)](https://github.com/adafruit/ArduinoCore-samd/releases/latest) + 7. [`Adafruit SAMD core 1.6.7+`](https://github.com/adafruit/ArduinoCore-samd) for SAMD ARM Cortex-M0+ and M4 boards (Nano 33 IoT, etc.). [![GitHub release](https://img.shields.io/github/release/adafruit/ArduinoCore-samd.svg)](https://github.com/adafruit/ArduinoCore-samd/releases/latest) 8. [`Seeeduino SAMD core 1.8.1+`](https://github.com/Seeed-Studio/ArduinoCore-samd) for SAMD21/SAMD51 boards (XIAO M0, Wio Terminal, etc.). [![Latest release](https://img.shields.io/github/release/Seeed-Studio/ArduinoCore-samd.svg)](https://github.com/Seeed-Studio/ArduinoCore-samd/releases/latest/) 9. [`Adafruit nRF52 v0.21.0+`](https://github.com/adafruit/Adafruit_nRF52_Arduino) for nRF52 boards such as Adafruit NRF52840_FEATHER, NRF52832_FEATHER, NRF52840_FEATHER_SENSE, NRF52840_ITSYBITSY, NRF52840_CIRCUITPLAY, NRF52840_CLUE, NRF52840_METRO, NRF52840_PCA10056, PARTICLE_XENON, **NINA_B302_ublox**, etc. [![GitHub release](https://img.shields.io/github/release/adafruit/Adafruit_nRF52_Arduino.svg)](https://github.com/adafruit/Adafruit_nRF52_Arduino/releases/latest) 10. [`ESP8266_AT_WebServer library v1.1.2+`](https://github.com/khoih-prog/ESP8266_AT_WebServer) to be able to support ESP32-AT shields. To install, check [![arduino-library-badge](https://www.ardu-badge.com/badge/ESP8266_AT_WebServer.svg?)](https://www.ardu-badge.com/ESP8266_AT_WebServer) 11. [`FlashStorage_SAMD library v1.1.0+`](https://github.com/khoih-prog/FlashStorage_SAMD) for SAMD21 and SAMD51 boards (ZERO, MKR, NANO_33_IOT, M0, M0 Pro, AdaFruit Itsy-Bitsy M4, etc.). [![GitHub release](https://img.shields.io/github/release/khoih-prog/FlashStorage_SAMD.svg)](https://github.com/khoih-prog/FlashStorage_SAMD/releases/latest). Or [`Platform.io FlashStorage_SAMD library v1.0.0+`](https://platformio.org/lib/show/11242/FlashStorage_SAMD) for SAMD21 and SAMD51 boards (ZERO, MKR, NANO_33_IOT, M0, M0 Pro, AdaFruit Itsy-Bitsy M4, etc.) -12. [`DueFlashStorage library v1.0.0+`](https://github.com/sebnil/DueFlashStorage) for SAM DUE. To install, check [![arduino-library-badge](https://www.ardu-badge.com/badge/DueFlashStorage.svg?)](https://www.ardu-badge.com/DueFlashStorage) -13. [`Adafruit's LittleFS/InternalFS`](www.adafruit.com) for nRF52 boards. -14. [`Ai-Thinker AT Firmware v1.5.4`](AT_Firmwares/At_firmware_bin1.54.zip) or [`AT Firmware v1.7.4.0`](AT_Firmwares/AT_Firmware_bin_1.7.4.0.zip) for ESP8266-AT shields. -15. [`AT version_2.1.0.0_dev`](AT_Firmwares/AT_version_2.1.0.0_dev.zip) for ESP32-AT shields. -16. `AT version_1.1.4` for WIS600-01S and W600-AT WiFi shields. +12. [`FlashStorage_STM32 library v1.1.0+`](https://github.com/khoih-prog/FlashStorage_STM32) for STM32F/L/H/G/WB/MP1 boards. To install. check [![arduino-library-badge](https://www.ardu-badge.com/badge/FlashStorage_STM32.svg?)](https://www.ardu-badge.com/FlashStorage_STM32) +13. [`DueFlashStorage library v1.0.0+`](https://github.com/sebnil/DueFlashStorage) for SAM DUE. To install, check [![arduino-library-badge](https://www.ardu-badge.com/badge/DueFlashStorage.svg?)](https://www.ardu-badge.com/DueFlashStorage) +14. [`Adafruit's LittleFS/InternalFS`](www.adafruit.com) for nRF52 boards. +15. [`Ai-Thinker AT Firmware v1.5.4`](AT_Firmwares/At_firmware_bin1.54.zip) or [`AT Firmware v1.7.4.0`](AT_Firmwares/AT_Firmware_bin_1.7.4.0.zip) for ESP8266-AT shields. +16. [`AT version_2.1.0.0_dev`](AT_Firmwares/AT_version_2.1.0.0_dev.zip) for ESP32-AT shields. +17. `AT version_1.1.4` for WIS600-01S and W600-AT WiFi shields. --- ### Important Notes about AT Firmwares -1. Tested OK with for ESP8266-AT shields: +### 1. Firmwares tested OK with ESP8266 AT shields + - [`Ai-Thinker AT Firmware v1.5.4`](https://github.com/khoih-prog/ESP8266_AT_WebServer/blob/master/AT_Firmwares/At_firmware_bin1.54.zip) ``` @@ -99,7 +237,8 @@ The configuration portal is captive, so it will present the configuration dialog ``` -2. Tested OK with for ESP32-AT shields: +### 2. Firmwares tested OK with ESP32 AT shields + - [`AT version_2.1.0.0_dev`](https://github.com/khoih-prog/ESP8266_AT_WebServer/blob/master/AT_Firmwares/AT_version_2.1.0.0_dev.zip) ``` @@ -158,6 +297,7 @@ You can also use this link [![arduino-library-badge](https://www.ardu-badge.com/ 4. Use included [platformio.ini](platformio/platformio.ini) file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at [Project Configuration File](https://docs.platformio.org/page/projectconf.html) +--- --- ### Packages' Patches @@ -222,7 +362,7 @@ This file must be copied into the directory: ***To be able to compile without error and automatically detect and display BOARD_NAME on Arduino SAMD (Nano-33-IoT, etc) boards***, you have to copy the whole [Arduino SAMD cores 1.8.10](Packages_Patches/arduino/hardware/samd/1.8.10) directory into Arduino SAMD directory (~/.arduino15/packages/arduino/hardware/samd/1.8.10). -#### For core version v1.8.11+ +#### For core version v1.8.10+ Supposing the Arduino SAMD version is 1.8.11. Now only one file must be copied into the directory: @@ -259,11 +399,11 @@ Whenever the above-mentioned compiler error issue is fixed with the new Arduino #### 5. For Adafruit SAMD boards - ***To be able to automatically detect and display BOARD_NAME on Adafruit SAMD (Itsy-Bitsy M4, etc) boards***, you have to copy the file [Adafruit SAMD platform.txt](Packages_Patches/adafruit/hardware/samd/1.6.4) into Adafruit samd directory (~/.arduino15/packages/adafruit/hardware/samd/1.6.4). + ***To be able to automatically detect and display BOARD_NAME on Adafruit SAMD (Itsy-Bitsy M4, etc) boards***, you have to copy the file [Adafruit SAMD platform.txt](Packages_Patches/adafruit/hardware/samd/1.6.7) into Adafruit samd directory (~/.arduino15/packages/adafruit/hardware/samd/1.6.7). -Supposing the Adafruit SAMD core version is 1.6.4. This file must be copied into the directory: +Supposing the Adafruit SAMD core version is 1.6.7. This file must be copied into the directory: -- `~/.arduino15/packages/adafruit/hardware/samd/1.6.4/platform.txt` +- `~/.arduino15/packages/adafruit/hardware/samd/1.6.7/platform.txt` Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory: @@ -285,6 +425,30 @@ This file must be copied into the directory: #### 7. For STM32 boards +#### 7.1 For STM32 boards to use LAN8720 + +To use LAN8720 on some STM32 boards + +- **Nucleo-144 (F429ZI, NUCLEO_F746NG, NUCLEO_F746ZG, NUCLEO_F756ZG)** +- **Discovery (DISCO_F746NG)** +- **STM32F4 boards (BLACK_F407VE, BLACK_F407VG, BLACK_F407ZE, BLACK_F407ZG, BLACK_F407VE_Mini, DIYMORE_F407VGT, FK407M1)** + +you have to copy the files [stm32f4xx_hal_conf_default.h](Packages_Patches/STM32/hardware/stm32/1.9.0/system/STM32F4xx) and [stm32f7xx_hal_conf_default.h](Packages_Patches/STM32/hardware/stm32/1.9.0/system/STM32F7xx) into STM32 stm32 directory (~/.arduino15/packages/STM32/hardware/stm32/1.9.0/system) to overwrite the old files. + +Supposing the STM32 stm32 core version is 1.9.0. These files must be copied into the directory: + +- `~/.arduino15/packages/STM32/hardware/stm32/1.9.0/system/STM32F4xx/stm32f4xx_hal_conf_default.h` for STM32F4. +- `~/.arduino15/packages/STM32/hardware/stm32/1.9.0/system/STM32F7xx/stm32f7xx_hal_conf_default.h` for Nucleo-144 STM32F7. + +Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz, +theses files must be copied into the corresponding directory: + +- `~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F4xx/stm32f4xx_hal_conf_default.h` +- `~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F7xx/stm32f7xx_hal_conf_default.h + + +#### 7.2 For STM32 boards to use Serial1 + **To use Serial1 on some STM32 boards without Serial1 definition (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.) boards**, you have to copy the files [STM32 variant.h](Packages_Patches/STM32/hardware/stm32/1.9.0) into STM32 stm32 directory (~/.arduino15/packages/STM32/hardware/stm32/1.9.0). You have to modify the files corresponding to your boards, this is just an illustration how to do. Supposing the STM32 stm32 core version is 1.9.0. These files must be copied into the directory: @@ -311,11 +475,15 @@ theses files must be copied into the corresponding directory: - `ESP8266/ESP32-AT shield` will try to connect. If successful, the dynamic DHCP or configured static IP address will be displayed in the configuration portal. - The `ESP8266/ESP32-AT shield` WiFi Config Portal network and Web Server will shutdown to return control to the sketch code. +--- --- ### How to use +#### 1. Basic usage + - Include in your sketch + ```cpp // Select depending on board @@ -346,17 +514,29 @@ const int LOCAL_PIN_LED = 13; // Pin 13, Controls the onboard LED. #define LED_OFF LOW ``` +#### 2. To open Config Portal + - When you want to open a config portal, just add ```cpp ESP_AT_WiFiManager ESP_AT_wiFiManager; ``` +#### 3. To use different AP WiFi Channel + - To not use default AP WiFi Channel 10 to avoid conflict with other WiFi APs, call ```cpp ESP_AT_wiFiManager.setAPChannel(newChannel); ``` +- To use random AP WiFi Channel to avoid conflict with other WiFi APs : + +```cpp +ESP_AT_WiFiManager->setAPChannel(0); +``` + +#### 4. To use different static AP IP from default + - To use static IP (not the default dynamically allocated DHCP IP) from the network to be connected, call ```cpp ESP_AT_wiFiManager.setSTAStaticIPConfig(IPAddress(xxx,xxx,xxx,xxx)); @@ -367,12 +547,16 @@ ESP_AT_wiFiManager.setSTAStaticIPConfig(IPAddress(xxx,xxx,xxx,xxx)); ESP_AT_wiFiManager.setAPStaticIPConfig(IPAddress(xxx,xxx,xxx,xxx)); ``` -- To use default AP SSID `ESP_AT_XXXXXX`, later call +#### 5. To use default AP SSID ESP_AT_XXXXXX + +- To use default AP SSID `ESP_AT_XXXXXX`, call ```cpp ESP_AT_wiFiManager.startConfigPortal() ``` +#### 6. To use personalized AP SSID and Password + - To use personalized SSID / Password, call ```cpp @@ -382,11 +566,24 @@ ESP_AT_wiFiManager.startConfigPortal((const char *) ssid.c_str(), password); While in AP mode, connect to it using its `SSID` (ESP_AT_XXXXXX) / `Password` ("ESP_AT_PW"), then open a browser to the Portal AP IP, default `192.168.4.1`, configure wifi then save. The Credentials / WiFi connection information will be saved in non-volatile memory. It will then autoconnect. -OnceCredentials / WiFi network information is saved in the host non-volatile memory, it will try to autoconnect to WiFi every time it is started, without requiring any function calls in the sketch. +Once Credentials / WiFi network information is saved in the host non-volatile memory, it will try to autoconnect to WiFi every time it is started, without requiring any function calls in the sketch. +--- +--- + +### Examples: + +1. [ConfigOnSwitch](examples/ConfigOnSwitch) +2. [ConfigOnStartup](examples/ConfigOnStartup) +3. [AutoConnect](examples/AutoConnect) +4. [AutoConnectWithFeedback](examples/AutoConnectWithFeedback) + + +--- --- ## So, how it works? + In `Configuration Portal Mode`, it starts an AP called `ESP_AT_XXXXXX`. Connect to it using the `configurable password` you can define in the code. For example, `ESP_AT_PW` (see examples): ```cpp @@ -416,11 +613,13 @@ Enter your credentials, then click `Save`. The WiFi Credentials will be saved an If you're already connected to a listed WiFi AP and don't want to change anything, just select `Exit` from the `Main` page to reboot the board and connect to the previously-stored AP. The WiFi Credentials are still intact. +--- --- -## Documentation +### Documentation + +#### 1. Password protect the configuration Access Point -#### Password protect the configuration Access Point You can password protect the configuration AP. Simply add an SSID as the first parameter and the password as a second parameter to `startConfigPortal` as follows: ```cpp @@ -432,25 +631,95 @@ Use Password having 8+ characters. The guidelines are that a wifi password must consist of 8 to 63 ASCII-encoded characters in the range of 32 to 126 (decimal) -#### Configuration Portal Timeout +#### 2. Configuration Portal Timeout + You can set a timeout(in seconds) so that `ESP8266/ESP32-AT shield` doesn't hang waiting to be configured for ever. ```cpp ESP_AT_WiFiManager.setConfigPortalTimeout(60); ``` + which will wait 1 minutes (60 seconds). When the time passes, the startConfigPortal function will return and continue the sketch, unless you're accessing the Config Portal. In this case, the `startConfigPortal` function will stay until you save config data or exit the Config Portal. --- -### Examples: +### Custom Configuration + +#### 1. Custom Parameters + +Many applications need configuration parameters like `MQTT host and port`, [Blynk](http://www.blynk.cc) or [emoncms](http://emoncms.org) tokens, etc. While it is possible to use `ESP_AT_WiFiManager` to collect additional parameters it is better to read these parameters from a web service once `ESP_AT_WiFiManager` has been used to connect to the internet. This makes `ESP_AT_WiFiManager` simple to code and use, parameters can be edited on a regular web server and can be changed remotely after deployment. + + +#### 2. Custom IP Configuration + +You can set a custom IP for both AP (access point, config mode) and STA (station mode, client mode, normal project state) + +#### 3. Custom Access Point IP Configuration + +This will set your captive portal to a specific IP should you need/want such a feature. Add the following snippet before `startConfigPortal()` +```cpp +// Default AP IP is 192.168.4.1. Uncomment to use different AP IP +ESP_AT_wiFiManager.setAPStaticIPConfig(IPAddress(192,168,100,1)); +``` + +#### 4. Custom Station (client) Static IP Configuration + +This will use the specified IP configuration instead of using DHCP in station mode. +```cpp +// Set static STA IP +ESP_AT_wiFiManager.setSTAStaticIPConfig(IPAddress(192,168,2,114)); +``` + +#### 5. Custom HTML, CSS, Javascript + +There are various ways in which you can inject custom HTML, CSS or Javascript into the configuration portal. + +The options are: + +##### 5.1 Inject custom head element + +You can use this to any html bit to the head of the configuration portal. If you add a `"); +``` + +##### 5.2 Inject a custom bit of html in the configuration form + +```cpp +ESP_AT_WMParameter custom_text("

This is just a text paragraph

"); +ESP_AT_wiFiManager.addParameter(&custom_text); +``` + +##### 5.3 Inject a custom bit of html in a configuration form element + +Just add the bit you want added as the last parameter to the custom parameter constructor. + +```cpp +ESP_AT_WMParameter custom_mqtt_server("server", "mqtt server", "iot.eclipse", 40, " readonly"); +``` + +#### 6. Filter Networks + +You can filter networks based on signal quality and show/hide duplicate networks. + +- If you would like to filter low signal quality networks you can tell WiFiManager to not show networks below an arbitrary quality %; + +```cpp +ESP_AT_wiFiManager.setMinimumSignalQuality(10); +``` + +will not show networks under 10% signal quality. If you omit the parameter it defaults to 8%; + +- You can also remove or show duplicate networks (default is remove). Use this function to show (or hide) all networks. + +```cpp +ESP_AT_wiFiManager.setRemoveDuplicateAPs(false); +``` - 1. [ConfigOnSwitch](examples/ConfigOnSwitch) - 2. [ConfigOnStartup](examples/ConfigOnStartup) - 3. [AutoConnect](examples/AutoConnect) - 4. [AutoConnectWithFeedback](examples/AutoConnectWithFeedback) - +--- --- ### Example [ConfigOnSwitch](examples/ConfigOnSwitch) @@ -495,7 +764,7 @@ const int TRIGGER_PIN2 = 23; // Change the PIN to whatever you'd like // Indicates whether ESP has WiFi credentials saved from previous session bool initialConfig = false; -void heartBeatPrint(void) +void heartBeatPrint() { static int num = 1; @@ -528,7 +797,7 @@ void check_status() } } -void enterConfigPortal(void) +void enterConfigPortal() { //Local intialization. Once its business is done, there is no need to keep it around ESP_AT_WiFiManager ESP_AT_wiFiManager; @@ -547,18 +816,25 @@ void enterConfigPortal(void) //Check if there is stored WiFi router/password credentials. //If not found, device will remain in configuration mode until switched off via webserver. - Serial.print("Opening Config Portal. "); + Serial.println("Opening Config Portal."); Router_SSID = ESP_AT_wiFiManager.WiFi_SSID(); Router_Pass = ESP_AT_wiFiManager.WiFi_Pass(); - if (Router_SSID != "") - { + if ( (Router_SSID != "") && ESP_AT_wiFiManager.isWiFiConfigValid() ) + { + if (ESP_AT_wiFiManager.connectWifi(Router_SSID, Router_Pass) == WL_CONNECTED) + { + Serial.println(F("Got stored Credentials. Try to connect first")); + + return; + } + ESP_AT_wiFiManager.setConfigPortalTimeout(60); //If no access point name has been previously entered disable timeout. - Serial.println(F("Got stored Credentials. Timeout 60s")); + Serial.println(F("Got stored Credentials but can't connect. Timeout 60s")); } else - Serial.println(F("No stored Credentials. No timeout")); + Serial.println(F("No stored or not valid Credentials. No timeout")); // SSID to uppercase ssid.toUpperCase(); @@ -596,6 +872,8 @@ void setup() Serial.println("\nStart ConfigOnSwitch with ESP8266-AT WiFi module on " + String(BOARD_NAME)); #endif + Serial.println(ESP_AT_WIFIMANAGER_VERSION); + // initialize serial for ESP module EspSerial.begin(115200); @@ -651,7 +929,6 @@ void loop() // put your main code here, to run repeatedly check_status(); - } ``` @@ -697,9 +974,9 @@ void loop() #define ESP8266_AT_USE_SAM_DUE true #endif -#if ( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \ - defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \ - defined(STM32WB) || defined(STM32MP1) ) +#if ( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \ + defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \ + defined(STM32WB) || defined(STM32MP1) || defined(STM32L5)) #if defined(ESP8266_AT_USE_STM32) #undef ESP8266_AT_USE_STM32 #endif @@ -926,6 +1203,9 @@ void loop() #elif defined(STM32L4) #warning STM32L4 board selected #define BOARD_TYPE "STM32L4" + #elif defined(STM32L5) + #warning STM32L5 board selected + #define BOARD_TYPE "STM32L5" #elif defined(STM32H7) #warning STM32H7 board selected #define BOARD_TYPE "STM32H7" @@ -986,19 +1266,21 @@ const int LOCAL_PIN_LED = 13; // Pin 13, Controls the onboard LED. #define LED_OFF LOW #endif //defines_h - ``` --- ### Debug Terminal Output -This is the terminal output when running [ConfigOnSwitch](examples/ConfigOnSwitch) example on **Adafruit Itsy-BItsy nRF52840**: +### 1. ConfigOnSwitch on Adafruit Itsy-BItsy nRF52840 with ESP8266-AT shield + +This is the terminal output when running [ConfigOnSwitch](examples/ConfigOnSwitch) example on **Adafruit Itsy-BItsy nRF52840 with ESP8266-AT shield**: -#### 1. Enter Config Portal +#### 1.1 Enter Config Portal ``` Start ConfigOnSwitch on NRF52840_ITSYBITSY +ESP_AT_WiFiManager v1.1.0 Opening Config Portal. *WM: LoadCfgFile *WM: OK *WM: ======= Start Stored Config Data ======= @@ -1018,7 +1300,7 @@ Opening Config Portal. *WM: LoadCfgFile *WM: Host Name = blank *WM: CCSum=0x7f4,RCSum=0x7f4 No stored Credentials. No timeout -Start Config Portal, SSID = ESP_AT_ABCDEF, Pass = ESP_AT_: Custom AP IP: 192.168.100.1 +Start Config Portal, SSID = ESP_AT_ABCDEF, Pass = ESP_AT_PW: Custom AP IP: 192.168.100.1 *WM: AP IP: 192.168.100.1 *WM: HTTP server on channel 1 *WM: Handle root @@ -1057,11 +1339,11 @@ After waiting 0 secs in setup(), connect result is connected. Local IP: 192.168. HH ``` -#### 2. Click `Save` +#### 1.2 Click `Save` ``` - Start ConfigOnSwitch on NRF52840_ITSYBITSY +ESP_AT_WiFiManager v1.1.0 Opening Config Portal. *WM: LoadCfgFile *WM: OK *WM: ======= Start Stored Config Data ======= @@ -1087,10 +1369,13 @@ HHHHHHHHHH HHHHHHHHHH HHHHHHHHHH HHHHHHHHHH HHHHHHHHHH HHHHHHHHHH HHHHHHHHHH HHH --- +### 2. ConfigOnStartup on SAM-DUE with ESP32-AT shield + This is the terminal output when running [ConfigOnStartup](examples/ConfigOnStartup) example using **SAM-DUE with ESP32-AT shield**. The ESP32-AT firmware is AT version:2.1.0.0-dev / SDK version:v4.0.1-193-ge7ac221b4: ``` Start ConfigOnStartup on SAM DUE +ESP_AT_WiFiManager v1.1.0 [ESP_AT] AT+RST [ESP_AT] ATE0 [ESP_AT] Use ESP32-AT Command @@ -1169,10 +1454,13 @@ H --- +### 3. ConfigOnStartup on STM32 Nucleo-144 NUCLEO_F767ZI with ESP8266-AT shield + This is the terminal output when running [ConfigOnStartup](examples/ConfigOnStartup) example using **STM32 Nucleo-144 NUCLEO_F767ZI with ESP8266-AT shield**. ``` Start ConfigOnStartup on NUCLEO_F767ZI +ESP_AT_WiFiManager v1.1.0 [ESP_AT] Use ES8266-AT Command Opening Config Portal. *WM: EEPROMsz:1024 *WM: CCSum=0x65a0,RCSum=0xffffffff @@ -1226,6 +1514,8 @@ HHHHHHHHH ``` --- +### 4. ConfigOnStartup on Seeeduino SEEED_XIAO_M0 with ESP8266-AT shield + This is the terminal output when running [ConfigOnStartup](examples/ConfigOnStartup) example using **Seeeduino SEEED_XIAO_M0 with ESP8266-AT shield**. ``` @@ -1276,84 +1566,120 @@ HHHHHHHHH --- -### Custom Configuration - -#### Custom Parameters -Many applications need configuration parameters like `MQTT host and port`, [Blynk](http://www.blynk.cc) or [emoncms](http://emoncms.org) tokens, etc. While it is possible to use `ESP_AT_WiFiManager` to collect additional parameters it is better to read these parameters from a web service once `ESP_AT_WiFiManager` has been used to connect to the internet. This makes `ESP_AT_WiFiManager` simple to code and use, parameters can be edited on a regular web server and can be changed remotely after deployment. +### 5. ConfigOnStartup on STM32 Nucleo-144 NUCLEO_F767ZI with ESP8266-AT shield with invalid data +This is the terminal output when running [ConfigOnStartup](examples/ConfigOnStartup) example using **STM32 Nucleo-144 NUCLEO_F767ZI with ESP8266-AT shield**. -#### Custom IP Configuration -You can set a custom IP for both AP (access point, config mode) and STA (station mode, client mode, normal project state) +### 5.1 Data OK => No Config Portal -##### Custom Access Point IP Configuration -This will set your captive portal to a specific IP should you need/want such a feature. Add the following snippet before `startConfigPortal()` -```cpp -// Default AP IP is 192.168.4.1. Uncomment to use different AP IP -ESP_AT_wiFiManager.setAPStaticIPConfig(IPAddress(192,168,100,1)); ``` - -##### Custom Station (client) Static IP Configuration -This will use the specified IP configuration instead of using DHCP in station mode. -```cpp -// Set static STA IP -ESP_AT_wiFiManager.setSTAStaticIPConfig(IPAddress(192,168,2,114)); +Start ConfigOnStartup with ESP8266-AT WiFi module on NUCLEO_F767ZI +ESP_AT_WiFiManager v1.1.0 +[ESP_AT] Use ES8266-AT Command +Opening Config Portal. +*WM: EEPROMsz:1024 +*WM: CCSum=0x9c7,RCSum=0x9c7 +*WM: Header = ESP_AT, SSID = HueNet1, PW = password +*WM: Host Name = blank +*WM: Connect wifi with new params +*WM: Data cleared +[ESP_AT] Use ES8266-AT Command +*WM: Static IP : 192.168.2.114 +*WM: Connect result: WL_CONNECTED +Got stored Credentials. Try to connect first +After waiting 0 secs in setup(), connect result is connected. Local IP: 192.168.2.114 +H ``` -#### Custom HTML, CSS, Javascript -There are various ways in which you can inject custom HTML, CSS or Javascript into the configuration portal. -The options are: -- inject custom head element -You can use this to any html bit to the head of the configuration portal. If you add a `"); +``` +Start ConfigOnStartup with ESP8266-AT WiFi module on NUCLEO_F767ZI +ESP_AT_WiFiManager v1.1.0 +[ESP_AT] Use ES8266-AT Command +Opening Config Portal. +*WM: EEPROMsz:1024 +*WM: CCSum=0x9c7,RCSum=0x9c7 +*WM: Header = ESP_AT, SSID = HueNet1, PW = password +*WM: Host Name = blank +*WM: Connect wifi with new params +*WM: Data cleared +[ESP_AT] Use ES8266-AT Command +*WM: Static IP : 192.168.2.114 +*WM: Connect result: WL_DISCONNECTED +Got stored Credentials but can't connect. Timeout 60s +Start Config Portal, SSID = ESP_AT_ABCDEF, Pass = ESP_AT_PW +*WM: Configure AP: ESP_AT_ABCDEF +*WM: AP PW: ESP_AT_PW +*WM: Custom AP IP: 192.168.100.1 +*WM: AP IP: 192.168.100.1 +*WM: HTTP server on channel 1 +*WM: WiFi save +*WM: SaveEEPROM,CSum=2503 +*WM: Sent wifisave page +*WM: Connect to new AP +*WM: Connect wifi with new params +*WM: Data cleared +[ESP_AT] Use ES8266-AT Command +*WM: Static IP : 192.168.2.114 +*WM: Connect result: WL_CONNECTED +WiFi connected...yeey +After waiting 0 secs in setup(), connect result is connected. Local IP: 192.168.2.114 +HHHHHH ``` -- inject a custom bit of html in the configuration form +--- +--- -```cpp -ESP_AT_WMParameter custom_text("

This is just a text paragraph

"); -ESP_AT_wiFiManager.addParameter(&custom_text); -``` -- inject a custom bit of html in a configuration form element -Just add the bit you want added as the last parameter to the custom parameter constructor. +### Debug + +Debug is enabled by default on Serial. To disable, add before `startConfigPortal()` ```cpp -ESP_AT_WMParameter custom_mqtt_server("server", "mqtt server", "iot.eclipse", 40, " readonly"); +ESP_AT_wiFiManager.setDebugOutput(false); ``` -#### Filter Networks -You can filter networks based on signal quality and show/hide duplicate networks. +--- -- If you would like to filter low signal quality networks you can tell WiFiManager to not show networks below an arbitrary quality %; +### Troubleshooting -```cpp -ESP_AT_wiFiManager.setMinimumSignalQuality(10); -``` -will not show networks under 10% signal quality. If you omit the parameter it defaults to 8%; +If you get compilation errors, more often than not, you may need to install a newer version of the board's core, `ESP8266/ESP32-AT shield` AT-command or this library version. -- You can also remove or show duplicate networks (default is remove). -Use this function to show (or hide) all networks. +Sometimes, the library will only work if you update the `ESP8266/ESP32-AT shield` core to the newer or older version because some function compatibility. -```cpp -ESP_AT_wiFiManager.setRemoveDuplicateAPs(false); -``` +--- --- -### Debug +## Releases -Debug is enabled by default on Serial. To disable, add before `startConfigPortal()` +### Major Release v1.1.0 -```cpp -ESP_AT_wiFiManager.setDebugOutput(false); -``` +1. Use new efficient [**FlashStorage_STM32** library](https://github.com/khoih-prog/FlashStorage_STM32). +2. Add support to new **STM32 core v2.0.0** and STM32L5 +3. Permit auto-connect without waiting for Config Portal if stored data is valid and WiFi test connection is OK. +4. Update examples with new features -### Troubleshooting -If you get compilation errors, more often than not, you may need to install a newer version of the board's core, `ESP8266/ESP32-AT shield` AT-command or this library version. +### Release v1.0.3 -Sometimes, the library will only work if you update the `ESP8266/ESP32-AT shield` core to the newer or older version because some function compatibility. +1. Add support to all **STM32F/L/H/G/WB/MP1 (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.)** +2. Add support to **Seeeduino SAMD21/SAMD51 boards (SEEED_WIO_TERMINAL, SEEED_FEMTO_M0, SEEED_XIAO_M0, Wio_Lite_MG126, WIO_GPS_BOARD, SEEEDUINO_ZERO, SEEEDUINO_LORAWAN, SEEED_GROVE_UI_WIRELESS, etc.)** +3. Add sample Packages_Patches for **STM32F/L/H/G/WB/MP1** (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8) +4. Add Packages_Patches for other boards. +5. Add instructions to use EspSerial/Serial1 on some **STM32F/L/H/G/WB/MP1** boards without Serial1 definition (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.) +6. Add Packages' Patches for Arduino SAMD21 to fix compiler error issue for **Nano-33-IoT, ZERO, MKR, etc.** + +### Release v1.0.2 + +1. Add support to **ESP32-AT-command shield**. + +### Release v1.0.1 + +1. Add support to **nRF52 (AdaFruit Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B302_ublox, NINA_B112_ublox, etc.)**. Credentials to be saved **automatically in LittleFS**. +2. Improve support to **STM32F/L/H/G/WB/MP1**. Credentials to be saved **automatically in EEPROM**. +3. Drop support to **Teensy** boards. +--- --- ### Issues ### @@ -1378,28 +1704,13 @@ Submit issues to: [ESP_AT_WiFiManager issues](https://github.com/khoih-prog/ESP_ 7. Add support to W600 and WIS600-01S 8. Add support to all **STM32F/L/H/G/WB/MP1** 9. Add support to **Seeeduino SAMD21/SAMD51 boards (SEEED_WIO_TERMINAL, SEEED_FEMTO_M0, SEEED_XIAO_M0, Wio_Lite_MG126, WIO_GPS_BOARD, SEEEDUINO_ZERO, SEEEDUINO_LORAWAN, SEEED_GROVE_UI_WIRELESS, etc.)** - ---- - -### New Version v1.0.3 - -1. Add support to all **STM32F/L/H/G/WB/MP1 (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.)** -2. Add support to **Seeeduino SAMD21/SAMD51 boards (SEEED_WIO_TERMINAL, SEEED_FEMTO_M0, SEEED_XIAO_M0, Wio_Lite_MG126, WIO_GPS_BOARD, SEEEDUINO_ZERO, SEEEDUINO_LORAWAN, SEEED_GROVE_UI_WIRELESS, etc.)** -3. Add sample Packages_Patches for **STM32F/L/H/G/WB/MP1** (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8) -4. Add Packages_Patches for other boards. -5. Add instructions to use EspSerial/Serial1 on some **STM32F/L/H/G/WB/MP1** boards without Serial1 definition (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.) -6. Add Packages' Patches for Arduino SAMD21 to fix compiler error issue for **Nano-33-IoT, ZERO, MKR, etc.** - -### New Version v1.0.2 - -1. Add support to **ESP32-AT-command shield**. - -### New Version v1.0.1 - -1. Add support to **nRF52 (AdaFruit Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B302_ublox, NINA_B112_ublox, etc.)**. Credentials to be saved **automatically in LittleFS**. -2. Improve support to **STM32F/L/H/G/WB/MP1**. Credentials to be saved **automatically in EEPROM**. -3. Drop support to **Teensy** boards. +10. Use more efficient [FlashStorage_SAMD](https://github.com/khoih-prog/FlashStorage_SAMD) and [FlashStorage_STM32](https://github.com/khoih-prog/FlashStorage_STM32) +11. Add Table-of-Contents and Version String +12. Enforce WiFi PWD minimum length of 8 chars +13. Permit auto-connect without waiting for Config Portal if stored data is valid and WiFi test connection is OK. +14. Add support to new STM32 core v2.0.0 and new STM32L5 boards. +--- --- ### Contributions and Thanks diff --git a/examples/AutoConnect/AutoConnect.ino b/examples/AutoConnect/AutoConnect.ino index b88d48e6..432ed55f 100644 --- a/examples/AutoConnect/AutoConnect.ino +++ b/examples/AutoConnect/AutoConnect.ino @@ -1,23 +1,24 @@ /**************************************************************************************************************************** - AutoConnect.ino - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + AutoConnect.ino + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 *****************************************************************************************************************************/ // Credits of [Miguel Alexandre Wisintainer](https://github.com/tcpipchip) for this simple yet effective method // For some STM32, there is only definition of Serial in variant.h, and is used for Serial/USB Debugging @@ -42,7 +43,7 @@ #include "defines.h" -void heartBeatPrint(void) +void heartBeatPrint() { static int num = 1; @@ -75,7 +76,7 @@ void check_status() } } -void enterConfigPortal(void) +void enterConfigPortal() { //Local intialization. Once its business is done, there is no need to keep it around ESP_AT_WiFiManager ESP_AT_wiFiManager; @@ -99,13 +100,20 @@ void enterConfigPortal(void) Router_SSID = ESP_AT_wiFiManager.WiFi_SSID(); Router_Pass = ESP_AT_wiFiManager.WiFi_Pass(); - if (Router_SSID != "") - { + if ( (Router_SSID != "") && ESP_AT_wiFiManager.isWiFiConfigValid() ) + { + if (ESP_AT_wiFiManager.connectWifi(Router_SSID, Router_Pass) == WL_CONNECTED) + { + Serial.println(F("Got stored Credentials. Try to connect first")); + + return; + } + ESP_AT_wiFiManager.setConfigPortalTimeout(60); //If no access point name has been previously entered disable timeout. - Serial.println(F("Got stored Credentials. Timeout 60s")); + Serial.println(F("Got stored Credentials but can't connect. Timeout 60s")); } else - Serial.println(F("No stored Credentials. No timeout")); + Serial.println(F("No stored or not valid Credentials. No timeout")); // SSID to uppercase ssid.toUpperCase(); @@ -147,7 +155,9 @@ void setup() #else Serial.println("\nStart AutoConnect with ESP8266-AT WiFi module on " + String(BOARD_NAME)); #endif - + + Serial.println(ESP_AT_WIFIMANAGER_VERSION); + // initialize serial for ESP module EspSerial.begin(115200); @@ -164,8 +174,8 @@ void setup() enterConfigPortal(); - //if you get here you have connected to the WiFi - Serial.println("WiFi connected"); + //if you get here you have exied from Config Portal + Serial.println("Exit Config Portal"); } void loop() diff --git a/examples/AutoConnect/defines.h b/examples/AutoConnect/defines.h index 3b955a5c..42050cd8 100644 --- a/examples/AutoConnect/defines.h +++ b/examples/AutoConnect/defines.h @@ -1,23 +1,15 @@ /**************************************************************************************************************************** - defines.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + defines.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license *****************************************************************************************************************************/ #ifndef defines_h @@ -59,9 +51,9 @@ #define ESP8266_AT_USE_SAM_DUE true #endif -#if ( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \ - defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \ - defined(STM32WB) || defined(STM32MP1) ) +#if ( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \ + defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \ + defined(STM32WB) || defined(STM32MP1) || defined(STM32L5) ) #if defined(ESP8266_AT_USE_STM32) #undef ESP8266_AT_USE_STM32 #endif @@ -288,6 +280,9 @@ #elif defined(STM32L4) #warning STM32L4 board selected #define BOARD_TYPE "STM32L4" + #elif defined(STM32L5) + #warning STM32L5 board selected + #define BOARD_TYPE "STM32L5" #elif defined(STM32H7) #warning STM32H7 board selected #define BOARD_TYPE "STM32H7" diff --git a/examples/AutoConnectWithFeedback/AutoConnectWithFeedback.ino b/examples/AutoConnectWithFeedback/AutoConnectWithFeedback.ino index d60723c8..254270ec 100644 --- a/examples/AutoConnectWithFeedback/AutoConnectWithFeedback.ino +++ b/examples/AutoConnectWithFeedback/AutoConnectWithFeedback.ino @@ -1,23 +1,24 @@ /**************************************************************************************************************************** - AutoConnectWithFeedBack.ino - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + AutoConnectWithFeedBack.ino + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 *****************************************************************************************************************************/ // Credits of [Miguel Alexandre Wisintainer](https://github.com/tcpipchip) for this simple yet effective method // For some STM32, there is only definition of Serial in variant.h, and is used for Serial/USB Debugging @@ -42,7 +43,7 @@ #include "defines.h" -void heartBeatPrint(void) +void heartBeatPrint() { static int num = 1; @@ -81,7 +82,7 @@ void configModeCallback (ESP_AT_WiFiManager *myESP_WiFiManager) Serial.println("AP_SSID : " + myESP_WiFiManager->getConfigPortalSSID() + " and AP_PASS = " + myESP_WiFiManager->getConfigPortalPW()); } -void enterConfigPortal(void) +void enterConfigPortal() { //Local intialization. Once its business is done, there is no need to keep it around ESP_AT_WiFiManager ESP_AT_wiFiManager; @@ -107,13 +108,20 @@ void enterConfigPortal(void) Router_SSID = ESP_AT_wiFiManager.WiFi_SSID(); Router_Pass = ESP_AT_wiFiManager.WiFi_Pass(); - if (Router_SSID != "") - { + if ( (Router_SSID != "") && ESP_AT_wiFiManager.isWiFiConfigValid() ) + { + if (ESP_AT_wiFiManager.connectWifi(Router_SSID, Router_Pass) == WL_CONNECTED) + { + Serial.println(F("Got stored Credentials. Try to connect first")); + + return; + } + ESP_AT_wiFiManager.setConfigPortalTimeout(60); //If no access point name has been previously entered disable timeout. - Serial.println(F("Got stored Credentials. Timeout 60s")); + Serial.println(F("Got stored Credentials but can't connect. Timeout 60s")); } else - Serial.println(F("No stored Credentials. No timeout")); + Serial.println(F("No stored or not valid Credentials. No timeout")); // SSID to uppercase ssid.toUpperCase(); @@ -156,6 +164,8 @@ void setup() Serial.println("\nStart AutoConnectWithFeedBack with ESP8266-AT WiFi module on " + String(BOARD_NAME)); #endif + Serial.println(ESP_AT_WIFIMANAGER_VERSION); + // initialize serial for ESP module EspSerial.begin(115200); @@ -172,8 +182,8 @@ void setup() enterConfigPortal(); - //if you get here you have connected to the WiFi - Serial.println("WiFi connected"); + //if you get here you have exied from Config Portal + Serial.println("Exit Config Portal"); } void loop() diff --git a/examples/AutoConnectWithFeedback/defines.h b/examples/AutoConnectWithFeedback/defines.h index 3b955a5c..999317e2 100644 --- a/examples/AutoConnectWithFeedback/defines.h +++ b/examples/AutoConnectWithFeedback/defines.h @@ -1,23 +1,15 @@ /**************************************************************************************************************************** - defines.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + defines.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license *****************************************************************************************************************************/ #ifndef defines_h @@ -288,6 +280,9 @@ #elif defined(STM32L4) #warning STM32L4 board selected #define BOARD_TYPE "STM32L4" + #elif defined(STM32L5) + #warning STM32L5 board selected + #define BOARD_TYPE "STM32L5" #elif defined(STM32H7) #warning STM32H7 board selected #define BOARD_TYPE "STM32H7" diff --git a/examples/ConfigOnStartup/ConfigOnStartup.ino b/examples/ConfigOnStartup/ConfigOnStartup.ino index 4e02a83f..5adf1712 100644 --- a/examples/ConfigOnStartup/ConfigOnStartup.ino +++ b/examples/ConfigOnStartup/ConfigOnStartup.ino @@ -1,23 +1,24 @@ /**************************************************************************************************************************** - ConfigOnStartup.ino - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + ConfigOnStartup.ino + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 *****************************************************************************************************************************/ /**************************************************************************************************************************** This example will open a configuration portal for 60 seconds when first powered up if the boards has stored WiFi Credentials. @@ -57,7 +58,7 @@ #include "defines.h" -void heartBeatPrint(void) +void heartBeatPrint() { static int num = 1; @@ -91,7 +92,7 @@ void check_status() } } -void enterConfigPortal(void) +void enterConfigPortal() { //Local intialization. Once its business is done, there is no need to keep it around ESP_AT_WiFiManager ESP_AT_wiFiManager; @@ -110,18 +111,25 @@ void enterConfigPortal(void) //Check if there is stored WiFi router/password credentials. //If not found, device will remain in configuration mode until switched off via webserver. - Serial.print("Opening Config Portal. "); + Serial.println("Opening Config Portal."); Router_SSID = ESP_AT_wiFiManager.WiFi_SSID(); Router_Pass = ESP_AT_wiFiManager.WiFi_Pass(); - if (Router_SSID != "") - { + if ( (Router_SSID != "") && ESP_AT_wiFiManager.isWiFiConfigValid() ) + { + if (ESP_AT_wiFiManager.connectWifi(Router_SSID, Router_Pass) == WL_CONNECTED) + { + Serial.println(F("Got stored Credentials. Try to connect first")); + + return; + } + ESP_AT_wiFiManager.setConfigPortalTimeout(60); //If no access point name has been previously entered disable timeout. - Serial.println(F("Got stored Credentials. Timeout 60s")); + Serial.println(F("Got stored Credentials but can't connect. Timeout 60s")); } else - Serial.println(F("No stored Credentials. No timeout")); + Serial.println(F("No stored or not valid Credentials. No timeout")); // SSID to uppercase ssid.toUpperCase(); @@ -157,6 +165,8 @@ void setup() Serial.println("\nStart ConfigOnStartup with ESP8266-AT WiFi module on " + String(BOARD_NAME)); #endif + Serial.println(ESP_AT_WIFIMANAGER_VERSION); + // initialize serial for ESP module EspSerial.begin(115200); diff --git a/examples/ConfigOnStartup/defines.h b/examples/ConfigOnStartup/defines.h index 3b955a5c..bc608d43 100644 --- a/examples/ConfigOnStartup/defines.h +++ b/examples/ConfigOnStartup/defines.h @@ -1,23 +1,15 @@ /**************************************************************************************************************************** - defines.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + defines.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license *****************************************************************************************************************************/ #ifndef defines_h @@ -288,6 +280,9 @@ #elif defined(STM32L4) #warning STM32L4 board selected #define BOARD_TYPE "STM32L4" + #elif defined(STM32L5) + #warning STM32L5 board selected + #define BOARD_TYPE "STM32L5" #elif defined(STM32H7) #warning STM32H7 board selected #define BOARD_TYPE "STM32H7" diff --git a/examples/ConfigOnSwitch/ConfigOnSwitch.ino b/examples/ConfigOnSwitch/ConfigOnSwitch.ino index 3728eeec..1bf2d60f 100644 --- a/examples/ConfigOnSwitch/ConfigOnSwitch.ino +++ b/examples/ConfigOnSwitch/ConfigOnSwitch.ino @@ -1,23 +1,24 @@ -/**************************************************************************************************************************** - ConfigOnSwitch.ino - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + /**************************************************************************************************************************** + ConfigOnSwitch.ino + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 *****************************************************************************************************************************/ /**************************************************************************************************************************** This example will open a configuration portal when no WiFi configuration has been previously entered or when a button is pushed. @@ -67,7 +68,7 @@ const int TRIGGER_PIN2 = 23; // Change the PIN to whatever you'd like // Indicates whether ESP has WiFi credentials saved from previous session bool initialConfig = false; -void heartBeatPrint(void) +void heartBeatPrint() { static int num = 1; @@ -100,7 +101,7 @@ void check_status() } } -void enterConfigPortal(void) +void enterConfigPortal() { //Local intialization. Once its business is done, there is no need to keep it around ESP_AT_WiFiManager ESP_AT_wiFiManager; @@ -119,18 +120,25 @@ void enterConfigPortal(void) //Check if there is stored WiFi router/password credentials. //If not found, device will remain in configuration mode until switched off via webserver. - Serial.print("Opening Config Portal. "); + Serial.println("Opening Config Portal."); Router_SSID = ESP_AT_wiFiManager.WiFi_SSID(); Router_Pass = ESP_AT_wiFiManager.WiFi_Pass(); - if (Router_SSID != "") - { + if ( (Router_SSID != "") && ESP_AT_wiFiManager.isWiFiConfigValid() ) + { + if (ESP_AT_wiFiManager.connectWifi(Router_SSID, Router_Pass) == WL_CONNECTED) + { + Serial.println(F("Got stored Credentials. Try to connect first")); + + return; + } + ESP_AT_wiFiManager.setConfigPortalTimeout(60); //If no access point name has been previously entered disable timeout. - Serial.println(F("Got stored Credentials. Timeout 60s")); + Serial.println(F("Got stored Credentials but can't connect. Timeout 60s")); } else - Serial.println(F("No stored Credentials. No timeout")); + Serial.println(F("No stored or not valid Credentials. No timeout")); // SSID to uppercase ssid.toUpperCase(); @@ -168,6 +176,8 @@ void setup() Serial.println("\nStart ConfigOnSwitch with ESP8266-AT WiFi module on " + String(BOARD_NAME)); #endif + Serial.println(ESP_AT_WIFIMANAGER_VERSION); + // initialize serial for ESP module EspSerial.begin(115200); @@ -223,5 +233,4 @@ void loop() // put your main code here, to run repeatedly check_status(); - } diff --git a/examples/ConfigOnSwitch/defines.h b/examples/ConfigOnSwitch/defines.h index 3b955a5c..e373f2cc 100644 --- a/examples/ConfigOnSwitch/defines.h +++ b/examples/ConfigOnSwitch/defines.h @@ -1,23 +1,15 @@ /**************************************************************************************************************************** - defines.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + defines.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license *****************************************************************************************************************************/ #ifndef defines_h @@ -59,9 +51,9 @@ #define ESP8266_AT_USE_SAM_DUE true #endif -#if ( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \ - defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \ - defined(STM32WB) || defined(STM32MP1) ) +#if ( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \ + defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \ + defined(STM32WB) || defined(STM32MP1) || defined(STM32L5)) #if defined(ESP8266_AT_USE_STM32) #undef ESP8266_AT_USE_STM32 #endif @@ -288,6 +280,9 @@ #elif defined(STM32L4) #warning STM32L4 board selected #define BOARD_TYPE "STM32L4" + #elif defined(STM32L5) + #warning STM32L5 board selected + #define BOARD_TYPE "STM32L5" #elif defined(STM32H7) #warning STM32H7 board selected #define BOARD_TYPE "STM32H7" diff --git a/keywords.txt b/keywords.txt index b516406c..51b5dc0a 100644 --- a/keywords.txt +++ b/keywords.txt @@ -48,7 +48,8 @@ WiFi_Pass KEYWORD2 IPAddressToString KEYWORD2 resetBoard KEYWORD2 setAPChannel KEYWORD2 - +connectWifi KEYWORD2 +isWiFiConfigValid KEYWORD2 ####################################### # Constants (LITERAL1) diff --git a/library.json b/library.json index d03f0538..9e36e4e7 100644 --- a/library.json +++ b/library.json @@ -1,8 +1,8 @@ { "name": "ESP_AT_WiFiManager", - "version": "1.0.3", - "keywords": "wifi, ESP8266, ESP32, AT, shield, nRF52, SAM DUE, SAMD21, SAMD51, STM32, Credentials, Manager, EEPROM, FlashStorage, DueFlashStorage, LittleFS", - "description": "WiFi/Credentials Manager for nRF52, SAM DUE, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, etc. boards running ESP8266/ESP32-AT-command shields with fallback web configuration portal. Credentials are saved in EEPROM, SAMD FlashStorage, DueFlashStorage of nRF52 LittleFS.", + "version": "1.1.0", + "keywords": "wifi, ESP8266, ESP32, AT, shield, nRF52, SAM DUE, SAMD21, SAMD51, STM32, Credentials, Manager, EEPROM, FlashStorage, FlashStorage-SAMD, FlashStorage-STM32, DueFlashStorage, LittleFS", + "description": "WiFi/Credentials Manager for nRF52, SAM DUE, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, etc. boards running ESP8266/ESP32-AT-command shields with fallback web configuration portal. Credentials are saved in EEPROM, FlashStorage_SAMD, FlashStorage_STM32, DueFlashStorage of nRF52 LittleFS.", "authors": { "name": "Khoi Hoang", @@ -25,9 +25,27 @@ "dependencies": [ { - "owner": "khoih-prog", + "owner": "khoih.prog", + "name": "FlashStorage_STM32", + "version": ">=1.1.0", + "platforms": ["*"] + }, + { + "owner": "khoih.prog", + "name": "FlashStorage_SAMD", + "version": "^1.1.0", + "platforms": ["*"] + }, + { + "owner": "sebnil", + "name": "DueFlashStorage", + "version": "^1.0.0", + "platforms": ["*"] + }, + { + "owner": "khoih.prog", "name": "ESP8266_AT_WebServer", - "version": "^1.1.1", + "version": "^1.1.2", "platforms": ["*"] } ], diff --git a/library.properties b/library.properties index 6400003e..c5845adc 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ESP_AT_WiFiManager -version=1.0.3 +version=1.1.0 author=Khoi Hoang maintainer=Khoi Hoang license=MIT @@ -8,4 +8,4 @@ paragraph=Library to configure WiFi/Credentials at runtime for nRF52, SAM DUE, S category=Communication url=https://github.com/khoih-prog/ESP_AT_WiFiManager architectures=* -depends=ESP8266_AT_WebServer +depends=ESP8266_AT_WebServer, FlashStorage_STM32, FlashStorage_SAMD, DueFlashStorage diff --git a/platformio/platformio.ini b/platformio/platformio.ini index c4c757f2..c8fe7a15 100644 --- a/platformio/platformio.ini +++ b/platformio/platformio.ini @@ -35,10 +35,16 @@ upload_speed = 921600 lib_deps = ; PlatformIO 4.x - ESP8266_AT_WebServer@~1.1.1 +; ESP8266_AT_WebServer@~1.1.2 +; FlashStorage_STM32@~1.1.0 +; FlashStorage_SAMD@~1.1.0 +; DueFlashStorage@~1.0.0 ; PlatformIO 5.x -; khoih-prog/ESP8266_AT_WebServer@~1.1.1 - + khoih.prog/ESP8266_AT_WebServer@~1.1.2 + khoih.prog/FlashStorage_STM32@~1.1.0 + khoih.prog/FlashStorage_SAMD@~1.1.0 + sebnil/DueFlashStorage@~1.0.0 + build_flags = ; set your debug output (default=Serial) ; -D DEBUG_ESP_PORT=Serial diff --git a/src/ESP_AT_WiFiManager-impl.h b/src/ESP_AT_WiFiManager-impl.h index ee4423a4..d9be28d6 100644 --- a/src/ESP_AT_WiFiManager-impl.h +++ b/src/ESP_AT_WiFiManager-impl.h @@ -1,28 +1,35 @@ -/**************************************************************************************************************************** - ESP_AT_WiFiManager-impl.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. - *****************************************************************************************************************************/ +/******************************************************************************************************************************** + ESP_AT_WiFiManager-impl.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Inspired by: + http://www.esp8266.com/viewtopic.php?f=29&t=2520 + https://github.com/chriscook8/esp-arduino-apboot + https://github.com/esp8266/Arduino/blob/master/libraries/DNSServer/examples/CaptivePortalAdvanced/ + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 + *********************************************************************************************************************************/ #ifndef ESP_AT_WiFiManager_impl_h #define ESP_AT_WiFiManager_impl_h +////////////////////////////////////////////// ESP_AT_WMParameter::ESP_AT_WMParameter(const char *custom) { @@ -35,21 +42,29 @@ ESP_AT_WMParameter::ESP_AT_WMParameter(const char *custom) _customHTML = custom; } +////////////////////////////////////////////// + ESP_AT_WMParameter::ESP_AT_WMParameter(const char *id, const char *placeholder, const char *defaultValue, int length) { init(id, placeholder, defaultValue, length, "", WFM_LABEL_BEFORE); } +////////////////////////////////////////////// + ESP_AT_WMParameter::ESP_AT_WMParameter(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom) { init(id, placeholder, defaultValue, length, custom, WFM_LABEL_BEFORE); } +////////////////////////////////////////////// + ESP_AT_WMParameter::ESP_AT_WMParameter(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom, int labelPlacement) { init(id, placeholder, defaultValue, length, custom, labelPlacement); } +////////////////////////////////////////////// + void ESP_AT_WMParameter::init(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom, int labelPlacement) { _id = id; @@ -71,6 +86,8 @@ void ESP_AT_WMParameter::init(const char *id, const char *placeholder, const cha _customHTML = custom; } +////////////////////////////////////////////// + ESP_AT_WMParameter::~ESP_AT_WMParameter() { if (_value != NULL) @@ -79,34 +96,49 @@ ESP_AT_WMParameter::~ESP_AT_WMParameter() } } +////////////////////////////////////////////// + const char* ESP_AT_WMParameter::getValue() { return _value; } +////////////////////////////////////////////// + const char* ESP_AT_WMParameter::getID() { return _id; } + +////////////////////////////////////////////// + const char* ESP_AT_WMParameter::getPlaceholder() { return _placeholder; } +////////////////////////////////////////////// + int ESP_AT_WMParameter::getValueLength() { return _length; } +////////////////////////////////////////////// + int ESP_AT_WMParameter::getLabelPlacement() { return _labelPlacement; } + +////////////////////////////////////////////// + const char* ESP_AT_WMParameter::getCustomHTML() { return _customHTML; } +////////////////////////////////////////////// /** * [getParameters description] @@ -116,6 +148,7 @@ ESP_AT_WMParameter** ESP_AT_WiFiManager::getParameters() { return _params; } +////////////////////////////////////////////// /** * [getParametersCount description] @@ -125,8 +158,9 @@ int ESP_AT_WiFiManager::getParametersCount() { return _paramsCount; } +////////////////////////////////////////////// -ESP_AT_WiFiManager::ESP_AT_WiFiManager(void) +ESP_AT_WiFiManager::ESP_AT_WiFiManager() { _max_params = WIFI_MANAGER_MAX_PARAMS; _params = (ESP_AT_WMParameter**)malloc(_max_params * sizeof(ESP_AT_WMParameter*)); @@ -134,6 +168,8 @@ ESP_AT_WiFiManager::ESP_AT_WiFiManager(void) networkIndices = NULL; } +////////////////////////////////////////////// + ESP_AT_WiFiManager::~ESP_AT_WiFiManager() { if (_params != NULL) @@ -147,6 +183,8 @@ ESP_AT_WiFiManager::~ESP_AT_WiFiManager() } } +////////////////////////////////////////////// + bool ESP_AT_WiFiManager::addParameter(ESP_AT_WMParameter *p) { if (_paramsCount == _max_params) @@ -170,9 +208,12 @@ bool ESP_AT_WiFiManager::addParameter(ESP_AT_WMParameter *p) _params[_paramsCount] = p; _paramsCount++; DEBUG_WM2(F("Adding param "), p->getID()); + return true; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::setupConfigPortal() { stopConfigPortal = false; //Signal not to close config portal @@ -250,6 +291,8 @@ void ESP_AT_WiFiManager::setupConfigPortal() } +////////////////////////////////////////////// + bool ESP_AT_WiFiManager::autoConnect() { String ssid = "ESP_AT_ABCDEF"; @@ -257,6 +300,8 @@ bool ESP_AT_WiFiManager::autoConnect() return autoConnect(ssid.c_str(), NULL); } +////////////////////////////////////////////// + /* This is not very useful as there has been an assumption that device has to be told to connect but Wifi already does it's best to connect in background. Calling this method will block until WiFi connects. Sketch can avoid @@ -285,6 +330,8 @@ bool ESP_AT_WiFiManager::autoConnect(char const *apName, char const *apPassword) return startConfigPortal(apName, apPassword); } +////////////////////////////////////////////// + bool ESP_AT_WiFiManager::startConfigPortal() { String ssid = "ESP_AT_ABCDEF"; @@ -294,6 +341,8 @@ bool ESP_AT_WiFiManager::startConfigPortal() return startConfigPortal(ssid.c_str(), NULL); } +////////////////////////////////////////////// + bool ESP_AT_WiFiManager::startConfigPortal(char const *apName, char const *apPassword) { _apName = apName; @@ -340,6 +389,7 @@ bool ESP_AT_WiFiManager::startConfigPortal(char const *apName, char const *apPa //todo: check if any custom parameters actually exist, and check if they really changed maybe _savecallback(); } + break; } @@ -352,6 +402,7 @@ bool ESP_AT_WiFiManager::startConfigPortal(char const *apName, char const *apPa //todo: check if any custom parameters actually exist, and check if they really changed maybe _savecallback(); } + break; } } @@ -362,6 +413,7 @@ bool ESP_AT_WiFiManager::startConfigPortal(char const *apName, char const *apPa stopConfigPortal = false; break; } + yield(); } @@ -390,6 +442,8 @@ bool ESP_AT_WiFiManager::startConfigPortal(char const *apName, char const *apPa return WiFi.status() == WL_CONNECTED; } +////////////////////////////////////////////// + int ESP_AT_WiFiManager::connectWifi(String ssid, String pass) { DEBUG_WM(F("Connect wifi with new params")); @@ -428,6 +482,8 @@ int ESP_AT_WiFiManager::connectWifi(String ssid, String pass) return connRes; } +////////////////////////////////////////////// + uint8_t ESP_AT_WiFiManager::waitForConnectResult() { if (_connectTimeout == 0) @@ -444,6 +500,7 @@ uint8_t ESP_AT_WiFiManager::waitForConnectResult() while (keepConnecting) { status = WiFi.status(); + if (millis() > start + _connectTimeout) { keepConnecting = false; @@ -454,12 +511,16 @@ uint8_t ESP_AT_WiFiManager::waitForConnectResult() { keepConnecting = false; } + delay(100); } + return status; } } +////////////////////////////////////////////// + //Convenient for debugging but wasteful of program space. //Remove if short of space const char* ESP_AT_WiFiManager::getStatus(int status) @@ -479,16 +540,22 @@ const char* ESP_AT_WiFiManager::getStatus(int status) } } +////////////////////////////////////////////// + String ESP_AT_WiFiManager::getConfigPortalSSID() { return _apName; } +////////////////////////////////////////////// + String ESP_AT_WiFiManager::getConfigPortalPW() { return _apPassword; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::resetSettings() { DEBUG_WM(F("Data cleared")); @@ -499,46 +566,64 @@ void ESP_AT_WiFiManager::resetSettings() return; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::setTimeout(unsigned long seconds) { setConfigPortalTimeout(seconds); } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::setConfigPortalTimeout(unsigned long seconds) { _configPortalTimeout = seconds * 1000; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::setConnectTimeout(unsigned long seconds) { _connectTimeout = seconds * 1000; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::setDebugOutput(bool debug) { _debug = debug; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::setAPStaticIPConfig(IPAddress ip) { _ap_static_ip = ip; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::setSTAStaticIPConfig(IPAddress ip) { _sta_static_ip = ip; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::setMinimumSignalQuality(int quality) { _minimumQuality = quality; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::setBreakAfterConfig(bool shouldBreak) { _shouldBreakAfterConfig = shouldBreak; } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::reportStatus(String &page) { if (WiFi_SSID() != "") @@ -565,6 +650,8 @@ void ESP_AT_WiFiManager::reportStatus(String &page) } } +////////////////////////////////////////////// + /** Handle root or redirect to captive portal */ void ESP_AT_WiFiManager::handleRoot() { @@ -624,6 +711,8 @@ void ESP_AT_WiFiManager::handleRoot() } +////////////////////////////////////////////// + /** Wifi config page handler */ void ESP_AT_WiFiManager::handleWifi() { @@ -759,6 +848,8 @@ void ESP_AT_WiFiManager::handleWifi() DEBUG_WM(F("Sent config page")); } +////////////////////////////////////////////// + /** Handle the WLAN save form and redirect to WLAN config page again */ void ESP_AT_WiFiManager::handleWifiSave() { @@ -856,6 +947,8 @@ void ESP_AT_WiFiManager::handleWifiSave() _configPortalTimeout = DEFAULT_PORTAL_TIMEOUT; } +////////////////////////////////////////////// + /** Handle shut down the server page */ void ESP_AT_WiFiManager::handleServerClose() { @@ -883,6 +976,7 @@ void ESP_AT_WiFiManager::handleServerClose() page += F("
"); page += F("IP: "); + if (_sta_static_ip) { page += IPAddressToString(_sta_static_ip); @@ -909,6 +1003,8 @@ void ESP_AT_WiFiManager::handleServerClose() _configPortalTimeout = DEFAULT_PORTAL_TIMEOUT; } +////////////////////////////////////////////// + /** Handle the info page */ void ESP_AT_WiFiManager::handleInfo() { @@ -980,6 +1076,8 @@ void ESP_AT_WiFiManager::handleInfo() DEBUG_WM(F("Sent info page")); } +////////////////////////////////////////////// + void ESP_AT_WiFiManager::handleNotFound() { String message = "File Not Found\n\n"; @@ -1023,29 +1121,39 @@ void ESP_AT_WiFiManager::handleNotFound() #endif } +////////////////////////////////////////////// + //start up config portal callback void ESP_AT_WiFiManager::setAPCallback(void(*func)(ESP_AT_WiFiManager* myWiFiManager)) { _apcallback = func; } +////////////////////////////////////////////// + //start up save config callback -void ESP_AT_WiFiManager::setSaveConfigCallback(void(*func)(void)) +void ESP_AT_WiFiManager::setSaveConfigCallback(void(*func)()) { _savecallback = func; } +////////////////////////////////////////////// + //sets a custom element to add to head, like a new style tag void ESP_AT_WiFiManager::setCustomHeadElement(const char* element) { _customHeadElement = element; } +////////////////////////////////////////////// + //if this is true, remove duplicated Access Points - defaut true void ESP_AT_WiFiManager::setRemoveDuplicateAPs(bool removeDuplicates) { _removeDuplicateAPs = removeDuplicates; } +////////////////////////////////////////////// + //Scan for WiFiNetworks in range and sort by signal strength //space for indices array allocated on the heap and should be freed when no longer required int ESP_AT_WiFiManager::scanWifiNetworks(int **indicesptr) @@ -1140,6 +1248,8 @@ int ESP_AT_WiFiManager::scanWifiNetworks(int **indicesptr) } } +////////////////////////////////////////////// + template void ESP_AT_WiFiManager::DEBUG_WM(Generic text) { @@ -1150,6 +1260,8 @@ void ESP_AT_WiFiManager::DEBUG_WM(Generic text) } } +////////////////////////////////////////////// + int ESP_AT_WiFiManager::getRSSIasQuality(int RSSI) { int quality = 0; @@ -1170,6 +1282,8 @@ int ESP_AT_WiFiManager::getRSSIasQuality(int RSSI) return quality; } +////////////////////////////////////////////// + /** Is this an IP? */ bool ESP_AT_WiFiManager::isIp(String str) { @@ -1182,13 +1296,17 @@ bool ESP_AT_WiFiManager::isIp(String str) return false; } } + return true; } +////////////////////////////////////////////// + /** IP to String? */ String ESP_AT_WiFiManager::toStringIp(IPAddress ip) { String res = ""; + for (int i = 0; i < 3; i++) { res += String((ip >> (8 * i)) & 0xFF) + "."; @@ -1199,16 +1317,21 @@ String ESP_AT_WiFiManager::toStringIp(IPAddress ip) return res; } -void ESP_AT_WiFiManager::displayConfigData(void) +////////////////////////////////////////////// + +void ESP_AT_WiFiManager::displayConfigData() { DEBUG_WM6(F("Header = "), ESP_AT_WM_Config.header, F(", SSID = "), ESP_AT_WM_Config.wifi_ssid, F(", PW = "), ESP_AT_WM_Config.wifi_pw); DEBUG_WM2(F("Host Name = "), ESP_AT_WM_Config.host_name); } -int ESP_AT_WiFiManager::calcChecksum(void) +////////////////////////////////////////////// + +int ESP_AT_WiFiManager::calcChecksum() { int checkSum = 0; + for (uint16_t index = 0; index < (sizeof(ESP_AT_WM_Config) - sizeof(ESP_AT_WM_Config.checkSum)); index++) { checkSum += * ( ( (byte*) &ESP_AT_WM_Config ) + index); @@ -1217,5 +1340,24 @@ int ESP_AT_WiFiManager::calcChecksum(void) return checkSum; } +////////////////////////////////////////////// + +bool ESP_AT_WiFiManager::isWiFiConfigValid() +{ + // If PWD length < 8 (as required by standard) => invalid set + // Need both sets of valid SSID/PWD + if ( strlen(ESP_AT_WM_Config.wifi_pw) < PASSWORD_MIN_LEN ) + { + // If SSID, PW = NULL or len < 8, set the flag + DEBUG_WM2(F("Invalid Stored Config Data : WiFi PWD len < 8. PWD = "), ESP_AT_WM_Config.wifi_pw); + + hadConfigData = false; + + return false; + } + + return true; +} + #endif //ESP_AT_WiFiManager-impl_h diff --git a/src/ESP_AT_WiFiManager-impl_DUE.h b/src/ESP_AT_WiFiManager-impl_DUE.h index aad25b84..c0b769a1 100644 --- a/src/ESP_AT_WiFiManager-impl_DUE.h +++ b/src/ESP_AT_WiFiManager-impl_DUE.h @@ -1,24 +1,30 @@ -/**************************************************************************************************************************** - ESP_AT_WiFiManager-impl_DUE.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. - *****************************************************************************************************************************/ +/******************************************************************************************************************************** + ESP_AT_WiFiManager-impl_DUE.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Inspired by: + http://www.esp8266.com/viewtopic.php?f=29&t=2520 + https://github.com/chriscook8/esp-arduino-apboot + https://github.com/esp8266/Arduino/blob/master/libraries/DNSServer/examples/CaptivePortalAdvanced/ + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 + *********************************************************************************************************************************/ #ifndef ESP_AT_WiFiManager_impl_DUE_h #define ESP_AT_WiFiManager_impl_DUE_h @@ -26,26 +32,27 @@ //Use DueFlashStorage to simulate EEPROM //https://github.com/sebnil/DueFlashStorage #include + DueFlashStorage dueFlashStorage; -void ESP_AT_WiFiManager::resetBoard(void) +void ESP_AT_WiFiManager::resetBoard() { rstc_start_software_reset(RSTC); } -void ESP_AT_WiFiManager::clearConfigData(void) +void ESP_AT_WiFiManager::clearConfigData() { memset(&ESP_AT_WM_Config, 0, sizeof(ESP_AT_WM_Config)); dueFlashStorage.write(EEPROM_START, (byte *) &ESP_AT_WM_Config, sizeof(ESP_AT_WM_Config)); } -bool ESP_AT_WiFiManager::getConfigData(void) +bool ESP_AT_WiFiManager::getConfigData() { hadConfigData = false; ESP_AT_WM_Configuration* dataPointer = (ESP_AT_WM_Configuration* ) dueFlashStorage.readAddress(EEPROM_START); memcpy(&ESP_AT_WM_Config, dataPointer, sizeof(ESP_AT_WM_Config)); - + int calChecksum = calcChecksum(); DEBUG_WM4(F("CCSum=0x"), String(calChecksum, HEX), F(",RCSum=0x"), String(ESP_AT_WM_Config.checkSum, HEX)); @@ -70,20 +77,26 @@ bool ESP_AT_WiFiManager::getConfigData(void) else if ( !strncmp(ESP_AT_WM_Config.wifi_ssid, ESP_AT_NO_CONFIG, strlen(ESP_AT_NO_CONFIG)) || !strncmp(ESP_AT_WM_Config.wifi_pw, ESP_AT_NO_CONFIG, strlen(ESP_AT_NO_CONFIG) ) ) { - // If SSID, PW ="nothing", return false + // If SSID, PW ="blank", return false return false; } else { displayConfigData(); } + + // If "blank" or NULL, set false flag and exit + if (!isWiFiConfigValid()) + { + return false; + } hadConfigData = true; return true; } -void ESP_AT_WiFiManager::saveConfigData(void) +void ESP_AT_WiFiManager::saveConfigData() { int calChecksum = calcChecksum(); ESP_AT_WM_Config.checkSum = calChecksum; diff --git a/src/ESP_AT_WiFiManager-impl_SAMD.h b/src/ESP_AT_WiFiManager-impl_SAMD.h index c7b5b464..7a5946b7 100644 --- a/src/ESP_AT_WiFiManager-impl_SAMD.h +++ b/src/ESP_AT_WiFiManager-impl_SAMD.h @@ -1,24 +1,30 @@ -/**************************************************************************************************************************** - ESP_AT_WiFiManager-impl_SAMD.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. - *****************************************************************************************************************************/ +/******************************************************************************************************************************** + ESP_AT_WiFiManager-impl_SAMD.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Inspired by: + http://www.esp8266.com/viewtopic.php?f=29&t=2520 + https://github.com/chriscook8/esp-arduino-apboot + https://github.com/esp8266/Arduino/blob/master/libraries/DNSServer/examples/CaptivePortalAdvanced/ + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 + *********************************************************************************************************************************/ #ifndef ESP_AT_WiFiManager_impl_SAMD_h #define ESP_AT_WiFiManager_impl_SAMD_h @@ -27,23 +33,23 @@ #include FlashStorage(ESP_AT_WM_Config_data, ESP_AT_WM_Configuration); -void ESP_AT_WiFiManager::resetBoard(void) +void ESP_AT_WiFiManager::resetBoard() { NVIC_SystemReset(); } -void ESP_AT_WiFiManager::clearConfigData(void) +void ESP_AT_WiFiManager::clearConfigData() { memset(&ESP_AT_WM_Config, 0, sizeof(ESP_AT_WM_Config)); ESP_AT_WM_Config_data.write(ESP_AT_WM_Config); } -bool ESP_AT_WiFiManager::getConfigData(void) +bool ESP_AT_WiFiManager::getConfigData() { hadConfigData = false; ESP_AT_WM_Config = ESP_AT_WM_Config_data.read(); - + int calChecksum = calcChecksum(); DEBUG_WM4(F("CCSum=0x"), String(calChecksum, HEX), F(",RCSum=0x"), String(ESP_AT_WM_Config.checkSum, HEX)); @@ -68,20 +74,26 @@ bool ESP_AT_WiFiManager::getConfigData(void) else if ( !strncmp(ESP_AT_WM_Config.wifi_ssid, ESP_AT_NO_CONFIG, strlen(ESP_AT_NO_CONFIG)) || !strncmp(ESP_AT_WM_Config.wifi_pw, ESP_AT_NO_CONFIG, strlen(ESP_AT_NO_CONFIG) ) ) { - // If SSID, PW ="nothing", return false + // If SSID, PW ="blank", return false return false; } else { displayConfigData(); } + + // If "blank" or NULL, set false flag and exit + if (!isWiFiConfigValid()) + { + return false; + } hadConfigData = true; return true; } -void ESP_AT_WiFiManager::saveConfigData(void) +void ESP_AT_WiFiManager::saveConfigData() { int calChecksum = calcChecksum(); ESP_AT_WM_Config.checkSum = calChecksum; diff --git a/src/ESP_AT_WiFiManager-impl_STM32.h b/src/ESP_AT_WiFiManager-impl_STM32.h index 928776bf..bd955956 100644 --- a/src/ESP_AT_WiFiManager-impl_STM32.h +++ b/src/ESP_AT_WiFiManager-impl_STM32.h @@ -1,50 +1,96 @@ -/**************************************************************************************************************************** - ESP_AT_WiFiManager-impl_STM32.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. - *****************************************************************************************************************************/ +/******************************************************************************************************************************** + ESP_AT_WiFiManager-impl_STM32.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Inspired by: + http://www.esp8266.com/viewtopic.php?f=29&t=2520 + https://github.com/chriscook8/esp-arduino-apboot + https://github.com/esp8266/Arduino/blob/master/libraries/DNSServer/examples/CaptivePortalAdvanced/ + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 + ********************************************************************************************************************************/ #ifndef ESP_AT_WiFiManager_impl_STM32_h #define ESP_AT_WiFiManager_impl_STM32_h -#include +#if !( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \ + defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \ + defined(STM32WB) || defined(STM32MP1) || defined(STM32L5) ) + #error This code is intended to run on STM32F/L/H/G/WB/MP1 platform! Please check your Tools->Board setting. +#endif -void ESP_AT_WiFiManager::resetBoard(void) +#include + +///////////////////////////////////////////// + +#if defined(DATA_EEPROM_BASE) + // For STM32 devices having integrated EEPROM. + #include + #warning STM32 devices have integrated EEPROM. Not using buffered API. +#else + /** + Most STM32 devices don't have an integrated EEPROM. To emulate a EEPROM, the STM32 Arduino core emulated + the operation of an EEPROM with the help of the embedded flash. + Writing to a flash is very expensive operation, since a whole flash page needs to be written, even if you only + want to access the flash byte-wise. + The STM32 Arduino core provides a buffered access API to the emulated EEPROM. The library has allocated the + buffer even if you don't use the buffered API, so it's strongly suggested to use the buffered API anyhow. + */ + #include // https://github.com/khoih-prog/FlashStorage_STM32 + #warning STM32 devices have no integrated EEPROM. Using buffered API with FlashStorage_STM32 library +#endif // #if defined(DATA_EEPROM_BASE) + +////////////////////////////////////////////// + +void ESP_AT_WiFiManager::resetBoard() { - void(*resetFunc)(void) = 0; + // Initialize the IWDG with 2 seconds timeout. + // This would cause a CPU reset if the IWDG timer + // is not reloaded in approximately 2 seconds. + IWatchdog.begin(2000000); + + // Back up + void(*resetFunc)() = 0; resetFunc(); } -void ESP_AT_WiFiManager::clearConfigData(void) +////////////////////////////////////////////// + +void ESP_AT_WiFiManager::clearConfigData() { memset(&ESP_AT_WM_Config, 0, sizeof(ESP_AT_WM_Config)); saveConfigData(); } -bool ESP_AT_WiFiManager::getConfigData(void) +////////////////////////////////////////////// + +bool ESP_AT_WiFiManager::getConfigData() { hadConfigData = false; - EEPROM.begin(); +#if defined(DATA_EEPROM_BASE) + EEPROM.begin(); +#endif + DEBUG_WM2(F("EEPROMsz:"), EEPROM_SIZE); EEPROM.get(EEPROM_START, ESP_AT_WM_Config); - + int calChecksum = calcChecksum(); DEBUG_WM4(F("CCSum=0x"), String(calChecksum, HEX), F(",RCSum=0x"), String(ESP_AT_WM_Config.checkSum, HEX)); @@ -70,20 +116,28 @@ bool ESP_AT_WiFiManager::getConfigData(void) else if ( !strncmp(ESP_AT_WM_Config.wifi_ssid, ESP_AT_NO_CONFIG, strlen(ESP_AT_NO_CONFIG)) || !strncmp(ESP_AT_WM_Config.wifi_pw, ESP_AT_NO_CONFIG, strlen(ESP_AT_NO_CONFIG) ) ) { - // If SSID, PW ="nothing", return false + // If SSID, PW ="blank", return false return false; } else { displayConfigData(); } - + + // If "blank" or NULL, set false flag and exit + if (!isWiFiConfigValid()) + { + return false; + } + hadConfigData = true; return true; } -void ESP_AT_WiFiManager::saveConfigData(void) +////////////////////////////////////////////// + +void ESP_AT_WiFiManager::saveConfigData() { int calChecksum = calcChecksum(); ESP_AT_WM_Config.checkSum = calChecksum; @@ -92,6 +146,8 @@ void ESP_AT_WiFiManager::saveConfigData(void) EEPROM.put(EEPROM_START, ESP_AT_WM_Config); } + +////////////////////////////////////////////// #endif //ESP_AT_WiFiManager_impl_STM32_h diff --git a/src/ESP_AT_WiFiManager-impl_nRF52.h b/src/ESP_AT_WiFiManager-impl_nRF52.h index a3d6beda..ee0ce660 100644 --- a/src/ESP_AT_WiFiManager-impl_nRF52.h +++ b/src/ESP_AT_WiFiManager-impl_nRF52.h @@ -1,24 +1,30 @@ -/**************************************************************************************************************************** - ESP_AT_WiFiManager-impl_nRF52.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. - *****************************************************************************************************************************/ +/******************************************************************************************************************************** + ESP_AT_WiFiManager-impl_nRF52.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Inspired by: + http://www.esp8266.com/viewtopic.php?f=29&t=2520 + https://github.com/chriscook8/esp-arduino-apboot + https://github.com/esp8266/Arduino/blob/master/libraries/DNSServer/examples/CaptivePortalAdvanced/ + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 + *********************************************************************************************************************************/ #ifndef ESP_AT_WiFiManager_impl_nRF52_h #define ESP_AT_WiFiManager_impl_nRF52_h @@ -34,21 +40,21 @@ File file(InternalFS); #define CONFIG_FILENAME ("/wm_config.dat") #define CONFIG_FILENAME_BACKUP ("/wm_config.bak") -void ESP_AT_WiFiManager::resetBoard(void) +void ESP_AT_WiFiManager::resetBoard() { delay(1000); // Restart for nRF52 NVIC_SystemReset(); } -void ESP_AT_WiFiManager::clearConfigData(void) +void ESP_AT_WiFiManager::clearConfigData() { memset(&ESP_AT_WM_Config, 0, sizeof(ESP_AT_WM_Config)); saveConfigData(); } -void ESP_AT_WiFiManager::loadConfigData(void) +void ESP_AT_WiFiManager::loadConfigData() { DEBUG_WM1(F("LoadCfgFile ")); @@ -76,7 +82,7 @@ void ESP_AT_WiFiManager::loadConfigData(void) file.close(); } -bool ESP_AT_WiFiManager::getConfigData(void) +bool ESP_AT_WiFiManager::getConfigData() { hadConfigData = false; @@ -88,10 +94,10 @@ bool ESP_AT_WiFiManager::getConfigData(void) } // if config file exists, load - loadConfigData(); + loadConfigData(); DEBUG_WM1(F("======= Start Stored Config Data =======")); - displayConfigData(); - + displayConfigData(); + int calChecksum = calcChecksum(); DEBUG_WM4(F("CCSum=0x"), String(calChecksum, HEX), F(",RCSum=0x"), String(ESP_AT_WM_Config.checkSum, HEX)); @@ -120,20 +126,26 @@ bool ESP_AT_WiFiManager::getConfigData(void) else if ( !strncmp(ESP_AT_WM_Config.wifi_ssid, ESP_AT_NO_CONFIG, strlen(ESP_AT_NO_CONFIG)) || !strncmp(ESP_AT_WM_Config.wifi_pw, ESP_AT_NO_CONFIG, strlen(ESP_AT_NO_CONFIG) ) ) { - // If SSID, PW ="nothing", return false + // If SSID, PW ="blank", return false return false; } else { displayConfigData(); } + + // If "blank" or NULL, set false flag and exit + if (!isWiFiConfigValid()) + { + return false; + } hadConfigData = true; return true; } -void ESP_AT_WiFiManager::saveConfigData(void) +void ESP_AT_WiFiManager::saveConfigData() { DEBUG_WM1(F("SaveCfgFile ")); diff --git a/src/ESP_AT_WiFiManager.h b/src/ESP_AT_WiFiManager.h index 86a2a5fc..da7d9986 100644 --- a/src/ESP_AT_WiFiManager.h +++ b/src/ESP_AT_WiFiManager.h @@ -1,33 +1,36 @@ -/**************************************************************************************************************************** - ESP_AT_WiFiManager.h - WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - - ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields - (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal - - Inspired by: - http://www.esp8266.com/viewtopic.php?f=29&t=2520 - https://github.com/chriscook8/esp-arduino-apboot - https://github.com/esp8266/Arduino/blob/master/libraries/DNSServer/examples/CaptivePortalAdvanced/ - - Based on and modified from Tzapu https://github.com/tzapu/WiFiManager - and from Ken Taylor https://github.com/kentaylor - - Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager - Licensed under MIT license - Version: 1.0.3 - - Version Modified By Date Comments - ------- ----------- ---------- ----------- - 1.0.0 K Hoang 08/03/2020 Initial coding - 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. - 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. - 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. - *****************************************************************************************************************************/ +/******************************************************************************************************************************** + ESP_AT_WiFiManager.h + WiFi/Credentials Manager for SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + + ESP_AT_WiFiManager is a library for the Teensy, SAM DUE, SAMD, nRF52, STM32F/L/H/G/WB/MP1, etc. boards running `ESP8266/ESP32-AT-command` shields + (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi, etc. credentials using a Captive Portal + + Inspired by: + http://www.esp8266.com/viewtopic.php?f=29&t=2520 + https://github.com/chriscook8/esp-arduino-apboot + https://github.com/esp8266/Arduino/blob/master/libraries/DNSServer/examples/CaptivePortalAdvanced/ + + Based on and modified from Tzapu https://github.com/tzapu/WiFiManager + and from Ken Taylor https://github.com/kentaylor + + Built by Khoi Hoang https://github.com/khoih-prog/ESP_AT_WiFiManager + Licensed under MIT license + Version: 1.1.0 + + Version Modified By Date Comments + ------- ----------- ---------- ----------- + 1.0.0 K Hoang 08/03/2020 Initial coding + 1.0.1 K Hoang 22/06/2020 Add support to nRF52 boards, such as AdaFruit Feather nRF52832, NINA_B302_ublox, etc. + 1.0.2 K Hoang 02/07/2020 Add support to ESP32-AT-command shields. + 1.0.3 K Hoang 28/07/2020 Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards. Add Packages' Patches. + 1.1.0 K Hoang 27/04/2021 Use new FlashStorage_STM32 library. Add support to new STM32 core v2.0.0 and STM32L5 + *********************************************************************************************************************************/ #ifndef ESP_AT_WiFiManager_h #define ESP_AT_WiFiManager_h +#define ESP_AT_WIFIMANAGER_VERSION "ESP_AT_WiFiManager v1.1.0" + #if !defined(DEBUG_WIFIMGR) #define DEBUG_WIFIMGR false #endif @@ -48,14 +51,14 @@ #warning Use nFR52 architecture from ESP8266_AT_WiFiManager #endif -#if ( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \ - defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \ - defined(STM32WB) || defined(STM32MP1) ) +#if ( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \ + defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \ + defined(STM32WB) || defined(STM32MP1) || defined(STM32L5) ) #if defined(STM32F0) - #error STMF0 not supported + #error STMF0 not supported #endif #if defined(ESP8266_AT_USE_STM32) - #undef ESP8266_AT_USE_STM32 + #undef ESP8266_AT_USE_STM32 #endif #define ESP8266_AT_USE_STM32 true #endif @@ -168,12 +171,20 @@ class ESP_AT_WMParameter friend class ESP_AT_WiFiManager; }; +#define SSID_MAX_LEN 32 +//From v1.0.3, WPA2 passwords can be min 8 and max 63 characters long. +#define PASSWORD_MIN_LEN 8 +#define PASSWORD_MAX_LEN 64 + +#define HEADER_MAX_LEN 16 +#define RFC952_HOSTNAME_MAXLEN 24 + typedef struct _ESP_AT_WM_Configuration { - char header [16]; - char wifi_ssid [32]; - char wifi_pw [32]; - char host_name [24]; + char header [HEADER_MAX_LEN]; + char wifi_ssid [SSID_MAX_LEN]; + char wifi_pw [PASSWORD_MAX_LEN]; + char host_name [RFC952_HOSTNAME_MAXLEN]; int checkSum; } ESP_AT_WM_Configuration; @@ -217,7 +228,7 @@ class ESP_AT_WiFiManager { public: - ESP_AT_WiFiManager(void); + ESP_AT_WiFiManager(); ~ESP_AT_WiFiManager(); @@ -255,10 +266,10 @@ class ESP_AT_WiFiManager //called when AP mode and config portal is started void setAPCallback(void(*func)(ESP_AT_WiFiManager*)); //called when settings have been changed and connection was successful - void setSaveConfigCallback(void(*func)(void)); + void setSaveConfigCallback(void(*func)()); //adds a custom parameter - bool addParameter(ESP_AT_WMParameter *p); + bool addParameter(ESP_AT_WMParameter *p); //if this is set, it will exit after config, even if connection is unsucessful. void setBreakAfterConfig(bool shouldBreak); @@ -272,12 +283,14 @@ class ESP_AT_WiFiManager int scanWifiNetworks(int **indicesptr); // return SSID of router in STA mode got from config portal. NULL if no user's input //KH - String getSSID(void) { + String getSSID() + { return WiFi_SSID(); } // return password of router in STA mode got from config portal. NULL if no user's input //KH - String getPW(void) { + String getPW() + { return WiFi_Pass(); } @@ -289,7 +302,7 @@ class ESP_AT_WiFiManager const char* getStatus(int status); - String WiFi_SSID(void) + String WiFi_SSID() { if (!hadConfigData) getConfigData(); @@ -300,7 +313,7 @@ class ESP_AT_WiFiManager return ""; } - String WiFi_Pass(void) + String WiFi_Pass() { if (!hadConfigData) getConfigData(); @@ -316,14 +329,24 @@ class ESP_AT_WiFiManager return (String(address[0]) + "." + address[1] + "." + address[2] + "." + address[3]); } - void resetBoard(void); + void resetBoard(); + #define MAX_WIFI_CHANNEL 11 + void setAPChannel(int apChannel) { - _apChannel = apChannel; + // Use random channel if AP_channel == 0 + if (apChannel == 0) + _apChannel = (millis() % MAX_WIFI_CHANNEL) + 1; + else + _apChannel = apChannel; } - void clearConfigData(void); + void clearConfigData(); + + int connectWifi(String ssid, String pass); + + bool isWiFiConfigValid(); private: @@ -358,14 +381,13 @@ class ESP_AT_WiFiManager int _paramsCount = 0; int _minimumQuality = -1; - bool _removeDuplicateAPs = true; - bool _shouldBreakAfterConfig = false; + bool _removeDuplicateAPs = true; + bool _shouldBreakAfterConfig = false; const char* _customHeadElement = ""; int status; - int connectWifi(String ssid, String pass); uint8_t waitForConnectResult(); void handleRoot(); @@ -381,15 +403,15 @@ class ESP_AT_WiFiManager //helpers int getRSSIasQuality(int RSSI); - bool isIp(String str); + bool isIp(String str); String toStringIp(IPAddress ip); - - bool connect; - bool stopConfigPortal = false; - bool _debug = false; //true; + + bool connect; + bool stopConfigPortal = false; + bool _debug = false; //true; void(*_apcallback)(ESP_AT_WiFiManager*) = NULL; - void(*_savecallback)(void) = NULL; + void(*_savecallback)() = NULL; int _max_params; ESP_AT_WMParameter** _params; @@ -406,11 +428,11 @@ class ESP_AT_WiFiManager return false; } - void displayConfigData(void); - int calcChecksum(void); - void loadConfigData(void); - bool getConfigData(void); - void saveConfigData(void); + void displayConfigData(); + int calcChecksum(); + void loadConfigData(); + bool getConfigData(); + void saveConfigData(); }; #if DEBUG_WIFIMGR