{v}

/************************************************************** WiFiManager is a library for the ESP8266/Arduino platform (https://github.com/esp8266/Arduino) to enable easy configuration and reconfiguration of WiFi credentials using a Captive Portal inspired by: http://www.esp8266.com/viewtopic.php?f=29&t=2520 https://github.com/chriscook8/esp-arduino-apboot https://github.com/esp8266/Arduino/tree/esp8266/hardware/esp8266com/esp8266/libraries/DNSServer/examples/CaptivePortalAdvanced Built by AlexT https://github.com/tzapu Ported to Async Web Server by https://github.com/alanswx Licensed under MIT license **************************************************************/ #ifndef ESPAsyncWiFiManager_h #define ESPAsyncWiFiManager_h #if defined(ESP8266) #include // https://github.com/esp8266/Arduino #else #include #include "esp_wps.h" #define ESP_WPS_MODE WPS_TYPE_PBC #endif #include //#define USE_EADNS // uncomment to use ESPAsyncDNSServer #ifdef USE_EADNS #include // https://github.com/devyte/ESPAsyncDNSServer // https://github.com/me-no-dev/ESPAsyncUDP #else #include #endif #include // fix crash on ESP32 (see https://github.com/alanswx/ESPAsyncWiFiManager/issues/44) #if defined(ESP8266) typedef int wifi_ssid_count_t; #else typedef int16_t wifi_ssid_count_t; #endif #if defined(ESP8266) extern "C" { #include "user_interface.h" } #else #include #endif const char WFM_HTTP_HEAD[] PROGMEM = "{v}"; const char HTTP_STYLE[] PROGMEM = ""; const char HTTP_SCRIPT[] PROGMEM = ""; const char HTTP_HEAD_END[] PROGMEM = "

"; const char HTTP_PORTAL_OPTIONS[] PROGMEM = "

"; const char HTTP_ITEM[] PROGMEM = "

{v} {r}%

"; const char HTTP_FORM_START[] PROGMEM = ""; const char HTTP_SCAN_LINK[] PROGMEM = "

Scan

"; const char HTTP_SAVED[] PROGMEM = "

Credentials Saved
Trying to connect ESP to network.
If it fails reconnect to AP to try again

"; const char HTTP_END[] PROGMEM = "

"; #define WIFI_MANAGER_MAX_PARAMS 10 class AsyncWiFiManagerParameter { public: AsyncWiFiManagerParameter(const char *custom); AsyncWiFiManagerParameter(const char *id, const char *placeholder, const char *defaultValue, unsigned int length); AsyncWiFiManagerParameter(const char *id, const char *placeholder, const char *defaultValue, unsigned int length, const char *custom); const char *getID(); const char *getValue(); const char *getPlaceholder(); unsigned int getValueLength(); const char *getCustomHTML(); private: const char *_id; const char *_placeholder; char *_value; unsigned int _length; const char *_customHTML; void init(const char *id, const char *placeholder, const char *defaultValue, unsigned int length, const char *custom); friend class AsyncWiFiManager; }; class WiFiResult { public: bool duplicate; String SSID; uint8_t encryptionType; int32_t RSSI; uint8_t *BSSID; int32_t channel; bool isHidden; WiFiResult() { } }; class AsyncWiFiManager { public: #ifdef USE_EADNS AsyncWiFiManager(AsyncWebServer *server, AsyncDNSServer *dns); #else AsyncWiFiManager(AsyncWebServer *server, DNSServer *dns); #endif void scan(boolean async = false); String scanModal(); void loop(); void safeLoop(); void criticalLoop(); String infoAsString(); boolean autoConnect(unsigned long maxConnectRetries = 1, unsigned long retryDelayMs = 1000); boolean autoConnect(char const *apName, char const *apPassword = NULL, unsigned long maxConnectRetries = 1, unsigned long retryDelayMs = 1000); // if you want to always start the config portal, without trying to connect first boolean startConfigPortal(char const *apName, char const *apPassword = NULL); void startConfigPortalModeless(char const *apName, char const *apPassword); // get the AP name of the config portal, so it can be used in the callback String getConfigPortalSSID(); 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(unsigned long seconds); void setTimeout(unsigned long seconds); // sets timeout for which to attempt connecting, usefull if you get a lot of failed connects void setConnectTimeout(unsigned long seconds); // wether or not the wifi manager tries to connect to configured access point even when // configuration portal (ESP as access point) is running [default true/on] void setTryConnectDuringConfigPortal(boolean v); void setDebugOutput(boolean debug); // defaults to not showing anything under 8% signal quality if called void setMinimumSignalQuality(unsigned int quality = 8); // sets a custom ip /gateway /subnet configuration void setAPStaticIPConfig(IPAddress ip, IPAddress gw, IPAddress sn); // sets config for a static IP void setSTAStaticIPConfig(IPAddress ip, IPAddress gw, IPAddress sn, IPAddress dns1 = (uint32_t)0x00000000, IPAddress dns2 = (uint32_t)0x00000000); // called when AP mode and config portal is started void setAPCallback(std::function); // called when settings have been changed and connection was successful void setSaveConfigCallback(std::function func); void setConnectCallback(std::function func); void setDisconnectCallback(std::function func); //adds a custom parameter void addParameter(AsyncWiFiManagerParameter *p); // if this is set, it will exit after config, even if connection is unsucessful void setBreakAfterConfig(boolean 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(boolean removeDuplicates); // sets a custom element to add to options page void setCustomOptionsElement(const char *element); String getConfiguredSTASSID(){ return _ssid; } String getConfiguredSTAPassword(){ return _pass; } void handleWifi(AsyncWebServerRequest *, boolean scan); void handleWifiSave(AsyncWebServerRequest *); void setupConfig(); private: AsyncWebServer *server; #ifdef USE_EADNS AsyncDNSServer *dnsServer; #else DNSServer *dnsServer; #endif boolean _modeless; unsigned long scannow; boolean shouldscan = true; boolean needInfo = true; //const int WM_DONE = 0; //const int WM_WAIT = 10; //const String HTTP_HEAD = "{v}"; void setupConfigPortal(); #ifdef NO_EXTRA_4K_HEAP void startWPS(); #endif String pager; wl_status_t wifiStatus; const char *_apName = "no-net"; const char *_apPassword = NULL; String _ssid = ""; String _pass = ""; unsigned long _configPortalTimeout = 0; unsigned long _connectTimeout = 0; unsigned long _configPortalStart = 0; IPAddress _ap_static_ip; IPAddress _ap_static_gw; IPAddress _ap_static_sn; IPAddress _sta_static_ip; IPAddress _sta_static_gw; IPAddress _sta_static_sn; IPAddress _sta_static_dns1 = (uint32_t)0x00000000; IPAddress _sta_static_dns2 = (uint32_t)0x00000000; unsigned int _paramsCount = 0; unsigned int _minimumQuality = 0; boolean _removeDuplicateAPs = true; boolean _shouldBreakAfterConfig = false; #ifdef NO_EXTRA_4K_HEAP boolean _tryWPS = false; #endif const char *_customHeadElement = ""; const char *_customOptionsElement = ""; //String getEEPROMString(int start, int len); //void setEEPROMString(int start, int len, String string); uint8_t status = WL_IDLE_STATUS; uint8_t connectWifi(String ssid, String pass); uint8_t waitForConnectResult(); void setInfo(); void copySSIDInfo(wifi_ssid_count_t n); String networkListAsString(); void handleRoot(AsyncWebServerRequest *); void handleInfo(AsyncWebServerRequest *); void handleReset(AsyncWebServerRequest *); void handleNotFound(AsyncWebServerRequest *); boolean captivePortal(AsyncWebServerRequest *); // DNS server const byte DNS_PORT = 53; // helpers unsigned int getRSSIasQuality(int RSSI); boolean isIp(String str); String toStringIp(IPAddress ip); boolean connect; boolean _debug = false; WiFiResult *wifiSSIDs; wifi_ssid_count_t wifiSSIDCount; boolean wifiSSIDscan; boolean _tryConnectDuringConfigPortal = true; std::function _apcallback; std::function _savecallback; std::function _connectcallback; std::function _disconnectcallback; AsyncWiFiManagerParameter *_params[WIFI_MANAGER_MAX_PARAMS]; 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 { DEBUG_WM(F("NO fromString METHOD ON IPAddress, you need ESP8266 core 2.1.0 or newer for Custom IP configuration to work.")); return false; } }; #endif