mirror of
https://github.com/alexhopeoconnor/WiFiManager.git
synced 2026-10-04 02:48:13 +10:00
937 lines
25 KiB
C++
937 lines
25 KiB
C++
/**************************************************************
|
|
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"
|
|
|
|
// PARAMETERS
|
|
|
|
WiFiManagerParameter::WiFiManagerParameter(const char *custom) {
|
|
_id = NULL;
|
|
_placeholder = NULL;
|
|
_length = 0;
|
|
_value = NULL;
|
|
_labelPlacement = WFM_LABEL_BEFORE;
|
|
_customHTML = custom;
|
|
}
|
|
|
|
WiFiManagerParameter::WiFiManagerParameter(const char *id, const char *placeholder, const char *defaultValue, int length) {
|
|
init(id, placeholder, defaultValue, length, "", WFM_LABEL_BEFORE);
|
|
}
|
|
|
|
WiFiManagerParameter::WiFiManagerParameter(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom) {
|
|
init(id, placeholder, defaultValue, length, custom, WFM_LABEL_BEFORE);
|
|
}
|
|
|
|
void WiFiManagerParameter::init(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom, int labelPlacement) {
|
|
_id = id;
|
|
_placeholder = placeholder;
|
|
_length = length;
|
|
_labelPlacement = labelPlacement;
|
|
_value = new char[length + 1];
|
|
for (int i = 0; i < length; i++) {
|
|
_value[i] = 0;
|
|
}
|
|
if (defaultValue != NULL) {
|
|
strncpy(_value, defaultValue, length);
|
|
}
|
|
|
|
_customHTML = custom;
|
|
}
|
|
|
|
const char* WiFiManagerParameter::getValue() {
|
|
return _value;
|
|
}
|
|
const char* WiFiManagerParameter::getID() {
|
|
return _id;
|
|
}
|
|
const char* WiFiManagerParameter::getPlaceholder() {
|
|
return _placeholder;
|
|
}
|
|
int WiFiManagerParameter::getValueLength() {
|
|
return _length;
|
|
}
|
|
int WiFiManagerParameter::getLabelPlacement() {
|
|
return _labelPlacement;
|
|
}
|
|
const char* WiFiManagerParameter::getCustomHTML() {
|
|
return _customHTML;
|
|
}
|
|
|
|
void WiFiManager::addParameter(WiFiManagerParameter *p) {
|
|
if(_paramsCount + 1 > WIFI_MANAGER_MAX_PARAMS)
|
|
{
|
|
//Max parameters exceeded!
|
|
DEBUG_WM("WIFI_MANAGER_MAX_PARAMS exceeded, increase number (in WiFiManager.h) before adding more parameters!");
|
|
DEBUG_WM("Skipping parameter with ID:");
|
|
DEBUG_WM(p->getID());
|
|
return;
|
|
}
|
|
_params[_paramsCount] = p;
|
|
_paramsCount++;
|
|
DEBUG_WM("Adding parameter");
|
|
DEBUG_WM(p->getID());
|
|
}
|
|
|
|
// constructor
|
|
WiFiManager::WiFiManager() {
|
|
WiFi.persistent(false);
|
|
}
|
|
|
|
// destructor
|
|
WiFiManager::~WiFiManager() {
|
|
WiFi.persistent(true); // @todo restore original
|
|
}
|
|
|
|
// AUTOCONNECT
|
|
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, deprecated
|
|
//String ssid = getSSID();
|
|
//String pass = getPassword();
|
|
|
|
// attempt to connect using saved settings, on fail fallback to AP config portal
|
|
if((WiFi.getMode() & WIFI_STA) == 0) wifimode(WIFI_STA); // if STA not on, turn it on
|
|
|
|
// if already connected, or try stored connect
|
|
if (WiFi.status() == WL_CONNECTED || connectWifi("", "") == WL_CONNECTED) {
|
|
//connected
|
|
DEBUG_WM(F("IP Address:"));
|
|
DEBUG_WM(WiFi.localIP());
|
|
return true;
|
|
}
|
|
// not connected start configportal
|
|
return startConfigPortal(apName, apPassword);
|
|
}
|
|
|
|
// CONFIG PORTAL
|
|
bool WiFiManager::startAP(){
|
|
DEBUG_WM(F("Configuring access point with with SSID ... "));
|
|
DEBUG_WM(_apName);
|
|
|
|
// setup optional soft AP static 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);
|
|
}
|
|
|
|
bool ret = true;
|
|
|
|
// start soft AP with password or anonymous
|
|
if (_apPassword != "") {
|
|
ret = WiFi.softAP(_apName.c_str(), _apPassword.c_str());//password option
|
|
} else {
|
|
DEBUG_WM(F("AP has anonymous access"));
|
|
ret = WiFi.softAP(_apName.c_str());
|
|
}
|
|
|
|
delay(500); // slight delay to make sure we get an AP IP
|
|
DEBUG_WM(F("AP IP address: "));
|
|
DEBUG_WM(WiFi.softAPIP());
|
|
|
|
// do AP callback if set
|
|
if ( _apcallback != NULL) {
|
|
_apcallback(this);
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
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);
|
|
}
|
|
|
|
void WiFiManager::setupConfigPortal() {
|
|
// setup dns and web servers
|
|
dnsServer.reset(new DNSServer());
|
|
server.reset(new ESP8266WebServer(80));
|
|
|
|
DEBUG_WM(F("setupConfigPortal"));
|
|
_configPortalStart = millis();
|
|
|
|
if(!startAP()) DEBUG_WM("There was an error stating the AP"); // @bug startAP returns unreliable success status
|
|
|
|
/* Setup the DNS server redirecting all the domains to the apIP */
|
|
dnsServer->setErrorReplyCode(DNSReplyCode::NoError);
|
|
dnsServer->start(DNS_PORT, "*", WiFi.softAPIP());
|
|
|
|
/* Setup httpd callbacks, web pages: root, wifi config pages, SO captive portal detectors and not found. */
|
|
server->on("/", std::bind(&WiFiManager::handleRoot, this));
|
|
server->on("/wifi", std::bind(&WiFiManager::handleWifi, this, true));
|
|
server->on("/0wifi", std::bind(&WiFiManager::handleWifi, this, false));
|
|
server->on("/wifisave", std::bind(&WiFiManager::handleWifiSave, this));
|
|
server->on("/i", std::bind(&WiFiManager::handleInfo, this));
|
|
server->on("/r", std::bind(&WiFiManager::handleReset, this));
|
|
//server->on("/fwlink", 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::startConfigPortal() {
|
|
String ssid = "ESP" + String(ESP.getChipId());
|
|
return startConfigPortal(ssid.c_str(), NULL);
|
|
}
|
|
|
|
boolean WiFiManager::startConfigPortal(char const *apName, char const *apPassword) {
|
|
//setup AP
|
|
if(!WiFi.isConnected()){
|
|
// this fixes most ap problems, simply doing mode(WIFI_AP) does not work if sta connection is hanging
|
|
wifioff();
|
|
wifimode(WIFI_AP);
|
|
DEBUG_WM("Disabling STA");
|
|
}
|
|
else wifimode(WIFI_AP_STA);
|
|
|
|
DEBUG_WM("Enabling AP");
|
|
|
|
_apName = apName; // @todo check valid apname ?
|
|
_apPassword = apPassword;
|
|
if(!validApPassword()) return false;
|
|
|
|
configPortalActive = true;
|
|
connect = false; // global
|
|
|
|
// init configportal
|
|
setupConfigPortal();
|
|
uint8_t state;
|
|
bool result = false;
|
|
|
|
if(!_configPortalIsBlocking){
|
|
DEBUG_WM(F("Config Portal Running, non blocking/processing"));
|
|
return result;
|
|
}
|
|
|
|
DEBUG_WM(F("Config Portal Running, blocking"));
|
|
// blocking loop waiting for config
|
|
while(1){
|
|
|
|
// check if timed out
|
|
if(configPortalHasTimeout()){
|
|
stopConfigPortal();
|
|
result = WiFi.status() == WL_CONNECTED; //returns connected bool, ok I guess
|
|
break;
|
|
}
|
|
|
|
state = handleConfigPortal();
|
|
|
|
if(state != WL_IDLE_STATUS){
|
|
result == WL_CONNECTED;
|
|
break;
|
|
}
|
|
yield();
|
|
}
|
|
return result;
|
|
}
|
|
|
|
boolean WiFiManager::process(){
|
|
if(configPortalActive){
|
|
uint8_t state = handleConfigPortal();
|
|
return state == WL_CONNECTED;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
//using esp enums returns for now, should be fine
|
|
uint8_t WiFiManager::handleConfigPortal(){
|
|
//DNS handler
|
|
dnsServer->processNextRequest();
|
|
//HTTP handler
|
|
server->handleClient();
|
|
|
|
// Waiting for save...
|
|
if (connect) {
|
|
connect = false;
|
|
delay(2000);
|
|
DEBUG_WM(F("Connecting to new AP"));
|
|
|
|
// attempt sta connection to submitted _ssid, _pass
|
|
if (connectWifi(_ssid, _pass) == WL_CONNECTED) {
|
|
DEBUG_WM(F("Connect to new AP SUCCESS"));
|
|
stopConfigPortal();
|
|
return WL_CONNECTED; // success
|
|
}
|
|
|
|
DEBUG_WM(F("Failed to connect."));
|
|
|
|
if (_shouldBreakAfterConfig) {
|
|
// this is more of an exiting callback than a save
|
|
stopConfigPortal(); // fail
|
|
return WL_CONNECT_FAILED;
|
|
}
|
|
}
|
|
|
|
return WL_IDLE_STATUS;
|
|
}
|
|
|
|
boolean WiFiManager::stopConfigPortal(){
|
|
// do save callback
|
|
if ( _savecallback != NULL) {
|
|
//todo: confirm or verify data was saved
|
|
_savecallback();
|
|
}
|
|
|
|
//DNS handler
|
|
dnsServer->processNextRequest();
|
|
//HTTP handler
|
|
server->handleClient();
|
|
|
|
// @todo does this free memory?
|
|
server.reset();
|
|
dnsServer.reset();
|
|
|
|
// turn off AP
|
|
DEBUG_WM(F("disconnect configportal"));
|
|
bool ret = WiFi.softAPdisconnect(false);
|
|
if(!ret)DEBUG_WM(F("disconnect configportal error"));
|
|
wifimode(WIFI_STA); // set back to sta, @todo use preservation variable
|
|
configPortalActive = false;
|
|
return ret;
|
|
}
|
|
|
|
// @todo refactor this up into seperate functions
|
|
// one for connecting to flash , one for new client
|
|
// clean up, flow is convoluted, and causes bugs
|
|
int WiFiManager::connectWifi(String ssid, String pass) {
|
|
DEBUG_WM(F("Connecting as wifi client..."));
|
|
|
|
bool waitforconx = true;
|
|
|
|
// Setup static IP config if provided
|
|
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());
|
|
}
|
|
|
|
wifimode(WIFI_AP_STA); // turn sta back on so begin does not call enablesta->mode
|
|
wifioff(); // disconnect before begin, in case anything is hung
|
|
|
|
// if ssid argument provided connect to that
|
|
if (ssid != "") {
|
|
DEBUG_WM("Connecting to new AP");
|
|
WiFi.persistent(true);
|
|
WiFi.begin(ssid.c_str(), pass.c_str());
|
|
WiFi.persistent(false);
|
|
} else {
|
|
// connect using saved ssid if there is one
|
|
if (WiFi.SSID() != "") {
|
|
DEBUG_WM("Connecting to saved AP");
|
|
WiFi.begin();
|
|
} else {
|
|
DEBUG_WM("No saved credentials");
|
|
waitforconx = false;
|
|
}
|
|
}
|
|
|
|
int connRes = waitforconx ? waitForConnectResult() : WL_NO_SSID_AVAIL;
|
|
DEBUG_WM ("Connection result: ");
|
|
DEBUG_WM ( connRes );
|
|
|
|
// do WPS, if WPS options enabled and not connected and no password was supplied
|
|
// @todo this seems like wrong place for this, is it a fallback or option?
|
|
if (_tryWPS && connRes != WL_CONNECTED && pass == "") {
|
|
startWPS();
|
|
// should be connected at the end of WPS
|
|
connRes = waitForConnectResult();
|
|
}
|
|
|
|
return connRes;
|
|
}
|
|
|
|
// @todo uses _connectTimeout for wifi save also, add timeout argument to bypass?
|
|
|
|
uint8_t WiFiManager::waitForConnectResult(uint16_t timeout) {
|
|
return waitForConnectResult(timeout * 1000);
|
|
}
|
|
|
|
uint8_t WiFiManager::waitForConnectResult() {
|
|
if (_connectTimeout == 0){
|
|
DEBUG_WM (F("connectTimeout not set, ESP waitForConnectResult..."));
|
|
return WiFi.waitForConnectResult();
|
|
}
|
|
|
|
DEBUG_WM (F("connectTimeout set, waiting for connect...."));
|
|
uint8_t status;
|
|
int timeout = millis() + _connectTimeout;
|
|
|
|
while(millis() < timeout) {
|
|
status = WiFi.status();
|
|
if (status == WL_CONNECTED || status == WL_CONNECT_FAILED) {
|
|
return status;
|
|
}
|
|
DEBUG_WM (".");
|
|
delay(100);
|
|
}
|
|
return status;
|
|
}
|
|
|
|
void WiFiManager::startWPS() {
|
|
DEBUG_WM("START WPS");
|
|
WiFi.beginWPSConfig();
|
|
DEBUG_WM("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;
|
|
}
|
|
*/
|
|
|
|
// GETTERS
|
|
String WiFiManager::getConfigPortalSSID() {
|
|
return _apName;
|
|
}
|
|
|
|
// SETTERS
|
|
void WiFiManager::resetSettings() {
|
|
DEBUG_WM(F("SETTINGS ERASED"));
|
|
DEBUG_WM(F("THIS MAY CAUSE AP NOT TO START UP PROPERLY. YOU NEED TO COMMENT IT OUT AFTER ERASING THE DATA.")); // @todo WHUT?
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* HTTPD CALLBACK root or redirect to captive portal
|
|
*/
|
|
void WiFiManager::handleRoot() {
|
|
DEBUG_WM(F("Handle root"));
|
|
if (captivePortal()) { // If captive portal redirect instead of displaying the page.
|
|
return;
|
|
}
|
|
|
|
String page = FPSTR(HTTP_HEAD);
|
|
page.replace("{v}", "Options");
|
|
page += FPSTR(HTTP_SCRIPT);
|
|
page += FPSTR(HTTP_STYLE);
|
|
page += _customHeadElement;
|
|
page += FPSTR(HTTP_HEAD_END);
|
|
page += "<h1>";
|
|
page += _apName;
|
|
page += "</h1>";
|
|
page += F("<h3>WiFiManager</h3>");
|
|
page += FPSTR(HTTP_PORTAL_OPTIONS);
|
|
page += FPSTR(HTTP_END);
|
|
|
|
server->sendHeader("Content-Length", String(page.length()));
|
|
server->send(200, "text/html", page);
|
|
|
|
}
|
|
|
|
/**
|
|
* HTTPD CALLBACK Wifi config page handler
|
|
*/
|
|
void WiFiManager::handleWifi(boolean scan) {
|
|
|
|
String page = FPSTR(HTTP_HEAD);
|
|
page.replace("{v}", "Config ESP");
|
|
page += FPSTR(HTTP_SCRIPT);
|
|
page += FPSTR(HTTP_STYLE);
|
|
page += _customHeadElement;
|
|
page += FPSTR(HTTP_HEAD_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 += "<br/>";
|
|
}
|
|
}
|
|
|
|
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);
|
|
String pitem;
|
|
switch (_params[i]->getLabelPlacement()) {
|
|
case WFM_LABEL_BEFORE:
|
|
pitem = FPSTR(HTTP_FORM_LABEL);
|
|
pitem += FPSTR(HTTP_FORM_PARAM);
|
|
break;
|
|
case WFM_LABEL_AFTER:
|
|
pitem = FPSTR(HTTP_FORM_PARAM);
|
|
pitem += FPSTR(HTTP_FORM_LABEL);
|
|
break;
|
|
default:
|
|
// WFM_NO_LABEL
|
|
pitem = FPSTR(HTTP_FORM_PARAM);
|
|
break;
|
|
}
|
|
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 += "<br/>";
|
|
}
|
|
|
|
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 += "<br/>";
|
|
}
|
|
|
|
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"));
|
|
}
|
|
|
|
/**
|
|
* HTTPD CALLBACK 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);
|
|
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_HEAD);
|
|
page.replace("{v}", "Credentials Saved");
|
|
page += FPSTR(HTTP_SCRIPT);
|
|
page += FPSTR(HTTP_STYLE);
|
|
page += _customHeadElement;
|
|
page += FPSTR(HTTP_HEAD_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
|
|
}
|
|
|
|
/**
|
|
* HTTPD CALLBACK info page
|
|
*/
|
|
void WiFiManager::handleInfo() {
|
|
DEBUG_WM(F("Info"));
|
|
|
|
String page = FPSTR(HTTP_HEAD);
|
|
page.replace("{v}", "Info");
|
|
page += FPSTR(HTTP_SCRIPT);
|
|
page += FPSTR(HTTP_STYLE);
|
|
page += _customHeadElement;
|
|
page += FPSTR(HTTP_HEAD_END);
|
|
page += F("<dl>");
|
|
page += F("<dt>Chip ID</dt><dd>");
|
|
page += ESP.getChipId();
|
|
page += F("</dd>");
|
|
page += F("<dt>Flash Chip ID</dt><dd>");
|
|
page += ESP.getFlashChipId();
|
|
page += F("</dd>");
|
|
page += F("<dt>IDE Flash Size</dt><dd>");
|
|
page += ESP.getFlashChipSize();
|
|
page += F(" bytes</dd>");
|
|
page += F("<dt>Real Flash Size</dt><dd>");
|
|
page += ESP.getFlashChipRealSize();
|
|
page += F(" bytes</dd>");
|
|
page += F("<dt>Soft AP IP</dt><dd>");
|
|
page += WiFi.softAPIP().toString();
|
|
page += F("</dd>");
|
|
page += F("<dt>Soft AP MAC</dt><dd>");
|
|
page += WiFi.softAPmacAddress();
|
|
page += F("</dd>");
|
|
page += F("<dt>Station MAC</dt><dd>");
|
|
page += WiFi.macAddress();
|
|
page += F("</dd>");
|
|
page += F("</dl>");
|
|
page += FPSTR(HTTP_END);
|
|
|
|
server->sendHeader("Content-Length", String(page.length()));
|
|
server->send(200, "text/html", page);
|
|
|
|
DEBUG_WM(F("Sent info page"));
|
|
}
|
|
|
|
/**
|
|
* HTTPD CALLBACK reset page
|
|
*/
|
|
void WiFiManager::handleReset() {
|
|
DEBUG_WM(F("Reset"));
|
|
|
|
String page = FPSTR(HTTP_HEAD);
|
|
page.replace("{v}", "Info");
|
|
page += FPSTR(HTTP_SCRIPT);
|
|
page += FPSTR(HTTP_STYLE);
|
|
page += _customHeadElement;
|
|
page += FPSTR(HTTP_HEAD_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 );
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
boolean WiFiManager::captivePortal() {
|
|
DEBUG_WM(server->hostHeader());
|
|
if (!isIp(server->hostHeader()) && false) {
|
|
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;
|
|
}
|
|
|
|
// MORE SETTERS
|
|
|
|
//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;
|
|
}
|
|
|
|
//if this is true, remove duplicated Access Points - defaut true
|
|
void WiFiManager::setConfigPortalBlocking(boolean shoudlBlock) {
|
|
_configPortalIsBlocking = shoudlBlock;
|
|
}
|
|
|
|
// HELPERS
|
|
|
|
template <typename Generic>
|
|
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 (int 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;
|
|
}
|
|
|
|
boolean WiFiManager::validApPassword(){
|
|
// check that ap password is valid, return false
|
|
if (_apPassword == NULL) _apPassword = "";
|
|
if (_apPassword != "") {
|
|
if (_apPassword.length() < 8 || _apPassword.length() > 63) {
|
|
DEBUG_WM(F("AccessPoint set password is INVALID"));
|
|
_apPassword = "";
|
|
return false; // @todo FATAL or fallback to empty ?
|
|
}
|
|
DEBUG_WM(F("AccessPoint set password is VALID"));
|
|
DEBUG_WM(_apPassword);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
// set mode without persistent
|
|
bool WiFiManager::wifimode(WiFiMode_t m) {
|
|
if(wifi_get_opmode() == (uint8) m) {
|
|
return true;
|
|
}
|
|
bool ret;
|
|
ETS_UART_INTR_DISABLE();
|
|
ret = wifi_set_opmode_current(m);
|
|
ETS_UART_INTR_ENABLE();
|
|
return ret;
|
|
}
|
|
|
|
// sta disconnect without persistent
|
|
bool WiFiManager::wifioff() {
|
|
DEBUG_WM(F("wifi disconncting"));
|
|
if((WiFi.getMode() & WIFI_STA) != 0) {
|
|
return wifi_station_disconnect();
|
|
}
|
|
} |