ElixirForge/WiFiManager
1
0
Fork 0
mirror of https://github.com/alexhopeoconnor/WiFiManager.git synced 2026-10-22 02:32:10 +10:00
Code Releases Activity

added captive portal

Browse Source 
removed mdsn lib
changed dependencies and constructor
This commit is contained in:
Alex Tudorache
2015-09-11 18:51:21 +03:00
parent 20dbfed7c6
commit d2bd81121d
4 changed files with 403 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files
WiFiManager.cpp
+341 -59
View File
@@ -3,21 +3,23 @@
* (https://github.com/esp8266/Arduino) to enable easy * (https://github.com/esp8266/Arduino) to enable easy
* configuration and reconfiguration of WiFi credentials and * configuration and reconfiguration of WiFi credentials and
* store them in EEPROM. * store them in EEPROM.
* inspired by http://www.esp8266.com/viewtopic.php?f=29&t=2520 * inspired by:
* http://www.esp8266.com/viewtopic.php?f=29&t=2520
* https://github.com/chriscook8/esp-arduino-apboot * 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 * Built by AlexT https://github.com/tzapu
* Licensed under MIT license * Licensed under MIT license
**************************************************************/ **************************************************************/
#include "WiFiManager.h" #include "WiFiManager.h"
MDNSResponder mdns;
WiFiServer server(80);
DNSServer dnsServer;
WiFiManager::WiFiManager(int eepromStart) // Web server
{ ESP8266WebServer server(80);
_eepromStart = eepromStart;
WiFiManager::WiFiManager() {
} }
void WiFiManager::begin() { void WiFiManager::begin() {
@@ -25,10 +27,30 @@ void WiFiManager::begin() {
} }
void WiFiManager::begin(char const *apName) { void WiFiManager::begin(char const *apName) {
Serial.println("");
_apName = apName; _apName = apName;
start = millis(); start = millis();
EEPROM.begin(512);
delay(10); Serial.print("Configuring access point... ");
Serial.println(_apName);
WiFi.softAP(_apName);//TODO: add password option
delay(500); // Without delay I've seen the IP address blank
Serial.print("AP IP address: ");
Serial.println(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("/", std::bind(&WiFiManager::handleRoot, this));
server.on("/wifi", std::bind(&WiFiManager::handleWifi, this));
server.on("/wifisave", std::bind(&WiFiManager::handleWifiSave, this));
server.on("/generate_204", std::bind(&WiFiManager::handleRoot, this)); //Android captive portal. Maybe not needed. Might be handled by notFound handler.
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
Serial.println("HTTP server started");
} }
boolean WiFiManager::autoConnect() { boolean WiFiManager::autoConnect() {
@@ -36,8 +58,22 @@ boolean WiFiManager::autoConnect() {
} }
boolean WiFiManager::autoConnect(char const *apName) { boolean WiFiManager::autoConnect(char const *apName) {
begin(apName); DEBUG_PRINT("");
DEBUG_PRINT("AutoConnect");
// read eeprom for ssid and pass
String ssid = getSSID();
String pass = getPassword();
WiFi.mode(WIFI_STA);
connectWifi(ssid, pass);
int s = WiFi.status();
if (s == WL_CONNECTED) {
//connected
return true;
}
/*
DEBUG_PRINT(""); DEBUG_PRINT("");
DEBUG_PRINT("AutoConnect"); DEBUG_PRINT("AutoConnect");
@@ -49,18 +85,71 @@ boolean WiFiManager::autoConnect(char const *apName) {
DEBUG_PRINT("Waiting for Wifi to connect"); DEBUG_PRINT("Waiting for Wifi to connect");
WiFi.mode(WIFI_STA); WiFi.mode(WIFI_STA);
WiFi.begin(ssid.c_str(), pass.c_str());
if ( hasConnected() ) { connectWifi(ssid, pass);
return true; int s = WiFi.status();
if (s != WL_CONNECTED) {
//not connected
//setup AP
beginConfigMode();
//start portal and loop
startWebConfig();
return false;
} }
return true;// connected
} }
*/
// delay(1000);
//not connected
//setup AP //setup AP
beginConfigMode(); WiFi.mode(WIFI_AP);
//start portal and loop
startWebConfig(); connect = false;
begin(apName);
while(1) {
//DNS
dnsServer.processNextRequest();
//HTTP
server.handleClient();
if(connect) {
delay(5000);
ESP.reset();
delay(1000);
}
/*
if(connect) {
DEBUG_PRINT("Connecting to new AP");
connect = false;
ssid = getSSID();
pass = getPassword();
connectWifi(ssid, pass);
int s = WiFi.status();
if (s == WL_CONNECTED) {
//connected
return true;
}
}*/
yield();
}
return false; return false;
} }
void WiFiManager::connectWifi(String ssid, String pass) {
Serial.println("Connecting as wifi client...");
WiFi.disconnect();
WiFi.begin(ssid.c_str(), pass.c_str());
int connRes = WiFi.waitForConnectResult();
Serial.print ( "connRes: " );
Serial.println ( connRes );
}
String WiFiManager::getSSID() { String WiFiManager::getSSID() {
if (_ssid == "") { if (_ssid == "") {
DEBUG_PRINT("Reading EEPROM SSID"); DEBUG_PRINT("Reading EEPROM SSID");
@@ -81,16 +170,34 @@ String WiFiManager::getPassword() {
return _pass; return _pass;
} }
void WiFiManager::setSSID(String s) {
_ssid = s;
setEEPROMString(0, 32, _ssid);
}
void WiFiManager::setPassword(String p) {
DEBUG_PRINT("Save password:");
DEBUG_PRINT(p);
_pass = p;
setEEPROMString(32, 64, _pass);
}
String WiFiManager::getEEPROMString(int start, int len) { String WiFiManager::getEEPROMString(int start, int len) {
EEPROM.begin(512);
delay(10);
String string = ""; String string = "";
for (int i = _eepromStart + start; i < _eepromStart + start + len; i++) { for (int i = _eepromStart + start; i < _eepromStart + start + len; i++) {
//DEBUG_PRINT(i); //DEBUG_PRINT(i);
string += char(EEPROM.read(i)); string += char(EEPROM.read(i));
} }
EEPROM.end();
return string; return string;
} }
void WiFiManager::setEEPROMString(int start, int len, String string) { void WiFiManager::setEEPROMString(int start, int len, String string) {
EEPROM.begin(512);
delay(10);
int si = 0; int si = 0;
for (int i = _eepromStart + start; i < _eepromStart + start + len; i++) { for (int i = _eepromStart + start; i < _eepromStart + start + len; i++) {
char c; char c;
@@ -104,73 +211,68 @@ void WiFiManager::setEEPROMString(int start, int len, String string) {
EEPROM.write(i, c); EEPROM.write(i, c);
si++; si++;
} }
EEPROM.end();
}
boolean WiFiManager::hasConnected(void) {
int c = 0;
while ( c < 50 ) {
if (WiFi.status() == WL_CONNECTED) {
return true;
}
delay(200);
DEBUG_PRINT(".");
c++;
}
DEBUG_PRINT("");
DEBUG_PRINT("Could not connect to WiFi");
return false;
} }
/*
void WiFiManager::startWebConfig() { void WiFiManager::startWebConfig() {
keepLooping = true;
DEBUG_PRINT(""); DEBUG_PRINT("");
DEBUG_PRINT("WiFi connected"); DEBUG_PRINT("Starting Config Portal");
DEBUG_PRINT(WiFi.localIP()); DEBUG_PRINT(WiFi.localIP());
DEBUG_PRINT(WiFi.softAPIP()); DEBUG_PRINT(WiFi.softAPIP());
if (!mdns.begin(_apName, WiFi.localIP())) {
DEBUG_PRINT("Error setting up MDNS responder!");
while (1) {
delay(1000);
}
}
DEBUG_PRINT("mDNS responder started");
// Start the server
server.begin();
DEBUG_PRINT("Server started");
while (serverLoop() == WM_WAIT) { while (keepLooping) {
//looping //looping
if(timeout > 0 && start + timeout < millis()) { if(timeout > 0 && start + timeout < millis()) {
//we passed timeout value, release //we passed timeout value, release
DEBUG_PRINT("timeout reached"); DEBUG_PRINT("timeout reached");
return; keepLooping = false;
} }
//DNS
dnsServer.processNextRequest();
//HTTP
server.handleClient();
yield();
} }
DEBUG_PRINT("Setup done"); DEBUG_PRINT("Exited setup");
delay(5000); }*/
ESP.reset();
}
/*
String WiFiManager::beginConfigMode(void) { String WiFiManager::beginConfigMode(void) {
WiFi.softAP(_apName); WiFi.softAP(_apName);
DEBUG_PRINT("Started Soft Access Point"); delay(500); // Without delay I've seen the IP address blank
IPAddress apIp = WiFi.softAPIP(); Serial.print("AP IP address: ");
char ip[24]; Serial.println(WiFi.softAPIP());
sprintf(ip, "%d.%d.%d.%d", apIp[0], apIp[1], apIp[2], apIp[3]);
return ip; / * 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("/", std::bind(&WiFiManager::handleRoot, this));
server.on("/wifi", std::bind(&WiFiManager::handleWifi, this));
server.on("/wifisave", std::bind(&WiFiManager::handleWifiSave, this));
server.on("/generate_204", std::bind(&WiFiManager::handleRoot, this)); //Android captive portal. Maybe not needed. Might be handled by notFound handler.
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
Serial.println("HTTP server started");
} }
*/
int WiFiManager::serverLoop() int WiFiManager::serverLoop()
{ {
// Check for any mDNS queries and send responses
mdns.update();
/*
// Check if a client has connected // Check if a client has connected
WiFiClient client = server.available(); // WiFiClient client = server.available();
if (!client) { if (!client) {
return (WM_WAIT); return (WM_WAIT);
} }
@@ -271,6 +373,8 @@ int WiFiManager::serverLoop()
client.print(s); client.print(s);
DEBUG_PRINT("Done with client"); DEBUG_PRINT("Done with client");
return (WM_WAIT); return (WM_WAIT);
*/
} }
String WiFiManager::urldecode(const char *src) String WiFiManager::urldecode(const char *src)
@@ -314,7 +418,6 @@ void WiFiManager::resetSettings() {
setEEPROMString(0, 32, "-"); setEEPROMString(0, 32, "-");
setEEPROMString(32, 64, "-"); setEEPROMString(32, 64, "-");
EEPROM.commit();
DEBUG_PRINT("settings invalidated"); DEBUG_PRINT("settings invalidated");
delay(200); delay(200);
WiFi.disconnect(); WiFi.disconnect();
@@ -324,3 +427,182 @@ void WiFiManager::setTimeout(unsigned long seconds) {
timeout = seconds * 1000; timeout = seconds * 1000;
} }
/** Handle root or redirect to captive portal */
void WiFiManager::handleRoot() {
DEBUG_PRINT("Handle root");
if (captivePortal()) { // If caprive portal redirect instead of displaying the page.
return;
}
server.sendHeader("Cache-Control", "no-cache, no-store, must-revalidate");
server.sendHeader("Pragma", "no-cache");
server.sendHeader("Expires", "-1");
server.send(200, "text/html", ""); // Empty content inhibits Content-length header so we have to close the socket ourselves.
String head = HTTP_HEAD;
head.replace("{v}", "Options");
server.sendContent(head);
server.sendContent(HTTP_SCRIPT);
server.sendContent(HTTP_STYLE);
server.sendContent(HTTP_HEAD_END);
server.sendContent(
"<form action=\"/wifi\" method=\"get\"><button>Configure WiFi</button></form>"
);
server.sendContent(HTTP_END);
server.client().stop(); // Stop is needed because we sent no content length
}
/** Wifi config page handler */
void WiFiManager::handleWifi() {
server.sendHeader("Cache-Control", "no-cache, no-store, must-revalidate");
server.sendHeader("Pragma", "no-cache");
server.sendHeader("Expires", "-1");
server.send(200, "text/html", ""); // Empty content inhibits Content-length header so we have to close the socket ourselves.
String head = HTTP_HEAD;
head.replace("{v}", "Config ESP");
server.sendContent(head);
server.sendContent(HTTP_SCRIPT);
server.sendContent(HTTP_STYLE);
server.sendContent(HTTP_HEAD_END);
int n = WiFi.scanNetworks();
DEBUG_PRINT("scan done");
if (n == 0) {
DEBUG_PRINT("no networks found");
server.sendContent("<div>No networks found. Refresh to scan again.</div>");
}
else {
for (int i = 0; i < n; ++i)
{
DEBUG_PRINT(WiFi.SSID(i));
DEBUG_PRINT(WiFi.RSSI(i));
String item = HTTP_ITEM;
item.replace("{v}", WiFi.SSID(i));
server.sendContent(item);
yield();
}
}
server.sendContent(HTTP_FORM);
server.sendContent(HTTP_END);
server.client().stop();
DEBUG_PRINT("Sent config page");
}
/** Handle the WLAN save form and redirect to WLAN config page again */
void WiFiManager::handleWifiSave() {
DEBUG_PRINT("wifi save");
//server.arg("s").toCharArray(ssid, sizeof(ssid) - 1);
//server.arg("p").toCharArray(password, sizeof(password) - 1);
setSSID(urldecode(server.arg("s").c_str()));
setPassword(urldecode(server.arg("p").c_str()));
server.sendHeader("Cache-Control", "no-cache, no-store, must-revalidate");
server.sendHeader("Pragma", "no-cache");
server.sendHeader("Expires", "-1");
server.send(200, "text/html", ""); // Empty content inhibits Content-length header so we have to close the socket ourselves.
String head = HTTP_HEAD;
head.replace("{v}", "Credentials Saved");
server.sendContent(head);
server.sendContent(HTTP_SCRIPT);
server.sendContent(HTTP_STYLE);
server.sendContent(HTTP_HEAD_END);
server.sendContent(HTTP_SAVED);
server.sendContent(HTTP_END);
server.client().stop();
DEBUG_PRINT("Sent wifi save page");
/*
server.sendHeader("Location", "wifi", true);
server.sendHeader("Cache-Control", "no-cache, no-store, must-revalidate");
server.sendHeader("Pragma", "no-cache");
server.sendHeader("Expires", "-1");
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*/
//saveCredentials();
connect = true; //signal ready to connect/reset
}
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.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()) ) {
Serial.print("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;
}
/** 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;
}
WiFiManager.h
+32 -8
View File
@@ -15,8 +15,10 @@
#include <ESP8266WiFi.h> #include <ESP8266WiFi.h>
#include <EEPROM.h> #include <EEPROM.h>
#include <ESP8266mDNS.h>
#include <WiFiClient.h> #include <WiFiClient.h>
#include <ESP8266WebServer.h>
#include <DNSServer.h>
#define DEBUG //until arduino ide can include defines at compile time from main sketch #define DEBUG //until arduino ide can include defines at compile time from main sketch
@@ -30,7 +32,8 @@
class WiFiManager class WiFiManager
{ {
public: public:
WiFiManager(int eepromStart); WiFiManager();
void begin(); void begin();
void begin(char const *apName); void begin(char const *apName);
@@ -42,9 +45,11 @@ public:
String beginConfigMode(void); String beginConfigMode(void);
void startWebConfig(); void startWebConfig();
String getSSID(); String getSSID();
String getPassword(); String getPassword();
void resetSettings(); void setSSID(String s);
void setPassword(String p);
void resetSettings();
//for conveniennce //for conveniennce
String urldecode(const char*); String urldecode(const char*);
@@ -52,7 +57,9 @@ public:
//usefully for devices that failed to connect at some point and got stuck in a webserver loop //usefully for devices that failed to connect at some point and got stuck in a webserver loop
//in seconds //in seconds
void setTimeout(unsigned long seconds); void setTimeout(unsigned long seconds);
int serverLoop();
private: private:
const int WM_DONE = 0; const int WM_DONE = 0;
const int WM_WAIT = 10; const int WM_WAIT = 10;
@@ -64,7 +71,8 @@ private:
const String HTTP_SCRIPT = "<script>function c(l){document.getElementById('s').value=l.innerText||l.textContent;document.getElementById('p').focus();}</script>"; const String HTTP_SCRIPT = "<script>function c(l){document.getElementById('s').value=l.innerText||l.textContent;document.getElementById('p').focus();}</script>";
const String HTTP_HEAD_END = "</head><body>"; const String HTTP_HEAD_END = "</head><body>";
const String HTTP_ITEM = "<div><a href='#' onclick='c(this)'>{v}</a></div>"; const String HTTP_ITEM = "<div><a href='#' onclick='c(this)'>{v}</a></div>";
const String HTTP_FORM = "<form method='get' action='s'><input id='s' name='ssid' length=32 placeholder='SSID'><input id='p' name='pass' length=64 placeholder='password'><br/><input type='submit'></form>"; const String HTTP_FORM = "<form method='get' action='wifisave'><input id='s' name='s' length=32 placeholder='SSID'><input id='p' name='p' length=64 placeholder='password'><br/><input type='submit'></form>";
const String HTTP_SAVED = "<div>Credentials Saved<br />Node will reboot in 5 seconds.</div>";
const String HTTP_END = "</body></html>"; const String HTTP_END = "</body></html>";
int _eepromStart; int _eepromStart;
@@ -77,9 +85,25 @@ private:
String getEEPROMString(int start, int len); String getEEPROMString(int start, int len);
void setEEPROMString(int start, int len, String string); void setEEPROMString(int start, int len, String string);
int serverLoop();
bool keepLooping = true;
int status = WL_IDLE_STATUS;
void connectWifi(String ssid, String pass);
void handleRoot();
void handleWifi();
void handleWifiSave();
void handleNotFound();
boolean captivePortal();
// DNS server
const byte DNS_PORT = 53;
boolean isIp(String str);
String toStringIp(IPAddress ip);
boolean connect;
}; };
examples/AutoConnect/AutoConnect.ino
+19 -18
View File
@@ -2,29 +2,30 @@
//needed for library //needed for library
#include <EEPROM.h> #include <EEPROM.h>
#include <ESP8266mDNS.h> #include <ESP8266WebServer.h>
#include <DNSServer.h>
#include <WiFiManager.h> //https://github.com/tzapu/WiFiManager #include <WiFiManager.h> //https://github.com/tzapu/WiFiManager
//this intitilises the library, parameter is eeprom start //this intitilises the library, parameter is eeprom start
WiFiManager wifi(0); WiFiManager wifi;
void setup() { void setup() {
// put your setup code here, to run once: // put your setup code here, to run once:
Serial.begin(115200); Serial.begin(115200);
//WiFiManager //WiFiManager
//fetches ssid and pass from eeprom and tries to connect //fetches ssid and pass from eeprom and tries to connect
//if it does not connect it starts an access point with the specified name //if it does not connect it starts an access point with the specified name
//here "AutoConnectAP" //here "AutoConnectAP"
//and goes into a blocking loop awaiting configuration //and goes into a blocking loop awaiting configuration
wifi.autoConnect("AutoConnectAP"); wifi.autoConnect("AutoConnectAP");
//if you get here you have connected to the WiFi //if you get here you have connected to the WiFi
Serial.println("connected...yeey :)"); Serial.println("connected...yeey :)");
} }
void loop() { void loop() {
// put your main code here, to run repeatedly: // put your main code here, to run repeatedly:
} }
examples/AutoConnectWithTimeout/AutoConnectWithTimeout.ino
+11 -4
View File
@@ -1,23 +1,30 @@
#include <ESP8266WiFi.h> //https://github.com/esp8266/Arduino #include <ESP8266WiFi.h> //https://github.com/esp8266/Arduino
//needed for library //needed for library
#include <EEPROM.h>
#include <ESP8266mDNS.h>
#include <WiFiManager.h> //https://github.com/tzapu/WiFiManager #include <WiFiManager.h> //https://github.com/tzapu/WiFiManager
#include <EEPROM.h>
#include <WiFiClient.h>
#include <ESP8266WebServer.h>
#include <DNSServer.h>
//this intitilises the library, parameter is eeprom start //this intitilises the library, parameter is eeprom start
WiFiManager wifi(0); WiFiManager wifi;
void setup() { void setup() {
// put your setup code here, to run once: // put your setup code here, to run once:
Serial.begin(115200); Serial.begin(115200);
//reset settings - for testing
//wifi.resetSettings();
//WiFiManager //WiFiManager
//sets timeout until configuration portal gets turned off //sets timeout until configuration portal gets turned off
//useful to make it all retry or go to sleep //useful to make it all retry or go to sleep
//in seconds //in seconds
wifi.setTimeout(120); wifi.setTimeout(180);
//fetches ssid and pass from eeprom and tries to connect //fetches ssid and pass from eeprom and tries to connect
//if it does not connect it starts an access point with the specified name //if it does not connect it starts an access point with the specified name