");
page += F("My network is
");
page += WiFi_SSID();
page += F("");
page += F("IP address is
");
page += WiFi.localIP().toString();
page += F("");
page += F("Portal closed...
");
//page += F("Push button on device to restart configuration server!");
page += FPSTR(WM_HTTP_END);
server->send(200, "text/html", page);
stopConfigPortal = true; //signal ready to shutdown config portal
LOGDEBUG(F("Sent server close page"));
// Restore when Press Save WiFi
_configPortalTimeout = DEFAULT_PORTAL_TIMEOUT;
}
//////////////////////////////////////////
/** Handle the info page */
void ESP_WiFiManager::handleInfo()
{
LOGDEBUG(F("Info"));
// Disable _configPortalTimeout when someone accessing Portal to give some time to config
_configPortalTimeout = 0; //KH
server->sendHeader(FPSTR(WM_HTTP_CACHE_CONTROL), FPSTR(WM_HTTP_NO_STORE));
#if USING_CORS_FEATURE
// New from v1.1.1, for configure CORS Header, default to WM_HTTP_CORS_ALLOW_ALL = "*"
server->sendHeader(FPSTR(WM_HTTP_CORS), _CORS_Header);
#endif
server->sendHeader(FPSTR(WM_HTTP_PRAGMA), FPSTR(WM_HTTP_NO_CACHE));
server->sendHeader(FPSTR(WM_HTTP_EXPIRES), "-1");
String page = FPSTR(WM_HTTP_HEAD_START);
page.replace("{v}", "Info");
page += FPSTR(WM_HTTP_SCRIPT);
page += FPSTR(WM_HTTP_SCRIPT_NTP);
page += FPSTR(WM_HTTP_STYLE);
page += _customHeadElement;
page += FPSTR(WM_HTTP_HEAD_END);
page += F("
WiFi Information
");
reportStatus(page);
page += FPSTR(WM_FLDSET_START);
page += F("
Device Data
");
page += F("
");
page += F("| Name | Value |
|---|
| Chip ID | ");
page += F("0x");
#ifdef ESP8266
page += String(ESP.getChipId(), HEX); //ESP.getChipId();
#else //ESP32
page += String(ESP_getChipId(), HEX); //ESP.getChipId();
page += F(" |
");
page += F("| Chip OUI | ");
page += F("0x");
page += String(getChipOUI(), HEX); //ESP.getChipId();
page += F(" |
");
page += F("| Chip Model | ");
page += ESP.getChipModel();
page += F(" Rev");
page += ESP.getChipRevision();
#endif
page += F(" |
");
page += F("| Flash Chip ID | ");
#ifdef ESP8266
page += String(ESP.getFlashChipId(), HEX); //ESP.getFlashChipId();
#else //ESP32
// TODO
page += F("TODO");
#endif
page += F(" |
");
page += F("| IDE Flash Size | ");
page += ESP.getFlashChipSize();
page += F(" bytes |
");
page += F("| Real Flash Size | ");
#ifdef ESP8266
page += ESP.getFlashChipRealSize();
#else //ESP32
// TODO
page += F("TODO");
#endif
page += F(" bytes |
");
page += F("| Access Point IP | ");
page += WiFi.softAPIP().toString();
page += F(" |
");
page += F("| Access Point MAC | ");
page += WiFi.softAPmacAddress();
page += F(" |
");
page += F("| SSID | ");
page += WiFi_SSID();
page += F(" |
");
page += F("| Station IP | ");
page += WiFi.localIP().toString();
page += F(" |
");
page += F("| Station MAC | ");
page += WiFi.macAddress();
page += F(" |
");
page += F("
");
page += FPSTR(WM_FLDSET_END);
#if USE_AVAILABLE_PAGES
page += FPSTR(WM_FLDSET_START);
page += FPSTR(WM_HTTP_AVAILABLE_PAGES);
page += FPSTR(WM_FLDSET_END);
#endif
page += F("
More information about ESP_WiFiManager at");
page += F("
https://github.com/khoih-prog/ESP_WiFiManager");
page += FPSTR(WM_HTTP_END);
server->send(200, "text/html", page);
LOGDEBUG(F("Sent info page"));
}
//////////////////////////////////////////
/** Handle the state page */
void ESP_WiFiManager::handleState()
{
LOGDEBUG(F("State - json"));
server->sendHeader(FPSTR(WM_HTTP_CACHE_CONTROL), FPSTR(WM_HTTP_NO_STORE));
#if USING_CORS_FEATURE
// New from v1.1.1, for configure CORS Header, default to WM_HTTP_CORS_ALLOW_ALL = "*"
server->sendHeader(FPSTR(WM_HTTP_CORS), _CORS_Header);
#endif
server->sendHeader(FPSTR(WM_HTTP_PRAGMA), FPSTR(WM_HTTP_NO_CACHE));
server->sendHeader(FPSTR(WM_HTTP_EXPIRES), "-1");
String page = F("{\"Soft_AP_IP\":\"");
page += WiFi.softAPIP().toString();
page += F("\",\"Soft_AP_MAC\":\"");
page += WiFi.softAPmacAddress();
page += F("\",\"Station_IP\":\"");
page += WiFi.localIP().toString();
page += F("\",\"Station_MAC\":\"");
page += WiFi.macAddress();
page += F("\",");
if (WiFi.psk() != "")
{
page += F("\"Password\":true,");
}
else
{
page += F("\"Password\":false,");
}
page += F("\"SSID\":\"");
page += WiFi_SSID();
page += F("\"}");
server->send(200, "application/json", page);
LOGDEBUG(F("Sent state page in json format"));
}
//////////////////////////////////////////
/** Handle the scan page */
void ESP_WiFiManager::handleScan()
{
LOGDEBUG(F("Scan"));
// Disable _configPortalTimeout when someone accessing Portal to give some time to config
_configPortalTimeout = 0; //KH
LOGDEBUG(F("State-Json"));
server->sendHeader(FPSTR(WM_HTTP_CACHE_CONTROL), FPSTR(WM_HTTP_NO_STORE));
#if USING_CORS_FEATURE
// New from v1.1.1, for configure CORS Header, default to WM_HTTP_CORS_ALLOW_ALL = "*"
server->sendHeader(FPSTR(WM_HTTP_CORS), _CORS_Header);
#endif
server->sendHeader(FPSTR(WM_HTTP_PRAGMA), FPSTR(WM_HTTP_NO_CACHE));
server->sendHeader(FPSTR(WM_HTTP_EXPIRES), "-1");
int n;
int *indices;
//Space for indices array allocated on heap in scanWifiNetworks
//and should be freed when indices no longer required.
n = scanWifiNetworks(&indices);
LOGDEBUG(F("In handleScan, scanWifiNetworks done"));
String page = F("{\"Access_Points\":[");
//display networks in page
for (int i = 0; i < n; i++)
{
if (indices[i] == -1)
continue; // skip duplicates and those that are below the required quality
if (i != 0)
page += F(", ");
LOGDEBUG1(F("Index ="), i);
LOGDEBUG1(F("SSID ="), WiFi.SSID(indices[i]));
LOGDEBUG1(F("RSSI ="), WiFi.RSSI(indices[i]));
int quality = getRSSIasQuality(WiFi.RSSI(indices[i]));
String item = FPSTR(JSON_ITEM);
String rssiQ;
rssiQ += quality;
item.replace("{v}", WiFi.SSID(indices[i]));
item.replace("{r}", rssiQ);
#ifdef ESP8266
if (WiFi.encryptionType(indices[i]) != ENC_TYPE_NONE)
#else //ESP32
if (WiFi.encryptionType(indices[i]) != WIFI_AUTH_OPEN)
#endif
{
item.replace("{i}", "true");
}
else
{
item.replace("{i}", "false");
}
//LOGDEBUG(item);
page += item;
delay(0);
}
if (indices)
{
free(indices); //indices array no longer required so free memory
}
page += F("]}");
server->send(200, "application/json", page);
LOGDEBUG(F("Sent WiFiScan Data in Json format"));
}
//////////////////////////////////////////
/** Handle the reset page */
void ESP_WiFiManager::handleReset()
{
LOGDEBUG(F("Reset"));
server->sendHeader("Cache-Control", "no-cache, no-store, must-revalidate");
server->sendHeader("Pragma", "no-cache");
server->sendHeader("Expires", "-1");
String page = FPSTR(WM_HTTP_HEAD_START);
page.replace("{v}", "WiFi Information");
page += FPSTR(WM_HTTP_SCRIPT);
page += FPSTR(WM_HTTP_STYLE);
page += _customHeadElement;
page += FPSTR(WM_HTTP_HEAD_END);
page += F("Resetting");
page += FPSTR(WM_HTTP_END);
server->send(200, "text/html", page);
LOGDEBUG(F("Sent reset page"));
delay(5000);
// New in v1.0.11
// Temporary fix for issue of not clearing WiFi SSID/PW from flash of ESP32
// See https://github.com/khoih-prog/ESP_WiFiManager/issues/25 and https://github.com/espressif/arduino-esp32/issues/400
resetSettings();
//WiFi.disconnect(true); // Wipe out WiFi credentials.
//////
#ifdef ESP8266
ESP.reset();
#else //ESP32
ESP.restart();
#endif
delay(2000);
}
//////////////////////////////////////////
void ESP_WiFiManager::handleNotFound()
{
if (captivePortal())
{
// If caprive 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->send(404, "text/plain", message);
}
//////////////////////////////////////////
/**
HTTPD redirector
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.
*/
bool ESP_WiFiManager::captivePortal()
{
LOGDEBUG1(F("captivePortal: hostHeader = "), server->hostHeader());
if (!isIp(server->hostHeader()))
{
LOGINFO1(F("Request redirected to captive portal : "), server->client().localIP());
server->sendHeader(F("Location"), (String)F("http://") + toStringIp(server->client().localIP()), true);
server->send(302, FPSTR(WM_HTTP_HEAD_CT2), ""); // 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 ESP_WiFiManager::setAPCallback(void(*func)(ESP_WiFiManager* myWiFiManager))
{
_apcallback = func;
}
//////////////////////////////////////////
//start up save config callback
void ESP_WiFiManager::setSaveConfigCallback(void(*func)())
{
_savecallback = func;
}
//////////////////////////////////////////
//sets a custom element to add to head, like a new style tag
void ESP_WiFiManager::setCustomHeadElement(const char* element) {
_customHeadElement = element;
}
//if this is true, remove duplicated Access Points - defaut true
void ESP_WiFiManager::setRemoveDuplicateAPs(bool removeDuplicates)
{
_removeDuplicateAPs = 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 ESP_WiFiManager::scanWifiNetworks(int **indicesptr)
{
LOGDEBUG(F("Scanning Network"));
int n = WiFi.scanNetworks(false, true);
LOGDEBUG1(F("scanWifiNetworks: Done, Scanned Networks n ="), n);
//KH, Terrible bug here. WiFi.scanNetworks() returns n < 0 => malloc( negative == very big ) => crash!!!
//In .../esp32/libraries/WiFi/src/WiFiType.h
//#define WIFI_SCAN_RUNNING (-1)
//#define WIFI_SCAN_FAILED (-2)
//if (n == 0)
if (n <= 0)
{
LOGDEBUG(F("No network found"));
return (0);
}
else
{
// Allocate space off the heap for indices array.
// This space should be freed when no longer required.
int* indices = (int *)malloc(n * sizeof(int));
if (indices == NULL)
{
LOGDEBUG(F("ERROR: Out of memory"));
*indicesptr = NULL;
return (0);
}
*indicesptr = indices;
//sort networks
for (int i = 0; i < n; i++)
{
indices[i] = i;
}
LOGDEBUG(F("Sorting"));
// 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]);
}
}
}
LOGDEBUG(F("Removing Dup"));
// 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]))
{
LOGDEBUG1("DUP AP:", WiFi.SSID(indices[j]));
indices[j] = -1; // set dup aps to index -1
}
}
}
}
for (int i = 0; i < n; i++)
{
if (indices[i] == -1)
continue; // skip dups
int quality = getRSSIasQuality(WiFi.RSSI(indices[i]));
if (!(_minimumQuality == -1 || _minimumQuality < quality))
{
indices[i] = -1;
LOGDEBUG(F("Skipping low quality"));
}
}
#if (DEBUG_WIFIMGR > 2)
for (int i = 0; i < n; i++)
{
if (indices[i] == -1)
continue; // skip dups
else
Serial.println(WiFi.SSID(indices[i]));
}
#endif
return (n);
}
}
//////////////////////////////////////////
int ESP_WiFiManager::getRSSIasQuality(const 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? */
bool ESP_WiFiManager::isIp(const String& str)
{
for (unsigned int i = 0; i < str.length(); i++)
{
int c = str.charAt(i);
if (c != '.' && c != ':' && (c < '0' || c > '9'))
{
return false;
}
}
return true;
}
//////////////////////////////////////////
/** IP to String? */
String ESP_WiFiManager::toStringIp(const 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;
}
//////////////////////////////////////////
#ifdef ESP32
// We can't use WiFi.SSID() in ESP32 as it's only valid after connected.
// SSID and Password stored in ESP32 wifi_ap_record_t and wifi_config_t are also cleared in reboot
// Have to create a new function to store in EEPROM/SPIFFS for this purpose
String ESP_WiFiManager::getStoredWiFiSSID()
{
if (WiFi.getMode() == WIFI_MODE_NULL)
{
return String();
}
wifi_ap_record_t info;
if (!esp_wifi_sta_get_ap_info(&info))
{
return String(reinterpret_cast
(info.ssid));
}
else
{
wifi_config_t conf;
esp_wifi_get_config(WIFI_IF_STA, &conf);
return String(reinterpret_cast(conf.sta.ssid));
}
return String();
}
//////////////////////////////////////////
String ESP_WiFiManager::getStoredWiFiPass()
{
if (WiFi.getMode() == WIFI_MODE_NULL)
{
return String();
}
wifi_config_t conf;
esp_wifi_get_config(WIFI_IF_STA, &conf);
return String(reinterpret_cast(conf.sta.password));
}
uint32_t getChipID()
{
uint64_t chipId64 = 0;
for (int i = 0; i < 6; i++)
{
chipId64 |= ( ( (uint64_t) ESP.getEfuseMac() >> (40 - (i * 8)) ) & 0xff ) << (i * 8);
}
return (uint32_t) (chipId64 & 0xFFFFFF);
}
uint32_t getChipOUI()
{
uint64_t chipId64 = 0;
for (int i = 0; i < 6; i++)
{
chipId64 |= ( ( (uint64_t) ESP.getEfuseMac() >> (40 - (i * 8)) ) & 0xff ) << (i * 8);
}
return (uint32_t) (chipId64 >> 24);
}
#endif
#endif //ESP_WiFiManager_Impl_h