# ESPAsync_WiFiManager **Repository Path**: guiyn/ESPAsync_WiFiManager ## Basic Information - **Project Name**: ESPAsync_WiFiManager - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 0 - **Created**: 2021-11-26 - **Last Updated**: 2025-01-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # ESPAsync_WiFiManager [![arduino-library-badge](https://www.ardu-badge.com/badge/ESPAsync_WiFiManager.svg?)](https://www.ardu-badge.com/ESPAsync_WiFiManager) [![GitHub release](https://img.shields.io/github/release/khoih-prog/ESPAsync_WiFiManager.svg)](https://github.com/khoih-prog/ESPAsync_WiFiManager/releases) [![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/khoih-prog/ESPAsync_WiFiManager/blob/master/LICENSE) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing) [![GitHub issues](https://img.shields.io/github/issues/khoih-prog/ESPAsync_WiFiManager.svg)](http://github.com/khoih-prog/ESPAsync_WiFiManager/issues) --- --- ## Table of Contents * [Why do we need this ESPAsync_WiFiManager library](#why-do-we-need-this-async-espasync_wifimanager-library) * [Features](#features) * [Why Async is better](#why-async-is-better) * [Currently supported Boards](#currently-supported-boards) * [Changelog](changelog.md) * [Prerequisites](#prerequisites) * [Installation](#installation) * [Use Arduino Library Manager](#use-arduino-library-manager) * [Manual Install](#manual-install) * [VS Code & PlatformIO](#vs-code--platformio) * [Libraries' Patches](#libraries-patches) * [1. For ESPAsyncWebServer library](#1-for-espasyncwebserver-library) * [Note for Platform IO using ESP32 LittleFS](#note-for-platform-io-using-esp32-littlefs) * [HOWTO Fix `Multiple Definitions` Linker Error](#howto-fix-multiple-definitions-linker-error) * [HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)](#howto-use-analogread-with-esp32-running-wifi-andor-bluetooth-btble) * [1. ESP32 has 2 ADCs, named ADC1 and ADC2](#1--esp32-has-2-adcs-named-adc1-and-adc2) * [2. ESP32 ADCs functions](#2-esp32-adcs-functions) * [3. ESP32 WiFi uses ADC2 for WiFi functions](#3-esp32-wifi-uses-adc2-for-wifi-functions) * [How It Works](#how-it-works) * [HOWTO Basic configurations](#howto-basic-configurations) * [1. Using default for every configurable parameter](#1-using-default-for-every-configurable-parameter) * [2. Using many configurable parameters](#2-using-many-configurable-parameters) * [3. Using STA-mode DHCP, but don't like to change to static IP or display in Config Portal](#3-using-sta-mode-dhcp-but-dont-like-to-change-to-static-ip-or-display-in-config-portal) * [4. Using STA-mode DHCP, but permit to change to static IP and display in Config Portal](#4-using-sta-mode-dhcp-but-permit-to-change-to-static-ip-and-display-in-config-portal) * [5. Using STA-mode StaticIP, and be able to change to DHCP IP and display in Config Portal](#5-using-sta-mode-staticip-and-be-able-to-change-to-dhcp-ip-and-display-in-config-portal) * [6. Using STA-mode StaticIP and configurable DNS, and be able to change to DHCP IP and display in Config Portal](#6-using-sta-mode-staticip-and-configurable-dns-and-be-able-to-change-to-dhcp-ip-and-display-in-config-portal) * [7. Using STA-mode StaticIP and auto DNS, and be able to change to DHCP IP and display in Config Portal](#7-using-sta-mode-staticip-and-auto-dns-and-be-able-to-change-to-dhcp-ip-and-display-in-config-portal) * [8. Not using NTP to avoid issue with some WebBrowsers, especially in CellPhone or Tablets.](#8-not-using-ntp-to-avoid-issue-with-some-webbrowsers-especially-in-cellphone-or-tablets) * [9. Using NTP feature with CloudFlare. System can hang until you have Internet access for CloudFlare.](#9-using-ntp-feature-with-cloudflare-system-can-hang-until-you-have-internet-access-for-cloudflare) * [10. Using NTP feature without CloudFlare to avoid system hang if no Internet access for CloudFlare.](#10-using-ntp-feature-without-cloudflare-to-avoid-system-hang-if-no-internet-access-for-cloudflare) * [11. Using random AP-mode channel to avoid conflict](#11-using-random-ap-mode-channel-to-avoid-conflict) * [12. Using fixed AP-mode channel, for example channel 3](#12-using-fixed-ap-mode-channel-for-example-channel-3) * [13. Setting STA-mode static IP](#13-setting-sta-mode-static-ip) * [14. Using AUTOCONNECT_NO_INVALIDATE feature](#14-using-autoconnect_no_invalidate-feature) * [15. Using CORS (Cross-Origin Resource Sharing) feature](#15-using-cors-cross-origin-resource-sharing-feature) * [16. Using MultiWiFi auto(Re)connect feature](#16-using-multiwifi-autoreconnect-feature) * [17. How to auto getting _timezoneName](#17-how-to-auto-getting-_timezonename) * [18. How to get TZ variable to configure Timezone](#18-how-to-get-tz-variable-to-configure-timezone) * [19. How to use the TZ variable to configure Timezone](#19-how-to-use-the-tz-variable-to-configure-timezone) * [HOWTO Open Config Portal](#howto-open-config-portal) * [HOWTO Add Dynamic Parameters](#howto-add-dynamic-parameters) * [1. Determine the variables to be configured via Config Portal (CP)](#1-determine-the-variables-to-be-configured-via-config-portal-cp) * [2. Initialize the variables to prepare for Config Portal (CP)](#2-initialize-the-variables-to-prepare-for-config-portal-cp) * [2.1 Use the following simple constructor for simple variables such as `thingspeakApiKey`, `pinSda` and `pinScl`](#21-use-the-following-simple-constructor-for-simple-variables-such-as-thingspeakapikey-pinsda-and-pinscl-) * [2.2 For example, to create a new `ESPAsync_WMParameter` object `p_thingspeakApiKey` for `thingspeakApiKey`](#22-for-example-to-create-a-new-espasync_wmparameter-object-p_thingspeakapikey-for-thingspeakapikey) * [2.3 Use the more complex following constructor for variables such as `sensorDht22`](#23-use-the-more-complex-following-constructor-for-variables-such-as-sensordht22) * [2.4 For example, to create a new `ESPAsync_WMParameter` object `p_sensorDht22` for `sensorDht22`](#24-for-example-to-create-a-new-espasync_wmparameter-object-p_sensordht22-for-sensordht22) * [3. Add the variables to Config Portal (CP)](#3-add-the-variables-to-config-portal-cp) * [3.1 addParameter() function Prototype:](#31-addparameter-function-prototype) * [3.2 Code to add variables to CP](#32-code-to-add-variables-to-cp) * [4. Save the variables configured in Config Portal (CP)](#4-save-the-variables-configured-in-config-portal-cp) * [4.1 Getting variables' data from CP](#41-getting-variables-data-from-cp) * [5. Write to FS (SPIFFS, LittleFS, etc.) using JSON format](#5-write-to-fs-spiffs-littlefs-etc-using-json-format) * [5.1 Create a DynamicJsonDocument Object](#51-create-a-dynamicjsondocument-object) * [5.2 Fill the DynamicJsonDocument Object with data got from Config Portal](#52-fill-the-dynamicjsondocument-object-with-data-got-from-config-portal) * [5.3 Open file to write the Jsonified data](#53-open-file-to-write-the-jsonified-data) * [5.4 Write the Jsonified data to CONFIG_FILE](#54-write-the-jsonified-data-to-config_file) * [5.5 Close CONFIG_FILE to flush and save the data](#55-close-config_file-to-flush-and-save-the-data) * [6. Read from FS using JSON format](#6-read-from-fs-using-json-format) * [6.1 Open CONFIG_FILE to read](#61-open-config_file-to-read) * [6.2 Open CONFIG_FILE to read](62-open-config_file-to-read) * [6.3 Populate the just-read Jsonified data into the DynamicJsonDocument json object](#63-populate-the-just-read-jsonified-data-into-the-dynamicjsondocument-json-object) * [6.4 Parse the Jsonified data from the DynamicJsonDocument json object to store into corresponding parameters](#64-parse-the-jsonified-data-from-the-dynamicjsondocument-json-object-to-store-into-corresponding-parameters) * [6.5 Then what to do now](#65-then-what-to-do-now) * [So, how it works?](#so-how-it-works) * [Documentation](#documentation) * [Password protect the configuration Access Point](#password-protect-the-configuration-access-point) * [Callbacks](#callbacks) * [Save settings](#save-settings) * [ConfigPortal Timeout](#configportal-timeout) * [On Demand ConfigPortal](#on-demand-configportal) * [Custom Parameters](#custom-parameters) * [Custom IP Configuration](#custom-ip-configuration) * [Custom Access Point IP Configuration](#custom-access-point-ip-configuration) * [Custom Station (client) Static IP Configuration](#custom-station-client-static-ip-configuration) * [Custom HTML, CSS, Javascript](#custom-html-css-javascript) * [Filter Networks](#filter-networks) * [Examples](#examples) * [Medium Complexity](#medium-complexity) * [Async_ConfigOnSwitch](examples/Async_ConfigOnSwitch) * [Async_ConfigOnSwitchFS](examples/Async_ConfigOnSwitchFS) * [Async_ConfigOnStartup](examples/Async_ConfigOnStartup) * [Async_ConfigOnDoubleReset](examples/Async_ConfigOnDoubleReset) (now support ArduinoJson 6.0.0+ as well as 5.13.5-) * [Async_ConfigOnDoubleReset_TZ](examples/Async_ConfigOnDoubleReset_TZ) (now support ArduinoJson 6.0.0+ as well as 5.13.5-) * [Async_ConfigPortalParamsOnSwitch](examples/Async_ConfigPortalParamsOnSwitch) (now support ArduinoJson 6.0.0+ as well as 5.13.5-) * [Async_AutoConnect](examples/Async_AutoConnect) * [Async_AutoConnectWithFeedback](examples/Async_AutoConnectWithFeedback) * [Async_AutoConnectWithFeedbackLED](examples/Async_AutoConnectWithFeedbackLED) * [Async_AutoConnectWithFSParameters](examples/Async_AutoConnectWithFSParameters) * [Async_ConfigOnSwitchFS_MQTT_Ptr](examples/Async_ConfigOnSwitchFS_MQTT_Ptr) * [Async_AutoConnectWithFSParametersAndCustomIP](examples/Async_AutoConnectWithFSParametersAndCustomIP) * [Async_ESP32_FSWebServer](examples/Async_ESP32_FSWebServer) * [Async_ESP32_FSWebServer_DRD](examples/Async_ESP32_FSWebServer_DRD) * [Async_ESP_FSWebServer](examples/Async_ESP_FSWebServer) * [Async_ESP_FSWebServer_DRD](examples/Async_ESP_FSWebServer_DRD) * [Async_ConfigOnDRD_FS_MQTT_Ptr](examples/Async_ConfigOnDRD_FS_MQTT_Ptr) * [High Complexity](#high-complexity) * [Async_ConfigOnDRD_FS_MQTT_Ptr_Complex](examples/Async_ConfigOnDRD_FS_MQTT_Ptr_Complex) * [Async_ConfigOnDRD_FS_MQTT_Ptr_Medium](examples/Async_ConfigOnDRD_FS_MQTT_Ptr_Medium) * [Simplest Possible](#simplest-possible) * [Async_AutoConnect_ESP32_minimal](examples/Async_AutoConnect_ESP32_minimal) * [Async_AutoConnect_ESP8266_minimal](examples/Async_AutoConnect_ESP8266_minimal) * [Async_ConfigOnDRD_ESP32_minimal](examples/Async_ConfigOnDRD_ESP32_minimal) * [Async_ConfigOnDRD_ESP8266_minimal](examples/Async_ConfigOnDRD_ESP8266_minimal) * [Example Async_ConfigOnDRD_FS_MQTT_Ptr](#example-async_configondrd_fs_mqtt_ptr) * [Debug Terminal Output Samples](#debug-terminal-output-samples) * [1. Async_ConfigOnDRD_FS_MQTT_Ptr on ESP32_DEV](#1-async_configondrd_fs_mqtt_ptr_medium-on-esp32_dev) * [2. Async_ConfigOnDRD_FS_MQTT_Ptr on ESP8266_NODEMCU_ESP12E](#2-async_configondrd_fs_mqtt_ptr_complex-on-ESP8266_NODEMCU_ESP12E) * [3. Async_ConfigOnDoubleReset on ESP32_DEV](#3-async_configondoublereset-on-esp32_dev) * [4. Async_ConfigOnDoubleReset on ESP8266_NODEMCU_ESP12E](#4-async_configondoublereset-on-ESP8266_NODEMCU_ESP12E) * [5. Async_ESP_FSWebServer_DRD on ESP8266_NODEMCU_ESP12E](#5-async_esp_fswebserver_drd-on-ESP8266_NODEMCU_ESP12E) * [6. Async_ESP32_FSWebServer_DRD on ESP32_DEV](#6-async_esp32_fswebserver_drd-on-esp32_dev) * [7. Async_ConfigOnDoubleReset on ESP32S2_DEV](#7-async_configondoublereset-on-esp32s2_dev) * [8. Async_ConfigOnDoubleReset_TZ on ESP32_DEV](#8-async_configondoublereset_tz-on-esp32_dev) * [8.1 DRD => Config Portal](#81-drd--config-portal) * [8.2 Data Saved => Connect to WiFi with correct local time, TZ set and using NTP](#82-data-saved--connect-to-wifi-with-correct-local-time-tz-set-and-using-ntp) * [8.3 Normal running with correct local time, TZ set and using NTP](#83-normal-running-with-correct-local-time-tz-set-and-using-ntp) * [9. Async_ESP_FSWebServer_DRD on ESP8266_NODEMCU_ESP12E](#9-async_esp_fswebserver_drd-on-ESP8266_NODEMCU_ESP12E) * [9.1 DRD => Config Portal](#91-drd--config-portal) * [9.2 Data Saved => Connect to WiFi with correct local time, TZ set and using NTP](#92-data-saved--connect-to-wifi-with-correct-local-time-tz-set-and-using-ntp) * [9.3 Normal running with correct local time, TZ set and using NTP](#93-normal-running-with-correct-local-time-tz-set-and-using-ntp) * [10. Async_ConfigOnDoubleReset_TZ on ESP32C3_DEV using SPIFFS](#10-async_configondoublereset_tz-on-esp32c3_dev-using-spiffs) * [Debug](#debug) * [Troubleshooting](#troubleshooting) * [Issues](#issues) * [Contributions and Thanks](#contributions-and-thanks) * [Contributing](#contributing) * [License and credits](#license-and-credits) * [Copyright](#copyright) --- --- ### Why do we need this Async [ESPAsync_WiFiManager library](https://github.com/khoih-prog/ESPAsync_WiFiManager) #### Features This is an `ESP32 / ESP8266` WiFi Connection Manager with fallback Web ConfigPortal. This Library is used for configuring ESP32, ESP8266 modules' (WiFi / Dynamic) Credentials at runtime. You can also specify static DNS servers, personalized HostName, fixed or random AP channel. Now with CORS feature. This library is based on, modified, bug-fixed and improved from: 1. [`Tzapu's WiFiManager`](https://github.com/tzapu/WiFiManager) 2. [`Ken Taylor's WiFiManager`](https://github.com/kentaylor/WiFiManager) 3. [`Alan Steremberg's ESPAsyncWiFiManager`](https://github.com/alanswx/ESPAsyncWiFiManager) 4. [`Khoi Hoang's ESP_WiFiManager`](https://github.com/khoih-prog/ESP_WiFiManager) to use the better and faster **asynchronous** [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) instead of (ESP8266)WebServer. Thanks to this [ESPAsync_WiFiManager library](https://github.com/khoih-prog/ESPAsync_WiFiManager) is based on and sync'ed with [`ESP_WiFiManager`](https://github.com/khoih-prog/ESP_WiFiManager), all the features currently supported by [`ESP_WiFiManager`](https://github.com/khoih-prog/ESP_WiFiManager) will be available. Please have a look at [`ESP_WiFiManager`](https://github.com/khoih-prog/ESP_WiFiManager) for those too-many-to-list features. ### Why Async is better - Using asynchronous network means that you can handle **more than one connection at the same time** - You are called once the request is ready and parsed - When you send the response, you are **immediately ready** to handle other connections while the server is taking care of sending the response in the background - **Speed is OMG** - **Easy to use API, HTTP Basic and Digest MD5 Authentication (default), ChunkedResponse** - Easily extensible to handle **any type of content** - Supports Continue 100 - Async WebSocket plugin offering different locations without extra servers or ports - Async EventSource (Server-Sent Events) plugin to send events to the browser - URL Rewrite plugin for conditional and permanent url rewrites - ServeStatic plugin that supports cache, Last-Modified, default index and more - Simple template processing engine to handle templates To appreciate the power of the [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) and underlying Async libraries, please compare the more efficient [Async_ESP32_FSWebServer example](examples/Async_ESP32_FSWebServer) example with the complicated twin [ESP32_FSWebServer](https://github.com/khoih-prog/ESP_WiFiManager/tree/master/examples/ESP32_FSWebServer). #### Currently supported Boards This [**ESPAsync_WiFiManager** library](https://github.com/khoih-prog/ESPAsync_WiFiManager) currently supports these following boards: 1. **ESP8266 and ESP32-based boards using EEPROM, SPIFFS or LittleFS**. 2. **ESP32-S2 (ESP32-S2 Saola, AI-Thinker ESP-12K, etc.) using EEPROM, SPIFFS or LittleFS**. 3. **ESP32-C3 (ARDUINO_ESP32C3_DEV) using EEPROM or SPIFFS**. --- --- ## Prerequisites 1. [`Arduino IDE 1.8.16+` for Arduino](https://www.arduino.cc/en/Main/Software) 2. [`ESP8266 Core 3.0.2+`](https://github.com/esp8266/Arduino) for ESP8266-based boards. [![Latest release](https://img.shields.io/github/release/esp8266/Arduino.svg)](https://github.com/esp8266/Arduino/releases/latest/) 3. [`ESP32 Core 2.0.0+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards. [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/) 4. [`ESPAsyncWebServer v1.2.3+`](https://github.com/me-no-dev/ESPAsyncWebServer) for all ESP32/ESP8266-based boards. You have to use the latest [forked ESPAsyncWebServer](https://github.com/khoih-prog/ESPAsyncWebServer) if the PR [Fix compiler error for ESP32-C3 and mbed TLS v2.7.0+ #970](https://github.com/me-no-dev/ESPAsyncWebServer/pull/970) hasn't been merged. 5. [`ESPAsyncTCP v1.2.2+`](https://github.com/me-no-dev/ESPAsyncTCP) for ESP8266-based boards. 6. [`AsyncTCP v1.1.1+`](https://github.com/me-no-dev/AsyncTCP) for ESP32-based boards 7. [`ESP_DoubleResetDetector v1.1.1+`](https://github.com/khoih-prog/ESP_DoubleResetDetector) if using DRD feature. To install, check [![arduino-library-badge](https://www.ardu-badge.com/badge/ESP_DoubleResetDetector.svg?)](https://www.ardu-badge.com/ESP_DoubleResetDetector). Use v1.1.0+ if using LittleFS for EP32. 8. [`LittleFS_esp32 v1.0.6+`](https://github.com/lorol/LITTLEFS) for ESP32-based boards using LittleFS. To install, check [![arduino-library-badge](https://www.ardu-badge.com/badge/LittleFS_esp32.svg?)](https://www.ardu-badge.com/LittleFS_esp32). **Notice**: This [`LittleFS_esp32 library`](https://github.com/lorol/LITTLEFS) has been integrated to Arduino [esp32 core v1.0.6](https://github.com/espressif/arduino-esp32/tree/master/libraries/LITTLEFS). --- ## Installation ### Use Arduino Library Manager The best and easiest way is to use `Arduino Library Manager`. Search for `ESPAsync_WiFiManager`, then select / install the latest version. You can also use this link [![arduino-library-badge](https://www.ardu-badge.com/badge/ESPAsync_WiFiManager.svg?)](https://www.ardu-badge.com/ESPAsync_WiFiManager) for more detailed instructions. ### Manual Install 1. Navigate to [ESPAsync_WiFiManager](https://github.com/khoih-prog/ESPAsync_WiFiManager) page. 2. Download the latest release `ESPAsync_WiFiManager-master.zip`. 3. Extract the zip file to `ESPAsync_WiFiManager-master` directory 4. Copy the whole `ESPAsync_WiFiManager-master` folder to Arduino libraries' directory such as `~/Arduino/libraries/`. ### VS Code & PlatformIO: 1. Install [VS Code](https://code.visualstudio.com/) 2. Install [PlatformIO](https://platformio.org/platformio-ide) 3. Install [**ESPAsync_WiFiManager** library](https://platformio.org/lib/show/11065/ESPAsync_WiFiManager) by using [Library Manager](https://platformio.org/lib/show/11065/ESPAsync_WiFiManager/installation). Search for **ESPAsync_WiFiManager** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22) 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) --- --- --- ### Libraries' Patches #### 1. For ESPAsyncWebServer library If you don't use the [forked ESPAsyncWebServer](https://github.com/khoih-prog/ESPAsyncWebServer), to fix [`ESPAsyncWebServer library`](https://github.com/me-no-dev/ESPAsyncWebServer) compile errors, just copy these following files into the [`ESPAsyncWebServer library`](https://github.com/me-no-dev/ESPAsyncWebServer) directory to overwrite the old files: - [AsyncWebSocket.cpp](esp32c3_ESPAsyncWebServer_Patch/AsyncWebSocket.cpp) - [WebAuthentication.cpp](esp32c3_ESPAsyncWebServer_Patch/WebAuthentication.cpp) Check the PR [Fix compiler error for ESP32-C3 and mbed TLS v2.7.0+ #970](https://github.com/me-no-dev/ESPAsyncWebServer/pull/970) --- --- ### Note for Platform IO using ESP32 LittleFS #### Necessary only for esp32 core v1.0.6- From esp32 core v1.0.6+, [`LittleFS_esp32 v1.0.6`](https://github.com/lorol/LITTLEFS) has been included and this step is not necessary anymore. In Platform IO, to fix the error when using [`LittleFS_esp32 v1.0`](https://github.com/lorol/LITTLEFS) for ESP32-based boards with ESP32 core v1.0.4- (ESP-IDF v3.2-), uncomment the following line from ``` //#define CONFIG_LITTLEFS_FOR_IDF_3_2 /* For old IDF - like in release 1.0.4 */ ``` to ``` #define CONFIG_LITTLEFS_FOR_IDF_3_2 /* For old IDF - like in release 1.0.4 */ ``` It's advisable to use the latest [`LittleFS_esp32 v1.0.5+`](https://github.com/lorol/LITTLEFS) to avoid the issue. Thanks to [Roshan](https://github.com/solroshan) to report the issue in [Error esp_littlefs.c 'utime_p'](https://github.com/khoih-prog/ESPAsync_WiFiManager/issues/28) --- --- ### HOWTO Fix `Multiple Definitions` Linker Error The current library implementation, using xyz-Impl.h instead of standard xyz.cpp, possibly creates certain `Multiple Definitions` Linker error in certain use cases. Although it's simple to just modify several lines of code, either in the library or in the application, the library is adding 2 more source directories 1. **scr_h** for new h-only files 2. **src_cpp** for standard h/cpp files besides the standard **src** directory. To use the old standard cpp way, locate this library' directory, then just 1. **Delete the all the files in src directory.** 2. **Copy all the files in src_cpp directory into src.** 3. Close then reopen the application code in Arduino IDE, etc. to recompile from scratch. To re-use the new h-only way, just 1. **Delete the all the files in src directory.** 2. **Copy the files in src_h directory into src.** 3. Close then reopen the application code in Arduino IDE, etc. to recompile from scratch. --- --- ### HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE) Please have a look at [**ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example**](https://github.com/khoih-prog/ESP_WiFiManager/issues/39) to have more detailed description and solution of the issue. #### 1. ESP32 has 2 ADCs, named ADC1 and ADC2 #### 2. ESP32 ADCs functions - ADC1 controls ADC function for pins **GPIO32-GPIO39** - ADC2 controls ADC function for pins **GPIO0, 2, 4, 12-15, 25-27** #### 3.. ESP32 WiFi uses ADC2 for WiFi functions Look in file [**adc_common.c**](https://github.com/espressif/esp-idf/blob/master/components/driver/adc_common.c#L61) > In ADC2, there're two locks used for different cases: > 1. lock shared with app and Wi-Fi: > ESP32: > When Wi-Fi using the ADC2, we assume it will never stop, so app checks the lock and returns immediately if failed. > ESP32S2: > The controller's control over the ADC is determined by the arbiter. There is no need to control by lock. > > 2. lock shared between tasks: > when several tasks sharing the ADC2, we want to guarantee > all the requests will be handled. > Since conversions are short (about 31us), app returns the lock very soon, > we use a spinlock to stand there waiting to do conversions one by one. > > adc2_spinlock should be acquired first, then adc2_wifi_lock or rtc_spinlock. - In order to use ADC2 for other functions, we have to **acquire complicated firmware locks and very difficult to do** - So, it's not advisable to use ADC2 with WiFi/BlueTooth (BT/BLE). - Use ADC1, and pins GPIO32-GPIO39 - If somehow it's a must to use those pins serviced by ADC2 (**GPIO0, 2, 4, 12, 13, 14, 15, 25, 26 and 27**), use the **fix mentioned at the end** of [**ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example**](https://github.com/khoih-prog/ESP_WiFiManager/issues/39) to work with ESP32 WiFi/BlueTooth (BT/BLE). --- --- ## How It Works - The [Async_ConfigOnSwitch](examples/Async_ConfigOnSwitch) example shows how it works and should be used as the basis for a sketch that uses this library. - The concept of [Async_ConfigOnSwitch](examples/Async_ConfigOnSwitch) is that a new `ESP32 / ESP8266` will start a WiFi ConfigPortal when powered up and save the configuration data in non volatile memory. Thereafter, the ConfigPortal will only be started again if a button is pushed on the `ESP32 / ESP8266` module. - Using any WiFi enabled device with a browser (computer, phone, tablet) connect to the newly created Access Point (AP) using configurable SSID and Password (specified in sketch) ```cpp // SSID and PW for Config Portal String ssid = "ESP_" + String(ESP_getChipId(), HEX); const char* password = "your_password"; ``` then connect WebBrowser to configurable ConfigPortal IP address, default is 192.168.4.1 - Choose one of the access points scanned, enter password, click **Save**. - ESP will restart, then try to connect to the WiFi netwotk using STA-only mode, **without running the ConfigPortal WebServer and WiFi AP**. See [Accessing manager after connection](https://github.com/khoih-prog/ESP_WiFiManager/issues/15). --- --- ### HOWTO Basic configurations #### 1. Using default for every configurable parameter - Include in your sketch ```cpp #ifdef ESP32 #include #include #include // From v1.1.1 #include WiFiMulti wifiMulti; // LittleFS has higher priority than SPIFFS #define USE_LITTLEFS true #define USE_SPIFFS false #if USE_LITTLEFS // Use LittleFS #include "FS.h" // The library will be depreciated after being merged to future major Arduino esp32 core release 2.x // At that time, just remove this library inclusion #include // https://github.com/lorol/LITTLEFS FS* filesystem = &LITTLEFS; #define FileFS LITTLEFS #define FS_Name "LittleFS" #elif USE_SPIFFS #include FS* filesystem = &SPIFFS; #define FileFS SPIFFS #define FS_Name "SPIFFS" #else // +Use FFat #include FS* filesystem = &FFat; #define FileFS FFat #define FS_Name "FFat" #endif ////// #define ESP_getChipId() ((uint32_t)ESP.getEfuseMac()) #define LED_BUILTIN 2 #define LED_ON HIGH #define LED_OFF LOW #else #include //https://github.com/esp8266/Arduino //needed for library #include // From v1.1.1 #include ESP8266WiFiMulti wifiMulti; #define USE_LITTLEFS true #if USE_LITTLEFS #include FS* filesystem = &LittleFS; #define FileFS LittleFS #define FS_Name "LittleFS" #else FS* filesystem = &SPIFFS; #define FileFS SPIFFS #define FS_Name "SPIFFS" #endif ////// #define ESP_getChipId() (ESP.getChipId()) #define LED_ON LOW #define LED_OFF HIGH #endif // SSID and PW for Config Portal String ssid = "ESP_" + String(ESP_getChipId(), HEX); const char* password = "your_password"; // SSID and PW for your Router String Router_SSID; String Router_Pass; // From v1.1.0 // You only need to format the filesystem once //#define FORMAT_FILESYSTEM true #define FORMAT_FILESYSTEM false #define MIN_AP_PASSWORD_SIZE 8 #define SSID_MAX_LEN 32 //From v1.0.10, WPA2 passwords can be up to 63 characters long. #define PASS_MAX_LEN 64 typedef struct { char wifi_ssid[SSID_MAX_LEN]; char wifi_pw [PASS_MAX_LEN]; } WiFi_Credentials; typedef struct { String wifi_ssid; String wifi_pw; } WiFi_Credentials_String; #define NUM_WIFI_CREDENTIALS 2 typedef struct { WiFi_Credentials WiFi_Creds [NUM_WIFI_CREDENTIALS]; } WM_Config; WM_Config WM_config; #define CONFIG_FILENAME F("/wifi_cred.dat") ////// #include //https://github.com/khoih-prog/ESPAsync_WiFiManager #define HTTP_PORT 80 ``` --- #### 2. Using many configurable parameters - Include in your sketch ```cpp #ifdef ESP32 #include #include #include // From v1.1.1 #include WiFiMulti wifiMulti; // LittleFS has higher priority than SPIFFS #define USE_LITTLEFS true #define USE_SPIFFS false #if USE_LITTLEFS // Use LittleFS #include "FS.h" // The library will be depreciated after being merged to future major Arduino esp32 core release 2.x // At that time, just remove this library inclusion #include // https://github.com/lorol/LITTLEFS FS* filesystem = &LITTLEFS; #define FileFS LITTLEFS #define FS_Name "LittleFS" #elif USE_SPIFFS #include FS* filesystem = &SPIFFS; #define FileFS SPIFFS #define FS_Name "SPIFFS" #else // +Use FFat #include FS* filesystem = &FFat; #define FileFS FFat #define FS_Name "FFat" #endif ////// #define ESP_getChipId() ((uint32_t)ESP.getEfuseMac()) #define LED_BUILTIN 2 #define LED_ON HIGH #define LED_OFF LOW #else #include //https://github.com/esp8266/Arduino //needed for library #include // From v1.1.1 #include ESP8266WiFiMulti wifiMulti; #define USE_LITTLEFS true #if USE_LITTLEFS #include FS* filesystem = &LittleFS; #define FileFS LittleFS #define FS_Name "LittleFS" #else FS* filesystem = &SPIFFS; #define FileFS SPIFFS #define FS_Name "SPIFFS" #endif ////// #define ESP_getChipId() (ESP.getChipId()) #define LED_ON LOW #define LED_OFF HIGH #endif // SSID and PW for Config Portal String ssid = "ESP_" + String(ESP_getChipId(), HEX); const char* password = "your_password"; // SSID and PW for your Router String Router_SSID; String Router_Pass; // From v1.1.0 // You only need to format the filesystem once //#define FORMAT_FILESYSTEM true #define FORMAT_FILESYSTEM false #define MIN_AP_PASSWORD_SIZE 8 #define SSID_MAX_LEN 32 //From v1.0.10, WPA2 passwords can be up to 63 characters long. #define PASS_MAX_LEN 64 typedef struct { char wifi_ssid[SSID_MAX_LEN]; char wifi_pw [PASS_MAX_LEN]; } WiFi_Credentials; typedef struct { String wifi_ssid; String wifi_pw; } WiFi_Credentials_String; #define NUM_WIFI_CREDENTIALS 2 typedef struct { WiFi_Credentials WiFi_Creds [NUM_WIFI_CREDENTIALS]; } WM_Config; WM_Config WM_config; #define CONFIG_FILENAME F("/wifi_cred.dat") ////// // Use false if you don't like to display Available Pages in Information Page of Config Portal // Comment out or use true to display Available Pages in Information Page of Config Portal // Must be placed before #include #define USE_AVAILABLE_PAGES true // From v1.0.10 to permit disable/enable StaticIP configuration in Config Portal from sketch. Valid only if DHCP is used. // You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa // You have to explicitly specify false to disable the feature. //#define USE_STATIC_IP_CONFIG_IN_CP false // Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal. // See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23) #define USE_ESP_WIFIMANAGER_NTP false // Use true to enable CloudFlare NTP service. System can hang if you don't have Internet access while accessing CloudFlare // See Issue #21: CloudFlare link in the default portal (https://github.com/khoih-prog/ESP_WiFiManager/issues/21) #define USE_CLOUDFLARE_NTP false // New in v1.0.11 #define USING_CORS_FEATURE true ////// // Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network #if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP) // Force DHCP to be true #if defined(USE_DHCP_IP) #undef USE_DHCP_IP #endif #define USE_DHCP_IP true #else // You can select DHCP or Static IP here //#define USE_DHCP_IP true #define USE_DHCP_IP false #endif #if ( USE_DHCP_IP || ( defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP ) ) // Use DHCP #warning Using DHCP IP IPAddress stationIP = IPAddress(0, 0, 0, 0); IPAddress gatewayIP = IPAddress(192, 168, 2, 1); IPAddress netMask = IPAddress(255, 255, 255, 0); #else // Use static IP #warning Using static IP #ifdef ESP32 IPAddress stationIP = IPAddress(192, 168, 2, 232); #else IPAddress stationIP = IPAddress(192, 168, 2, 186); #endif IPAddress gatewayIP = IPAddress(192, 168, 2, 1); IPAddress netMask = IPAddress(255, 255, 255, 0); #endif #define USE_CONFIGURABLE_DNS true IPAddress dns1IP = gatewayIP; IPAddress dns2IP = IPAddress(8, 8, 8, 8); IPAddress APStaticIP = IPAddress(192, 168, 100, 1); IPAddress APStaticGW = IPAddress(192, 168, 100, 1); IPAddress APStaticSN = IPAddress(255, 255, 255, 0); #include //https://github.com/khoih-prog/ESPAsync_WiFiManager #define HTTP_PORT 80 AsyncWebServer webServer(HTTP_PORT); DNSServer dnsServer; /////////////////////////////////////////// // New in v1.4.0 /****************************************** * // Defined in ESPAsync_WiFiManager.h typedef struct { IPAddress _ap_static_ip; IPAddress _ap_static_gw; IPAddress _ap_static_sn; } WiFi_AP_IPConfig; typedef struct { IPAddress _sta_static_ip; IPAddress _sta_static_gw; IPAddress _sta_static_sn; #if USE_CONFIGURABLE_DNS IPAddress _sta_static_dns1; IPAddress _sta_static_dns2; #endif } WiFi_STA_IPConfig; ******************************************/ WiFi_AP_IPConfig WM_AP_IPconfig; WiFi_STA_IPConfig WM_STA_IPconfig; ``` --- #### 3. Using STA-mode DHCP, but don't like to change to static IP or display in Config Portal ```cpp // From v1.0.10 to permit disable/enable StaticIP configuration in Config Portal from sketch. Valid only if DHCP is used. // You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa // You have to explicitly specify false to disable the feature. #define USE_STATIC_IP_CONFIG_IN_CP false ``` --- #### 4. Using STA-mode DHCP, but permit to change to static IP and display in Config Portal ```cpp // From v1.0.10 to permit disable/enable StaticIP configuration in Config Portal from sketch. Valid only if DHCP is used. // You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa // You have to explicitly specify false to disable the feature. //#define USE_STATIC_IP_CONFIG_IN_CP false // Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network #if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP) // Force DHCP to be true #if defined(USE_DHCP_IP) #undef USE_DHCP_IP #endif #define USE_DHCP_IP true #else // You can select DHCP or Static IP here #define USE_DHCP_IP true #endif ``` --- #### 5. Using STA-mode StaticIP, and be able to change to DHCP IP and display in Config Portal ```cpp // From v1.0.10 to permit disable/enable StaticIP configuration in Config Portal from sketch. Valid only if DHCP is used. // You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa // You have to explicitly specify false to disable the feature. //#define USE_STATIC_IP_CONFIG_IN_CP false // Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network #if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP) // Force DHCP to be true #if defined(USE_DHCP_IP) #undef USE_DHCP_IP #endif #define USE_DHCP_IP true #else // You can select DHCP or Static IP here #define USE_DHCP_IP false #endif ``` --- #### 6. Using STA-mode StaticIP and configurable DNS, and be able to change to DHCP IP and display in Config Portal ```cpp // From v1.0.10 to permit disable/enable StaticIP configuration in Config Portal from sketch. Valid only if DHCP is used. // You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa // You have to explicitly specify false to disable the feature. //#define USE_STATIC_IP_CONFIG_IN_CP false // Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network #if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP) // Force DHCP to be true #if defined(USE_DHCP_IP) #undef USE_DHCP_IP #endif #define USE_DHCP_IP true #else // You can select DHCP or Static IP here #define USE_DHCP_IP false #endif #define USE_CONFIGURABLE_DNS true IPAddress dns1IP = gatewayIP; IPAddress dns2IP = IPAddress(8, 8, 8, 8); ``` --- #### 7. Using STA-mode StaticIP and auto DNS, and be able to change to DHCP IP and display in Config Portal ```cpp // From v1.0.10 to permit disable/enable StaticIP configuration in Config Portal from sketch. Valid only if DHCP is used. // You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa // You have to explicitly specify false to disable the feature. //#define USE_STATIC_IP_CONFIG_IN_CP false // Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network #if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP) // Force DHCP to be true #if defined(USE_DHCP_IP) #undef USE_DHCP_IP #endif #define USE_DHCP_IP true #else // You can select DHCP or Static IP here #define USE_DHCP_IP false #endif #define USE_CONFIGURABLE_DNS false ``` --- #### 8. Not using NTP to avoid issue with some WebBrowsers, especially in CellPhone or Tablets. ```cpp // Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal. // See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23) #define USE_ESP_WIFIMANAGER_NTP false ``` --- #### 9. Using NTP feature with CloudFlare. System can hang until you have Internet access for CloudFlare. ```cpp // Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal. // See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23) #define USE_ESP_WIFIMANAGER_NTP true // Use true to enable CloudFlare NTP service. System can hang if you don't have Internet access while accessing CloudFlare // See Issue #21: CloudFlare link in the default portal (https://github.com/khoih-prog/ESP_WiFiManager/issues/21) #define USE_CLOUDFLARE_NTP true ``` --- #### 10. Using NTP feature without CloudFlare to avoid system hang if no Internet access for CloudFlare. ```cpp // Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal. // See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23) #define USE_ESP_WIFIMANAGER_NTP true // Use true to enable CloudFlare NTP service. System can hang if you don't have Internet access while accessing CloudFlare // See Issue #21: CloudFlare link in the default portal (https://github.com/khoih-prog/ESP_WiFiManager/issues/21) #define USE_CLOUDFLARE_NTP false ``` --- #### 11. Using random AP-mode channel to avoid conflict ```cpp // From v1.0.10 only // Set config portal channel, default = 1. Use 0 => random channel from 1-13 ESPAsync_wifiManager.setConfigPortalChannel(0); ////// ``` --- #### 12. Using fixed AP-mode channel, for example channel 3 ```cpp // From v1.0.10 only // Set config portal channel, default = 1. Use 0 => random channel from 1-13 ESPAsync_wifiManager.setConfigPortalChannel(3); ////// ``` --- #### 13. Setting STA-mode static IP ```cpp // Set static IP, Gateway, Subnetmask, DNS1 and DNS2. New in v1.0.5 //ESPAsync_wifiManager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask, dns1IP, dns2IP); ESPAsync_wifiManager.setSTAStaticIPConfig(WM_STA_IPconfig); ``` --- #### 14. Using AUTOCONNECT_NO_INVALIDATE feature 1. Don't invalidate WiFi SSID/PW when calling autoConnect() (default) ```cpp #define AUTOCONNECT_NO_INVALIDATE true ``` 2. To invalidate WiFi SSID/PW when calling autoConnect() ```cpp #define AUTOCONNECT_NO_INVALIDATE false ``` --- #### 15. Using CORS (Cross-Origin Resource Sharing) feature 1. To use CORS feature with **default** CORS Header "*". Some WebBrowsers won't accept this allowing-all "*" CORS Header. ```cpp // Default false for using only whenever necessary to avoid security issue #define USING_CORS_FEATURE true ``` 2. To use CORS feature with specific CORS Header "Your Access-Control-Allow-Origin". **To be modified** according to your specific Allowed-Origin. ```cpp // Default false for using only whenever necessary to avoid security issue #define USING_CORS_FEATURE true ... // New from v1.1.1 #if USING_CORS_FEATURE ESP_wifiManager.setCORSHeader("Your Access-Control-Allow-Origin"); #endif ``` 3. Not use CORS feature (default) ```cpp // Default false for using only whenever necessary to avoid security issue #define USING_CORS_FEATURE false ``` #### 16. Using MultiWiFi auto(Re)connect feature 1. In loop() ```cpp void check_WiFi(void) { if ( (WiFi.status() != WL_CONNECTED) ) { Serial.println("\nWiFi lost. Call connectMultiWiFi in loop"); connectMultiWiFi(); } } void check_status(void) { static ulong checkwifi_timeout = 0; static ulong current_millis; #define WIFICHECK_INTERVAL 1000L current_millis = millis(); // Check WiFi every WIFICHECK_INTERVAL (1) seconds. if ((current_millis > checkwifi_timeout) || (checkwifi_timeout == 0)) { check_WiFi(); checkwifi_timeout = current_millis + WIFICHECK_INTERVAL; } } void loop() { // put your main code here, to run repeatedly check_status(); } ``` --- #### 17. How to auto getting _timezoneName 1. Turn on auto NTP configuration by ``` // Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal. // See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23) #define USE_ESP_WIFIMANAGER_NTP true ``` 2. The `_timezoneName`, in the format similar to **America/New_York, America/Toronto, Europe/London, etc.**, can be retrieved by using ``` String tempTZ = ESPAsync_wifiManager.getTimezoneName(); ``` --- #### 18. How to get TZ variable to configure Timezone 1. ESP32 and ESP8266 TZ can be configured, using the similar to `EST5EDT,M3.2.0,M11.1.0` (for America/New_York) , as follows: ``` // EST5EDT,M3.2.0,M11.1.0 (for America/New_York) // EST5EDT is the name of the time zone // EST is the abbreviation used when DST is off // 6 hours is the time difference from GMT // EDT is the abbreviation used when DST is on // ,M3 is the third month // .2 is the second occurrence of the day in the month // .0 is Sunday // ,M11 is the eleventh month // .1 is the first occurrence of the day in the month // .0 is Sunday #if ESP8266 configTime(WM_config.TZ, "pool.ntp.org"); #else //configTzTime(WM_config.TZ, "pool.ntp.org" ); configTzTime(WM_config.TZ, "time.nist.gov", "0.pool.ntp.org", "1.pool.ntp.org"); #endif ``` 2. To convert from `_timezoneName` to TZ, use the function getTZ() as follows: ``` const char * TZ_Result = ESPAsync_wifiManager.getTZ(_timezoneName); ``` The conversion depends on the stored TZs, which is using some memory, and can cause issue for ESP8266 in certain cases. Therefore, enable just the region you're interested. For example, your application is used in America continent, you need just ``` #define USING_AMERICA true ``` Hereafter is the regions' list ``` // Just use enough to save memory. On ESP8266, can cause blank ConfigPortal screen // if using too much memory #define USING_AFRICA false #define USING_AMERICA true #define USING_ANTARCTICA false #define USING_ASIA false #define USING_ATLANTIC false #define USING_AUSTRALIA false #define USING_EUROPE false #define USING_INDIAN false #define USING_PACIFIC false #define USING_ETC_GMT false ``` --- #### 19. How to use the TZ variable to configure Timezone ``` #if ESP8266 configTime(WM_config.TZ, "pool.ntp.org"); #else //configTzTime(WM_config.TZ, "pool.ntp.org" ); configTzTime(WM_config.TZ, "time.nist.gov", "0.pool.ntp.org", "1.pool.ntp.org"); #endif ``` then to print local time ``` void printLocalTime() { #if ESP8266 static time_t now; now = time(nullptr); if ( now > 1000000 ) { Serial.print("Local Date/Time: "); Serial.print(ctime(&now)); } #else struct tm timeinfo; getLocalTime( &timeinfo ); Serial.print("Local Date/Time: "); Serial.print( asctime( &timeinfo ) ); #endif } ``` --- --- ### HOWTO Open Config Portal - When you want to open a config portal, with default DHCP hostname `ESP8266-XXXXXX` or `ESP32-XXXXXX`, just add ```cpp #include //https://github.com/khoih-prog/ESPAsync_WiFiManager #define HTTP_PORT 80 AsyncWebServer webServer(HTTP_PORT); DNSServer dnsServer; ESPAsync_WiFiManager ESPAsync_wifiManager(&webServer, &dnsServer); ``` If you'd like to have a personalized hostname `(RFC952-conformed,- 24 chars max,- only a..z A..Z 0..9 '-' and no '-' as last char)` add ```cpp ESPAsync_WiFiManager ESPAsync_wifiManager(&webServer, &dnsServer, "Personalized-HostName"); ``` then later call ```cpp ESPAsync_wifiManager.startConfigPortal() ``` While in AP mode, connect to it using its `SSID` (ESP_XXXXXX) / `Password` ("your_password"), then open a browser to the AP IP, default `192.168.4.1`, configure wifi then save. The WiFi connection information will be saved in non volatile memory. It will then reboot and autoconnect. You can also change the AP IP by: ```cpp //set custom ip for portal //ESPAsync_wifiManager.setAPStaticIPConfig(IPAddress(10,0,1,1), IPAddress(10,0,1,1), IPAddress(255,255,255,0)); ESPAsync_wifiManager.setAPStaticIPConfig(WM_AP_IPconfig); ``` and use fixed / dynamic / random AP channel by: ```cpp // Set config portal channel, default = 1. Use 0 => random channel from 1-13 ESPAsync_wifiManager.setConfigPortalChannel(0); ////// ``` Once WiFi network information is saved in the `ESP32 / ESP8266`, it will try to autoconnect to WiFi every time it is started, without requiring any function calls in the sketch. --- --- ### HOWTO Add Dynamic Parameters These illustrating steps is based on the example [Async_ConfigOnSwitchFS](https://github.com/khoih-prog/ESPAsync_WiFiManager/tree/master/examples/Async_ConfigOnSwitchFS) ### 1. Determine the variables to be configured via Config Portal (CP) The application will: - use DHT sensor (either DHT11 or DHT22) and - need to connect to ThingSpeak with unique user's API Key. The DHT sensor is connected to the ESP boards using SDA/SCL pins which also need to be configurable. So this is the list of variables to be dynamically configured using CP ``` 1. `thingspeakApiKey`, type `char array`, max length 17 chars, and just arbitrarily selected default value to be "" or "ThingSpeak-APIKey" 2. `sensorDht22`, type `bool`, default to be `true` (DHT22) 3. `pinSda`, type `int`, default to be `PIN_D2` 4. `pinScl`, type `int`, default to be `PIN_D1` ``` The Label can be any arbitrary string that help you identify the variable, but must be unique in your application The initial code will be ``` #define API_KEY_LEN 17 // Default configuration values char thingspeakApiKey[API_KEY_LEN] = ""; bool sensorDht22 = true; int pinSda = PIN_D2; // Pin D2 mapped to pin GPIO4 of ESP8266 int pinScl = PIN_D1; // Pin D1 mapped to pin GPIO5 of ESP8266 // Any unique string helping you identify the vars #define ThingSpeakAPI_Label "thingspeakApiKey" #define SensorDht22_Label "SensorDHT22" #define PinSDA_Label "PinSda" #define PinSCL_Label "PinScl" ``` --- ### 2. Initialize the variables to prepare for Config Portal (CP) The example [Async_ConfigOnSwitchFS](https://github.com/khoih-prog/ESPAsync_WiFiManager/tree/master/examples/Async_ConfigOnSwitchFS) will open the CP whenever a SW press is detected in loop(). So the code to add `dynamic variables` will be there, just after the CP `ESPAsync_WiFiManager` class initialization to create `ESPAsync_wifiManager` object. ``` void loop() { // is configuration portal requested? if ((digitalRead(TRIGGER_PIN) == LOW) || (digitalRead(TRIGGER_PIN2) == LOW)) { Serial.println("\nConfiguration portal requested."); digitalWrite(LED_BUILTIN, LED_ON); // turn the LED on by making the voltage LOW to tell us we are in configuration mode. //Local intialization. Once its business is done, there is no need to keep it around ESPAsync_WiFiManager ESPAsync_wifiManager(&webServer, &dnsServer, "ConfigOnSwitchFS"); //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 configuration portal. "); ... // The addition of dynamic vars will be somewhere here } ``` The `ESPAsync_WMParameter` class constructor will be used to initialize each newly-added parameter object. #### 2.1 Use the following simple constructor for simple variables such as `thingspeakApiKey`, `pinSda` and `pinScl` : ``` ESPAsync_WMParameter(const char *id, const char *placeholder, const char *defaultValue, int length); ``` #### 2.2 For example, to create a new `ESPAsync_WMParameter` object `p_thingspeakApiKey` for `thingspeakApiKey`, The command to use will be ``` ESPAsync_WMParameter p_thingspeakApiKey(ThingSpeakAPI_Label, "Thingspeak API Key", thingspeakApiKey, API_KEY_LEN); ``` where ``` - p_thingspeakApiKey : ESPAsync_WMParameter class object reference that stores the new Custom Parameter - id => ThingSpeakAPI_Label : var ref to Json associative name and HTML element ID for the new Custom Paramerter you just defined in step 1 - placeholder => "Thingspeak API Key" : HTML input placeholder and/or label element text the user sees in the configuration interface for this Custom Parameter - defaultValue => thingspeakApiKey : variable for storing the value of your Custom Parameter in the file system or default value when no data is entered - length => API_KEY_LEN : max allowed length you want for this Custom Parameter to have ``` For `pinSda` and `pinScl`, the command will be similar ``` // I2C SCL and SDA parameters are integers so we need to convert them to char array but // no other special considerations char convertedValue[3]; sprintf(convertedValue, "%d", pinSda); ESPAsync_WMParameter p_pinSda(PinSDA_Label, "I2C SDA pin", convertedValue, 3); sprintf(convertedValue, "%d", pinScl); ESPAsync_WMParameter p_pinScl(PinSCL_Label, "I2C SCL pin", convertedValue, 3); ``` where ``` - p_pinSda / p_pinScl : ESPAsync_WMParameter class object reference that stores the new Custom Parameter - id => PinSDA_Label/PinSCL_Label : var ref to Json associative name and HTML element ID for the new Custom Paramerter you just defined in step 1 - placeholder => "I2C SDA pin"/"I2C SCL pin" : HTML input placeholder and/or label element text the user sees in the configuration interface for this Custom Parameter - defaultValue => convertedValue : variable for storing the value of your Custom Parameter in the file system or default value when no data is entered - length => 3 : max allowed length you want for this Custom Parameter to have ``` --- #### 2.3 Use the more complex following constructor for variables such as `sensorDht22`: ``` ESPAsync_WMParameter(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom, int labelPlacement); ``` #### 2.4 For example, to create a new `ESPAsync_WMParameter` object `p_sensorDht22` for `sensorDht22`, The command to use will be ``` ESPAsync_WMParameter p_sensorDht22(SensorDht22_Label, "DHT-22 Sensor", "T", 2, customhtml, WFM_LABEL_AFTER); ``` where ``` - p_sensorDht22 : ESPAsync_WMParameter class object reference that stores the new Custom Parameter - id => SensorDht22_Label : var ref to Json associative name and HTML element ID for the new Custom Paramerter you just defined in step 1 - placeholder => "DHT-22 Sensor" : HTML input placeholder and/or label element text the user sees in the configuration interface for this Custom Parameter - defaultValue => "T" : variable for storing the value of your Custom Parameter in the file system or default value when no data is entered ("T" means `true`) - length => 2 : max allowed length you want for this Custom Parameter to have - custom => customhtml : custom HTML code to add element type, e.g. `checkbox`, and `checked` when `sensorDht22 == true` - labelPlacement => WFM_LABEL_AFTER : to place label after ``` and customhtml Code is: ``` char customhtml[24] = "type=\"checkbox\""; if (sensorDht22) { strcat(customhtml, " checked"); } ``` --- ### 3. Add the variables to Config Portal (CP) Adding those `ESPAsync_WMParameter` objects created in Step 2 using the function `addParameter()` of object `ESPAsync_wifiManager` #### 3.1 addParameter() function Prototype: ``` //adds a custom parameter bool addParameter(ESPAsync_WMParameter *p); ``` #### 3.2 Code to add variables to CP Add parameter objects, previously created in Step 2, such as : `p_thingspeakApiKey`, `p_sensorDht22`, `p_pinSda` and `p_pinScl` ``` //add all parameters here ESPAsync_wifiManager.addParameter(&p_thingspeakApiKey); ESPAsync_wifiManager.addParameter(&p_sensorDht22); ESPAsync_wifiManager.addParameter(&p_pinSda); ESPAsync_wifiManager.addParameter(&p_pinScl); ``` --- ### 4. Save the variables configured in Config Portal (CP) When the CP exits, we have to store the parameters' values that users input via CP to use later. For ESP32, that can be `EEPROM` or `SPIFFS`. While on ESP8266, `LittleFS` can be used besides `EEPROM` or `deprecated SPIFFS`. We can write directly to a **well-defined structure of our choice**, but the current example is using `JSON` to be portable but **much more complicated and not advised for new users**. #### 4.1 Getting variables' data from CP After users select `Save`, the CP `ESPAsync_wifiManager` object will save the user input data into related `ESPAsync_WMParameter` objects. We can now retrieve the data, using `getValue()` function, for each `ESPAsync_WMParameter` object. Then we can utilize the data for our purpose, such as `thingspeakApiKey` to log in, `sensorDht22` type to know how to handle the sensor, `pinSda` and `pinSda` to know which pins to use to communicate with the DHT sensor. The code is as follows: ``` // Getting posted form values and overriding local variables parameters // Config file is written regardless the connection state strcpy(thingspeakApiKey, p_thingspeakApiKey.getValue()); sensorDht22 = (strncmp(p_sensorDht22.getValue(), "T", 1) == 0); pinSda = atoi(p_pinSda.getValue()); pinScl = atoi(p_pinScl.getValue()); ``` We can also save to FS file to use later in next boot. ``` // Writing JSON config file to flash for next boot writeConfigFile(); ``` --- ### 5. Write to FS (SPIFFS, LittleFS, etc.) using JSON format First, you have to familiarize yourself with `ArduinoJson` library, its functions, the disruptive differences between `ArduinoJson version 5.x.x-` and `v6.0.0+`. The best documentation can be found at [The best JSON library for embedded C++](https://arduinojson.org/). This documentation will discuss only ArduinoJson v6.x.x+ (`ARDUINOJSON_VERSION_MAJOR >= 6`) Then have a look at the code snippet of `writeConfigFile()` function and the following step-by-step explanations. ``` bool writeConfigFile() { Serial.println("Saving config file"); #if (ARDUINOJSON_VERSION_MAJOR >= 6) DynamicJsonDocument json(1024); #else DynamicJsonBuffer jsonBuffer; JsonObject& json = jsonBuffer.createObject(); #endif // JSONify local configuration parameters json[ThingSpeakAPI_Label] = thingspeakApiKey; json[SensorDht22_Label] = sensorDht22; json[PinSDA_Label] = pinSda; json[PinSCL_Label] = pinScl; // Open file for writing File f = FileFS.open(CONFIG_FILE, "w"); if (!f) { Serial.println("Failed to open config file for writing"); return false; } #if (ARDUINOJSON_VERSION_MAJOR >= 6) serializeJsonPretty(json, Serial); // Write data to file and close it serializeJson(json, f); #else json.prettyPrintTo(Serial); // Write data to file and close it json.printTo(f); #endif f.close(); Serial.println("\nConfig file was successfully saved"); return true; } ``` #### 5.1 Create a DynamicJsonDocument Object We'll create an object with size 1024 bytes, enough to hold our data: ``` DynamicJsonDocument json(1024); ``` #### 5.2 Fill the DynamicJsonDocument Object with data got from Config Portal Then `JSONify` all local parameters we've just received from CP and wish to store into FS by using the function prototype: ``` json[Unique_Label] = Value_For_Unique_Label; ``` as follows: ``` // JSONify local configuration parameters json[ThingSpeakAPI_Label] = thingspeakApiKey; json[SensorDht22_Label] = sensorDht22; json[PinSDA_Label] = pinSda; json[PinSCL_Label] = pinScl; ``` #### 5.3 Open file to write the Jsonified data This is the `CONFIG_FILE` file name we already declared at the beginning of the sketch (for ESP32): ``` #include FS* filesystem = &SPIFFS; #define FileFS SPIFFS const char* CONFIG_FILE = "/ConfigSW.json"; ``` Now just open the file for writing, and abort if open-for-writing error: ``` // Open file for writing File f = FileFS.open(CONFIG_FILE, "w"); if (!f) { Serial.println("Failed to open config file for writing"); return false; } ``` #### 5.4 Write the Jsonified data to CONFIG_FILE As simple as this single command to write the whole `json` object we declared then filled with data in steps 5.1 and 5.2 ``` // Write data to file and close it serializeJson(json, f); ``` #### 5.5 Close CONFIG_FILE to flush and save the data Soooo simple !!! Now everybody can do it. ``` f.close(); ``` But **HOWTO use the saved data in the next startup** ???? That's in next step 6. ### 6. Read from FS using JSON format Now, you have familiarized yourself with ArduinoJson library, its functions. We'll discuss HOWTO read data from the CONFIG_FILE in Jsonified format, then HOWTO parse the to use. The documentation will discuss only ArduinoJson v6.x.x+ (`ARDUINOJSON_VERSION_MAJOR >= 6`) First, have a look at the code snippet of `readConfigFile()` function. ``` bool readConfigFile() { // this opens the config file in read-mode File f = FileFS.open(CONFIG_FILE, "r"); if (!f) { Serial.println("Configuration file not found"); return false; } else { // we could open the file size_t size = f.size(); // Allocate a buffer to store contents of the file. std::unique_ptr buf(new char[size + 1]); // Read and store file contents in buf f.readBytes(buf.get(), size); // Closing file f.close(); // Using dynamic JSON buffer which is not the recommended memory model, but anyway // See https://github.com/bblanchon/ArduinoJson/wiki/Memory%20model #if (ARDUINOJSON_VERSION_MAJOR >= 6) DynamicJsonDocument json(1024); auto deserializeError = deserializeJson(json, buf.get()); if ( deserializeError ) { Serial.println("JSON parseObject() failed"); return false; } serializeJson(json, Serial); #else DynamicJsonBuffer jsonBuffer; // Parse JSON string JsonObject& json = jsonBuffer.parseObject(buf.get()); // Test if parsing succeeds. if (!json.success()) { Serial.println("JSON parseObject() failed"); return false; } json.printTo(Serial); #endif // Parse all config file parameters, override // local config variables with parsed values if (json.containsKey(ThingSpeakAPI_Label)) { strcpy(thingspeakApiKey, json[ThingSpeakAPI_Label]); } if (json.containsKey(SensorDht22_Label)) { sensorDht22 = json[SensorDht22_Label]; } if (json.containsKey(PinSDA_Label)) { pinSda = json[PinSDA_Label]; } if (json.containsKey(PinSCL_Label)) { pinScl = json[PinSCL_Label]; } } Serial.println("\nConfig file was successfully parsed"); return true; } ``` and the following step-by-step explanations. ### 6.1 Open CONFIG_FILE to read As simple as this ``` // this opens the config file in read-mode File f = FileFS.open(CONFIG_FILE, "r"); ``` We'll inform and abort if the CONFIG_FILE can't be opened (file not found, can't be opened, etc.) ``` if (!f) { Serial.println("Configuration file not found"); return false; } ``` ### 6.2 Open CONFIG_FILE to read Now we have to determine the file size to create a buffer large enough to store the to-be-read data ``` // we could open the file size_t size = f.size(); // Allocate a buffer to store contents of the file. std::unique_ptr buf(new char[size + 1]); ``` **Remember always add 1 to the buffer length to store the terminating `0`.** Then just read the file into the buffer, and close the file to be safe ``` // Read and store file contents in buf f.readBytes(buf.get(), size); // Closing file f.close(); ``` ### 6.3 Populate the just-read Jsonified data into the DynamicJsonDocument json object We again use the same `DynamicJsonDocument json` object to store the data we've just read fron `CONFIG_FILE`. Why the same complicated `DynamicJsonDocument json` object ?? Because in steps 5, we did store `Jsonified data` using the same `DynamicJsonDocument json` object. It's much easier we now use it again to facilitate the parsing of `Jsonified data` back to the data we can use easily. We first create the object with enough size ``` DynamicJsonDocument json(1024); ``` then populate it with data from buffer we read from CONFIG_FILE in step 6.2, pre-parse and check for error. All is done just by one command `deserializeJson()` ``` auto deserializeError = deserializeJson(json, buf.get()); ``` Abort if there is any data error in the process of writing, storing, reading back. If OK, just nicely print out to the Debug Terminal ``` if ( deserializeError ) { Serial.println("JSON parseObject() failed"); return false; } serializeJson(json, Serial); ``` ### 6.4 Parse the Jsonified data from the DynamicJsonDocument json object to store into corresponding parameters This is as simple as in the step 5.2, but in reverse direction. To be sure there is good corresponding data, not garbage, for each variable, we have to perform **sanity checks** by verifying the `DynamicJsonDocument json object` still contains the correct keys we passed to it when we wrote into CONFIG_FILE. For example: ``` if (json.containsKey(ThingSpeakAPI_Label)) ``` Then proceed to get every parameter we know we stored there from last CP `Save`. ``` // Parse all config file parameters, override // local config variables with parsed values if (json.containsKey(ThingSpeakAPI_Label)) { strcpy(thingspeakApiKey, json[ThingSpeakAPI_Label]); } if (json.containsKey(SensorDht22_Label)) { sensorDht22 = json[SensorDht22_Label]; } if (json.containsKey(PinSDA_Label)) { pinSda = json[PinSDA_Label]; } if (json.containsKey(PinSCL_Label)) { pinScl = json[PinSCL_Label]; } ``` ### 6.5 Then what to do now **Just use those parameters for whatever purpose you designed them for in step 1:** ``` The application will use DHT sensor (either DHT11 or DHT22) and need to connect to ThingSpeak with unique user's API Key. The DHT sensor is connected to the ESP boards using SDA/SCL pins which also need to be configurable. ``` --- --- ## So, how it works? In `ConfigPortal Mode`, it starts an access point called `ESP_XXXXXX`. Connect to it using the `configurable password` you can define in the code. For example, `your_password` (see examples): ```cpp // SSID and PW for Config Portal String ssid = "ESP_" + String(ESP_getChipId(), HEX); const char* password = "your_password"; ``` After you connected, please, go to http://192.168.4.1, you'll see this `Main` page:

Select `Information` to enter the Info page where the board info will be shown (long page)

or short page (default)

Select `Configuration` to enter this page where you can select an AP and specify its WiFi Credentials

Enter your credentials, then click **Save**. The WiFi Credentials will be saved and the board reboots to connect to the selected WiFi AP.

If you're already connected to a listed WiFi AP and don't want to change anything, just select **Exit Portal** from the `Main` page to reboot the board and connect to the previously-stored AP. The WiFi Credentials are still intact. --- --- ## Documentation #### Password protect the configuration Access Point You can password protect the ConfigPortal AP. Simply add an SSID as the first parameter and the password as a second parameter to `startConfigPortal`. See the above examples. A short password seems to have unpredictable results so use one that's around 8 characters or more in length. The guidelines are that a wifi password must consist of 8 to 63 ASCII-encoded characters in the range of 32 to 126 (decimal) ```cpp ESPAsync_wifiManager.startConfigPortal( SSID , password ) ``` #### Callbacks ##### Save settings This gets called when custom parameters have been set **AND** a connection has been established. Use it to set a flag, so when all the configuration finishes, you can save the extra parameters somewhere. See [Async_ConfigOnSwitchFS Example](examples/Async_ConfigOnSwitchFS). ```cpp ESPAsync_wifiManager.setSaveConfigCallback(saveConfigCallback); ``` saveConfigCallback declaration and example ```cpp //flag for saving data bool shouldSaveConfig = false; //callback notifying us of the need to save config void saveConfigCallback () { Serial.println("Should save config"); shouldSaveConfig = true; } ``` #### ConfigPortal Timeout If you need to set a timeout so the `ESP32 / ESP8266` doesn't hang waiting to be configured for ever. ```cpp ESPAsync_wifiManager.setConfigPortalTimeout(120); ``` which will wait 2 minutes (120 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. #### On Demand ConfigPortal Example usage ```cpp void loop() { // is configuration portal requested? if ((digitalRead(TRIGGER_PIN) == LOW) || (digitalRead(TRIGGER_PIN2) == LOW)) { Serial.println(F("\nConfiguration portal requested.")); digitalWrite(LED_BUILTIN, LED_ON); // turn the LED on by making the voltage LOW to tell us we are in configuration mode. //Local intialization. Once its business is done, there is no need to keep it around ESPAsync_WiFiManager ESPAsync_wifiManager(&webServer, &dnsServer, "ConfigOnSwitch"); ESPAsync_wifiManager.setMinimumSignalQuality(-1); // From v1.0.10 only // Set config portal channel, default = 1. Use 0 => random channel from 1-13 ESPAsync_wifiManager.setConfigPortalChannel(0); ////// //set custom ip for portal //ESPAsync_wifiManager.setAPStaticIPConfig(IPAddress(192, 168, 100, 1), IPAddress(192, 168, 100, 1), IPAddress(255, 255, 255, 0)); #if !USE_DHCP_IP #if USE_CONFIGURABLE_DNS // Set static IP, Gateway, Subnetmask, DNS1 and DNS2. New in v1.0.5 ESPAsync_wifiManager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask, dns1IP, dns2IP); #else // Set static IP, Gateway, Subnetmask, Use auto DNS1 and DNS2. ESPAsync_wifiManager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask); #endif #endif // New from v1.1.1 #if USING_CORS_FEATURE ESPAsync_wifiManager.setCORSHeader("Your Access-Control-Allow-Origin"); #endif //Check if there is stored WiFi router/password credentials. //If not found, device will remain in configuration mode until switched off via webserver. Serial.println(F("Opening configuration portal. ")); Router_SSID = ESPAsync_wifiManager.WiFi_SSID(); Router_Pass = ESPAsync_wifiManager.WiFi_Pass(); //Remove this line if you do not want to see WiFi password printed Serial.println("ESP Self-Stored: SSID = " + Router_SSID + ", Pass = " + Router_Pass); // From v1.1.0, Don't permit NULL password if ( (Router_SSID != "") && (Router_Pass != "") ) { LOGERROR3(F("* Add SSID = "), Router_SSID, F(", PW = "), Router_Pass); wifiMulti.addAP(Router_SSID.c_str(), Router_Pass.c_str()); ESPAsync_wifiManager.setConfigPortalTimeout(120); //If no access point name has been previously entered disable timeout. Serial.println(F("Got ESP Self-Stored Credentials. Timeout 120s for Config Portal")); } else if (loadConfigData()) { ESPAsync_wifiManager.setConfigPortalTimeout(120); //If no access point name has been previously entered disable timeout. Serial.println(F("Got stored Credentials. Timeout 120s for Config Portal")); } else { // Enter CP only if no stored SSID on flash and file Serial.println(F("Open Config Portal without Timeout: No stored Credentials.")); initialConfig = true; } //Starts an access point //and goes into a blocking loop awaiting configuration if (!ESPAsync_wifiManager.startConfigPortal((const char *) ssid.c_str(), password)) { Serial.println(F("Not connected to WiFi but continuing anyway.")); } else { //if you get here you have connected to the WiFi Serial.println(F("connected...yeey :)")); Serial.print(F("Local IP: ")); Serial.println(WiFi.localIP()); } // Only clear then save data if CP entered and with new valid Credentials // No CP => stored getSSID() = "" if ( String(ESPAsync_wifiManager.getSSID(0)) != "" && String(ESPAsync_wifiManager.getSSID(1)) != "" ) { // Stored for later usage, from v1.1.0, but clear first memset(&WM_config, 0, sizeof(WM_config)); for (uint8_t i = 0; i < NUM_WIFI_CREDENTIALS; i++) { String tempSSID = ESPAsync_wifiManager.getSSID(i); String tempPW = ESPAsync_wifiManager.getPW(i); if (strlen(tempSSID.c_str()) < sizeof(WM_config.WiFi_Creds[i].wifi_ssid) - 1) strcpy(WM_config.WiFi_Creds[i].wifi_ssid, tempSSID.c_str()); else strncpy(WM_config.WiFi_Creds[i].wifi_ssid, tempSSID.c_str(), sizeof(WM_config.WiFi_Creds[i].wifi_ssid) - 1); if (strlen(tempPW.c_str()) < sizeof(WM_config.WiFi_Creds[i].wifi_pw) - 1) strcpy(WM_config.WiFi_Creds[i].wifi_pw, tempPW.c_str()); else strncpy(WM_config.WiFi_Creds[i].wifi_pw, tempPW.c_str(), sizeof(WM_config.WiFi_Creds[i].wifi_pw) - 1); // Don't permit NULL SSID and password len < MIN_AP_PASSWORD_SIZE (8) if ( (String(WM_config.WiFi_Creds[i].wifi_ssid) != "") && (strlen(WM_config.WiFi_Creds[i].wifi_pw) >= MIN_AP_PASSWORD_SIZE) ) { LOGERROR3(F("* Add SSID = "), WM_config.WiFi_Creds[i].wifi_ssid, F(", PW = "), WM_config.WiFi_Creds[i].wifi_pw ); wifiMulti.addAP(WM_config.WiFi_Creds[i].wifi_ssid, WM_config.WiFi_Creds[i].wifi_pw); } } saveConfigData(); } digitalWrite(LED_BUILTIN, LED_OFF); // Turn led off as we are not in configuration mode. } // put your main code here, to run repeatedly check_status(); } ``` See [Async_ConfigOnSwitch](examples/Async_ConfigOnSwitch) example for a more complex version. --- --- #### 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 [`ESPAsync_WiFiManager`](https://github.com/khoih-prog/ESPAsync_WiFiManager) to collect additional parameters, it is better to read these parameters from a web service once [`ESPAsync_WiFiManager`](https://github.com/khoih-prog/ESPAsync_WiFiManager) has been used to connect to the Internet. To capture other parameters with [`ESPAsync_WiFiManager`](https://github.com/khoih-prog/ESPAsync_WiFiManager) is a little bit more complicated than all the other features. This requires adding custom HTML to your form. If you want to do it with [`ESPAsync_WiFiManager`](https://github.com/khoih-prog/ESPAsync_WiFiManager) see the example [Async_ConfigOnSwitchFS](examples/Async_ConfigOnSwitchFS) #### 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) ##### 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 //set custom ip for portal ESPAsync_wifiManager.setAPStaticIPConfig(IPAddress(10,0,1,1), IPAddress(10,0,1,1), IPAddress(255,255,255,0)); ``` ##### Custom Station (client) Static IP Configuration This will use the specified IP configuration instead of using DHCP in station mode. ```cpp ESPAsync_wifiManager.setSTAStaticIPConfig(IPAddress(192,168,0,99), IPAddress(192,168,0,1), IPAddress(255,255,255,0)); ``` #### Custom HTML, CSS, Javascript There are various ways in which you can inject custom HTML, CSS or Javascript into the ConfigPortal. The options are: - inject custom head element You can use this to any html bit to the head of the ConfigPortal. If you add a `"); ``` - inject a custom bit of html in the configuration form ```cpp ESPAsync_WMParameter custom_text("

This is just a text paragraph

"); ESPAsync_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. ```cpp ESPAsync_WMParameter custom_mqtt_server("server", "mqtt server", "iot.eclipse", 40, " readonly"); ``` #### 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 ESPAsync_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 ESPAsync_wifiManager.setRemoveDuplicateAPs(false); ``` --- --- ### Examples #### Medium Complexity 1. [Async_ConfigOnSwitch](examples/Async_ConfigOnSwitch) 2. [Async_ConfigOnSwitchFS](examples/Async_ConfigOnSwitchFS) 3. [Async_ConfigOnStartup](examples/Async_ConfigOnStartup) 4. [Async_ConfigOnDoubleReset](examples/Async_ConfigOnDoubleReset) (now support ArduinoJson 6.0.0+ as well as 5.13.5-) 5. [Async_ConfigPortalParamsOnSwitch](examples/Async_ConfigPortalParamsOnSwitch) (now support ArduinoJson 6.0.0+ as well as 5.13.5-) 6. [Async_AutoConnect](examples/Async_AutoConnect) 7. [Async_AutoConnectWithFeedback](examples/Async_AutoConnectWithFeedback) 8. [Async_AutoConnectWithFeedbackLED](examples/Async_AutoConnectWithFeedbackLED) 9. [Async_AutoConnectWithFSParameters](examples/Async_AutoConnectWithFSParameters) 10. [Async_ConfigOnSwitchFS_MQTT_Ptr](examples/Async_ConfigOnSwitchFS_MQTT_Ptr) 11. [Async_AutoConnectWithFSParametersAndCustomIP](examples/Async_AutoConnectWithFSParametersAndCustomIP) 12. [ModelessConnect](examples/ModelessConnect) 13. [ModelessWithInterrupts](examples/ModelessWithInterrupts) 14. [Async_ESP32_FSWebServer](examples/Async_ESP32_FSWebServer) 15. [Async_ESP32_FSWebServer_DRD](examples/Async_ESP32_FSWebServer_DRD) 16. [Async_ESP_FSWebServer](examples/Async_ESP_FSWebServer) 17. [Async_ESP_FSWebServer_DRD](examples/Async_ESP_FSWebServer_DRD) 18. [Async_ConfigOnDRD_FS_MQTT_Ptr](examples/Async_ConfigOnDRD_FS_MQTT_Ptr) 19. [Async_ConfigPortalParamsOnSwitch_TZ](examples/Async_ConfigPortalParamsOnSwitch_TZ) (now support ArduinoJson 6.0.0+ as well as 5.13.5-) #### High Complexity 1. [Async_ConfigOnDRD_FS_MQTT_Ptr_Complex](examples/Async_ConfigOnDRD_FS_MQTT_Ptr_Complex) 2. [Async_ConfigOnDRD_FS_MQTT_Ptr_Medium](examples/Async_ConfigOnDRD_FS_MQTT_Ptr_Medium) #### Simplest Possible 1. [Async_AutoConnect_ESP32_minimal](examples/Async_AutoConnect_ESP32_minimal) 2. [Async_AutoConnect_ESP8266_minimal](examples/Async_AutoConnect_ESP8266_minimal) 3. [Async_ConfigOnDRD_ESP32_minimal](examples/Async_ConfigOnDRD_ESP32_minimal) 4. [Async_ConfigOnDRD_ESP8266_minimal](examples/Async_ConfigOnDRD_ESP8266_minimal) --- --- ### Example [Async_ConfigOnDRD_FS_MQTT_Ptr](examples/Async_ConfigOnDRD_FS_MQTT_Ptr) ```cpp #if !( defined(ESP8266) || defined(ESP32) ) #error This code is intended to run on the ESP8266 or ESP32 platform! Please check your Tools->Board setting. #endif #define ESP_ASYNC_WIFIMANAGER_VERSION_MIN_TARGET "ESPAsync_WiFiManager v1.9.4" // Use from 0 to 4. Higher number, more debugging messages and memory usage. #define _ESPASYNC_WIFIMGR_LOGLEVEL_ 3 #include // Now support ArduinoJson 6.0.0+ ( tested with v6.15.2 to v6.16.1 ) #include // get it from https://arduinojson.org/ or install via Arduino library manager //For ESP32, To use ESP32 Dev Module, QIO, Flash 4MB/80MHz, Upload 921600 //Ported to ESP32 #ifdef ESP32 #include #include #include // From v1.1.1 #include WiFiMulti wifiMulti; // LittleFS has higher priority than SPIFFS #if ( ARDUINO_ESP32C3_DEV ) // Currently, ESP32-C3 only supporting SPIFFS and EEPROM. Will fix to support LittleFS #define USE_LITTLEFS false #define USE_SPIFFS true #else #define USE_LITTLEFS true #define USE_SPIFFS false #endif #if USE_LITTLEFS // Use LittleFS #include "FS.h" // The library has been merged into esp32 core release 1.0.6 #include // https://github.com/lorol/LITTLEFS FS* filesystem = &LITTLEFS; #define FileFS LITTLEFS #define FS_Name "LittleFS" #elif USE_SPIFFS #include FS* filesystem = &SPIFFS; #define FileFS SPIFFS #define FS_Name "SPIFFS" #else // +Use FFat #include FS* filesystem = &FFat; #define FileFS FFat #define FS_Name "FFat" #endif ////// #define ESP_getChipId() ((uint32_t)ESP.getEfuseMac()) #define LED_BUILTIN 2 #define LED_ON HIGH #define LED_OFF LOW #else #include //https://github.com/esp8266/Arduino //needed for library #include // From v1.1.1 #include ESP8266WiFiMulti wifiMulti; #define USE_LITTLEFS true #if USE_LITTLEFS #include FS* filesystem = &LittleFS; #define FileFS LittleFS #define FS_Name "LittleFS" #else FS* filesystem = &SPIFFS; #define FileFS SPIFFS #define FS_Name "SPIFFS" #endif ////// #define ESP_getChipId() (ESP.getChipId()) #define LED_ON LOW #define LED_OFF HIGH #endif // These defines must be put before #include // to select where to store DoubleResetDetector's variable. // For ESP32, You must select one to be true (EEPROM or SPIFFS) // For ESP8266, You must select one to be true (RTC, EEPROM, SPIFFS or LITTLEFS) // Otherwise, library will use default EEPROM storage #ifdef ESP32 // These defines must be put before #include // to select where to store DoubleResetDetector's variable. // For ESP32, You must select one to be true (EEPROM or SPIFFS) // Otherwise, library will use default EEPROM storage #if USE_LITTLEFS #define ESP_DRD_USE_LITTLEFS true #define ESP_DRD_USE_SPIFFS false #define ESP_DRD_USE_EEPROM false #elif USE_SPIFFS #define ESP_DRD_USE_LITTLEFS false #define ESP_DRD_USE_SPIFFS true #define ESP_DRD_USE_EEPROM false #else #define ESP_DRD_USE_LITTLEFS false #define ESP_DRD_USE_SPIFFS false #define ESP_DRD_USE_EEPROM true #endif #else //ESP8266 // For DRD // These defines must be put before #include // to select where to store DoubleResetDetector's variable. // For ESP8266, You must select one to be true (RTC, EEPROM, SPIFFS or LITTLEFS) // Otherwise, library will use default EEPROM storage #if USE_LITTLEFS #define ESP_DRD_USE_LITTLEFS true #define ESP_DRD_USE_SPIFFS false #else #define ESP_DRD_USE_LITTLEFS false #define ESP_DRD_USE_SPIFFS true #endif #define ESP_DRD_USE_EEPROM false #define ESP8266_DRD_USE_RTC false #endif #define DOUBLERESETDETECTOR_DEBUG true //false #include //https://github.com/khoih-prog/ESP_DoubleResetDetector // Number of seconds after reset during which a // subseqent reset will be considered a double reset. #define DRD_TIMEOUT 10 // RTC Memory Address for the DoubleResetDetector to use #define DRD_ADDRESS 0 DoubleResetDetector* drd = NULL; #include "Adafruit_MQTT.h" //https://github.com/adafruit/Adafruit_MQTT_Library #include "Adafruit_MQTT_Client.h" //https://github.com/adafruit/Adafruit_MQTT_Library const char* CONFIG_FILE = "/ConfigMQTT.json"; // Default configuration values for Adafruit IO MQTT // This actually works #define AIO_SERVER "io.adafruit.com" #define AIO_SERVERPORT "1883" //1883, or 8883 for SSL #define AIO_USERNAME "private" //Adafruit IO #define AIO_KEY "private" // Labels for custom parameters in WiFi manager #define AIO_SERVER_Label "AIO_SERVER_Label" #define AIO_SERVERPORT_Label "AIO_SERVERPORT_Label" #define AIO_USERNAME_Label "AIO_USERNAME_Label" #define AIO_KEY_Label "AIO_KEY_Label" // Just dummy topics. To be updated later when got valid data from FS or Config Portal String MQTT_Pub_Topic = "private/feeds/Temperature"; // Variables to save custom parameters to... // I would like to use these instead of #defines #define custom_AIO_SERVER_LEN 20 #define custom_AIO_PORT_LEN 5 #define custom_AIO_USERNAME_LEN 20 #define custom_AIO_KEY_LEN 40 char custom_AIO_SERVER[custom_AIO_SERVER_LEN]; char custom_AIO_SERVERPORT[custom_AIO_PORT_LEN]; char custom_AIO_USERNAME[custom_AIO_USERNAME_LEN]; char custom_AIO_KEY[custom_AIO_KEY_LEN]; // Function Prototypes void MQTT_connect(); bool readConfigFile(); bool writeConfigFile(); // For Config Portal // SSID and PW for Config Portal String ssid = "ESP_" + String(ESP_getChipId(), HEX); String password; // SSID and PW for your Router String Router_SSID; String Router_Pass; // From v1.1.1 // You only need to format the filesystem once //#define FORMAT_FILESYSTEM true #define FORMAT_FILESYSTEM false #define MIN_AP_PASSWORD_SIZE 8 #define SSID_MAX_LEN 32 //From v1.0.10, WPA2 passwords can be up to 63 characters long. #define PASS_MAX_LEN 64 typedef struct { char wifi_ssid[SSID_MAX_LEN]; char wifi_pw [PASS_MAX_LEN]; } WiFi_Credentials; typedef struct { String wifi_ssid; String wifi_pw; } WiFi_Credentials_String; #define NUM_WIFI_CREDENTIALS 2 // Assuming max 49 chars #define TZNAME_MAX_LEN 50 #define TIMEZONE_MAX_LEN 50 typedef struct { WiFi_Credentials WiFi_Creds [NUM_WIFI_CREDENTIALS]; char TZ_Name[TZNAME_MAX_LEN]; // "America/Toronto" char TZ[TIMEZONE_MAX_LEN]; // "EST5EDT,M3.2.0,M11.1.0" uint16_t checksum; } WM_Config; WM_Config WM_config; #define CONFIG_FILENAME F("/wifi_cred.dat") ////// // Indicates whether ESP has WiFi credentials saved from previous session, or double reset detected bool initialConfig = false; // Use false if you don't like to display Available Pages in Information Page of Config Portal // Comment out or use true to display Available Pages in Information Page of Config Portal // Must be placed before #include #define USE_AVAILABLE_PAGES false // From v1.0.10 to permit disable/enable StaticIP configuration in Config Portal from sketch. Valid only if DHCP is used. // You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa // You have to explicitly specify false to disable the feature. //#define USE_STATIC_IP_CONFIG_IN_CP false // Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal. // See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23) #define USE_ESP_WIFIMANAGER_NTP true // Just use enough to save memory. On ESP8266, can cause blank ConfigPortal screen // if using too much memory #define USING_AFRICA false #define USING_AMERICA true #define USING_ANTARCTICA false #define USING_ASIA false #define USING_ATLANTIC false #define USING_AUSTRALIA false #define USING_EUROPE false #define USING_INDIAN false #define USING_PACIFIC false #define USING_ETC_GMT false // Use true to enable CloudFlare NTP service. System can hang if you don't have Internet access while accessing CloudFlare // See Issue #21: CloudFlare link in the default portal (https://github.com/khoih-prog/ESP_WiFiManager/issues/21) #define USE_CLOUDFLARE_NTP false // New in v1.0.11 #define USING_CORS_FEATURE true ////// // Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network #if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP) // Force DHCP to be true #if defined(USE_DHCP_IP) #undef USE_DHCP_IP #endif #define USE_DHCP_IP true #else // You can select DHCP or Static IP here //#define USE_DHCP_IP true #define USE_DHCP_IP false #endif #if ( USE_DHCP_IP ) // Use DHCP #warning Using DHCP IP IPAddress stationIP = IPAddress(0, 0, 0, 0); IPAddress gatewayIP = IPAddress(192, 168, 2, 1); IPAddress netMask = IPAddress(255, 255, 255, 0); #else // Use static IP #warning Using static IP #ifdef ESP32 IPAddress stationIP = IPAddress(192, 168, 2, 232); #else IPAddress stationIP = IPAddress(192, 168, 2, 186); #endif IPAddress gatewayIP = IPAddress(192, 168, 2, 1); IPAddress netMask = IPAddress(255, 255, 255, 0); #endif #define USE_CONFIGURABLE_DNS true IPAddress dns1IP = gatewayIP; IPAddress dns2IP = IPAddress(8, 8, 8, 8); #define USE_CUSTOM_AP_IP false IPAddress APStaticIP = IPAddress(192, 168, 100, 1); IPAddress APStaticGW = IPAddress(192, 168, 100, 1); IPAddress APStaticSN = IPAddress(255, 255, 255, 0); #include //https://github.com/khoih-prog/ESPAsync_WiFiManager #define HTTP_PORT 80 // Create an ESP32 WiFiClient class to connect to the MQTT server WiFiClient *client = NULL; Adafruit_MQTT_Client *mqtt = NULL; Adafruit_MQTT_Publish *Temperature = NULL; // Forward Declaration /////////////////////////////////////////// // New in v1.4.0 /****************************************** typedef struct { IPAddress _ap_static_ip; IPAddress _ap_static_gw; IPAddress _ap_static_sn; } WiFi_AP_IPConfig; typedef struct { IPAddress _sta_static_ip; IPAddress _sta_static_gw; IPAddress _sta_static_sn; #if USE_CONFIGURABLE_DNS IPAddress _sta_static_dns1; IPAddress _sta_static_dns2; #endif } WiFi_STA_IPConfig; ******************************************/ WiFi_AP_IPConfig WM_AP_IPconfig; WiFi_STA_IPConfig WM_STA_IPconfig; void initAPIPConfigStruct(WiFi_AP_IPConfig &in_WM_AP_IPconfig) { in_WM_AP_IPconfig._ap_static_ip = APStaticIP; in_WM_AP_IPconfig._ap_static_gw = APStaticGW; in_WM_AP_IPconfig._ap_static_sn = APStaticSN; } void initSTAIPConfigStruct(WiFi_STA_IPConfig &in_WM_STA_IPconfig) { in_WM_STA_IPconfig._sta_static_ip = stationIP; in_WM_STA_IPconfig._sta_static_gw = gatewayIP; in_WM_STA_IPconfig._sta_static_sn = netMask; #if USE_CONFIGURABLE_DNS in_WM_STA_IPconfig._sta_static_dns1 = dns1IP; in_WM_STA_IPconfig._sta_static_dns2 = dns2IP; #endif } void displayIPConfigStruct(WiFi_STA_IPConfig in_WM_STA_IPconfig) { LOGERROR3(F("stationIP ="), in_WM_STA_IPconfig._sta_static_ip, ", gatewayIP =", in_WM_STA_IPconfig._sta_static_gw); LOGERROR1(F("netMask ="), in_WM_STA_IPconfig._sta_static_sn); #if USE_CONFIGURABLE_DNS LOGERROR3(F("dns1IP ="), in_WM_STA_IPconfig._sta_static_dns1, ", dns2IP =", in_WM_STA_IPconfig._sta_static_dns2); #endif } void configWiFi(WiFi_STA_IPConfig in_WM_STA_IPconfig) { #if USE_CONFIGURABLE_DNS // Set static IP, Gateway, Subnetmask, DNS1 and DNS2. New in v1.0.5 WiFi.config(in_WM_STA_IPconfig._sta_static_ip, in_WM_STA_IPconfig._sta_static_gw, in_WM_STA_IPconfig._sta_static_sn, in_WM_STA_IPconfig._sta_static_dns1, in_WM_STA_IPconfig._sta_static_dns2); #else // Set static IP, Gateway, Subnetmask, Use auto DNS1 and DNS2. WiFi.config(in_WM_STA_IPconfig._sta_static_ip, in_WM_STA_IPconfig._sta_static_gw, in_WM_STA_IPconfig._sta_static_sn); #endif } /////////////////////////////////////////// uint8_t connectMultiWiFi() { #if ESP32 // For ESP32, this better be 0 to shorten the connect time. // For ESP32-S2/C3, must be > 500 #if ( USING_ESP32_S2 || USING_ESP32_C3 ) #define WIFI_MULTI_1ST_CONNECT_WAITING_MS 500L #else // For ESP32 core v1.0.6, must be >= 500 #define WIFI_MULTI_1ST_CONNECT_WAITING_MS 800L #endif #else // For ESP8266, this better be 2200 to enable connect the 1st time #define WIFI_MULTI_1ST_CONNECT_WAITING_MS 2200L #endif #define WIFI_MULTI_CONNECT_WAITING_MS 500L uint8_t status; //WiFi.mode(WIFI_STA); LOGERROR(F("ConnectMultiWiFi with :")); if ( (Router_SSID != "") && (Router_Pass != "") ) { LOGERROR3(F("* Flash-stored Router_SSID = "), Router_SSID, F(", Router_Pass = "), Router_Pass ); LOGERROR3(F("* Add SSID = "), Router_SSID, F(", PW = "), Router_Pass ); wifiMulti.addAP(Router_SSID.c_str(), Router_Pass.c_str()); } for (uint8_t i = 0; i < NUM_WIFI_CREDENTIALS; i++) { // Don't permit NULL SSID and password len < MIN_AP_PASSWORD_SIZE (8) if ( (String(WM_config.WiFi_Creds[i].wifi_ssid) != "") && (strlen(WM_config.WiFi_Creds[i].wifi_pw) >= MIN_AP_PASSWORD_SIZE) ) { LOGERROR3(F("* Additional SSID = "), WM_config.WiFi_Creds[i].wifi_ssid, F(", PW = "), WM_config.WiFi_Creds[i].wifi_pw ); } } LOGERROR(F("Connecting MultiWifi...")); //WiFi.mode(WIFI_STA); #if !USE_DHCP_IP // New in v1.4.0 configWiFi(WM_STA_IPconfig); ////// #endif int i = 0; status = wifiMulti.run(); delay(WIFI_MULTI_1ST_CONNECT_WAITING_MS); while ( ( i++ < 20 ) && ( status != WL_CONNECTED ) ) { status = WiFi.status(); if ( status == WL_CONNECTED ) break; else delay(WIFI_MULTI_CONNECT_WAITING_MS); } if ( status == WL_CONNECTED ) { LOGERROR1(F("WiFi connected after time: "), i); LOGERROR3(F("SSID:"), WiFi.SSID(), F(",RSSI="), WiFi.RSSI()); LOGERROR3(F("Channel:"), WiFi.channel(), F(",IP address:"), WiFi.localIP() ); } else { LOGERROR(F("WiFi not connected")); // To avoid unnecessary DRD drd->loop(); #if ESP8266 ESP.reset(); #else ESP.restart(); #endif } return status; } void toggleLED() { //toggle state digitalWrite(LED_BUILTIN, !digitalRead(LED_BUILTIN)); } #if USE_ESP_WIFIMANAGER_NTP void printLocalTime() { #if ESP8266 static time_t now; now = time(nullptr); if ( now > 1451602800 ) { Serial.print("Local Date/Time: "); Serial.print(ctime(&now)); } #else struct tm timeinfo; getLocalTime( &timeinfo ); // Valid only if year > 2000. // You can get from timeinfo : tm_year, tm_mon, tm_mday, tm_hour, tm_min, tm_sec if (timeinfo.tm_year > 100 ) { Serial.print("Local Date/Time: "); Serial.print( asctime( &timeinfo ) ); } #endif } #endif void heartBeatPrint() { #if USE_ESP_WIFIMANAGER_NTP printLocalTime(); #else static int num = 1; if (WiFi.status() == WL_CONNECTED) Serial.print(F("H")); // H means connected to WiFi else Serial.print(F("F")); // F means not connected to WiFi if (num == 80) { Serial.println(); num = 1; } else if (num++ % 10 == 0) { Serial.print(F(" ")); } #endif } void publishMQTT() { float some_number = 25.0 + (float) ( millis() % 100 ) / 100; // For debug only //Serial.print(F("Published Temp = ")); //Serial.println(some_number); MQTT_connect(); if (Temperature->publish(some_number)) { Serial.print(F("T")); // T means publishing OK } else { Serial.print(F("F")); // F means publishing failure } } void check_WiFi() { if ( (WiFi.status() != WL_CONNECTED) ) { Serial.println(F("\nWiFi lost. Call connectMultiWiFi in loop")); connectMultiWiFi(); } } void check_status() { static ulong checkstatus_timeout = 0; static ulong LEDstatus_timeout = 0; static ulong checkwifi_timeout = 0; static ulong mqtt_publish_timeout = 0; ulong current_millis = millis(); #define WIFICHECK_INTERVAL 1000L #if USE_ESP_WIFIMANAGER_NTP #define HEARTBEAT_INTERVAL 60000L #else #define HEARTBEAT_INTERVAL 10000L #endif #define LED_INTERVAL 2000L #define PUBLISH_INTERVAL 70000L // Check WiFi every WIFICHECK_INTERVAL (1) seconds. if ((current_millis > checkwifi_timeout) || (checkwifi_timeout == 0)) { check_WiFi(); checkwifi_timeout = current_millis + WIFICHECK_INTERVAL; } if ((current_millis > LEDstatus_timeout) || (LEDstatus_timeout == 0)) { // Toggle LED at LED_INTERVAL = 2s toggleLED(); LEDstatus_timeout = current_millis + LED_INTERVAL; } // Print hearbeat every HEARTBEAT_INTERVAL (10) seconds. if ((current_millis > checkstatus_timeout) || (checkstatus_timeout == 0)) { heartBeatPrint(); checkstatus_timeout = current_millis + HEARTBEAT_INTERVAL; } // Check every PUBLISH_INTERVAL (60) seconds. if ((current_millis > mqtt_publish_timeout) || (mqtt_publish_timeout == 0)) { if (WiFi.status() == WL_CONNECTED) { publishMQTT(); } mqtt_publish_timeout = current_millis + PUBLISH_INTERVAL; } } int calcChecksum(uint8_t* address, uint16_t sizeToCalc) { uint16_t checkSum = 0; for (uint16_t index = 0; index < sizeToCalc; index++) { checkSum += * ( ( (byte*) address ) + index); } return checkSum; } bool loadConfigData() { File file = FileFS.open(CONFIG_FILENAME, "r"); LOGERROR(F("LoadWiFiCfgFile ")); memset((void *) &WM_config, 0, sizeof(WM_config)); // New in v1.4.0 memset((void *) &WM_STA_IPconfig, 0, sizeof(WM_STA_IPconfig)); ////// if (file) { file.readBytes((char *) &WM_config, sizeof(WM_config)); // New in v1.4.0 file.readBytes((char *) &WM_STA_IPconfig, sizeof(WM_STA_IPconfig)); ////// file.close(); LOGERROR(F("OK")); if ( WM_config.checksum != calcChecksum( (uint8_t*) &WM_config, sizeof(WM_config) - sizeof(WM_config.checksum) ) ) { LOGERROR(F("WM_config checksum wrong")); return false; } // New in v1.4.0 displayIPConfigStruct(WM_STA_IPconfig); ////// return true; } else { LOGERROR(F("failed")); return false; } } void saveConfigData() { File file = FileFS.open(CONFIG_FILENAME, "w"); LOGERROR(F("SaveWiFiCfgFile ")); if (file) { WM_config.checksum = calcChecksum( (uint8_t*) &WM_config, sizeof(WM_config) - sizeof(WM_config.checksum) ); file.write((uint8_t*) &WM_config, sizeof(WM_config)); displayIPConfigStruct(WM_STA_IPconfig); // New in v1.4.0 file.write((uint8_t*) &WM_STA_IPconfig, sizeof(WM_STA_IPconfig)); ////// file.close(); LOGERROR(F("OK")); } else { LOGERROR(F("failed")); } } void deleteOldInstances() { // Delete previous instances if (mqtt) { delete mqtt; mqtt = NULL; Serial.println(F("Deleting old MQTT object")); } if (Temperature) { delete Temperature; Temperature = NULL; Serial.println(F("Deleting old Temperature object")); } } void createNewInstances() { if (!client) { client = new WiFiClient; Serial.print(F("\nCreating new WiFi client object : ")); Serial.println(client? F("OK") : F("failed")); } // Create new instances from new data if (!mqtt) { // Setup the MQTT client class by passing in the WiFi client and MQTT server and login details. mqtt = new Adafruit_MQTT_Client(client, custom_AIO_SERVER, atoi(custom_AIO_SERVERPORT), custom_AIO_USERNAME, custom_AIO_KEY); Serial.print(F("Creating new MQTT object : ")); if (mqtt) { Serial.println(F("OK")); Serial.println(String("AIO_SERVER = ") + custom_AIO_SERVER + ", AIO_SERVERPORT = " + custom_AIO_SERVERPORT); Serial.println(String("AIO_USERNAME = ") + custom_AIO_USERNAME + ", AIO_KEY = " + custom_AIO_KEY); } else Serial.println(F("Failed")); } if (!Temperature) { Serial.print(F("Creating new MQTT_Pub_Topic, Temperature = ")); Serial.println(MQTT_Pub_Topic); Temperature = new Adafruit_MQTT_Publish(mqtt, MQTT_Pub_Topic.c_str()); Serial.print(F("Creating new Temperature object : ")); if (Temperature) { Serial.println(F("OK")); Serial.println(String("Temperature MQTT_Pub_Topic = ") + MQTT_Pub_Topic); } else Serial.println(F("Failed")); } } void wifi_manager() { Serial.println(F("\nConfig Portal requested.")); digitalWrite(LED_BUILTIN, LED_ON); // turn the LED on by making the voltage LOW to tell us we are in configuration mode. //Local intialization. Once its business is done, there is no need to keep it around // Use this to default DHCP hostname to ESP8266-XXXXXX or ESP32-XXXXXX //ESPAsync_WiFiManager ESPAsync_wifiManager(&webServer, &dnsServer); // Use this to personalize DHCP hostname (RFC952 conformed) AsyncWebServer webServer(HTTP_PORT); #if ( USING_ESP32_S2 || USING_ESP32_C3 ) ESPAsync_WiFiManager ESPAsync_wifiManager(&webServer, NULL, "ConfigOnDRD-FS-MQTT"); #else DNSServer dnsServer; ESPAsync_WiFiManager ESPAsync_wifiManager(&webServer, &dnsServer, "ConfigOnDRD-FS-MQTT"); #endif //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(F("Opening Configuration Portal. ")); Router_SSID = ESPAsync_wifiManager.WiFi_SSID(); Router_Pass = ESPAsync_wifiManager.WiFi_Pass(); // From v1.1.1, Don't permit NULL password if ( !initialConfig && (Router_SSID != "") && (Router_Pass != "") ) { //If valid AP credential and not DRD, set timeout 120s. ESPAsync_wifiManager.setConfigPortalTimeout(120); Serial.println("Got stored Credentials. Timeout 120s"); } else { ESPAsync_wifiManager.setConfigPortalTimeout(0); Serial.print(F("No timeout : ")); if (initialConfig) { Serial.println(F("DRD or No stored Credentials..")); } else { Serial.println(F("No stored Credentials.")); } } // Extra parameters to be configured // After connecting, parameter.getValue() will get you the configured value // Format: