/************************************************************** 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/master/libraries/DNSServer/examples/CaptivePortalAdvanced Built by AlexT https://github.com/tzapu Licensed under MIT license **************************************************************/ #include "WiFiManager.h" WiFiManagerParameter::WiFiManagerParameter(const char *custom) { _id = NULL; _placeholder = NULL; _length = 0; _value = NULL; _customHTML = custom; } WiFiManagerParameter::WiFiManagerParameter(const char *id, const char *placeholder, const char *defaultValue, int length) { init(id, placeholder, defaultValue, length, ""); } WiFiManagerParameter::WiFiManagerParameter(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom) { init(id, placeholder, defaultValue, length, custom); } void WiFiManagerParameter::init(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom) { _id = id; _placeholder = placeholder; _length = length; _value = new char[length + 1]; for (int i = 0; i < length + 1; i++) { _value[i] = 0; } if (defaultValue != NULL) { strncpy(_value, defaultValue, length); } _customHTML = custom; } WiFiManagerParameter::~WiFiManagerParameter() { if (_value != NULL) { delete[] _value; } } const char* WiFiManagerParameter::getValue() { return _value; } const char* WiFiManagerParameter::getID() { return _id; } const char* WiFiManagerParameter::getPlaceholder() { return _placeholder; } int WiFiManagerParameter::getValueLength() { return _length; } const char* WiFiManagerParameter::getCustomHTML() { return _customHTML; } WiFiManager::WiFiManager() { _max_params = WIFI_MANAGER_MAX_PARAMS; _params = (WiFiManagerParameter**)malloc(_max_params * sizeof(WiFiManagerParameter*)); } WiFiManager::~WiFiManager() { if (_params != NULL) { DEBUG_WM(F("freeing allocated params!")); free(_params); } } bool WiFiManager::addParameter(WiFiManagerParameter *p) { if(_paramsCount + 1 > _max_params) { // rezise the params array _max_params += WIFI_MANAGER_MAX_PARAMS; DEBUG_WM(F("Increasing _max_params to:")); DEBUG_WM(_max_params); WiFiManagerParameter** new_params = (WiFiManagerParameter**)realloc(_params, _max_params * sizeof(WiFiManagerParameter*)); if (new_params != NULL) { _params = new_params; } else { DEBUG_WM(F("ERROR: failed to realloc params, size not increased!")); return false; } } _params[_paramsCount] = p; _paramsCount++; DEBUG_WM(F("Adding parameter")); DEBUG_WM(p->getID()); return true; } void WiFiManager::setupConfigPortal() { dnsServer.reset(new DNSServer()); server.reset(new ESP8266WebServer(80)); DEBUG_WM(F("")); _configPortalStart = millis(); DEBUG_WM(F("Configuring access point... ")); DEBUG_WM(_apName); if (_apPassword != NULL) { if (strlen(_apPassword) < 8 || strlen(_apPassword) > 63) { // fail passphrase to short or long! DEBUG_WM(F("Invalid AccessPoint password. Ignoring")); _apPassword = NULL; } DEBUG_WM(_apPassword); } //optional soft ip config if (_ap_static_ip) { DEBUG_WM(F("Custom AP IP/GW/Subnet")); WiFi.softAPConfig(_ap_static_ip, _ap_static_gw, _ap_static_sn); } if (_apPassword != NULL) { WiFi.softAP(_apName, _apPassword);//password option } else { WiFi.softAP(_apName); } delay(500); // Without delay I've seen the IP address blank DEBUG_WM(F("AP IP address: ")); DEBUG_WM(WiFi.softAPIP()); /* Setup the DNS server redirecting all the domains to the apIP */ dnsServer->setErrorReplyCode(DNSReplyCode::NoError); dnsServer->start(DNS_PORT, "*", WiFi.softAPIP()); /* Setup web pages: root, wifi config pages, SO captive portal detectors and not found. */ server->on(String(F("/")).c_str(), std::bind(&WiFiManager::handleRoot, this)); server->on(String(F("/wifi")).c_str(), std::bind(&WiFiManager::handleWifi, this, true)); server->on(String(F("/0wifi")).c_str(), std::bind(&WiFiManager::handleWifi, this, false)); server->on(String(F("/wifisave")).c_str(), std::bind(&WiFiManager::handleWifiSave, this)); server->on(String(F("/i")).c_str(), std::bind(&WiFiManager::handleInfo, this)); server->on(String(F("/r")).c_str(), std::bind(&WiFiManager::handleReset, this)); //server->on("/generate_204", std::bind(&WiFiManager::handle204, this)); //Android/Chrome OS captive portal check. server->on(String(F("/fwlink")).c_str(), std::bind(&WiFiManager::handleRoot, this)); //Microsoft captive portal. Maybe not needed. Might be handled by notFound handler. server->onNotFound (std::bind(&WiFiManager::handleNotFound, this)); server->begin(); // Web server start DEBUG_WM(F("HTTP server started")); } boolean WiFiManager::autoConnect() { String ssid = "ESP" + String(ESP.getChipId()); return autoConnect(ssid.c_str(), NULL); } boolean WiFiManager::autoConnect(char const *apName, char const *apPassword) { DEBUG_WM(F("")); DEBUG_WM(F("AutoConnect")); // read eeprom for ssid and pass //String ssid = getSSID(); //String pass = getPassword(); // attempt to connect; should it fail, fall back to AP WiFi.mode(WIFI_STA); if (connectWifi("", "") == WL_CONNECTED) { DEBUG_WM(F("IP Address:")); DEBUG_WM(WiFi.localIP()); //connected return true; } return startConfigPortal(apName, apPassword); } boolean WiFiManager::configPortalHasTimeout(){ if(_configPortalTimeout == 0 || wifi_softap_get_station_num() > 0){ _configPortalStart = millis(); // kludge, bump configportal start time to skew timeouts return false; } return (millis() > _configPortalStart + _configPortalTimeout); } boolean WiFiManager::startConfigPortal() { String ssid = "ESP" + String(ESP.getChipId()); return startConfigPortal(ssid.c_str(), NULL); } boolean WiFiManager::startConfigPortal(char const *apName, char const *apPassword) { if(!WiFi.isConnected()){ WiFi.persistent(false); // disconnect sta, start ap WiFi.disconnect(); // this alone is not enough to stop the autoconnecter WiFi.mode(WIFI_AP); WiFi.persistent(true); } else { //setup AP WiFi.mode(WIFI_AP_STA); DEBUG_WM(F("SET AP STA")); } _apName = apName; _apPassword = apPassword; //notify we entered AP mode if ( _apcallback != NULL) { _apcallback(this); } connect = false; setupConfigPortal(); while(1){ // check if timeout if(configPortalHasTimeout()) break; //DNS dnsServer->processNextRequest(); //HTTP server->handleClient(); if (connect) { delay(1000); connect = false; // if saving with no ssid filled in, reconnect to ssid // will not exit cp if(_ssid == ""){ DEBUG_WM(F("No ssid, skipping wifi")); } else{ DEBUG_WM(F("Connecting to new AP")); if (connectWifi(_ssid, _pass) != WL_CONNECTED) { delay(2000); // using user-provided _ssid, _pass in place of system-stored ssid and pass DEBUG_WM(F("Failed to connect.")); } else { //connected WiFi.mode(WIFI_STA); //notify that configuration has changed and any optional parameters should be saved if ( _savecallback != NULL) { //todo: check if any custom parameters actually exist, and check if they really changed maybe _savecallback(); } break; } } if (_shouldBreakAfterConfig) { //flag set to exit after config after trying to connect //notify that configuration has changed and any optional parameters should be saved if ( _savecallback != NULL) { //todo: check if any custom parameters actually exist, and check if they really changed maybe _savecallback(); } WiFi.mode(WIFI_STA); // turn off ap // reconnect to ssid // int res = WiFi.begin(); // attempt connect for 10 seconds DEBUG_WM(F("Waiting for sta (10 secs) .......")); for(size_t i = 0 ; i<100;i++){ if(WiFi.status() == WL_CONNECTED) break; DEBUG_WM("."); // Serial.println(WiFi.status()); delay(100); } delay(1000); break; } } yield(); } server.reset(); dnsServer.reset(); return WiFi.status() == WL_CONNECTED; } int WiFiManager::connectWifi(String ssid, String pass) { DEBUG_WM(F("Connecting as wifi client...")); // check if we've got static_ip settings, if we do, use those. if (_sta_static_ip) { DEBUG_WM(F("Custom STA IP/GW/Subnet")); WiFi.config(_sta_static_ip, _sta_static_gw, _sta_static_sn); DEBUG_WM(WiFi.localIP()); } //fix for auto connect racing issue if (WiFi.status() == WL_CONNECTED && (WiFi.SSID() == ssid)) { DEBUG_WM(F("Already connected. Bailing out.")); return WL_CONNECTED; } DEBUG_WM(F("Status:")); DEBUG_WM(WiFi.status()); wl_status_t res; //check if we have ssid and pass and force those, if not, try with last saved values if (ssid != "") { //trying to fix connection in progress hanging ETS_UART_INTR_DISABLE(); wifi_station_disconnect(); ETS_UART_INTR_ENABLE(); res = WiFi.begin(ssid.c_str(), pass.c_str(),0,NULL,true); if(res != WL_CONNECTED){ DEBUG_WM(F("[ERROR] WiFi.begin res:")); DEBUG_WM(res); } } else { if (WiFi.SSID() != "") { DEBUG_WM(F("Using last saved values, should be faster")); //trying to fix connection in progress hanging ETS_UART_INTR_DISABLE(); wifi_station_disconnect(); ETS_UART_INTR_ENABLE(); res = WiFi.begin(); } else { DEBUG_WM(F("No saved credentials")); } } int connRes = waitForConnectResult(); DEBUG_WM ("Connection result: "); DEBUG_WM ( connRes ); //not connected, WPS enabled, no pass - first attempt #ifdef NO_EXTRA_4K_HEAP if (_tryWPS && connRes != WL_CONNECTED && pass == "") { startWPS(); //should be connected at the end of WPS connRes = waitForConnectResult(); } #endif return connRes; } uint8_t WiFiManager::waitForConnectResult() { if (_connectTimeout == 0) { return WiFi.waitForConnectResult(); } else { DEBUG_WM (F("Waiting for connection result with time out")); unsigned long start = millis(); boolean keepConnecting = true; uint8_t status; while (keepConnecting) { status = WiFi.status(); if (millis() > start + _connectTimeout) { keepConnecting = false; DEBUG_WM (F("Connection timed out")); } if (status == WL_CONNECTED) { keepConnecting = false; } delay(100); } return status; } } void WiFiManager::startWPS() { DEBUG_WM(F("START WPS")); WiFi.beginWPSConfig(); DEBUG_WM(F("END WPS")); } /* String WiFiManager::getSSID() { if (_ssid == "") { DEBUG_WM(F("Reading SSID")); _ssid = WiFi.SSID(); DEBUG_WM(F("SSID: ")); DEBUG_WM(_ssid); } return _ssid; } String WiFiManager::getPassword() { if (_pass == "") { DEBUG_WM(F("Reading Password")); _pass = WiFi.psk(); DEBUG_WM("Password: " + _pass); //DEBUG_WM(_pass); } return _pass; } */ String WiFiManager::getConfigPortalSSID() { return _apName; } void WiFiManager::resetSettings() { DEBUG_WM(F("settings invalidated")); DEBUG_WM(F("THIS MAY CAUSE AP NOT TO START UP PROPERLY. YOU NEED TO COMMENT IT OUT AFTER ERASING THE DATA.")); WiFi.disconnect(true); //delay(200); } void WiFiManager::setTimeout(unsigned long seconds) { setConfigPortalTimeout(seconds); } void WiFiManager::setConfigPortalTimeout(unsigned long seconds) { _configPortalTimeout = seconds * 1000; } void WiFiManager::setConnectTimeout(unsigned long seconds) { _connectTimeout = seconds * 1000; } void WiFiManager::setDebugOutput(boolean debug) { _debug = debug; } void WiFiManager::setAPStaticIPConfig(IPAddress ip, IPAddress gw, IPAddress sn) { _ap_static_ip = ip; _ap_static_gw = gw; _ap_static_sn = sn; } void WiFiManager::setSTAStaticIPConfig(IPAddress ip, IPAddress gw, IPAddress sn) { _sta_static_ip = ip; _sta_static_gw = gw; _sta_static_sn = sn; } void WiFiManager::setMinimumSignalQuality(int quality) { _minimumQuality = quality; } void WiFiManager::setBreakAfterConfig(boolean shouldBreak) { _shouldBreakAfterConfig = shouldBreak; } /** Handle root or redirect to captive portal */ void WiFiManager::handleRoot() { DEBUG_WM(F("Handle root")); if (captivePortal()) { // If caprive portal redirect instead of displaying the page. return; } String page = FPSTR(HTTP_HEADER); page.replace("{v}", "Options"); page += FPSTR(HTTP_SCRIPT); page += FPSTR(HTTP_STYLE); page += _customHeadElement; page += FPSTR(HTTP_HEADER_END); page += String(F("

")); page += _apName; page += String(F("

")); page += String(F("

WiFiManager

")); page += FPSTR(HTTP_PORTAL_OPTIONS); page += FPSTR(HTTP_END); server->sendHeader("Content-Length", String(page.length())); server->send(200, "text/html", page); } /** Wifi config page handler */ void WiFiManager::handleWifi(boolean scan) { String page = FPSTR(HTTP_HEADER); page.replace("{v}", "Config ESP"); page += FPSTR(HTTP_SCRIPT); page += FPSTR(HTTP_STYLE); page += _customHeadElement; page += FPSTR(HTTP_HEADER_END); if (scan) { int n = WiFi.scanNetworks(); DEBUG_WM(F("Scan done")); if (n == 0) { DEBUG_WM(F("No networks found")); page += F("No networks found. Refresh to scan again."); } else { //sort networks int indices[n]; for (int i = 0; i < n; i++) { indices[i] = i; } // RSSI SORT // old sort for (int i = 0; i < n; i++) { for (int j = i + 1; j < n; j++) { if (WiFi.RSSI(indices[j]) > WiFi.RSSI(indices[i])) { std::swap(indices[i], indices[j]); } } } /*std::sort(indices, indices + n, [](const int & a, const int & b) -> bool { return WiFi.RSSI(a) > WiFi.RSSI(b); });*/ // remove duplicates ( must be RSSI sorted ) if (_removeDuplicateAPs) { String cssid; for (int i = 0; i < n; i++) { if (indices[i] == -1) continue; cssid = WiFi.SSID(indices[i]); for (int j = i + 1; j < n; j++) { if (cssid == WiFi.SSID(indices[j])) { DEBUG_WM("DUP AP: " + WiFi.SSID(indices[j])); indices[j] = -1; // set dup aps to index -1 } } } } //display networks in page for (int i = 0; i < n; i++) { if (indices[i] == -1) continue; // skip dups DEBUG_WM(WiFi.SSID(indices[i])); DEBUG_WM(WiFi.RSSI(indices[i])); int quality = getRSSIasQuality(WiFi.RSSI(indices[i])); if (_minimumQuality == -1 || _minimumQuality < quality) { String item = FPSTR(HTTP_ITEM); String rssiQ; rssiQ += quality; item.replace("{v}", WiFi.SSID(indices[i])); item.replace("{r}", rssiQ); if (WiFi.encryptionType(indices[i]) != ENC_TYPE_NONE) { item.replace("{i}", "l"); } else { item.replace("{i}", ""); } //DEBUG_WM(item); page += item; delay(0); } else { DEBUG_WM(F("Skipping due to quality")); } } page += "
"; } } page += FPSTR(HTTP_FORM_START); char parLength[5]; // add the extra parameters to the form for (int i = 0; i < _paramsCount; i++) { if (_params[i] == NULL) { break; } String pitem = FPSTR(HTTP_FORM_PARAM); if (_params[i]->getID() != NULL) { pitem.replace("{i}", _params[i]->getID()); pitem.replace("{n}", _params[i]->getID()); pitem.replace("{p}", _params[i]->getPlaceholder()); snprintf(parLength, 5, "%d", _params[i]->getValueLength()); pitem.replace("{l}", parLength); pitem.replace("{v}", _params[i]->getValue()); pitem.replace("{c}", _params[i]->getCustomHTML()); } else { pitem = _params[i]->getCustomHTML(); } page += pitem; } if (_params[0] != NULL) { page += "
"; } if (_sta_static_ip) { String item = FPSTR(HTTP_FORM_PARAM); item.replace("{i}", "ip"); item.replace("{n}", "ip"); item.replace("{p}", "Static IP"); item.replace("{l}", "15"); item.replace("{v}", _sta_static_ip.toString()); page += item; item = FPSTR(HTTP_FORM_PARAM); item.replace("{i}", "gw"); item.replace("{n}", "gw"); item.replace("{p}", "Static Gateway"); item.replace("{l}", "15"); item.replace("{v}", _sta_static_gw.toString()); page += item; item = FPSTR(HTTP_FORM_PARAM); item.replace("{i}", "sn"); item.replace("{n}", "sn"); item.replace("{p}", "Subnet"); item.replace("{l}", "15"); item.replace("{v}", _sta_static_sn.toString()); page += item; page += "
"; } page += FPSTR(HTTP_FORM_END); page += FPSTR(HTTP_SCAN_LINK); page += FPSTR(HTTP_END); server->sendHeader("Content-Length", String(page.length())); server->send(200, "text/html", page); DEBUG_WM(F("Sent config page")); } /** Handle the WLAN save form and redirect to WLAN config page again */ void WiFiManager::handleWifiSave() { DEBUG_WM(F("WiFi save")); //SAVE/connect here _ssid = server->arg("s").c_str(); _pass = server->arg("p").c_str(); //parameters for (int i = 0; i < _paramsCount; i++) { if (_params[i] == NULL) { break; } //read parameter String value = server->arg(_params[i]->getID()).c_str(); //store it in array value.toCharArray(_params[i]->_value, _params[i]->_length + 1); DEBUG_WM(F("Parameter")); DEBUG_WM(_params[i]->getID()); DEBUG_WM(value); } if (server->arg("ip") != "") { DEBUG_WM(F("static ip")); DEBUG_WM(server->arg("ip")); //_sta_static_ip.fromString(server->arg("ip")); String ip = server->arg("ip"); optionalIPFromString(&_sta_static_ip, ip.c_str()); } if (server->arg("gw") != "") { DEBUG_WM(F("static gateway")); DEBUG_WM(server->arg("gw")); String gw = server->arg("gw"); optionalIPFromString(&_sta_static_gw, gw.c_str()); } if (server->arg("sn") != "") { DEBUG_WM(F("static netmask")); DEBUG_WM(server->arg("sn")); String sn = server->arg("sn"); optionalIPFromString(&_sta_static_sn, sn.c_str()); } String page = FPSTR(HTTP_HEADER); page.replace("{v}", "Credentials Saved"); page += FPSTR(HTTP_SCRIPT); page += FPSTR(HTTP_STYLE); page += _customHeadElement; page += FPSTR(HTTP_HEADER_END); page += FPSTR(HTTP_SAVED); page += FPSTR(HTTP_END); server->sendHeader("Content-Length", String(page.length())); server->send(200, "text/html", page); DEBUG_WM(F("Sent wifi save page")); connect = true; //signal ready to connect/reset } /** Handle the info page */ void WiFiManager::handleInfo() { DEBUG_WM(F("Info")); String page = FPSTR(HTTP_HEADER); page.replace("{v}", "Info"); page += FPSTR(HTTP_SCRIPT); page += FPSTR(HTTP_STYLE); page += _customHeadElement; page += FPSTR(HTTP_HEADER_END); page += F("
"); page += F("
Chip ID
"); page += ESP.getChipId(); page += F("
"); page += F("
Flash Chip ID
"); page += ESP.getFlashChipId(); page += F("
"); page += F("
IDE Flash Size
"); page += ESP.getFlashChipSize(); page += F(" bytes
"); page += F("
Real Flash Size
"); page += ESP.getFlashChipRealSize(); page += F(" bytes
"); page += F("
Soft AP IP
"); page += WiFi.softAPIP().toString(); page += F("
"); page += F("
Soft AP MAC
"); page += WiFi.softAPmacAddress(); page += F("
"); page += F("
Station MAC
"); page += WiFi.macAddress(); page += F("
"); page += F("
"); page += FPSTR(HTTP_END); server->sendHeader("Content-Length", String(page.length())); server->send(200, "text/html", page); DEBUG_WM(F("Sent info page")); } /** Handle the reset page */ void WiFiManager::handleReset() { DEBUG_WM(F("Reset")); String page = FPSTR(HTTP_HEADER); page.replace("{v}", "Info"); page += FPSTR(HTTP_SCRIPT); page += FPSTR(HTTP_STYLE); page += _customHeadElement; page += FPSTR(HTTP_HEADER_END); page += F("Module will reset in a few seconds."); page += FPSTR(HTTP_END); server->sendHeader("Content-Length", String(page.length())); server->send(200, "text/html", page); DEBUG_WM(F("Sent reset page")); delay(5000); ESP.reset(); delay(2000); } void WiFiManager::handleNotFound() { if (captivePortal()) { // If captive portal redirect instead of displaying the error page. return; } String message = "File Not Found\n\n"; message += "URI: "; message += server->uri(); message += "\nMethod: "; message += ( server->method() == HTTP_GET ) ? "GET" : "POST"; message += "\nArguments: "; message += server->args(); message += "\n"; for ( uint8_t i = 0; i < server->args(); i++ ) { message += " " + server->argName ( i ) + ": " + server->arg ( i ) + "\n"; } server->sendHeader("Cache-Control", "no-cache, no-store, must-revalidate"); server->sendHeader("Pragma", "no-cache"); server->sendHeader("Expires", "-1"); server->sendHeader("Content-Length", String(message.length())); server->send ( 404, "text/plain", message ); } /** Redirect to captive portal if we got a request for another domain. Return true in that case so the page handler do not try to handle the request again. */ boolean WiFiManager::captivePortal() { if (!isIp(server->hostHeader()) ) { DEBUG_WM(F("Request redirected to captive portal")); server->sendHeader("Location", String("http://") + toStringIp(server->client().localIP()), true); server->send ( 302, "text/plain", ""); // Empty content inhibits Content-length header so we have to close the socket ourselves. server->client().stop(); // Stop is needed because we sent no content length return true; } return false; } //start up config portal callback void WiFiManager::setAPCallback( void (*func)(WiFiManager* myWiFiManager) ) { _apcallback = func; } //start up save config callback void WiFiManager::setSaveConfigCallback( void (*func)(void) ) { _savecallback = func; } //sets a custom element to add to head, like a new style tag void WiFiManager::setCustomHeadElement(const char* element) { _customHeadElement = element; } //if this is true, remove duplicated Access Points - defaut true void WiFiManager::setRemoveDuplicateAPs(boolean removeDuplicates) { _removeDuplicateAPs = removeDuplicates; } template void WiFiManager::DEBUG_WM(Generic text) { if (_debug) { Serial.print("*WM: "); Serial.println(text); } } int WiFiManager::getRSSIasQuality(int RSSI) { int quality = 0; if (RSSI <= -100) { quality = 0; } else if (RSSI >= -50) { quality = 100; } else { quality = 2 * (RSSI + 100); } return quality; } /** Is this an IP? */ boolean WiFiManager::isIp(String str) { for (size_t i = 0; i < str.length(); i++) { int c = str.charAt(i); if (c != '.' && (c < '0' || c > '9')) { return false; } } return true; } /** IP to String? */ String WiFiManager::toStringIp(IPAddress ip) { String res = ""; for (int i = 0; i < 3; i++) { res += String((ip >> (8 * i)) & 0xFF) + "."; } res += String(((ip >> 8 * 3)) & 0xFF); return res; }