Table of Contents

Why do we need this AsyncAsyncWT32_ETH01_Manager library

Features

Why Async is better

Currently supported Boards

WT32_ETH01

Prerequisites

Installation

Use Arduino Library Manager

Manual Install

VS Code & PlatformIO:

Libraries' Patches

1. For ESPAsyncWebServer library

Note for Platform IO using ESP32 LittleFS

Necessary only for esp32 core v1.0.6-

//#define CONFIG_LITTLEFS_FOR_IDF_3_2   /* For old IDF - like in release 1.0.4 */

#defineCONFIG_LITTLEFS_FOR_IDF_3_2/* For old IDF - like in release 1.0.4*/

HOWTO FixMultiple Definitions Linker Error

#include<AsyncWT32_ETH01_Manager.hpp>//https://github.com/khoih-prog/AsyncWT32_ETH01_Manager

// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error#include<AsyncWT32_ETH01_Manager.h>//https://github.com/khoih-prog/AsyncWT32_ETH01_Manager

HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)

1. ESP32 has 2 ADCs, named ADC1 and ADC2

2. ESP32 ADCs functions

3.. ESP32 WiFi uses ADC2 for WiFi functions

How It Works

HOWTO Basic configurations

1. Using default for every configurable parameter

#include<esp_wifi.h>// LittleFS has higher priority than SPIFFS#if ( defined(ESP_ARDUINO_VERSION_MAJOR) && (ESP_ARDUINO_VERSION_MAJOR >= 2) )  #defineUSE_LITTLEFStrue  #defineUSE_SPIFFSfalse#elif defined(ARDUINO_ESP32C3_DEV)// For core v1.0.6-, ESP32-C3 only supporting SPIFFS and EEPROM. To use v2.0.0+ for LittleFS  #defineUSE_LITTLEFSfalse  #defineUSE_SPIFFStrue#endif#if USE_LITTLEFS// Use LittleFS  #include"FS.h"// Check cores/esp32/esp_arduino_version.h and cores/esp32/core_version.h//#if ( ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(2, 0, 0) )  //(ESP_ARDUINO_VERSION_MAJOR >= 2)  #if ( defined(ESP_ARDUINO_VERSION_MAJOR) && (ESP_ARDUINO_VERSION_MAJOR >= 2) )    #if (_ESPASYNC_ETH_MGR_LOGLEVEL_ > 3)      #warning Using ESP32 Core 1.0.6 or 2.0.0+    #endif// The library has been merged into esp32 core from release 1.0.6    #include<LittleFS.h>// https://github.com/espressif/arduino-esp32/tree/master/libraries/LittleFS    FS* filesystem =      &LittleFS;    #defineFileFS        LittleFS    #defineFS_Name"LittleFS"  #else    #if (_ESPASYNC_ETH_MGR_LOGLEVEL_ > 3)      #warning Using ESP32 Core 1.0.5-. You must install LITTLEFS library    #endif// The library has been merged into esp32 core from release 1.0.6    #include<LITTLEFS.h>// https://github.com/lorol/LITTLEFS    FS* filesystem =      &LITTLEFS;    #defineFileFS        LITTLEFS    #defineFS_Name"LittleFS"  #endif#elif USE_SPIFFS  #include<SPIFFS.h>  FS* filesystem =      &SPIFFS;  #defineFileFS        SPIFFS  #defineFS_Name"SPIFFS"#else// +Use FFat  #include<FFat.h>  FS* filesystem =      &FFat;  #defineFileFS        FFat  #defineFS_Name"FFat"#endif//////#defineLED_BUILTIN2#defineLED_ON            HIGH#defineLED_OFF           LOW////////////////////////////////////////////////////// You only need to format the filesystem once//#define FORMAT_FILESYSTEM       true#defineFORMAT_FILESYSTEMfalse////////////////////////////////////////////////////#include<AsyncWT32_ETH01_Manager.h>//https://github.com/khoih-prog/AsyncWT32_ETH01_Manager#defineHTTP_PORT80

2. Using many configurable parameters

#include<esp_wifi.h>// LittleFS has higher priority than SPIFFS#if ( defined(ESP_ARDUINO_VERSION_MAJOR) && (ESP_ARDUINO_VERSION_MAJOR >= 2) )  #defineUSE_LITTLEFStrue  #defineUSE_SPIFFSfalse#elif defined(ARDUINO_ESP32C3_DEV)// For core v1.0.6-, ESP32-C3 only supporting SPIFFS and EEPROM. To use v2.0.0+ for LittleFS  #defineUSE_LITTLEFSfalse  #defineUSE_SPIFFStrue#endif#if USE_LITTLEFS// Use LittleFS  #include"FS.h"// Check cores/esp32/esp_arduino_version.h and cores/esp32/core_version.h//#if ( ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(2, 0, 0) )  //(ESP_ARDUINO_VERSION_MAJOR >= 2)  #if ( defined(ESP_ARDUINO_VERSION_MAJOR) && (ESP_ARDUINO_VERSION_MAJOR >= 2) )    #if (_ESPASYNC_ETH_MGR_LOGLEVEL_ > 3)      #warning Using ESP32 Core 1.0.6 or 2.0.0+    #endif// The library has been merged into esp32 core from release 1.0.6    #include<LittleFS.h>// https://github.com/espressif/arduino-esp32/tree/master/libraries/LittleFS    FS* filesystem =      &LittleFS;    #defineFileFS        LittleFS    #defineFS_Name"LittleFS"  #else    #if (_ESPASYNC_ETH_MGR_LOGLEVEL_ > 3)      #warning Using ESP32 Core 1.0.5-. You must install LITTLEFS library    #endif// The library has been merged into esp32 core from release 1.0.6    #include<LITTLEFS.h>// https://github.com/lorol/LITTLEFS    FS* filesystem =      &LITTLEFS;    #defineFileFS        LITTLEFS    #defineFS_Name"LittleFS"  #endif#elif USE_SPIFFS  #include<SPIFFS.h>  FS* filesystem =      &SPIFFS;  #defineFileFS        SPIFFS  #defineFS_Name"SPIFFS"#else// +Use FFat  #include<FFat.h>  FS* filesystem =      &FFat;  #defineFileFS        FFat  #defineFS_Name"FFat"#endif//////#defineLED_BUILTIN2#defineLED_ON            HIGH#defineLED_OFF           LOW// These defines must be put before #include <ESP_DoubleResetDetector.h>// 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// These defines must be put before #include <ESP_DoubleResetDetector.h>// 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  #defineESP_DRD_USE_LITTLEFStrue  #defineESP_DRD_USE_SPIFFSfalse  #defineESP_DRD_USE_EEPROMfalse#elif USE_SPIFFS  #defineESP_DRD_USE_LITTLEFSfalse  #defineESP_DRD_USE_SPIFFStrue  #defineESP_DRD_USE_EEPROMfalse#else  #defineESP_DRD_USE_LITTLEFSfalse  #defineESP_DRD_USE_SPIFFSfalse  #defineESP_DRD_USE_EEPROMtrue#endif#defineDOUBLERESETDETECTOR_DEBUGtrue//false#include<ESP_DoubleResetDetector.h>//https://github.com/khoih-prog/ESP_DoubleResetDetector// Number of seconds after reset during which a// subsequent reset will be considered a double reset.#defineDRD_TIMEOUT10// RTC Memory Address for the DoubleResetDetector to use#defineDRD_ADDRESS0//DoubleResetDetector drd(DRD_TIMEOUT, DRD_ADDRESS);DoubleResetDetector* drd;//////// Onboard LED I/O pin on NodeMCU boardconstint PIN_LED =2;// D4 on NodeMCU and WeMos. GPIO2/ADC12 of ESP32. Controls the onboard LED.// You only need to format the filesystem once//#define FORMAT_FILESYSTEM       true#defineFORMAT_FILESYSTEMfalse// Assuming max 49 chars#defineTZNAME_MAX_LEN50#defineTIMEZONE_MAX_LEN50typedefstruct{char TZ_Name[TZNAME_MAX_LEN];// "America/Toronto"char TZ[TIMEZONE_MAX_LEN];// "EST5EDT,M3.2.0,M11.1.0"uint16_t checksum;} EthConfig;EthConfig         Ethconfig;#defineCONFIG_FILENAMEF("/eth_cred.dat")//////// Indicates whether ESP has credentials saved from previous session, or double reset detectedbool 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 <AsyncWT32_ETH01_Manager.h>#defineUSE_AVAILABLE_PAGEStrue//false// 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)#defineUSE_ESP_ETH_MANAGER_NTPtrue//false// Just use enough to save memory. On ESP8266, can cause blank ConfigPortal screen// if using too much memory#defineUSING_AFRICAfalse#defineUSING_AMERICAtrue#defineUSING_ANTARCTICAfalse#defineUSING_ASIAfalse#defineUSING_ATLANTICfalse#defineUSING_AUSTRALIAfalse#defineUSING_EUROPEfalse#defineUSING_INDIANfalse#defineUSING_PACIFICfalse#defineUSING_ETC_GMTfalse// 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)#defineUSE_CLOUDFLARE_NTPfalse#defineUSING_CORS_FEATUREtrue////////////////////////////////////////////// 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  #defineUSE_DHCP_IPtrue#else// You can select DHCP or Static IP here//#define USE_DHCP_IP     true  #defineUSE_DHCP_IPfalse#endif#if ( USE_DHCP_IP )// Use DHCP  #if (_ESPASYNC_ETH_MGR_LOGLEVEL_ > 3)    #warning Using DHCP IP  #endif  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  #if (_ESPASYNC_ETH_MGR_LOGLEVEL_ > 3)    #warning Using static IP  #endif  IPAddress stationIP   = IPAddress(192,168,2,232);  IPAddress gatewayIP   = IPAddress(192,168,2,1);  IPAddress netMask     = IPAddress(255,255,255,0);#endif////////////////////////////////////////////#defineUSE_CONFIGURABLE_DNStrueIPAddress dns1IP      = gatewayIP;IPAddress dns2IP      = IPAddress(8,8,8,8);#include<AsyncWT32_ETH01_Manager.h>//https://github.com/khoih-prog/AsyncWT32_ETH01_Manager#defineHTTP_PORT80AsyncWebServerwebServer(HTTP_PORT);AsyncDNSServer dnsServer;////////////////////////////////////////////******************************************   // Defined in AsyncWT32_ETH01_Manager.hpp  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  }  ETH_STA_IPConfig;******************************************/ETH_STA_IPConfig EthSTA_IPconfig;

3. Using STA-mode DHCP, but don't like to change to static IP or display in Config Portal

// 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.#defineUSE_STATIC_IP_CONFIG_IN_CPfalse

4. Using STA-mode DHCP, but permit to change to static IP and display in Config Portal

// 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  #defineUSE_DHCP_IPtrue#else// You can select DHCP or Static IP here  #defineUSE_DHCP_IPtrue#endif

5. Using STA-mode StaticIP, and be able to change to DHCP IP and display in Config Portal

// 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  #defineUSE_DHCP_IPtrue#else// You can select DHCP or Static IP here  #defineUSE_DHCP_IPfalse#endif

6. Using STA-mode StaticIP and configurable DNS, and be able to change to DHCP IP and display in Config Portal

// 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  #defineUSE_DHCP_IPtrue#else// You can select DHCP or Static IP here  #defineUSE_DHCP_IPfalse#endif#defineUSE_CONFIGURABLE_DNStrueIPAddress 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

// 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  #defineUSE_DHCP_IPtrue#else// You can select DHCP or Static IP here  #defineUSE_DHCP_IPfalse#endif#defineUSE_CONFIGURABLE_DNSfalse

8. Not using NTP to avoid issue with some WebBrowsers, especially in CellPhone or Tablets.

// 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)#defineUSE_ESP_ETH_MANAGER_NTPfalse

9. Using NTP feature with CloudFlare. System can hang until you have Internet access for CloudFlare.

// 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)#defineUSE_ESP_ETH_MANAGER_NTPtrue// 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)#defineUSE_CLOUDFLARE_NTPtrue

10. Using NTP feature without CloudFlare to avoid system hang if no Internet access for CloudFlare.

// 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)#defineUSE_ESP_ETH_MANAGER_NTPtrue// 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)#defineUSE_CLOUDFLARE_NTPfalse

11. Setting STA-mode static IP

//AsyncWT32_ETH01_manager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask, dns1IP, dns2IP);AsyncWT32_ETH01_manager.setSTAStaticIPConfig(WM_STA_IPconfig);

12. Using CORS (Cross-Origin Resource Sharing) feature

// Default false for using only whenever necessary to avoid security issue#defineUSING_CORS_FEATUREtrue

// Default false for using only whenever necessary to avoid security issue#defineUSING_CORS_FEATUREtrue...#if USING_CORS_FEATURE  ESP_wifiManager.setCORSHeader("Your Access-Control-Allow-Origin");#endif

// Default false for using only whenever necessary to avoid security issue#defineUSING_CORS_FEATUREfalse

13. How to auto getting _timezoneName

// 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)#defineUSE_ESP_ETH_MANAGER_NTPtrue

String tempTZ = AsyncWT32_ETH01_manager.getTimezoneName();

14. How to get TZ variable to configure Timezone

// 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//configTzTime(WM_config.TZ, "pool.ntp.org" );configTzTime(WM_config.TZ,"time.nist.gov","0.pool.ntp.org","1.pool.ntp.org");

constchar * TZ_Result = AsyncWT32_ETH01_manager.getTZ(_timezoneName);

#defineUSING_AMERICAtrue

// Just use enough to save memory. On ESP8266, can cause blank ConfigPortal screen// if using too much memory#defineUSING_AFRICAfalse#defineUSING_AMERICAtrue#defineUSING_ANTARCTICAfalse#defineUSING_ASIAfalse#defineUSING_ATLANTICfalse#defineUSING_AUSTRALIAfalse#defineUSING_EUROPEfalse#defineUSING_INDIANfalse#defineUSING_PACIFICfalse#defineUSING_ETC_GMTfalse

15. How to use the TZ variable to configure Timezone

//configTzTime(WM_config.TZ, "pool.ntp.org" );configTzTime(WM_config.TZ,"time.nist.gov","0.pool.ntp.org","1.pool.ntp.org");

voidprintLocalTime(){structtm timeinfo;getLocalTime( &timeinfo );  Serial.print("Local Date/Time:");  Serial.print(asctime( &timeinfo ) );}

HOWTO Open Config Portal

#include<AsyncWT32_ETH01_Manager.h>//https://github.com/khoih-prog/AsyncWT32_ETH01_Manager#defineHTTP_PORT80AsyncWebServerwebServer(HTTP_PORT);AsyncDNSServer dnsServer;AsyncWT32_ETH01_ManagerAsyncWT32_ETH01_manager(&webServer, &dnsServer);

AsyncWT32_ETH01_ManagerAsyncWT32_ETH01_manager(&webServer, &dnsServer,"Personalized-HostName");

AsyncWT32_ETH01_manager.startConfigPortal()

HOWTO Add Dynamic Parameters

1. Determine the variables to be configured via Config Portal (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`

#defineAPI_KEY_LEN17// Default configuration valueschar thingspeakApiKey[API_KEY_LEN]  ="";bool sensorDht22                    =true;int pinSda                          = PIN_D2;// Pin D2 mapped to pin GPIO4 of ESP8266int pinScl                          = PIN_D1;// Pin D1 mapped to pin GPIO5 of ESP8266// Any unique string helping you identify the vars#defineThingSpeakAPI_Label"thingspeakApiKey"#defineSensorDht22_Label"SensorDHT22"#definePinSDA_Label"PinSda"#definePinSCL_Label"PinScl"

2. Initialize the variables to prepare for Config Portal (CP)

voidloop(){// 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 initialization. Once its business is done, there is no need to keep it around    AsyncWT32_ETH01_ManagerAsyncWT32_ETH01_manager(&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    }

2.1 Use the following simple constructor for simple variables such asthingspeakApiKey,pinSda andpinScl :

ESPAsync_EMParameter(constchar *id,constchar *placeholder,constchar *defaultValue,int length);

2.2 For example, to create a newESPAsync_EMParameter objectp_thingspeakApiKey forthingspeakApiKey,

ESPAsync_EMParameterp_thingspeakApiKey(ThingSpeakAPI_Label,"Thingspeak API Key", thingspeakApiKey, API_KEY_LEN);

- p_thingspeakApiKey                  : ESPAsync_EMParameter 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

// I2C SCL and SDA parameters are integers so we need to convert them to char array but// no other special considerationschar convertedValue[3];sprintf(convertedValue,"%d", pinSda);ESPAsync_EMParameterp_pinSda(PinSDA_Label,"I2C SDA pin", convertedValue,3);sprintf(convertedValue,"%d", pinScl);ESPAsync_EMParameterp_pinScl(PinSCL_Label,"I2C SCL pin", convertedValue,3);

- p_pinSda / p_pinScl                         : ESPAsync_EMParameter 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 assensorDht22:

ESPAsync_EMParameter(constchar *id,constchar *placeholder,constchar *defaultValue,int length,constchar *custom,int labelPlacement);

2.4 For example, to create a newESPAsync_EMParameter objectp_sensorDht22 forsensorDht22,

ESPAsync_EMParameterp_sensorDht22(SensorDht22_Label,"DHT-22 Sensor","T",2, customhtml, WFM_LABEL_AFTER);

- p_sensorDht22                       : ESPAsync_EMParameter 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

char customhtml[24] ="type=\"checkbox\"";if (sensorDht22){strcat(customhtml," checked");}

3. Add the variables to Config Portal (CP)

3.1 addParameter() function Prototype:

//adds a custom parameterbooladdParameter(ESPAsync_EMParameter *p);

3.2 Code to add variables to CP

//add all parameters hereAsyncWT32_ETH01_manager.addParameter(&p_thingspeakApiKey);AsyncWT32_ETH01_manager.addParameter(&p_sensorDht22);AsyncWT32_ETH01_manager.addParameter(&p_pinSda);AsyncWT32_ETH01_manager.addParameter(&p_pinScl);

4. Save the variables configured in Config Portal (CP)

4.1 Getting variables' data from CP

// Getting posted form values and overriding local variables parameters// Config file is written regardless the connection statestrcpy(thingspeakApiKey, p_thingspeakApiKey.getValue());sensorDht22 = (strncmp(p_sensorDht22.getValue(),"T",1) ==0);pinSda = atoi(p_pinSda.getValue());pinScl = atoi(p_pinScl.getValue());

// Writing JSON config file to flash for next bootwriteConfigFile();

5. Write to FS (SPIFFS, LittleFS, etc.) using JSON format

boolwriteConfigFile(){  Serial.println("Saving config file");#if (ARDUINOJSON_VERSION_MAJOR >= 6)  DynamicJsonDocumentjson(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");returnfalse;  }#if (ARDUINOJSON_VERSION_MAJOR >= 6)serializeJsonPretty(json, Serial);// Write data to file and close itserializeJson(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");returntrue;}

5.1 Create a DynamicJsonDocument Object

DynamicJsonDocumentjson(1024);

5.2 Fill the DynamicJsonDocument Object with data got from Config Portal

json[Unique_Label] = Value_For_Unique_Label;

// JSONify local configuration parametersjson[ThingSpeakAPI_Label] = thingspeakApiKey;json[SensorDht22_Label]   = sensorDht22;json[PinSDA_Label]        = pinSda;json[PinSCL_Label]        = pinScl;

5.3 Open file to write the Jsonified data

#include<SPIFFS.h>FS* filesystem =      &SPIFFS;#defineFileFS        SPIFFSconstchar* CONFIG_FILE ="/ConfigSW.json";

// Open file for writingFile f = FileFS.open(CONFIG_FILE,"w");if (!f){  Serial.println("Failed to open config file for writing");returnfalse;}

5.4 Write the Jsonified data to CONFIG_FILE

// Write data to file and close itserializeJson(json, f);

5.5 Close CONFIG_FILE to flush and save the data

f.close();

6. Read from FS using JSON format

boolreadConfigFile(){// this opens the config file in read-mode  File f = FileFS.open(CONFIG_FILE,"r");if (!f)  {    Serial.println("Configuration file not found");returnfalse;  }else  {// we could open the filesize_t size = f.size();// Allocate a buffer to store contents of the file.    std::unique_ptr<char[]>buf(newchar[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)    DynamicJsonDocumentjson(1024);auto deserializeError =deserializeJson(json, buf.get());if ( deserializeError )    {      Serial.println("JSON parseObject() failed");returnfalse;    }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");returnfalse;    }    json.printTo(Serial);#endif// Parse all config file parameters, override// local config variables with parsed valuesif (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");returntrue;}

6.1 Open CONFIG_FILE to read

// this opens the config file in read-modeFile f = FileFS.open(CONFIG_FILE,"r");

if (!f){  Serial.println("Configuration file not found");returnfalse;}

6.2 Open CONFIG_FILE to read

// we could open the filesize_t size = f.size();// Allocate a buffer to store contents of the file.std::unique_ptr<char[]>buf(newchar[size +1]);

// Read and store file contents in buff.readBytes(buf.get(), size);// Closing filef.close();

6.3 Populate the just-read Jsonified data into the DynamicJsonDocument json object

DynamicJsonDocumentjson(1024);

auto deserializeError = deserializeJson(json, buf.get());

if ( deserializeError ){  Serial.println("JSON parseObject() failed");returnfalse;}serializeJson(json, Serial);

6.4 Parse the Jsonified data from the DynamicJsonDocument json object to store into corresponding parameters

if (json.containsKey(ThingSpeakAPI_Label))

// Parse all config file parameters, override// local config variables with parsed valuesif (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

The application will use DHTsensor (either DHT11or 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?

Documentation

Password protect the configuration Access Point

Callbacks

Save settings

AsyncWT32_ETH01_manager.setSaveConfigCallback(saveConfigCallback);

//flag for saving databool shouldSaveConfig =false;//callback notifying us of the need to save configvoidsaveConfigCallback () {  Serial.println("Should save config");  shouldSaveConfig =true;}

ConfigPortal Timeout

AsyncWT32_ETH01_manager.setConfigPortalTimeout(120);

On Demand ConfigPortal

voidloop(){// 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 initialization. Once its business is done, there is no need to keep it around// Use this to default DHCP hostname to ESP32-XXXXXX//AsyncWT32_ETH01_Manager AsyncWT32_ETH01_manager(&webServer, &dnsServer);// Use this to personalize DHCP hostname (RFC952 conformed)    AsyncWebServerwebServer(HTTP_PORT);#if ( USING_ESP32_S2 || USING_ESP32_C3 )    AsyncWT32_ETH01_ManagerAsyncWT32_ETH01_manager(&webServer,NULL,"ConfigOnSwitch");#else    AsyncDNSServer dnsServer;    AsyncWT32_ETH01_ManagerAsyncWT32_ETH01_manager(&webServer, &dnsServer,"ConfigOnSwitch");#endif#if !USE_DHCP_IP#if USE_CONFIGURABLE_DNS// Set static IP, Gateway, Subnetmask, DNS1 and DNS2    AsyncWT32_ETH01_manager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask, dns1IP, dns2IP);#else// Set static IP, Gateway, Subnetmask, Use auto DNS1 and DNS2.    AsyncWT32_ETH01_manager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask);#endif#endif#if USING_CORS_FEATURE    AsyncWT32_ETH01_manager.setCORSHeader("Your Access-Control-Allow-Origin");#endif//Check if there is stored credentials.//If not found, device will remain in configuration mode until switched off via webserver.    Serial.println(F("Opening configuration portal."));if (loadConfigData())    {      AsyncWT32_ETH01_manager.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      AsyncWT32_ETH01_manager.setConfigPortalTimeout(0);      Serial.println(F("Open Config Portal without Timeout: No stored Credentials."));      initialConfig =true;    }//Starts an access point//and goes into a blocking loop awaiting configurationif (!AsyncWT32_ETH01_manager.startConfigPortal())      Serial.println(F("Not connected to ETH network but continuing anyway."));else    {      Serial.println(F("ETH network connected...yeey :)"));      Serial.print(F("Local IP:"));      Serial.println(ETH.localIP());    }#if USE_ESP_ETH_MANAGER_NTP    String tempTZ = AsyncWT32_ETH01_manager.getTimezoneName();if (strlen(tempTZ.c_str()) <sizeof(Ethconfig.TZ_Name) -1)strcpy(Ethconfig.TZ_Name, tempTZ.c_str());elsestrncpy(Ethconfig.TZ_Name, tempTZ.c_str(),sizeof(Ethconfig.TZ_Name) -1);constchar * TZ_Result = AsyncWT32_ETH01_manager.getTZ(Ethconfig.TZ_Name);if (strlen(TZ_Result) <sizeof(Ethconfig.TZ) -1)strcpy(Ethconfig.TZ, TZ_Result);elsestrncpy(Ethconfig.TZ, TZ_Result,sizeof(Ethconfig.TZ_Name) -1);if (strlen(Ethconfig.TZ_Name) >0 )    {LOGERROR3(F("Saving current TZ_Name ="), Ethconfig.TZ_Name,F(", TZ ="), Ethconfig.TZ);//configTzTime(Ethconfig.TZ, "pool.ntp.org" );configTzTime(Ethconfig.TZ,"time.nist.gov","0.pool.ntp.org","1.pool.ntp.org");    }else    {LOGERROR(F("Current Timezone Name is not set. Enter Config Portal to set."));    }#endif    AsyncWT32_ETH01_manager.getSTAStaticIPConfig(EthSTA_IPconfig);saveConfigData();#if !USE_DHCP_IP// Reset to use new Static IP, if different from current ETH.localIP()if (ETH.localIP() != EthSTA_IPconfig._sta_static_ip)    {      Serial.print(F("Current IP ="));      Serial.print(ETH.localIP());      Serial.print(F(". Reset to take new IP ="));      Serial.println(EthSTA_IPconfig._sta_static_ip);      ESP.restart();delay(2000);    }#endifdigitalWrite(LED_BUILTIN, LED_OFF);// Turn led off as we are not in configuration mode.  }// put your main code here, to run repeatedlycheck_status();}

Custom Parameters

Custom IP Configuration

Custom Station (client) Static IP Configuration

AsyncWT32_ETH01_manager.setSTAStaticIPConfig(IPAddress(192,168,2,232), IPAddress(192,168,2,1), IPAddress(255,255,255,0));

Custom HTML, CSS, Javascript

AsyncWT32_ETH01_manager.setCustomHeadElement("<style>html{filter: invert(100%); -webkit-filter: invert(100%);}</style>");

ESPAsync_EMParametercustom_text("<p>This is just a text paragraph</p>");AsyncWT32_ETH01_manager.addParameter(&custom_text);

ESPAsync_EMParametercustom_mqtt_server("server","mqtt server","iot.eclipse",40," readonly");

Examples

ExampleAsync_ConfigOnSwitch

Debug Terminal Output Samples

1. Async_ConfigOnDoubleReset using LittleFS on ESP32_DEV with ETH_PHY_LAN8720

1.1 DRD => Config Portal

Starting Async_ConfigOnDoubleReset using LittleFS on ESP32_DEV with ETH_PHY_LAN8720AsyncWT32_ETH01_Manager v1.0.0ESP_DoubleResetDetector v1.3.2ETH StartedETH ConnectedETH MAC: A8:48:FA:08:4B:FF, IPv4: 192.168.2.97FULL_DUPLEX, 100Mbps[EM] RFC925 Hostname = AsyncConfigOnDoubleReset[EM] setSTAStaticIPConfig[EM] Set CORS Header to :  Your Access-Control-Allow-Origin[EM] LoadCfgFile [EM] failed[EM] stationIP = 0.0.0.0 , gatewayIP = 0.0.0.0[EM] netMask = 0.0.0.0[EM] dns1IP = 0.0.0.0 , dns2IP = 0.0.0.0LittleFS Flag read = 0xD0D01234doubleResetDetectedSaving config file...Saving config file OKOpen Config Portal without Timeout: Double Reset DetectedStarting configuration portal @ 192.168.2.97[EM] _configPortalStart millis() = 1937[EM] Config Portal IP address = 192.168.2.97[EM] HTTP server started[EM] startConfigPortal : Enter loop[EM] handleRoot[EM] request host IP = 192.168.2.97[EM] Info[EM] Info page sent[EM] handleRoot[EM] request host IP = 192.168.2.97[EM] Handle ETH[EM] Static IP = 192.168.2.232[EM] Sent config page[EM] ETH save[EM] TZ = America/New_York[EM] New Static IP = 192.168.2.232[EM] New Static Gateway = 192.168.2.1[EM] New Static Netmask = 255.255.255.0[EM] New Static DNS1 = 192.168.2.1[EM] New Static DNS2 = 8.8.8.8[EM] Sent eth save page[EM] stopConfigPortalETH network connected...yeey :)[EM] Saving current TZ_Name = America/New_York , TZ =  EST5EDT,M3.2.0,M11.1.0[EM] getSTAStaticIPConfig[EM] SaveCfgFile [EM] stationIP = 192.168.2.232 , gatewayIP = 192.168.2.1[EM] netMask = 255.255.255.0[EM] dns1IP = 192.168.2.1 , dns2IP = 8.8.8.8[EM] OKCurrent IP = 192.168.2.97. Reset to take new IP = 192.168.2.232ets Jun  8 2016 00:22:57

1.2. Get new Static IP after reset

Starting Async_ConfigOnDoubleReset using LittleFS on ESP32_DEV with ETH_PHY_LAN8720AsyncWT32_ETH01_Manager v1.0.0ESP_DoubleResetDetector v1.3.2ETH StartedETH ConnectedETH MAC: A8:48:FA:08:4B:FF, IPv4: 192.168.2.97FULL_DUPLEX, 100Mbps[EM] RFC925 Hostname = AsyncConfigOnDoubleReset[EM] setSTAStaticIPConfig[EM] Set CORS Header to :  Your Access-Control-Allow-Origin[EM] LoadCfgFile [EM] OK[EM] stationIP = 192.168.2.232 , gatewayIP = 192.168.2.1[EM] netMask = 255.255.255.0[EM] dns1IP = 192.168.2.1 , dns2IP = 8.8.8.8Got stored Credentials. Timeout 120s for Config Portal[EM] Current TZ_Name = America/New_York , TZ =  EST5EDT,M3.2.0,M11.1.0[EM] stationIP = 192.168.2.232 , gatewayIP = 192.168.2.1[EM] netMask = 255.255.255.0[EM] dns1IP = 192.168.2.1 , dns2IP = 8.8.8.8LittleFS Flag read = 0xD0D04321No doubleResetDetectedSaving config file...Saving config file OKAfter waiting 0.00 secs more in setup(), connection result is connected. Local IP: 192.168.2.232[EM] freeing allocated params!Local Date/Time: Thu Dec  8 21:51:18 2022Stop doubleResetDetectingSaving config file...Saving config file OKLocal Date/Time: Thu Dec  8 22:34:53 2022Local Date/Time: Thu Dec  8 22:35:53 2022Local Date/Time: Thu Dec  8 22:36:53 2022Local Date/Time: Thu Dec  8 22:37:53 2022

2. Async_ConfigOnSwichFS using LittleFS on ESP32_DEV with ETH_PHY_LAN8720

Starting Async_ConfigOnSwichFS using LittleFS on ESP32_DEV with ETH_PHY_LAN8720AsyncWT32_ETH01_Manager v1.0.0ESP_DoubleResetDetector v1.3.2ETH StartedETH ConnectedETH MAC: A8:48:FA:08:4B:FF, IPv4: 192.168.2.97FULL_DUPLEX, 100MbpsConfiguration file not foundFailed to read ConfigFile, using default values[EM] RFC925 Hostname = ConfigOnSwitchFS[EM] setSTAStaticIPConfig[EM] Set CORS Header to :  Your Access-Control-Allow-Origin[EM] LoadCfgFile [EM] OK[EM] stationIP = 192.168.2.232 , gatewayIP = 192.168.2.1[EM] netMask = 255.255.255.0[EM] dns1IP = 192.168.2.1 , dns2IP = 8.8.8.8Got stored Credentials. Timeout 120s for Config Portal[EM] Current TZ_Name = America/New_York , TZ =  EST5EDT,M3.2.0,M11.1.0[EM] stationIP = 192.168.2.232 , gatewayIP = 192.168.2.1[EM] netMask = 255.255.255.0[EM] dns1IP = 192.168.2.1 , dns2IP = 8.8.8.8ETH ConnectedETH MAC: DE:AD:BE:EF:FE:07, IPv4: 192.168.2.232FULL_DUPLEX, 10MbpsAfter waiting 0.00 secs more in setup(), connection result is connected. Local IP: 192.168.2.232[EM] freeing allocated params!Local Date/Time: Thu Dec  8 16:31:38 2022Configuration portal requested.[EM] RFC925 Hostname = ConfigOnSwitchFSOpening configuration portal. [EM] LoadCfgFile [EM] OK[EM] stationIP = 192.168.2.232 , gatewayIP = 192.168.2.1[EM] netMask = 255.255.255.0[EM] dns1IP = 192.168.2.1 , dns2IP = 8.8.8.8Got stored Credentials. Timeout 120s for Config Portal[EM] Adding parameter thingspeakApiKey[EM] Adding parameter SensorDHT22[EM] Adding parameter PinSda[EM] Adding parameter PinScl[EM] setSTAStaticIPConfig for USE_CONFIGURABLE_DNS[EM] Set CORS Header to :  Your Access-Control-Allow-Origin[EM] _configPortalStart millis() = 17427[EM] Config Portal IP address = 192.168.2.232[EM] HTTP server started[EM] startConfigPortal : Enter loop[EM] handleRoot[EM] request host IP = 192.168.2.232[EM] Handle ETH[EM] Static IP = 192.168.2.232[EM] Sent config page[EM] ETH save[EM] TZ = America/New_York[EM] Parameter and value : thingspeakApiKey API_Key[EM] Parameter and value : SensorDHT22 T[EM] Parameter and value : PinSda 21[EM] Parameter and value : PinScl 22[EM] New Static IP = 192.168.2.233[EM] New Static Gateway = 192.168.2.1[EM] New Static Netmask = 255.255.255.0[EM] New Static DNS1 = 192.168.2.1[EM] New Static DNS2 = 8.8.8.8[EM] Sent eth save page[EM] stopConfigPortal[EM] startConfigPortal: exit, _configPortalTimeout = 0 millis() = 67391ETH network connected...yeey :)Local IP: 192.168.2.232[EM] Saving current TZ_Name = America/New_York , TZ =  EST5EDT,M3.2.0,M11.1.0[EM] getSTAStaticIPConfig[EM] SaveCfgFile [EM] stationIP = 192.168.2.233 , gatewayIP = 192.168.2.1[EM] netMask = 255.255.255.0[EM] dns1IP = 192.168.2.1 , dns2IP = 8.8.8.8[EM] OKSaving config file{  "thingspeakApiKey": "API_Key",  "SensorDHT22": true,  "PinSda": 21,  "PinScl": 22}Config file was successfully saved[EM] freeing allocated params!Local Date/Time: Thu Dec  8 22:42:53 2022Local Date/Time: Thu Dec  8 22:43:53 2022Local Date/Time: Thu Dec  8 22:44:53 2022

3. Async_ESP32_FSWebServer_DRD using LittleFS on ESP32_DEV with ETH_PHY_LAN8720

Starting Async_ESP32_FSWebServer_DRDusing LittleFS on ESP32_DEV with ETH_PHY_LAN8720AsyncWT32_ETH01_Manager v1.0.0ESP_DoubleResetDetector v1.3.2FS File: CanadaFlag_1.png, size:40.25KBFS File: CanadaFlag_2.png, size:8.12KBFS File: CanadaFlag_3.jpg, size:10.89KBFS File: drd.dat, size: 4BFS File: edit.htm.gz, size:4.02KBFS File: eth_cred.dat, size: 142BFS File: favicon.ico, size:1.12KBFS File: graphs.js.gz, size:1.92KBFS File: index.htm, size:3.63KBFS File: wifi_cred.dat, size: 142BETH StartedETH ConnectedETH MAC: A8:48:FA:08:4B:FF, IPv4:192.168.2.97FULL_DUPLEX, 100Mbps[EM] RFC925 Hostname = AsyncESP32-FSWebServer[EM] setSTAStaticIPConfig[EM] Set CORS Header to :  Your Access-Control-Allow-Origin[EM] LoadCfgFile [EM] OK[EM] stationIP =192.168.2.232 , gatewayIP =192.168.2.1[EM] netMask =255.255.255.0[EM] dns1IP =192.168.2.1 , dns2IP =8.8.8.8ETH ConnectedETH MAC: DE:AD:BE:EF:FE:07, IPv4:192.168.2.232FULL_DUPLEX, 10MbpsGot stored Credentials. Timeout 120sfor Config PortalLittleFS Flag read =0xD0D04321No doubleResetDetectedSaving config file...Saving config file OKAfter waiting0.00 secs more insetup(), connection result is connected. Local IP: 192.168.2.232HTTP server started @ 192.168.2.232===============================================================Open http://192.168.2.232/edit to see the file browserUsing username = admin and password = admin===============================================================[EM] freeing allocated params!HStop doubleResetDetectingSaving config file...Saving config file OKHHHHH HHHHHHHHHH HHHHHHHHHH HHHHHHHHHH

Debug

AsyncWT32_ETH01_manager.setDebugOutput(false);

// Use from 0 to 4. Higher number, more debugging messages and memory usage.#define_ESPASYNC_ETH_MGR_LOGLEVEL_3

Troubleshooting

Issues

Contributions and Thanks

Contributing

License and credits

Copyright