- Why do we need this ESP32_SC_W6100_Manager library
- Changelog
- Prerequisites
- Installation
- Note for Platform IO using ESP32 LittleFS
- HOWTO Fix
Multiple DefinitionsLinker Error - HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)
- How It Works
- HOWTO Basic configurations
- 1. Using default for every configurable parameter
- 2. Using many configurable parameters
- 3. Using STA-mode DHCP, but don't 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
- 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
- 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.
- 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.
- 11. Setting STA-mode static IP
- 12. Using CORS (Cross-Origin Resource Sharing) feature
- 13. How to auto getting _timezoneName
- 14. How to get TZ variable to configure Timezone
- 15. How to use the TZ variable to configure Timezone
- HOWTO Open Config Portal
- HOWTO Add Dynamic Parameters
- 1. Determine the variables to be configured via 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,pinSdaandpinScl - 2.2 For example, to create a new
ESP32_EMParameterobjectp_thingspeakApiKeyforthingspeakApiKey - 2.3 Use the more complex following constructor for variables such as
sensorDht22 - 2.4 For example, to create a new
ESP32_EMParameterobjectp_sensorDht22forsensorDht22
- 2.1 Use the following simple constructor for simple variables such as
- 3. Add the variables to Config Portal (CP)
- 4. Save the variables configured in Config Portal (CP)
- 5. Write to FS (SPIFFS, LittleFS, etc.) using JSON format
- 6. Read from FS using JSON format
- So, how it works?
- Documentation
- How to connect W6100 to ESP32_S2/S3/C3
- Examples
- ConfigOnSwitch
- ConfigOnSwitchFS
- ConfigOnDoubleReset_TZ (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
- ConfigOnDoubleReset (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
- ConfigPortalParamsOnSwitch (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
- ESP32_FSWebServer
- ESP32_FSWebServer_DRD
- Example ConfigOnSwitch
- Debug Terminal Output Samples
- Debug
- Troubleshooting
- Issues
- TO DO
- DONE
- Contributions and Thanks
- Contributing
- License and credits
- Copyright
Why do we need this ESP32_SC_W6100_Manager library
This is an ESP32_S2/S3/C3 + LwIP W6100 Credentials and Connection Manager with fallback Web ConfigPortal. This Library is used for configuring ESP32_S2/S3/C3 Ethernet Static / DHCP and Credentials at runtime. You can specify static DNS servers, personalized HostName and CORS feature.
This library is based on, modified and improved from:
Please also check these sibling libraries
- WebServer_WT32_ETH01 for ESP32-based
WT32_ETH01usingLwIP LAN8720 - WebServer_ESP32_ENC for ESP32-boards using
LwIP ENC28J60 - WebServer_ESP32_W5500 for ESP32-boards using
LwIP W5500 - WebServer_ESP32_W6100 for ESP32-boards using
LwIP W6100 - WebServer_ESP32_SC_ENC for ESP32_S2/S3/C3-boards using
LwIP ENC28J60 - WebServer_ESP32_SC_W5500 for ESP32_S2/S3/C3-boards using
LwIP W5500 - WebServer_ESP32_SC_W6100 for ESP32_S2/S3/C3-boards using
LwIP W6100
- ESP32_ENC_Manager for ESP32-boards using
LwIP ENC28J60 - ESP32_W5500_Manager for ESP32-boards using
LwIP W5500 - ESP32_W6100_Manager for ESP32-boards using
LwIP W6100 - ESP32_Ethernet_Manager for ESP32-boards using
LwIP W5500, W6100 or ENC28J60 - ESP32_SC_ENC_Manager for ESP32_S2/S3/C3-boards using
LwIP ENC28J60 - ESP32_SC_W5500_Manager for ESP32_S2/S3/C3-boards using
LwIP W5500 - ESP32_SC_W6100_Manager for ESP32_S2/S3/C3-boards using
LwIP W6100 - ESP32_SC_Ethernet_Manager for ESP32_S2/S3/C3-boards using
LwIP W5500, W6100 or ENC28J60
- AsyncWT32_ETH01_Manager for ESP32-based
WT32_ETH01usingLwIP LAN8720 - AsyncESP32_ENC_Manager for ESP32-boards using
LwIP ENC28J60 - AsyncESP32_W5500_Manager for ESP32-boards using
LwIP W5500 - AsyncESP32_W6100_Manager for ESP32-boards using
LwIP W6100 - AsyncESP32_Ethernet_Manager for ESP32-boards using
LwIP W6100 or ENC28J60 - AsyncESP32_SC_ENC_Manager for ESP32_S2/S3/C3-boards using
LwIP ENC28J60 - AsyncESP32_SC_W5500_Manager for ESP32_S2/S3/C3-boards using
LwIP W5500 - AsyncESP32_SC_W6100_Manager for ESP32_S2/S3/C3-boards using
LwIP W6100 - AsyncESP32_SC_Ethernet_Manager for ESP32_S2/S3/C3-boards using
LwIP W5500, W6100 or ENC28J60
This ESP32_SC_W6100_Manager library currently supports these following boards:
- ESP32_S3-based boards (ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.)
- ESP32-S2 (ESP32-S2 Saola, AI-Thinker ESP-12K, etc.)
- ESP32-C3 (ARDUINO_ESP32C3_DEV, etc.)
using LwIP W6100 Ethernet
FULL_DUPLEX, 100Mbps
Arduino IDE 1.8.19+for Arduino.ESP32 Core 2.0.6+for ESP32-based boards.ESP_DoubleResetDetector v1.3.2+if using DRD feature. To install, check. Use v1.1.0+ if using
LittleFSfor ESP32 v1.0.6+.WebServer_ESP32_SC_W6100 library v1.2.1+if necessary to use ESP32_S2/S3/C3 boards using LwIP W6100 Ethernet. To install, check
The best and easiest way is to use Arduino Library Manager. Search for ESP32_SC_W6100_Manager, then select / install the latest version. You can also use this link
- Navigate to ESP32_SC_W6100_Manager page.
- Download the latest release
ESP32_SC_W6100_Manager-main.zip. - Extract the zip file to
ESP32_SC_W6100_Manager-maindirectory - Copy the whole
ESP32_SC_W6100_Manager-mainfolder to Arduino libraries' directory such as~/Arduino/libraries/.
- Install VS Code
- Install PlatformIO
- Install ESP32_SC_W6100_Manager library by using Library Manager. Search for ESP32_SC_W6100_Manager in Platform.io Author's Libraries
- Use included 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
From esp32 core v1.0.6+, LittleFS_esp32 v1.0.6 has been included and this step is not necessary anymore.
In Platform IO, to fix the error when using LittleFS_esp32 v1.0 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.6+ to avoid the issue.
Thanks to Roshan to report the issue in Error esp_littlefs.c 'utime_p'
The current library implementation, using xyz-Impl.h instead of standard xyz.cpp, possibly creates certain Multiple Definitions Linker error in certain use cases.
You can use
#include <ESP32_SC_W6100_Manager.hpp> //https://github.com/khoih-prog/ESP32_SC_W6100_Managerin many files. But be sure to use the following #include <ESP32_SC_W6100_Manager.h> in just 1 .h, .cpp or .ino file, which must not be included in any other file, to avoid Multiple Definitions Linker Error
// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
#include <ESP32_SC_W6100_Manager.h> //https://github.com/khoih-prog/ESP32_SC_W6100_ManagerHave a look at the discussion in Different behaviour using the src_cpp or src_h lib #80
Please have a look at ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to have more detailed description and solution of the issue.
ADC1controls ADC function for pins GPIO32-GPIO39ADC2controls ADC function for pins GPIO0, 2, 4, 12-15, 25-27
Look in file adc_common.c
In
ADC2, there're two locks used for different cases:
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 theADCis determined by the arbiter. There is no need to control by lock.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
ADC2for other functions, we have to acquire complicated firmware locks and very difficult to do - So, it's not advisable to use
ADC2with 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 to work with ESP32 WiFi/BlueTooth (BT/BLE).
- The ConfigOnSwitch example shows how it works and should be used as the basis for a sketch that uses this library.
- The concept of ConfigOnSwitch is that a new
ESP32will start a 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 theESP32module. - Using any network-enabled device with a browser (computer, phone, tablet) connect to the newly created Access Point (AP) (Dynamic or Static IP specified in sketch)
then connect WebBrowser to configurable ConfigPortal IP address, e.g. 192.168.232
- Include in your sketch
#include <esp_wifi.h>
// LittleFS has higher priority than SPIFFS
#if ( defined(ESP_ARDUINO_VERSION_MAJOR) && (ESP_ARDUINO_VERSION_MAJOR >= 2) )
#define USE_LITTLEFS true
#define USE_SPIFFS false
#elif defined(ARDUINO_ESP32C3_DEV)
// For core v1.0.6-, ESP32-C3 only supporting SPIFFS and EEPROM. To use v2.0.0+ for LittleFS
#define USE_LITTLEFS false
#define USE_SPIFFS true
#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 (_ESP32_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;
#define FileFS LittleFS
#define FS_Name "LittleFS"
#else
#if (_ESP32_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;
#define FileFS LITTLEFS
#define FS_Name "LittleFS"
#endif
#elif USE_SPIFFS
#include <SPIFFS.h>
FS* filesystem = &SPIFFS;
#define FileFS SPIFFS
#define FS_Name "SPIFFS"
#else
// +Use FFat
#include <FFat.h>
FS* filesystem = &FFat;
#define FileFS FFat
#define FS_Name "FFat"
#endif
//////
#define LED_BUILTIN 2
#define LED_ON HIGH
#define LED_OFF LOW
////////////////////////////////////////////////////
// You only need to format the filesystem once
//#define FORMAT_FILESYSTEM true
#define FORMAT_FILESYSTEM false
////////////////////////////////////////////////////
#include <ESP32_SC_W6100_Manager.h> //https://github.com/khoih-prog/ESP32_SC_W6100_Manager
#define HTTP_PORT 80
- Include in your sketch
#include <esp_wifi.h>
// LittleFS has higher priority than SPIFFS
#if ( defined(ESP_ARDUINO_VERSION_MAJOR) && (ESP_ARDUINO_VERSION_MAJOR >= 2) )
#define USE_LITTLEFS true
#define USE_SPIFFS false
#elif defined(ARDUINO_ESP32C3_DEV)
// For core v1.0.6-, ESP32-C3 only supporting SPIFFS and EEPROM. To use v2.0.0+ for LittleFS
#define USE_LITTLEFS false
#define USE_SPIFFS true
#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 (_ESP32_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;
#define FileFS LittleFS
#define FS_Name "LittleFS"
#else
#if (_ESP32_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;
#define FileFS LITTLEFS
#define FS_Name "LittleFS"
#endif
#elif USE_SPIFFS
#include <SPIFFS.h>
FS* filesystem = &SPIFFS;
#define FileFS SPIFFS
#define FS_Name "SPIFFS"
#else
// +Use FFat
#include <FFat.h>
FS* filesystem = &FFat;
#define FileFS FFat
#define FS_Name "FFat"
#endif
//////
#define LED_BUILTIN 2
#define LED_ON HIGH
#define LED_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
#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
#define DOUBLERESETDETECTOR_DEBUG true //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.
#define DRD_TIMEOUT 10
// RTC Memory Address for the DoubleResetDetector to use
#define DRD_ADDRESS 0
//DoubleResetDetector drd(DRD_TIMEOUT, DRD_ADDRESS);
DoubleResetDetector* drd;//////
// Onboard LED I/O pin on NodeMCU board
const int 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
#define FORMAT_FILESYSTEM false
// Assuming max 49 chars
#define TZNAME_MAX_LEN 50
#define TIMEZONE_MAX_LEN 50
typedef struct
{
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;
#define CONFIG_FILENAME F("/eth_cred.dat")
//////
// Indicates whether ESP has 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 <ESP32_SC_W6100_Manager.h>
#define USE_AVAILABLE_PAGES true //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)
#define USE_ESP_ETH_MANAGER_NTP true //false
// 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
#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
#if (_ESP32_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 (_ESP32_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
////////////////////////////////////////////
#define USE_CONFIGURABLE_DNS true
IPAddress dns1IP = gatewayIP;
IPAddress dns2IP = IPAddress(8, 8, 8, 8);
#include <ESP32_SC_W6100_Manager.h> //https://github.com/khoih-prog/ESP32_SC_W6100_Manager
#define HTTP_PORT 80
WebServer webServer(HTTP_PORT);
///////////////////////////////////////////
/******************************************
// Defined in ESP32_SC_W6100_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;// 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// 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// 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
#endif6. 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
#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
// 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// 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_ETH_MANAGER_NTP false9. 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)
#define USE_ESP_ETH_MANAGER_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// 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_ETH_MANAGER_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//ESP32_SC_W6100_manager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask, dns1IP, dns2IP);
ESP32_SC_W6100_manager.setSTAStaticIPConfig(WM_STA_IPconfig);- To use CORS feature with default CORS Header "". Some WebBrowsers won't accept this allowing-all "" CORS Header.
// Default false for using only whenever necessary to avoid security issue
#define USING_CORS_FEATURE true- To use CORS feature with specific CORS Header "Your Access-Control-Allow-Origin". To be modified according to your specific Allowed-Origin.
// Default false for using only whenever necessary to avoid security issue
#define USING_CORS_FEATURE true
...
#if USING_CORS_FEATURE
ESP_wifiManager.setCORSHeader("Your Access-Control-Allow-Origin");
#endif- Not use CORS feature (default)
// Default false for using only whenever necessary to avoid security issue
#define USING_CORS_FEATURE false- Turn on auto
NTPconfiguration 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_ETH_MANAGER_NTP true- The
_timezoneName, in the format similar to America/New_York, America/Toronto, Europe/London, etc., can be retrieved by using
String tempTZ = ESP32_SC_W6100_manager.getTimezoneName();- ESP32
TZcan be configured, using the similar toEST5EDT,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
//configTzTime(WM_config.TZ, "pool.ntp.org" );
configTzTime(WM_config.TZ, "time.nist.gov", "0.pool.ntp.org", "1.pool.ntp.org");- To convert from
_timezoneNametoTZ, use the functiongetTZ()as follows:
const char * TZ_Result = ESP32_SC_W6100_manager.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 trueHereafter 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//configTzTime(WM_config.TZ, "pool.ntp.org" );
configTzTime(WM_config.TZ, "time.nist.gov", "0.pool.ntp.org", "1.pool.ntp.org");then to print local time
void printLocalTime()
{
struct tm timeinfo;
getLocalTime( &timeinfo );
Serial.print("Local Date/Time: ");
Serial.print( asctime( &timeinfo ) );
}- When you want to open a config portal, with default
DHCPhostnameESP32-XXXXXX, just add
#include <ESP32_SC_W6100_Manager.h> //https://github.com/khoih-prog/ESP32_SC_W6100_Manager
#define HTTP_PORT 80
WebServer webServer(HTTP_PORT);
ESP32_SC_W6100_Manager ESP32_SC_W6100_manager();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
ESP32_SC_W6100_Manager ESP32_SC_W6100_manager("Personalized-HostName");then later call
ESP32_SC_W6100_manager.startConfigPortal()While in Config Portal, connect to it using its AP IP, e.g. 192.168.2.232, configure Credentials, then save. The settings will be saved in non volatile memory. It will then reboot and autoconnect.
These illustrating steps is based on the example ConfigOnSwitchFS
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"The example 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 ESP32_SC_W6100_Manager class initialization to create ESP32_SC_W6100_Manager 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 initialization. Once its business is done, there is no need to keep it around
ESP32_SC_W6100_Manager ESP32_SC_W6100_manager("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 ESP32_EMParameter 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 :
ESP32_EMParameter(const char *id, const char *placeholder, const char *defaultValue, int length);The command to use will be
ESP32_EMParameter p_thingspeakApiKey(ThingSpeakAPI_Label, "Thingspeak API Key", thingspeakApiKey, API_KEY_LEN);where
- p_thingspeakApiKey : ESP32_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
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);
ESP32_EMParameter p_pinSda(PinSDA_Label, "I2C SDA pin", convertedValue, 3);
sprintf(convertedValue, "%d", pinScl);
ESP32_EMParameter p_pinScl(PinSCL_Label, "I2C SCL pin", convertedValue, 3);where
- p_pinSda / p_pinScl : ESP32_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
ESP32_EMParameter(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom, int labelPlacement);The command to use will be
ESP32_EMParameter p_sensorDht22(SensorDht22_Label, "DHT-22 Sensor", "T", 2, customhtml, WFM_LABEL_AFTER);where
- p_sensorDht22 : ESP32_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
and customhtml Code is:
char customhtml[24] = "type=\"checkbox\"";
if (sensorDht22)
{
strcat(customhtml, " checked");
}Adding those ESP32_EMParameter objects created in Step 2 using the function addParameter() of object ESP32_SC_W6100_Manager
//adds a custom parameter
bool addParameter(ESP32_EMParameter *p);Add parameter objects, previously created in Step 2, such as : p_thingspeakApiKey, p_sensorDht22, p_pinSda and p_pinScl
//add all parameters here
ESP32_SC_W6100_manager.addParameter(&p_thingspeakApiKey);
ESP32_SC_W6100_manager.addParameter(&p_sensorDht22);
ESP32_SC_W6100_manager.addParameter(&p_pinSda);
ESP32_SC_W6100_manager.addParameter(&p_pinScl);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.
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.
After users select Save, the CP ESP32_SC_W6100_Manager object will save the user input data into related ESP32_EMParameter objects.
We can now retrieve the data, using getValue() function, for each ESP32_EMParameter 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();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++.
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;
}We'll create an object with size 1024 bytes, enough to hold our data:
DynamicJsonDocument json(1024);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;This is the CONFIG_FILE file name we already declared at the beginning of the sketch (for ESP32):
#include <SPIFFS.h>
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;
}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);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.
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<char[]> 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.
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;
}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<char[]> 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();We again use the same DynamicJsonDocument json object to store the data we've just read from 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];
}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.In ConfigPortal Mode, it starts an access point @ the current Static or DHCP IP.
Connect to it by going to, e.g. http://192.168.2.232, you'll see this Main page:
Select Information to enter the Info page where the board info will be shown (long page)
Select Configuration to enter this page where you can modify its Credentials
Enter your credentials, then click Save. The Credentials will be saved and the board continues, or reboots if necessary, to connect to the selected Static IP or DHCP.
If you're already satisfied with the current settings and don't want to change anything, just select Exit Portal from the Main page to continue or reboot the board and connect using the previously-stored Credentials.
You can password protect the ConfigPortal AP. Check ESP32_FSWebServer example
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.
ESP32_SC_W6100_manager.setSaveConfigCallback(saveConfigCallback);saveConfigCallback declaration and example
//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;
}If you need to set a timeout so the ESP32 doesn't hang waiting to be configured for ever.
ESP32_SC_W6100_manager.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.
Example usage
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 initialization. Once its business is done, there is no need to keep it around
// Use this to default DHCP hostname to ESP32-XXXXXX
//ESP32_SC_W6100_Manager ESP32_SC_W6100_manager;
// Use this to personalize DHCP hostname (RFC952 conformed)
ESP32_SC_W6100_Manager ESP32_SC_W6100_manager("ConfigOnSwitch");
#if !USE_DHCP_IP
#if USE_CONFIGURABLE_DNS
// Set static IP, Gateway, Subnetmask, DNS1 and DNS2
ESP32_SC_W6100_manager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask, dns1IP, dns2IP);
#else
// Set static IP, Gateway, Subnetmask, Use auto DNS1 and DNS2.
ESP32_SC_W6100_manager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask);
#endif
#endif
#if USING_CORS_FEATURE
ESP32_SC_W6100_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())
{
ESP32_SC_W6100_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
ESP32_SC_W6100_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 configuration
if (!ESP32_SC_W6100_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 = ESP32_SC_W6100_manager.getTimezoneName();
if (strlen(tempTZ.c_str()) < sizeof(Ethconfig.TZ_Name) - 1)
strcpy(Ethconfig.TZ_Name, tempTZ.c_str());
else
strncpy(Ethconfig.TZ_Name, tempTZ.c_str(), sizeof(Ethconfig.TZ_Name) - 1);
const char * TZ_Result = ESP32_SC_W6100_manager.getTZ(Ethconfig.TZ_Name);
if (strlen(TZ_Result) < sizeof(Ethconfig.TZ) - 1)
strcpy(Ethconfig.TZ, TZ_Result);
else
strncpy(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
ESP32_SC_W6100_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);
}
#endif
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 ConfigOnSwitch example for a more complex version.
Many applications need configuration parameters like MQTT host and port, Blynk or emoncms tokens, etc. While it is possible to use ESP32_SC_W6100_Manager to collect additional parameters, it is better to read these parameters from a web service once ESP32_SC_W6100_Manager has been used to connect to the Internet.
To capture other parameters with ESP32_SC_W6100_Manager 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 ESP32_SC_W6100_Manager see the example ConfigOnSwitchFS
You can set a custom IP for STA (station mode, client mode, normal project state)
This will use the specified IP configuration instead of using DHCP in station mode.
ESP32_SC_W6100_manager.setSTAStaticIPConfig(IPAddress(192,168,2,232), IPAddress(192,168,2,1), IPAddress(255,255,255,0));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 <style> element, keep in mind it overwrites the included css, not replaces.
ESP32_SC_W6100_manager.setCustomHeadElement("<style>html{filter: invert(100%); -webkit-filter: invert(100%);}</style>");- inject a custom bit of html in the configuration form
ESP32_EMParameter custom_text("<p>This is just a text paragraph</p>");
ESP32_SC_W6100_manager.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.
ESP32_EMParameter custom_mqtt_server("server", "mqtt server", "iot.eclipse", 40, " readonly");You can change the INT pin to another one. Default is GPIO4
// Must connect INT to GPIOxx or not working
#define INT_GPIO 4
| W6100 | <---> | ESP32_S3 |
|---|---|---|
| MOSI | <---> | GPIO11 |
| MISO | <---> | GPIO13 |
| SCK | <---> | GPIO12 |
| CS/SS | <---> | GPIO10 |
| INT | <---> | GPIO4 |
| RST | <---> | RST |
| GND | <---> | GND |
| 3.3V | <---> | 3.3V |
| W6100 | <---> | ESP32_S2 |
|---|---|---|
| MOSI | <---> | GPIO35 |
| MISO | <---> | GPIO37 |
| SCK | <---> | GPIO36 |
| CS/SS | <---> | GPIO34 |
| INT | <---> | GPIO4 |
| RST | <---> | RST |
| GND | <---> | GND |
| 3.3V | <---> | 3.3V |
| W6100 | <---> | ESP32_C3 |
|---|---|---|
| MOSI | <---> | GPIO6 |
| MISO | <---> | GPIO5 |
| SCK | <---> | GPIO4 |
| CS/SS | <---> | GPIO7 |
| INT | <---> | GPIO10 |
| RST | <---> | RST |
| GND | <---> | GND |
| 3.3V | <---> | 3.3V |
- ConfigOnSwitch
- ConfigOnSwitchFS
- ConfigOnDoubleReset_TZ (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
- ConfigOnDoubleReset (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
- ConfigPortalParamsOnSwitch (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
- ESP32_FSWebServer
- ESP32_FSWebServer_DRD
Example ConfigOnSwitch
ESP32_SC_W6100_Manager/examples/ConfigOnSwitch/ConfigOnSwitch.ino
Lines 25 to 905 in e71d847
This is terminal debug output when running ConfigOnDoubleReset on ESP32_S3_W6100. Config Portal was requested by DRD to input and save Credentials, such as Static IP address.
Starting ConfigOnDoubleReset_TZ using LittleFS on ESP32S3_DEV with ESP32_S3_W6100
ESP32_SC_W6100_Manager v1.0.0
ESP_DoubleResetDetector v1.3.2
[EM] Default SPI pinout:
[EM] SPI_HOST: 2
[EM] MOSI: 23
[EM] MISO: 19
[EM] SCK: 18
[EM] CS: 5
[EM] INT: 4
[EM] SPI Clock (MHz): 25
[EM] =========================
ETH Started
[EM] RFC925 Hostname = ConfigOnDoubleReset_TZ
[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.8
Got 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.8
ETH Connected
ETH MAC: DE:AD:BE:EF:BE:0C, IPv4: 192.168.2.232
FULL_DUPLEX, 100Mbps
LittleFS Flag read = 0xD0D01234
doubleResetDetected
Saving config file...
Saving config file OK
Open Config Portal without Timeout: Double Reset Detected
Starting configuration portal @ 192.168.2.232
[EM] _configPortalStart millis() = 2325
[EM] Config Portal IP address = 192.168.2.232
[EM] HTTP server started
[EM] startConfigPortal : Enter loop
[EM] handleRoot
[EM] captivePortal: hostHeader = 192.168.2.232
[EM] Handle ETH
[EM] Static IP = 192.168.2.232
[EM] Sent config page
[EM] ETH save
[EM] TZ name = America/New_York
[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
ETH 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.233 , gatewayIP = 192.168.2.1
[EM] netMask = 255.255.255.0
[EM] dns1IP = 192.168.2.1 , dns2IP = 8.8.8.8
[EM] OK
Current IP = 192.168.2.232. Reset to take new IP = 192.168.2.233
ets Jun 8 2016 00:22:57
Starting ConfigOnDoubleReset_TZ using LittleFS on ESP32S3_DEV with ESP32_S3_W6100
ESP32_SC_W6100_Manager v1.0.0
ESP_DoubleResetDetector v1.3.2
[EM] Default SPI pinout:
[EM] SPI_HOST: 2
[EM] MOSI: 11
[EM] MISO: 13
[EM] SCK: 12
[EM] CS: 10
[EM] INT: 4
[EM] SPI Clock (MHz): 25
[EM] =========================
ETH Started
[EM] RFC925 Hostname = ConfigOnDoubleReset_TZ
[EM] setSTAStaticIPConfig
[EM] Set CORS Header to : Your Access-Control-Allow-Origin
[EM] LoadCfgFile
[EM] OK
[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
Got 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.233 , gatewayIP = 192.168.2.1
[EM] netMask = 255.255.255.0
[EM] dns1IP = 192.168.2.1 , dns2IP = 8.8.8.8
ETH Connected
ETH MAC: DE:AD:BE:EF:FE:0D, IPv4: 192.168.2.233
FULL_DUPLEX, 100Mbps
LittleFS Flag read = 0xD0D04321
No doubleResetDetected
Saving config file...
Saving config file OK
After waiting 0.00 secs more in setup(), connection result is connected. Local IP: 192.168.2.233
[EM] freeing allocated params!
Local Date/Time: Sat Jan 14 20:05:27 2023
Stop doubleResetDetecting
Saving config file...
Saving config file OK
Local Date/Time: Sat Jan 14 20:06:27 2023
Local Date/Time: Sat Jan 14 20:07:27 2023
Local Date/Time: Sat Jan 14 20:08:27 2023
Local Date/Time: Sat Jan 14 20:09:27 2023
This is terminal debug output when running ConfigOnSwichFS on ESP32_S3_W6100. Config Portal was requested to input and save Credentials.
Starting ConfigOnSwichFS using LittleFS on ESP32S3_DEV with ESP32_S3_W6100
ESP32_SC_W6100_Manager v1.0.0
[EM] Default SPI pinout:
[EM] SPI_HOST: 2
[EM] MOSI: 11
[EM] MISO: 13
[EM] SCK: 12
[EM] CS: 10
[EM] INT: 4
[EM] SPI Clock (MHz): 25
[EM] =========================
ETH Started
Configuration file not found
Failed 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.8
Got 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.8
ETH Connected
ETH MAC: DE:AD:BE:EF:FE:07, IPv4: 192.168.2.232
FULL_DUPLEX, 100Mbps
After waiting 0.00 secs more in setup(), connection result is connected. Local IP: 192.168.2.232
[EM] freeing allocated params!
Local Date/Time: Sat Jan 14 20:13:27 2023
Configuration portal requested.
[EM] RFC925 Hostname = ConfigOnSwitchFS
Opening 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.8
Got 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() = 67391
ETH 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] OK
Saving config file
{
"thingspeakApiKey": "API_Key",
"SensorDHT22": true,
"PinSda": 21,
"PinScl": 22
}
Config file was successfully saved
[EM] freeing allocated params!
Local Date/Time: Sat Jan 14 20:14:27 2023
Local Date/Time: Sat Jan 14 20:15:27 2023
Local Date/Time: Sat Jan 14 20:16:27 2023
Local Date/Time: Sat Jan 14 20:17:27 2023
This is terminal debug output when running ESP32_FSWebServer_DRD on ESP32_S3_W6100. Config Portal was requested by DRD (also using LittleFS) to input and save Credentials.
Starting ESP32_FSWebServer_DRD using LittleFS on ESP32S3_DEV with ESP32_S3_W6100
ESP32_SC_W6100_Manager v1.0.0
ESP_DoubleResetDetector v1.3.2
FS File: CanadaFlag_1.png, size: 40.25KB
FS File: CanadaFlag_2.png, size: 8.12KB
FS File: CanadaFlag_3.jpg, size: 10.89KB
FS File: drd.dat, size: 4B
FS File: edit.htm.gz, size: 4.02KB
FS File: eth_cred.dat, size: 142B
FS File: favicon.ico, size: 1.12KB
FS File: graphs.js.gz, size: 1.92KB
FS File: index.htm, size: 3.63KB
FS File: wifi_cred.dat, size: 142B
[EM] Default SPI pinout:
[EM] SPI_HOST: 2
[EM] MOSI: 11
[EM] MISO: 13
[EM] SCK: 12
[EM] CS: 10
[EM] INT: 4
[EM] SPI Clock (MHz): 25
[EM] =========================
ETH Started
[EM] RFC925 Hostname = ESP32-FSWebServer_DRD
[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.8
[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
ETH Connected
ETH MAC: DE:AD:BE:EF:FE:07, IPv4: 192.168.2.232
FULL_DUPLEX, 100Mbps
Got stored Credentials. Timeout 120s for Config Portal
LittleFS Flag read = 0xD0D04321
No doubleResetDetected
Saving config file...
Saving config file OK
After waiting 0.00 secs more in setup(), connection result is connected. Local IP: 192.168.2.232
HTTP server started @ 192.168.2.232
===============================================================
Open http://192.168.2.232/edit to see the file browser
Using username = admin and password = admin
===============================================================
[EM] freeing allocated params!
HStop doubleResetDetecting
Saving config file...
Saving config file OK
HHHHH HHHHHHHHHH HHHHHHHHHH HHHHHHHHHHDebug is enabled by default on Serial. To disable, add before startConfigPortal()
ESP32_SC_W6100_manager.setDebugOutput(false);You can also change the debugging level from 0 to 4
// Use from 0 to 4. Higher number, more debugging messages and memory usage.
#define _ESP32_ETH_MGR_LOGLEVEL_ 3If you get compilation errors, more often than not, you may need to install a newer version of the ESP32 core for Arduino.
Sometimes, the library will only work if you update the ESP32 core to the latest version because I am using some newly added function.
If you connect to the created configuration Access Point but the ConfigPortal does not show up, just open a browser and type in the IP of the web portal, by default 192.168.2.232.
Submit issues to: ESP32_SC_W6100_Manager issues
- Bug Searching and Killing
- Add support to
ESP32_S2/S3/C3-based boards usingLwIP W6100 Ethernet
- Based on and modified from Tzapu, KenTaylor's version, and
Khoi Hoang's ESP_WiFiManager.
 ⭐️ Tzapu |
 ⭐️ Ken Taylor |
If you want to contribute to this project:
- Report bugs and errors
- Ask for enhancements
- Create issues and pull requests
- Tell other people about this library
- The library is licensed under MIT
Copyright 2023- Khoi Hoang