{v}

"; const char WM_FLDSET_START[] PROGMEM = "

"; const char WM_FLDSET_END[] PROGMEM = "

"; ////// const char WM_HTTP_PORTAL_OPTIONS[] PROGMEM = "

"; const char WM_HTTP_ITEM[] PROGMEM = "

{v} {r}%

"; const char JSON_ITEM[] PROGMEM = "{\"SSID\":\"{v}\", \"Encryption\":{i}, \"Quality\":\"{r}\"}"; // KH, update from v1.1.0 const char WM_HTTP_FORM_START[] PROGMEM = ""; // KH, update from v1.1.0 const char WM_HTTP_SAVED[] PROGMEM = "

Credentials Saved
Try connecting ESP to the {x}/{x1} network. Wait around 10 seconds then check if it's OK.

The {v} AP will run on the same WiFi channel of the {x}/{x1} AP. You may have to manually reconnect to the {v} AP.

"; ////// const char WM_HTTP_END[] PROGMEM = "

"; //KH, from v1.1.0 const char WM_HTTP_HEAD_CL[] PROGMEM = "Content-Length"; const char WM_HTTP_HEAD_CT[] PROGMEM = "text/html"; const char WM_HTTP_HEAD_CT2[] PROGMEM = "text/plain"; //KH Add repeatedly used const const char WM_HTTP_CACHE_CONTROL[] PROGMEM = "Cache-Control"; const char WM_HTTP_NO_STORE[] PROGMEM = "no-cache, no-store, must-revalidate"; const char WM_HTTP_PRAGMA[] PROGMEM = "Pragma"; const char WM_HTTP_NO_CACHE[] PROGMEM = "no-cache"; const char WM_HTTP_EXPIRES[] PROGMEM = "Expires"; const char WM_HTTP_CORS[] PROGMEM = "Access-Control-Allow-Origin"; const char WM_HTTP_CORS_ALLOW_ALL[] PROGMEM = "*"; #if USE_AVAILABLE_PAGES const char WM_HTTP_AVAILABLE_PAGES[] PROGMEM = "

Available Pages

Page	Function
/	Menu page.
/wifi	Show WiFi scan results and enter WiFi configuration.
/wifisave	Save WiFi configuration information and configure device. Needs variables supplied.
/close	Close the configuration server and configuration WiFi network.
/i	This page.
/r	Delete WiFi configuration and reboot. ESP device will not reconnect to a network until new WiFi configuration data is entered.
/state	Current device state in JSON format. Interface for programmatic WiFi configuration.
/scan	Run a WiFi scan and return results in JSON format. Interface for programmatic WiFi configuration.

"; #else const char WM_HTTP_AVAILABLE_PAGES[] PROGMEM = ""; #endif //KH #define WIFI_MANAGER_MAX_PARAMS 20 ///////////////////////////////////////////////////////////////////////////// // New in v1.4.0 typedef struct { const char *_id; const char *_placeholder; char *_value; int _length; int _labelPlacement; } WMParam_Data; ////// class ESP_WMParameter { public: ESP_WMParameter(const char *custom); ESP_WMParameter(const char *id, const char *placeholder, const char *defaultValue, const int& length, const char *custom = "", const int& labelPlacement = WFM_LABEL_BEFORE); // New in v1.4.0 ESP_WMParameter(const WMParam_Data& WMParam_data); ////// ~ESP_WMParameter(); // New in v1.4.0 void setWMParam_Data(const WMParam_Data& WMParam_data); void getWMParam_Data(WMParam_Data& WMParam_data); ////// const char *getID(); const char *getValue(); const char *getPlaceholder(); int getValueLength(); int getLabelPlacement(); const char *getCustomHTML(); private: WMParam_Data _WMParam_data; const char *_customHTML; void init(const char *id, const char *placeholder, const char *defaultValue, const int& length, const char *custom, const int& labelPlacement); friend class ESP_WiFiManager; }; #define USE_DYNAMIC_PARAMS true #define DEFAULT_PORTAL_TIMEOUT 60000L // From v1.0.10 to permit disable/enable StaticIP configuration in Config Portal from sketch. Valid only if DHCP is used. // You have to explicitly specify false to disable the feature. #ifndef USE_STATIC_IP_CONFIG_IN_CP #define USE_STATIC_IP_CONFIG_IN_CP true #endif class ESP_WiFiManager { public: ESP_WiFiManager(const char *iHostname = ""); ~ESP_WiFiManager(); // Update feature from v1.0.11. Can use with STA staticIP now bool autoConnect(); bool autoConnect(char const *apName, char const *apPassword = NULL); ////// //if you want to start the config portal bool startConfigPortal(); bool startConfigPortal(char const *apName, char const *apPassword = NULL); // get the AP name of the config portal, so it can be used in the callback String getConfigPortalSSID(); // get the AP password of the config portal, so it can be used in the callback String getConfigPortalPW(); void resetSettings(); //sets timeout before webserver loop ends and exits even if there has been no setup. //usefully for devices that failed to connect at some point and got stuck in a webserver loop //in seconds setConfigPortalTimeout is a new name for setTimeout void setConfigPortalTimeout(const unsigned long& seconds); void setTimeout(const unsigned long& seconds); //sets timeout for which to attempt connecting, usefull if you get a lot of failed connects void setConnectTimeout(const unsigned long& seconds); void setDebugOutput(bool debug); //defaults to not showing anything under 8% signal quality if called void setMinimumSignalQuality(const int& quality = 8); // KH, new from v1.0.10 to enable dynamic/random channel int setConfigPortalChannel(const int& channel = 1); ////// //sets a custom ip /gateway /subnet configuration void setAPStaticIPConfig(const IPAddress& ip, const IPAddress& gw, const IPAddress& sn); // New in v1.4.0 void setAPStaticIPConfig(const WiFi_AP_IPConfig& WM_AP_IPconfig); void getAPStaticIPConfig(WiFi_AP_IPConfig& WM_AP_IPconfig); ////// //sets config for a static IP void setSTAStaticIPConfig(const IPAddress& ip, const IPAddress& gw, const IPAddress& sn); // New in v1.4.0 void setSTAStaticIPConfig(const WiFi_STA_IPConfig& WM_STA_IPconfig); void getSTAStaticIPConfig(WiFi_STA_IPConfig& WM_STA_IPconfig); ////// #if USE_CONFIGURABLE_DNS void setSTAStaticIPConfig(const IPAddress& ip, const IPAddress& gw, const IPAddress& sn, const IPAddress& dns_address_1, const IPAddress& dns_address_2); #endif //called when AP mode and config portal is started void setAPCallback(void(*func)(ESP_WiFiManager*)); //called when settings have been changed and connection was successful void setSaveConfigCallback(void(*func)()); #if USE_DYNAMIC_PARAMS //adds a custom parameter bool addParameter(ESP_WMParameter *p); #else //adds a custom parameter void addParameter(ESP_WMParameter *p); #endif //if this is set, it will exit after config, even if connection is unsucessful. void setBreakAfterConfig(bool shouldBreak); //if this is set, try WPS setup when starting (this will delay config portal for up to 2 mins) //TODO //if this is set, customise style void setCustomHeadElement(const char* element); //if this is true, remove duplicated Access Points - defaut true void setRemoveDuplicateAPs(bool removeDuplicates); //Scan for WiFiNetworks in range and sort by signal strength //space for indices array allocated on the heap and should be freed when no longer required int scanWifiNetworks(int **indicesptr); // return SSID of router in STA mode got from config portal. NULL if no user's input //KH String getSSID() { return _ssid; } // return password of router in STA mode got from config portal. NULL if no user's input //KH String getPW() { return _pass; } // New from v1.1.0 // return SSID of router in STA mode got from config portal. NULL if no user's input //KH String getSSID1() { return _ssid1; } // return password of router in STA mode got from config portal. NULL if no user's input //KH String getPW1() { return _pass1; } #define MAX_WIFI_CREDENTIALS 2 String getSSID(const uint8_t& index) { if (index == 0) return _ssid; else if (index == 1) return _ssid1; else return String(""); } String getPW(const uint8_t& index) { if (index == 0) return _pass; else if (index == 1) return _pass1; else return String(""); } ////// // New from v1.1.1, for configure CORS Header, default to WM_HTTP_CORS_ALLOW_ALL = "*" #if USING_CORS_FEATURE void setCORSHeader(const char* CORSHeaders) { _CORS_Header = CORSHeaders; LOGWARN1(F("Set CORS Header to : "), _CORS_Header); } const char* getCORSHeader() { return _CORS_Header; } #endif //returns the list of Parameters ESP_WMParameter** getParameters(); // returns the Parameters Count int getParametersCount(); const char* getStatus(const int& status); #ifdef ESP32 String getStoredWiFiSSID(); String getStoredWiFiPass(); #endif String WiFi_SSID() { #ifdef ESP8266 return WiFi.SSID(); #else return getStoredWiFiSSID(); #endif } String WiFi_Pass() { #ifdef ESP8266 return WiFi.psk(); #else return getStoredWiFiPass(); #endif } void setHostname() { if (RFC952_hostname[0] != 0) { #if ESP8266 WiFi.hostname(RFC952_hostname); #else // 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) ) WiFi.setHostname(RFC952_hostname); #else // Still have bug in ESP32_S2 for old core. If using WiFi.setHostname() => WiFi.localIP() always = 255.255.255.255 if ( String(ARDUINO_BOARD) != "ESP32S2_DEV" ) { // See https://github.com/espressif/arduino-esp32/issues/2537 WiFi.config(INADDR_NONE, INADDR_NONE, INADDR_NONE); WiFi.setHostname(RFC952_hostname); } #endif #endif } } #if USE_ESP_WIFIMANAGER_NTP String getTimezoneName() { return _timezoneName; } void setTimezoneName(const String& inTimezoneName) { _timezoneName = inTimezoneName; } ////// //See: https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html // 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 const char * getTZ(const char * timezoneName) { //const char TZ_NAME[][TIMEZONE_MAX_LEN] for (uint16_t index = 0; index < sizeof(TZ_NAME) / TIMEZONE_MAX_LEN; index++) { if ( !strncmp(timezoneName, (TZ_NAME[index]), strlen((TZ_NAME[index])) ) ) { yield(); return (ESP_TZ_NAME[index]); } } return ""; } const char * getTZ(const String& timezoneName) { return getTZ(timezoneName.c_str()); } #endif private: std::unique_ptr dnsServer; //KH, for ESP32 #ifdef ESP8266 std::unique_ptr server; #else //ESP32 std::unique_ptr server; #endif #define RFC952_HOSTNAME_MAXLEN 24 char RFC952_hostname[RFC952_HOSTNAME_MAXLEN + 1]; char* getRFC952_hostname(const char* iHostname); void setupConfigPortal(); void startWPS(); //const char* getStatus(const int& status); const char* _apName = "no-net"; const char* _apPassword = NULL; String _ssid = ""; String _pass = ""; // New from v1.1.0 String _ssid1 = ""; String _pass1 = ""; ////// #if USE_ESP_WIFIMANAGER_NTP // Timezone info String _timezoneName = ""; #endif unsigned long _configPortalTimeout = 0; unsigned long _connectTimeout = 0; unsigned long _configPortalStart = 0; int numberOfNetworks; int *networkIndices; // KH, new from v1.0.10 to enable dynamic/random channel // default to channel 1 #define MIN_WIFI_CHANNEL 1 #define MAX_WIFI_CHANNEL 11 // Channel 12,13 is flaky, because of bad number 13 ;-) int _WiFiAPChannel = 1; ////// // New in v1.4.0 WiFi_AP_IPConfig _WiFi_AP_IPconfig; WiFi_STA_IPConfig _WiFi_STA_IPconfig = { IPAddress(0, 0, 0, 0), IPAddress(192, 168, 2, 1), IPAddress(255, 255, 255, 0), IPAddress(192, 168, 2, 1), IPAddress(8, 8, 8, 8) }; ////// int _paramsCount = 0; int _minimumQuality = -1; bool _removeDuplicateAPs = true; bool _shouldBreakAfterConfig = false; bool _tryWPS = false; const char* _customHeadElement = ""; int status = WL_IDLE_STATUS; // New from v1.1.0, for configure CORS Header, default to WM_HTTP_CORS_ALLOW_ALL = "*" #if USING_CORS_FEATURE const char* _CORS_Header = WM_HTTP_CORS_ALLOW_ALL; //"*"; #endif ////// // New v1.0.8 void setWifiStaticIP(); // New v1.1.0 int reconnectWifi(); ////// // New v1.0.11 int connectWifi(const String& ssid = "", const String& pass = ""); ////// uint8_t waitForConnectResult(); void handleRoot(); void handleWifi(); void handleWifiSave(); void handleServerClose(); void handleInfo(); void handleState(); void handleScan(); void handleReset(); void handleNotFound(); bool captivePortal(); void reportStatus(String& page); // DNS server const byte DNS_PORT = 53; //helpers int getRSSIasQuality(const int& RSSI); bool isIp(const String& str); String toStringIp(const IPAddress& ip); bool connect; bool stopConfigPortal = false; bool _debug = false; //true; void(*_apcallback) (ESP_WiFiManager*) = NULL; void(*_savecallback)() = NULL; #if USE_DYNAMIC_PARAMS int _max_params; ESP_WMParameter** _params; #else ESP_WMParameter* _params[WIFI_MANAGER_MAX_PARAMS]; #endif template void DEBUG_WM(Generic text); template auto optionalIPFromString(T *obj, const char *s) -> decltype(obj->fromString(s)) { return obj->fromString(s); } auto optionalIPFromString(...) -> bool { LOGINFO("NO fromString METHOD ON IPAddress, you need ESP8266 core 2.1.0 or newer for Custom IP configuration to work."); return false; } }; #endif // ESP_WiFiManager_h