0.6 release

updated readme

README.md

@@ -5,7 +5,30 @@ The configuration portal is of the captive variety, so on various devices it wil
 
 First attempt at a library. Lots more changes and fixes to do. Contributions are welcome.
 
-## How It works
+#### This works with the ESP8266 Arduino platform with a recent stable release(2.0.0 or newer) https://github.com/esp8266/Arduino
+
+## Contents
+ - [How it works](#how-it-works)
+ - [Wishlist](#wishlist)
+ - [Quick start](#quick-start)
+   - Installing
+     - [Through Boards Manager](#install-through-boards-manager)
+     - [From Github](#checkout-from-github)
+   - [Using](#using)
+ - [Documentation](#documentation)
+   - [Access Point Password](#password-protect-the-configuration-access-point)
+   - [Callbacks](#callbacks)
+   - [Timeout](#timeout)
+   - [On Demand Configuration](#on-demand-configuration-portal)
+   - [Custom Parameters](#custom-parameters)
+   - [Custom IP Configuration](#custom-ip-configuration)
+   - [Filter Low Quality Networks](#filter-networks)
+   - [Debug Output](#debug)
+ - [Releases](#releases)
+ - [Contributors](#contributions-and-thanks)
+
+
+## How It Works
 - when your ESP starts up, it sets it up in Station mode and tries to connect to a previously saved Access Point
 - if this is unsuccessful (or no previous network saved) it moves the ESP into Access Point mode and spins up a DNS and WebServer (default ip 192.168.4.1)
 - using any wifi enabled device with a browser (computer, phone, tablet) connect to the newly created Access Point
@@ -13,29 +36,41 @@ First attempt at a library. Lots more changes and fixes to do. Contributions are
 - choose one of the access points scanned, enter password, click save
 - ESP will try to connect. If successful, it relinquishes control back to your app. If not, reconnect to AP and reconfigure.
 
-## Still left to do
+## How It Looks
+![ESP8266 WiFi Captive Portal Homepage](http://i.imgur.com/YPvW9eql.png) ![ESP8266 WiFi Captive Portal Configuration](http://i.imgur.com/oicWJ4gl.png)
+
+## Wishlist
 - ~~remove dependency on EEPROM library~~
-- move HTML Strings to PROGMEM
-- cleanup and streamline code
+- ~~move HTML Strings to PROGMEM~~
+- ~~cleanup and streamline code~~ (although this is ongoing)
 - if timeout is set, extend it when a page is fetched in AP mode
-- add ability to configure more parameters than ssid/password
+- ~~add ability to configure more parameters than ssid/password~~
 - maybe allow setting ip of ESP after reboot
-
-This works with the ESP8266 Arduino platform https://github.com/esp8266/Arduino
-
-## Releases
-> v0.3 removed the need for EEPROM and works with the 2.0.0 and above stable release of the ESP8266 for Arduino IDE package
-
-> **v0.2 and newer need the latest staging version (or at least a recent release of the staging version) to work**
-
-> v0.1 works with the staging release ver. 1.6.5-1044-g170995a, built on Aug 10, 2015 of the ESP8266 Arduino library.
-
+- ~~add to Arduino Boards Manager~~
+- add to PlatformIO
+- add multiple sets of network credentials
+- allow users to customize CSS
 
 ## Quick Start
-- Make sure you have a recent package of the ESP8266 for Arduino IDE
 
+### Installing
+You can either install through the Arduino Boards Manager or checkout the latest changes or a release from github
+
+#### Install through Boards Manager
+__Currently version 0.6 works with release 2.0.0 or newer of the [ESP8266 core for Arduino](https://github.com/esp8266/Arduino)__
+ - in Arduino IDE got to Sketch/Include Library/Manage Libraries
+  ![Manage Libraries](http://i.imgur.com/9BkEBkR.png)
+
+ - search for WiFiManager
+  ![WiFiManager package](http://i.imgur.com/18yIai8.png)
+
+ - click Install and start [using it](#using)
+
+####  Checkout from github
+__Github version works with release 2.0.0 or newer of the [ESP8266 core for Arduino](https://github.com/esp8266/Arduino)__
 - Checkout library to your Arduino libraries folder
 
+### Using
 - Include in your sketch
 ```cpp
 #include <DNSServer.h>
@@ -43,14 +78,18 @@ This works with the ESP8266 Arduino platform https://github.com/esp8266/Arduino
 #include <WiFiManager.h>
 ```
 
-- Initialise library, in your setup function add
+- Initialize library, in your setup function add
 ```cpp
 WiFiManager wifiManager;
 ```
 
 - Also in the setup function add
 ```cpp
-//parameter is name of access point
+//first parameter is name of access point, second is the password
+wifiManager.autoConnect("AP-NAME", "AP-PASSWORD");
+```
+if you just want an unsecured access point
+```cpp
 wifiManager.autoConnect("AP-NAME");
 ```
 or if you want to use and auto generated name from 'ESP' and the esp's Chip ID use
@@ -61,9 +100,53 @@ wifiManager.autoConnect();
 After you write your sketch and start the ESP, it will try to connect to WiFi. If it fails it starts in Access Point mode.
 While in AP mode, connect to it then open a browser to the gateway IP, default 192.168.4.1, configure wifi, save and it should reboot and connect.
 
-Also see examples.
+Also see [examples](https://github.com/tzapu/WiFiManager/tree/master/examples).
 
-### Timeout
+## Documentation
+
+#### Password protect the configuration Access Point
+You can and should password protect the configuration access point.  Simply add the password as a second parameter to `autoConnect`.
+A short password seems to have unpredictable results so use one that's around 8 characters or more in length.
+The guidelines are that a wifi password must consist of 8 to 63 ASCII-encoded characters in the range of 32 to 126 (decimal)
+```cpp
+wifiManager.autoConnect("AutoConnectAP", "password")
+```
+
+#### Callbacks
+##### Enter Config mode
+Use this if you need to do something when your device enters configuration mode on failed WiFi connection attempt.
+Before `autoConnect()`
+```cpp
+wifiManager.setAPCallback(configModeCallback);
+```
+`configModeCallback` declaration and example
+```cpp
+void configModeCallback (WiFiManager *myWiFiManager) {
+  Serial.println("Entered config mode");
+  Serial.println(WiFi.softAPIP());
+
+  Serial.println(myWiFiManager->getConfigPortalSSID());
+}
+```
+
+##### Save settings
+This gets called when custom parameters have been set **AND** a connection has been established. Use it to set a flag, so when all the configuration finishes, you can save the extra parameters somewhere. See [AutoConnectWithFSParameters Example](https://github.com/tzapu/WiFiManager/tree/master/examples/AutoConnectWithFSParameters).
+```cpp
+wifiManager.setSaveConfigCallback(saveConfigCallback);
+```
+`saveConfigCallback` declaration and example
+```cpp
+//flag for saving data
+bool shouldSaveConfig = false;
+
+//callback notifying us of the need to save config
+void saveConfigCallback () {
+  Serial.println("Should save config");
+  shouldSaveConfig = true;
+}
+```
+
+#### Timeout
 If you need to set a timeout so the ESP doesn't hang waiting to be configured, for instance after a power failure, you can add
 ```cpp
 wifiManager.setTimeout(180);
@@ -71,11 +154,46 @@ wifiManager.setTimeout(180);
 which will wait 3 minutes (180 seconds). When the time passes, the autoConnect function will return, no matter the outcome.
 Check for connection and if it's still not established do whatever is needed (on some modules I restart them to retry, on others I enter deep sleep)
 
-### Debug
-Debug is enabled by default on Serial. To disable add before autoConnect
+#### On Demand Configuration Portal
+If you would rather start the configuration portal on demand rather than automatically on a failed connection attempt, then this is for you.
+
+Instead of calling `autoConnect()` which does all the connecting and failover configuration portal setup for you, you need to use `startConfigPortal()`
+Example usage
 ```cpp
-wifiManager.setDebugOutput(false);
+void loop() {
+  // is configuration portal requested?
+  if ( digitalRead(TRIGGER_PIN) == LOW ) {
+    WiFiManager wifiManager;
+    wifiManager.startConfigPortal("OnDemandAP");
+    Serial.println("connected...yeey :)");
+  }
+}
 ```
+See example for a more complex version. [OnDemandConfigPortal](https://github.com/tzapu/WiFiManager/tree/master/examples/OnDemandConfigPortal)
+
+### Custom Parameters
+You can use WiFiManager to collect more parameters than just SSID and password.
+This could be helpful for configuring stuff like MQTT host and port, [blynk](http://www.blynk.cc) or [emoncms](http://emoncms.org) tokens, just to name a few.
+**You are responsible for saving and loading these custom values.** The library just collects and displays the data for you as a convenience.
+Usage scenario would be:
+- load values from somewhere (EEPROM/FS) or generate some defaults
+- add the custom parameters to WiFiManager using
+ ```cpp
+ // id/name, placeholder/prompt, default, length
+ WiFiManagerParameter custom_mqtt_server("server", "mqtt server", mqtt_server, 40);
+ wifiManager.addParameter(&custom_mqtt_server);
+
+ ```
+- if connection to AP fails, configuration portal starts and you can set /change the values (or use on demand configuration portal)
+- once configuration is done and connection is established [save config callback]() is called
+- once WiFiManager returns control to your application, read and save the new values using the `WiFiManagerParameter` object.
+ ```cpp
+ mqtt_server = custom_mqtt_server.getValue();
+ ```  
+This feature is a lot more involved than all the others, so here are some examples to fully show how it is done
+- Save and load custom parameters to file system in json form [AutoConnectWithFSParameters](https://github.com/tzapu/WiFiManager/tree/master/examples/AutoConnectWithFSParameters)
+- *Save and load custom parameters to EEPROM* (not done yet)
+
 
 ### Custom IP Configuration
 This will set your captive portal to a specific IP should you need/want such a feature. Add the following snippet before `autoConnect()`
@@ -83,8 +201,67 @@ This will set your captive portal to a specific IP should you need/want such a f
 //set custom ip for portal
 wifiManager.setAPConfig(IPAddress(10,0,1,1), IPAddress(10,0,1,1), IPAddress(255,255,255,0));
 ```
+#### Filter Networks
+If you would like to filter low signal quality networks you can tell WiFiManager to not show networks below an arbitrary quality %;
+```
+wifiManager.setMinimumSignalQuality(10);
+```
+will not show networks under 10% signal quality. If you omit the parameter it defaults to 8%;
+
+#### Debug
+Debug is enabled by default on Serial. To disable add before autoConnect
+```cpp
+wifiManager.setDebugOutput(false);
+```
+
+## Releases
+#### 0.6
+ - custom parameters
+ - prettier
+ - on demand config portal
+ - commit #100 :D
+
+##### 0.5
+ - Added to Arduino Boards Manager - Thanks Max
+ - moved most stuff to PROGMEM
+ - added signal quality and a nice little padlock to show which networks are encrypted
+
+##### v0.4 - all of it user contributed changes - Thank you
+ - added ability to password protect the configuration Access Point
+ - callback for enter configuration mode
+ - memory allocation improvements
+
+##### v0.3
+ - removed the need for EEPROM and works with the 2.0.0 and above stable release of the ESP8266 for Arduino IDE package
+ - removed restart on save of credentials
+ - updated examples
+
+##### v0.2
+needs the latest staging version (or at least a recent release of the staging version) to work
+This is jsut random textTo show the lagginess.
+[the editor is completly](behing the typing)
+
+##### v0.1
+works with the staging release ver. 1.6.5-1044-g170995a, built on Aug 10, 2015 of the ESP8266 Arduino library.
+
+
+### Contributions and thanks
+The support and help I got from the community has been nothing short of phenomenal. I can't thank you guys enough. This is my first real attept in developing open source stuff and I must say, now I understand why people are so dedicated to it, it is because of all the wonderful people involved.
+
+__THANK YOU__
+
+[Maximiliano Duarte](https://github.com/domonetic)
+[alltheblinkythings](https://github.com/alltheblinkythings)
+[Niklas Wall](https://github.com/niklaswall)
+[Jakub Piasecki](https://github.com/zaporylie)
+[Peter Allan](https://github.com/alwynallan)
+[John Little](https://github.com/j0hnlittle)
+[markaswift](https://github.com/markaswift)
+[franklinvv](https://github.com/franklinvv)
+[Alberto Ricci Bitti](https://github.com/riccibitti)
+[SebiPanther](https://github.com/SebiPanther)
+
+Sorry if i have missed anyone.
 
 #### Inspiration
 - http://www.esp8266.com/viewtopic.php?f=29&t=2520
-
-To be continued...

WiFiManager.cpp

@@ -1,219 +1,214 @@
 /**************************************************************
- * WiFiManager is a library for the ESP8266/Arduino platform
- * (https://github.com/esp8266/Arduino) to enable easy
- * configuration and reconfiguration of WiFi credentials and
- * store them in EEPROM.
- * 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
- * Licensed under MIT license
+   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
+   Licensed under MIT license
  **************************************************************/
 
 #include "WiFiManager.h"
 
-
-//DNSServer dnsServer;
-
-// Web server
-//ESP8266WebServer server(80);
-
-WiFiManager::WiFiManager() : server(80) {
+WiFiManagerParameter::WiFiManagerParameter(const char *id, const char *placeholder, const char *defaultValue, int length) {
+  _id = id;
+  _placeholder = placeholder;
+  _length = length;
+  _value = new char[length];
+  for (int i = 0; i < length; i++) {
+    _value[i] = 0;
+  }
+  if (defaultValue != NULL) {
+    strncpy(_value, defaultValue, length);
+  }
 }
 
-void WiFiManager::begin() {
-  begin("NoNetESP");
+const char* WiFiManagerParameter::getValue() {
+  return _value;
+}
+const char* WiFiManagerParameter::getID() {
+  return _id;
+}
+const char* WiFiManagerParameter::getPlaceholder() {
+  return _placeholder;
+}
+int WiFiManagerParameter::getValueLength() {
+  return _length;
 }
 
-void WiFiManager::begin(char const *apName) {
-  
-  DEBUG_PRINT("");
-  _apName = apName;
+WiFiManager::WiFiManager() {
+}
+
+void WiFiManager::addParameter(WiFiManagerParameter *p) {
+  _params[_paramsCount] = p;
+  _paramsCount++;
+  DEBUG_WM("Adding parameter");
+  DEBUG_WM(p->getID());
+}
+
+void WiFiManager::setupConfigPortal() {
+  dnsServer.reset(new DNSServer());
+  server.reset(new ESP8266WebServer(80));
+
+  DEBUG_WM(F(""));
   start = millis();
 
-  DEBUG_PRINT("Configuring access point... ");
-  DEBUG_PRINT(_apName);
+  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 (_ip) {
-    DEBUG_PRINT("Custom IP/GW/Subnet");
+    DEBUG_WM(F("Custom IP/GW/Subnet"));
     WiFi.softAPConfig(_ip, _gw, _sn);
   }
 
-  WiFi.softAP(_apName);//TODO: add password option
-  delay(500); // Without delay I've seen the IP address blank
-  DEBUG_PRINT("AP IP address: ");
-  DEBUG_PRINT(WiFi.softAPIP());
+  if (_apPassword != NULL) {
+    WiFi.softAP(_apName, _apPassword);//password option
+  } else {
+    WiFi.softAP(_apName);
+  }
 
-  /* Setup the DNS server redirecting all the domains to the apIP */  
-  dnsServer.setErrorReplyCode(DNSReplyCode::NoError);
-  dnsServer.start(DNS_PORT, "*", WiFi.softAPIP());
+  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("/", 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("/generate_204", std::bind(&WiFiManager::handle204, this));  //Android/Chrome OS captive portal check.
-  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_PRINT("HTTP server started");
+  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("/generate_204", std::bind(&WiFiManager::handle204, this));  //Android/Chrome OS captive portal check.
+  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::autoConnect() {
   String ssid = "ESP" + String(ESP.getChipId());
-  return autoConnect(ssid.c_str());
+  return autoConnect(ssid.c_str(), NULL);
 }
 
-boolean WiFiManager::autoConnect(char const *apName) {
-  DEBUG_PRINT("");
-  DEBUG_PRINT("AutoConnect");
-  
+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();
-  //use SDK functions to get SSID and pass
-  //String ssid = WiFi.SSID();
-  //String pass = WiFi.psk();
-  
+
+  // attempt to connect; should it fail, fall back to AP
   WiFi.mode(WIFI_STA);
-  connectWifi(ssid, pass);
-  int s = WiFi.status();
-  if (s == WL_CONNECTED) {
-    DEBUG_PRINT("IP Address:");
-    DEBUG_PRINT(WiFi.localIP());
+  if (connectWifi(ssid, pass) == WL_CONNECTED)   {
+    DEBUG_WM(F("IP Address:"));
+    DEBUG_WM(WiFi.localIP());
     //connected
     return true;
   }
- 
 
-  // delay(1000);
-  //not connected
+  return startConfigPortal(apName, apPassword);
+}
+
+boolean  WiFiManager::startConfigPortal(char const *apName, char const *apPassword) {
   //setup AP
   WiFi.mode(WIFI_AP);
 
-  connect = false;
-  begin(apName);
+  _apName = apName;
+  _apPassword = apPassword;
 
-  bool looping = true;
-  //while(1) {
-  while(timeout == 0 || millis() < start + timeout) {
-    //DNS
-    dnsServer.processNextRequest();
-    //HTTP
-    server.handleClient();
-
-    /*if(connect) {
-      delay(5000);
-      ESP.reset();
-      delay(1000);
-    }*/
-    
-    if(connect) {
-      delay(2000);
-      DEBUG_PRINT("Connecting to new AP");
-      connect = false;
-      //ssid = getSSID();
-      //pass = getPassword();
-      connectWifi(_ssid, _pass);
-      int s = WiFi.status();
-      if (s != WL_CONNECTED) {
-        DEBUG_PRINT("Failed to connect.");
-        //not connected, should retry everything
-        //ESP.reset();
-        //delay(1000);
-        //return false;
-      } else {
-        //connected 
-        WiFi.mode(WIFI_STA);
-        return true;
-      }
- 
-    }
-    yield();    
+  //notify we entered AP mode
+  if ( _apcallback != NULL) {
+    _apcallback(this);
   }
 
+  connect = false;
+  setupConfigPortal();
+
+  while (timeout == 0 || millis() < start + timeout) {
+    //DNS
+    dnsServer->processNextRequest();
+    //HTTP
+    server->handleClient();
+
+
+    if (connect) {
+      delay(2000);
+      DEBUG_WM(F("Connecting to new AP"));
+      connect = false;
+      // using user-provided  _ssid, _pass in place of system-stored ssid amd pass
+      if (connectWifi(_ssid, _pass) != WL_CONNECTED) {
+        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;
+      }
+
+    }
+    yield();
+  }
+
+  server.reset();
+  dnsServer.reset();
+
   return  WiFi.status() == WL_CONNECTED;
 }
 
 
-void WiFiManager::connectWifi(String ssid, String pass) {
-  DEBUG_PRINT("Connecting as wifi client...");
+int WiFiManager::connectWifi(String ssid, String pass) {
+  DEBUG_WM(F("Connecting as wifi client..."));
   //WiFi.disconnect();
   WiFi.begin(ssid.c_str(), pass.c_str());
   int connRes = WiFi.waitForConnectResult();
-  DEBUG_PRINT ("Connection result: ");
-  DEBUG_PRINT ( connRes );
+  DEBUG_WM ("Connection result: ");
+  DEBUG_WM ( connRes );
+  return connRes;
 }
 
 
 String WiFiManager::getSSID() {
   if (_ssid == "") {
-    DEBUG_PRINT("Reading EEPROM SSID");
-    _ssid = WiFi.SSID();//getEEPROMString(0, 32);
-    DEBUG_PRINT("SSID: ");
-    DEBUG_PRINT(_ssid);
+    DEBUG_WM(F("Reading SSID"));
+    _ssid = WiFi.SSID();
+    DEBUG_WM(F("SSID: "));
+    DEBUG_WM(_ssid);
   }
   return _ssid;
 }
 
 String WiFiManager::getPassword() {
   if (_pass == "") {
-    DEBUG_PRINT("Reading EEPROM Password");
-    _pass = WiFi.psk();//getEEPROMString(32, 64);
-    DEBUG_PRINT("Password: " + _pass);
-    //DEBUG_PRINT(_pass);
+    DEBUG_WM(F("Reading Password"));
+    _pass = WiFi.psk();
+    DEBUG_WM("Password: " + _pass);
+    //DEBUG_WM(_pass);
   }
   return _pass;
 }
 
-/*
-void WiFiManager::setSSID(String s) {
-  _ssid = s;
-  setEEPROMString(0, 32, _ssid);
+String WiFiManager::getConfigPortalSSID() {
+  return _apName;
 }
 
-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) {
-  EEPROM.begin(512);
-  delay(10);
-  String string = "";
-  for (int i = _eepromStart + start; i < _eepromStart + start + len; i++) {
-    //DEBUG_PRINT(i);
-    string += char(EEPROM.read(i));
-  }
-  EEPROM.end();
-  return string;
-}
-*/
-/*
-void WiFiManager::setEEPROMString(int start, int len, String string) {
-  EEPROM.begin(512);
-  delay(10);
-  int si = 0;
-  for (int i = _eepromStart + start; i < _eepromStart + start + len; i++) {
-    char c;
-    if (si < string.length()) {
-      c = string[si];
-      //DEBUG_PRINT("Wrote: ");
-      //DEBUG_PRINT(c);
-    } else {
-      c = 0;
-    }
-    EEPROM.write(i, c);
-    si++;
-  }
-  EEPROM.end();
-  DEBUG_PRINT("Wrote " + string);
-}*/
-
 String WiFiManager::urldecode(const char *src)
 {
   String decoded = "";
@@ -251,13 +246,10 @@ String WiFiManager::urldecode(const char *src)
 }
 
 void WiFiManager::resetSettings() {
-  //need to call it only after lib has been started with autoConnect or begin
-  //setEEPROMString(0, 32, "-");
-  //setEEPROMString(32, 64, "-");
-
-  DEBUG_PRINT("settings invalidated");
-  WiFi.disconnect();
-  delay(200);
+  DEBUG_WM(F("settings invalidated"));
+  DEBUG_WM(F("THIS MAY CAUSE AP NOT TO STRT UP PROPERLY. YOU NEED TO COMMENT IT OUT AFTER ERASING THE DATA."));
+  WiFi.disconnect(true);
+  //delay(200);
 }
 
 void WiFiManager::setTimeout(unsigned long seconds) {
@@ -274,170 +266,244 @@ void WiFiManager::setAPConfig(IPAddress ip, IPAddress gw, IPAddress sn) {
   _sn = sn;
 }
 
+void WiFiManager::setMinimumSignalQuality(int quality) {
+  _minimumQuality = quality;
+}
+
 
 /** Handle root or redirect to captive portal */
 void WiFiManager::handleRoot() {
-  DEBUG_PRINT("Handle root");
+  DEBUG_WM(F("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.
+  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><br/>"
-  );
-  server.sendContent(
-    "<form action=\"/0wifi\" method=\"get\"><button>Configure WiFi (No Scan)</button></form>"
-  );
-  
-  server.sendContent(HTTP_END);
+  server->sendContent(head);
+  server->sendContent_P(HTTP_SCRIPT);
+  server->sendContent_P(HTTP_STYLE);
+  server->sendContent_P(HTTP_HEAD_END);
 
-  server.client().stop(); // Stop is needed because we sent no content length
+  //server->sendContent(F("<h1>"));
+  String title = "<h1>";
+  title += _apName;
+  title += "</h1>";
+  server->sendContent(title);
+  server->sendContent(F("<h3>WiFiManager</h3>"));
+
+
+  server->sendContent_P(HTTP_PORTAL_OPTIONS);
+  server->sendContent_P(HTTP_END);
+
+  server->client().stop(); // Stop is needed because we sent no content length
 }
 
 /** Wifi config page handler */
-void WiFiManager::handleWifi(bool scan) {
-  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.
+void WiFiManager::handleWifi(boolean scan) {
+  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);
+  server->sendContent(head);
+  server->sendContent_P(HTTP_SCRIPT);
+  server->sendContent_P(HTTP_STYLE);
+  server->sendContent_P(HTTP_HEAD_END);
 
   if (scan) {
     int n = WiFi.scanNetworks();
-    DEBUG_PRINT("Scan done");
+    DEBUG_WM(F("Scan done"));
     if (n == 0) {
-      DEBUG_PRINT("No networks found");
-      server.sendContent("<div>No networks found. Refresh to scan again.</div>");
+      DEBUG_WM(F("No networks found"));
+      server->sendContent("No networks found. Refresh to scan again.");
     }
     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();
+        DEBUG_WM(WiFi.SSID(i));
+        DEBUG_WM(WiFi.RSSI(i));
+        int quality = getRSSIasQuality(WiFi.RSSI(i));
+        
+        if (_minimumQuality == -1 || _minimumQuality < quality) {
+          String item = FPSTR(HTTP_ITEM);
+          String rssiQ;
+          rssiQ += quality;
+          item.replace("{v}", WiFi.SSID(i));
+          item.replace("{r}", rssiQ);
+          if (WiFi.encryptionType(i) != ENC_TYPE_NONE) {
+            item.replace("{i}", FPSTR(HTTP_ITEM_PADLOCK));
+          } else {
+            item.replace("{i}", "");
+          }
+          //DEBUG_WM(item);
+          server->sendContent(item);
+          delay(0);
+        } else {
+          DEBUG_WM(F("Skipping due to quality"));
+        }
+
       }
+      server->sendContent("<br/>");
     }
   }
-  
-  server.sendContent(HTTP_FORM);
-  server.sendContent(HTTP_END);
-  server.client().stop();
-  
-  DEBUG_PRINT("Sent config page");  
+
+  server->sendContent_P(HTTP_FORM_START);
+  char parLength[2];
+  // 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);
+    pitem.replace("{i}", _params[i]->getID());
+    pitem.replace("{n}", _params[i]->getID());
+    pitem.replace("{p}", _params[i]->getPlaceholder());
+    snprintf(parLength, 2, "%d", _params[i]->getValueLength());
+    pitem.replace("{l}", parLength);
+    pitem.replace("{v}", _params[i]->getValue());
+
+    server->sendContent(pitem);
+  }
+  if (_params[0] != NULL) {
+    server->sendContent_P("<br/>");
+  }
+
+  server->sendContent_P(HTTP_FORM_END);
+  server->sendContent_P(HTTP_END);
+  server->client().stop();
+
+  DEBUG_WM(F("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);
+  DEBUG_WM(F("WiFi save"));
 
   //SAVE/connect here
-  //setSSID(urldecode(server.arg("s").c_str()));
-  //setPassword(urldecode(server.arg("p").c_str()));
-  _ssid = urldecode(server.arg("s").c_str());
-  _pass = urldecode(server.arg("p").c_str());
+  _ssid = urldecode(server->arg("s").c_str());
+  _pass = 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.
+  //parameters
+  for (int i = 0; i < _paramsCount; i++) {
+    if (_params[i] == NULL) {
+      break;
+    }
+    //read parameter
+    String value = urldecode(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);
+  }
+
+  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(head);
+  server->sendContent_P(HTTP_SCRIPT);
+  server->sendContent_P(HTTP_STYLE);
+  server->sendContent_P(HTTP_HEAD_END);
+
+  server->sendContent_P(HTTP_SAVED);
+
+  server->sendContent_P(HTTP_END);
+  server->client().stop();
+
+  DEBUG_WM(F("Sent wifi save page"));
 
-  server.sendContent(HTTP_END);
-  server.client().stop();
-  
-  DEBUG_PRINT("Sent wifi save page");  
-  
-  //saveCredentials();
   connect = true; //signal ready to connect/reset
 }
 
 void WiFiManager::handle204() {
-  DEBUG_PRINT("204 No Response");  
-  server.sendHeader("Cache-Control", "no-cache, no-store, must-revalidate");
-  server.sendHeader("Pragma", "no-cache");
-  server.sendHeader("Expires", "-1");
-  server.send ( 204, "text/plain", "");
+  DEBUG_WM(F("204 No Response"));
+  server->sendHeader("Cache-Control", "no-cache, no-store, must-revalidate");
+  server->sendHeader("Pragma", "no-cache");
+  server->sendHeader("Expires", "-1");
+  server->send ( 204, "text/plain", "");
 }
 
-
 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 += server->uri();
   message += "\nMethod: ";
-  message += ( server.method() == HTTP_GET ) ? "GET" : "POST";
+  message += ( server->method() == HTTP_GET ) ? "GET" : "POST";
   message += "\nArguments: ";
-  message += server.args();
+  message += server->args();
   message += "\n";
 
-  for ( uint8_t i = 0; i < server.args(); i++ ) {
-    message += " " + server.argName ( i ) + ": " + server.arg ( i ) + "\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 );
+  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()) ) {
-    DEBUG_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
+  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;
+}
 
-template <typename Generic>
-void WiFiManager::DEBUG_PRINT(Generic text) {
-  if(_debug) {
-    Serial.print("*WM: ");
-    Serial.println(text);    
-  }
+//start up save config callback
+void WiFiManager::setSaveConfigCallback( void (*func)(void) ) {
+  _savecallback = func;
 }
 
 
 
+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) {

WiFiManager.h

@@ -1,116 +1,153 @@
 /**************************************************************
- * WiFiManager is a library for the ESP8266/Arduino platform
- * (https://github.com/esp8266/Arduino) to enable easy 
- * configuration and reconfiguration of WiFi credentials and 
- * store them in EEPROM.
- * inspired by http://www.esp8266.com/viewtopic.php?f=29&t=2520
- * https://github.com/chriscook8/esp-arduino-apboot 
- * Built by AlexT https://github.com/tzapu
- * Licensed under MIT license
+   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
+   Licensed under MIT license
  **************************************************************/
 
 #ifndef WiFiManager_h
 #define WiFiManager_h
 
 #include <ESP8266WiFi.h>
-
-//#include <EEPROM.h>
-//#include <WiFiClient.h>
 #include <ESP8266WebServer.h>
 #include <DNSServer.h>
+#include <memory>
+
+
+const char HTTP_200[] PROGMEM = "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n";
+//const char HTTP_HEAD[] PROGMEM = "<!DOCTYPE html><html lang=\"en\"><head><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"/><title>{v}</title>";
+const char HTTP_STYLE[] PROGMEM = "<style>div,input{padding:5px;font-size:1em;} input{width:95%;} body{text-align:center;font-family:verdana;} button{border:0;border-radius:0.3rem;background-color:#1fa3ec;color:#fff;line-height:2.4rem;font-size:1.2rem;width:100%;}</style>";
+const char HTTP_SCRIPT[] PROGMEM = "<script>function c(l){document.getElementById('s').value=l.innerText||l.textContent;document.getElementById('p').focus();}</script>";
+const char HTTP_HEAD_END[] PROGMEM = "</head><body><div style='text-align: left; display: inline-block;'>";
+const char HTTP_PORTAL_OPTIONS[] PROGMEM = "<form action=\"/wifi\" method=\"get\"><button>Configure WiFi</button></form><br/><form action=\"/0wifi\" method=\"get\"><button>Configure WiFi (No Scan)</button></form>";
+const char HTTP_ITEM[] PROGMEM = "<div><a href='#' onclick='c(this)'>{v}</a> {r}% {i}</div>";
+const char HTTP_ITEM_PADLOCK[] PROGMEM = "<img src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAALVBMVEX///8EBwfBwsLw8PAzNjaCg4NTVVUjJiZDRUUUFxdiZGSho6OSk5Pg4eFydHTCjaf3AAAAZElEQVQ4je2NSw7AIAhEBamKn97/uMXEGBvozkWb9C2Zx4xzWykBhFAeYp9gkLyZE0zIMno9n4g19hmdY39scwqVkOXaxph0ZCXQcqxSpgQpONa59wkRDOL93eAXvimwlbPbwwVAegLS1HGfZAAAAABJRU5ErkJggg==' width='13px'/>";
+const char HTTP_FORM_START[] PROGMEM = "<form method='get' action='wifisave'><input id='s' name='s' length=32 placeholder='SSID'><br/><input id='p' name='p' length=64 type='password' placeholder='password'><br/>";
+const char HTTP_FORM_PARAM[] PROGMEM = "<br/><input id='{i}' name='{n}' length={l} placeholder='{p}' value='{v}'>";
+const char HTTP_FORM_END[] PROGMEM = "<br/><button type='submit'>save</button></form>";
+
+const char HTTP_SAVED[] PROGMEM = "<div>Credentials Saved<br />Trying to connect ESP to network.<br />If it fails reconnect to AP to try again</div>";
+const char HTTP_END[] PROGMEM = "</div></body></html>";
+
+#define WIFI_MANAGER_MAX_PARAMS 10
+
+class WiFiManagerParameter {
+  public:
+    WiFiManagerParameter(const char *id, const char *placeholder, const char *defaultValue, int length);
+
+    const char* getID();
+    const char* getValue();
+    const char* getPlaceholder();
+    int getValueLength();
+  private:
+    const char* _id;
+    const char* _placeholder;
+    char* _value;
+    int _length;
+
+    friend class WiFiManager;
+};
 
 
 class WiFiManager
 {
-public:
+  public:
     WiFiManager();
-    
-    void    begin();
-    void    begin(char const *apName);
-    
-    boolean autoConnect();
-    boolean autoConnect(char const *apName);
-    
-    boolean hasConnected();
-    
-    String  beginConfigMode(void);
-    void    startWebConfig();
-    
-    String  getSSID();
-    String  getPassword();
-    void    setSSID(String s);
-    void    setPassword(String p);
-    void    resetSettings();
-    //for conveniennce
-    String  urldecode(const char*);
 
-    //sets timeout before webserver loop ends and exits even if there has been no setup. 
+    boolean       autoConnect();
+    boolean       autoConnect(char const *apName, char const *apPassword = NULL);
+
+    //if you want to always start the config portal, without trying to connect first
+    boolean       startConfigPortal(char const *apName, char const *apPassword = NULL);
+
+    String        getSSID();
+    String        getPassword();
+
+    // get the AP name of the config portal, so it can be used in the callback
+    String        getConfigPortalSSID();
+
+    void          resetSettings();
+    //for convenience
+    String        urldecode(const char*);
+
+    //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
-    void    setTimeout(unsigned long seconds);
-    void    setDebugOutput(boolean debug);
+    void          setTimeout(unsigned long seconds);
+    void          setDebugOutput(boolean debug);
+    //defaults to not showing anything under 8% signal quality if called
+    void          setMinimumSignalQuality(int quality = 8);
 
     //sets a custom ip /gateway /subnet configuration
-    void    setAPConfig(IPAddress ip, IPAddress gw, IPAddress sn);
-    
-    int     serverLoop();
+    void          setAPConfig(IPAddress ip, IPAddress gw, IPAddress sn);
+    //called when AP mode and config portal is started
+    void          setAPCallback( void (*func)(WiFiManager*) );
+    //called when settings have been changed and connection was successful
+    void          setSaveConfigCallback( void (*func)(void) );
 
-private:
-    DNSServer dnsServer;
-    ESP8266WebServer server;
+    //adds a custom parameter
+    void          addParameter(WiFiManagerParameter *p);
 
-    const int WM_DONE = 0;
-    const int WM_WAIT = 10;
-    
-    const String HTTP_404 = "HTTP/1.1 404 Not Found\r\n\r\n";
-    const String HTTP_200 = "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n";
-    const String HTTP_HEAD = "<!DOCTYPE html><html lang=\"en\"><head><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"/><title>{v}</title>";
-    const String HTTP_STYLE = "<style>div,input {margin-bottom: 5px;} body{width:200px;display:block;margin-left:auto;margin-right:auto;} button{padding:0.75rem 1rem;border:0;border-radius:0.317rem;background-color:#1fa3ec;color:#fff;line-height:1.5;cursor:pointer;}</style>";
-    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_ITEM = "<div><a href='#' onclick='c(this)'>{v}</a></div>";
-    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/><button type='submit'>save</button></form>";
-    const String HTTP_SAVED = "<div>Credentials Saved<br />Trying to connect ESP to network.<br />If it fails reconnect to AP to try again</div>";
-    const String HTTP_END = "</body></html>";
-    //const char HTTP_END[] PROGMEM = R"=====(
-    //</body></html>
-    //)=====";
-    
-    int _eepromStart;
-    const char* _apName = "no-net";
-    String _ssid = "";
-    String _pass = "";
+  private:
+    std::unique_ptr<DNSServer>        dnsServer;
+    std::unique_ptr<ESP8266WebServer> server;
+
+    const int     WM_DONE = 0;
+    const int     WM_WAIT = 10;
+
+    const String  HTTP_HEAD = "<!DOCTYPE html><html lang=\"en\"><head><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"/><title>{v}</title>";
+
+    void          setupConfigPortal();
+
+    int           _eepromStart;
+    const char*   _apName = "no-net";
+    const char*   _apPassword = NULL;
+    String        _ssid = "";
+    String        _pass = "";
     unsigned long timeout = 0;
     unsigned long start = 0;
-    IPAddress _ip;
-    IPAddress _gw;
-    IPAddress _sn;
-    
-    String getEEPROMString(int start, int len);
-    void setEEPROMString(int start, int len, String string);
+    IPAddress     _ip;
+    IPAddress     _gw;
+    IPAddress     _sn;
+    int           _paramsCount = 0;
+    int           _minimumQuality = -1;
 
-    bool keepLooping = true;
-    int status = WL_IDLE_STATUS;
-    void connectWifi(String ssid, String pass);
+    //String        getEEPROMString(int start, int len);
+    //void          setEEPROMString(int start, int len, String string);
+
+    int           status = WL_IDLE_STATUS;
+    int           connectWifi(String ssid, String pass);
+
+    void          handleRoot();
+    void          handleWifi(boolean scan);
+    void          handleWifiSave();
+    void          handleNotFound();
+    void          handle204();
+    boolean       captivePortal();
 
-    void handleRoot();
-    void handleWifi(bool scan);
-    void handleWifiSave();
-    void handleNotFound();
-    void handle204();
-    boolean captivePortal();
-    
     // DNS server
-    const byte DNS_PORT = 53;
-    
-    boolean isIp(String str);
-    String toStringIp(IPAddress ip);
+    const byte    DNS_PORT = 53;
 
-    boolean connect;
-    boolean _debug = true;
+    //helpers
+    int           getRSSIasQuality(int RSSI);
+    boolean       isIp(String str);
+    String        toStringIp(IPAddress ip);
+
+    boolean       connect;
+    boolean       _debug = true;
+
+    void (*_apcallback)(WiFiManager*) = NULL;
+    void (*_savecallback)(void) = NULL;
+
+    WiFiManagerParameter* _params[WIFI_MANAGER_MAX_PARAMS];
 
     template <typename Generic>
-    void DEBUG_PRINT(Generic text);
+    void          DEBUG_WM(Generic text);
 };
 
 

examples/AutoConnect/AutoConnect.ino

@@ -1,10 +1,9 @@
 #include <ESP8266WiFi.h>          //https://github.com/esp8266/Arduino
 
 //needed for library
-#include <EEPROM.h>
-#include <ESP8266WebServer.h>
 #include <DNSServer.h>
-#include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager
+#include <ESP8266WebServer.h>
+#include <WiFiManager.h>         //https://github.com/tzapu/WiFiManager
 
 
 void setup() {
@@ -13,20 +12,20 @@ void setup() {
 
     //WiFiManager
     //Local intialization. Once its business is done, there is no need to keep it around
-    WiFiManager wifi;
+    WiFiManager wifiManager;
     //reset saved settings
-    //wifi.resetSettings();
+    //wifiManager.resetSettings();
     
     //set custom ip for portal
-    //wifi.setAPConfig(IPAddress(10,0,1,1), IPAddress(10,0,1,1), IPAddress(255,255,255,0));
+    //wifiManager.setAPConfig(IPAddress(10,0,1,1), IPAddress(10,0,1,1), IPAddress(255,255,255,0));
 
     //fetches ssid and pass from eeprom and tries to connect
     //if it does not connect it starts an access point with the specified name
     //here  "AutoConnectAP"
     //and goes into a blocking loop awaiting configuration
-    wifi.autoConnect("AutoConnectAP");
+    wifiManager.autoConnect("AutoConnectAP");
     //or use this for auto generated name ESP + ChipID
-    //wifi.autoConnect();
+    //wifiManager.autoConnect();
 
     
     //if you get here you have connected to the WiFi

examples/AutoConnectWithFSParameters/AutoConnectWithFSParameters.ino

@@ -0,0 +1,148 @@
+#include <FS.h>                   //this needs to be first, or it all crashes and burns...
+
+#include <ESP8266WiFi.h>          //https://github.com/esp8266/Arduino
+
+//needed for library
+#include <DNSServer.h>
+#include <ESP8266WebServer.h>
+#include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager
+
+#include <ArduinoJson.h>          //https://github.com/bblanchon/ArduinoJson
+
+//define your default values here, if there are different values in config.json, they are overwritten.
+const char *mqtt_server = NULL;
+const char *mqtt_port = "8080";
+const char *blynk_token = "YOUR_BLYNK_TOKEN";
+
+//flag for saving data
+bool shouldSaveConfig = false;
+
+//callback notifying us of the need to save config
+void saveConfigCallback () {
+  Serial.println("Should save config");
+  shouldSaveConfig = true;
+}
+
+
+void setup() {
+  // put your setup code here, to run once:
+  Serial.begin(115200);
+  Serial.println();
+
+  //clean FS, for testing
+  //SPIFFS.format();
+
+  //read configuration from FS json
+  Serial.println("mounting FS...");
+
+  if (SPIFFS.begin()) {
+    Serial.println("mounted file system");
+    if (SPIFFS.exists("/config.json")) {
+      //file exists, reading and loading
+      Serial.println("reading config file");
+      File configFile = SPIFFS.open("/config.json", "r");
+      if (configFile) {
+        Serial.println("opened config file");
+        size_t size = configFile.size();
+        // Allocate a buffer to store contents of the file.
+        std::unique_ptr<char[]> buf(new char[size]);
+
+        configFile.readBytes(buf.get(), size);
+        StaticJsonBuffer<200> jsonBuffer;
+        JsonObject& json = jsonBuffer.parseObject(buf.get());
+        json.printTo(Serial);
+        if (json.success()) {
+          Serial.println("\nparsed json");
+
+          mqtt_server = json["mqtt_server"];
+          mqtt_port = json["mqtt_port"];
+          blynk_token = json["blynk_token"];
+        } else {
+          Serial.println("failed to load json config");
+        }
+      }
+    }
+  } else {
+    Serial.println("failed to mount FS");
+  }
+  //end read
+
+
+
+  // The extra parameters to be configured (can be either global or just in the setup)
+  // After connecting, parameter.getValue() will get you the configured value
+  // id/name placeholder/prompt default length
+  WiFiManagerParameter custom_mqtt_server("server", "mqtt server", mqtt_server, 40);
+  WiFiManagerParameter custom_mqtt_port("port", "mqtt port", mqtt_port, 8);
+  WiFiManagerParameter custom_blynk_token("blynk", "blynk token", blynk_token, 32);
+
+  //WiFiManager
+  //Local intialization. Once its business is done, there is no need to keep it around
+  WiFiManager wifiManager;
+
+  //set config save notify callback
+  wifiManager.setSaveConfigCallback(saveConfigCallback);
+
+  //add all your parameters here
+  wifiManager.addParameter(&custom_mqtt_server);
+  wifiManager.addParameter(&custom_mqtt_port);
+  wifiManager.addParameter(&custom_blynk_token);
+
+  //reset settings - for testing
+  wifiManager.resetSettings();
+
+  //set minimu quality of signal so it ignores AP's under that quality
+  //defaults to 8%
+  wifiManager.setMinimumSignalQuality();
+  
+  //sets timeout until configuration portal gets turned off
+  //useful to make it all retry or go to sleep
+  //in seconds
+  //wifiManager.setTimeout(120);
+
+  //fetches ssid and pass and tries to connect
+  //if it does not connect it starts an access point with the specified name
+  //here  "AutoConnectAP"
+  //and goes into a blocking loop awaiting configuration
+  if (!wifiManager.autoConnect("AutoConnectAP", "password")) {
+    Serial.println("failed to connect and hit timeout");
+    delay(3000);
+    //reset and try again, or maybe put it to deep sleep
+    ESP.reset();
+    delay(5000);
+  }
+
+  //if you get here you have connected to the WiFi
+  Serial.println("connected...yeey :)");
+
+  //read updated parameters
+  mqtt_server = custom_mqtt_server.getValue();
+  mqtt_port = custom_mqtt_port.getValue();
+  blynk_token = custom_blynk_token.getValue();
+
+  //save the custom parameters to FS
+  if (shouldSaveConfig) {
+    Serial.println("saving config");
+    StaticJsonBuffer<200> jsonBuffer;
+    JsonObject& json = jsonBuffer.createObject();
+    json["mqtt_server"] = mqtt_server;
+    json["mqtt_port"] = mqtt_port;
+    json["blynk_token"] = blynk_token;
+
+    File configFile = SPIFFS.open("/config.json", "w");
+    if (!configFile) {
+      Serial.println("failed to open config file for writing");
+    }
+
+    json.printTo(Serial);
+    json.printTo(configFile);
+    configFile.close();
+    //end save
+  }
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+
+
+}

examples/AutoConnectWithFeedback/AutoConnectWithFeedback.ino

@@ -0,0 +1,47 @@
+#include <ESP8266WiFi.h>          //https://github.com/esp8266/Arduino
+
+//needed for library
+#include <DNSServer.h>
+#include <ESP8266WebServer.h>
+#include "WiFiManager.h"          //https://github.com/tzapu/WiFiManager
+
+void configModeCallback (WiFiManager *myWiFiManager) {
+  Serial.println("Entered config mode");
+  Serial.println(WiFi.softAPIP());
+  //if you used auto generated SSID, print it
+  Serial.println(myWiFiManager->getConfigPortalSSID());
+}
+
+void setup() {
+  // put your setup code here, to run once:
+  Serial.begin(115200);
+  
+  //WiFiManager
+  //Local intialization. Once its business is done, there is no need to keep it around
+  WiFiManager wifiManager;
+  //reset settings - for testing
+  //wifiManager.resetSettings();
+
+  //set callback that gets called when connecting to previous WiFi fails, and enters Access Point mode
+  wifiManager.setAPCallback(configModeCallback);
+
+  //fetches ssid and pass and tries to connect
+  //if it does not connect it starts an access point with the specified name
+  //here  "AutoConnectAP"
+  //and goes into a blocking loop awaiting configuration
+  if(!wifiManager.autoConnect()) {
+    Serial.println("failed to connect and hit timeout");
+    //reset and try again, or maybe put it to deep sleep
+    ESP.reset();
+    delay(1000);
+  } 
+
+  //if you get here you have connected to the WiFi
+  Serial.println("connected...yeey :)");
+ 
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+
+}

examples/AutoConnectWithTimeout/AutoConnectWithTimeout.ino

@@ -1,37 +1,32 @@
 #include <ESP8266WiFi.h>          //https://github.com/esp8266/Arduino
 
 //needed for library
-//#include <EEPROM.h>
-//#include <WiFiClient.h>
-#include <ESP8266WebServer.h>
 #include <DNSServer.h>
+#include <ESP8266WebServer.h>
 #include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager
 
 
-//this intitilises the library, parameter is eeprom start
-
-
 
 void setup() {
   // put your setup code here, to run once:
   Serial.begin(115200);
+  
   //WiFiManager
   //Local intialization. Once its business is done, there is no need to keep it around
-  WiFiManager wifi;
-
+  WiFiManager wifiManager;
   //reset settings - for testing
-  wifi.resetSettings();
+  //wifiManager.resetSettings();
 
   //sets timeout until configuration portal gets turned off
   //useful to make it all retry or go to sleep
   //in seconds
-  wifi.setTimeout(180);
+  wifiManager.setTimeout(180);
   
-  //fetches ssid and pass from eeprom and tries to connect
+  //fetches ssid and pass and tries to connect
   //if it does not connect it starts an access point with the specified name
   //here  "AutoConnectAP"
   //and goes into a blocking loop awaiting configuration
-  if(!wifi.autoConnect("AutoConnectAP")) {
+  if(!wifiManager.autoConnect("AutoConnectAP")) {
     Serial.println("failed to connect and hit timeout");
     delay(3000);
     //reset and try again, or maybe put it to deep sleep

examples/OnDemandConfigPortal/OnDemandConfigPortal.ino

@@ -0,0 +1,60 @@
+#include <ESP8266WiFi.h>          //https://github.com/esp8266/Arduino
+
+//needed for library
+#include <ESP8266WebServer.h>
+#include <DNSServer.h>
+#include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager
+
+// select wich pin will trigger the configuraton portal when set to LOW
+// ESP-01 users please note: the only pins available (0 and 2), are shared 
+// with the bootloader, so always set them HIGH at power-up
+#define TRIGGER_PIN 0
+
+
+void setup() {
+  // put your setup code here, to run once:
+  Serial.begin(115200);
+  Serial.println("\n Starting");
+
+  pinMode(TRIGGER_PIN, INPUT);
+}
+
+
+void loop() {
+  // is configuration portal requested?
+  if ( digitalRead(TRIGGER_PIN) == LOW ) {
+    //WiFiManager
+    //Local intialization. Once its business is done, there is no need to keep it around
+    WiFiManager wifiManager;
+
+    //reset settings - for testing
+    //wifiManager.resetSettings();
+
+    //sets timeout until configuration portal gets turned off
+    //useful to make it all retry or go to sleep
+    //in seconds
+    //wifiManager.setTimeout(120);
+
+    //it starts an access point with the specified name
+    //here  "AutoConnectAP"
+    //and goes into a blocking loop awaiting configuration
+
+    //WITHOUT THIS THE AP DOES NOT SEEM TO WORK PROPERLY WITH SDK 1.5 , update to at least 1.5.1
+    //WiFi.mode(WIFI_STA);
+    
+    if (!wifiManager.startConfigPortal("OnDemandAP")) {
+      Serial.println("failed to connect and hit timeout");
+      delay(3000);
+      //reset and try again, or maybe put it to deep sleep
+      ESP.reset();
+      delay(5000);
+    }
+
+    //if you get here you have connected to the WiFi
+    Serial.println("connected...yeey :)");
+  }
+
+
+  // put your main code here, to run repeatedly:
+
+}

extras/WiFiManager.template.html

@@ -0,0 +1,17 @@
+<!DOCTYPE html><html lang=\"en\"><head><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"/><title>{v}</title>
+	<style>div,input{padding:5px;font-size:1em;} input{width:95%;} body{text-align: center;} button{border:0;border-radius:0.3rem;background-color:#1fa3ec;color:#fff;line-height:2.4rem;font-size:1.2rem;width:100%;}</style>
+	<script>function c(l){document.getElementById('s').value=l.innerText||l.textContent;document.getElementById('p').focus();}</script>
+</head><body><div style="text-align: left; display: inline-block;">
+  	<div><a href='#' onclick='c(this)'>{v}</a> {r}% {i}</div>
+  	<div><a href='#' onclick='c(this)'>{v}</a> 100% 	<img src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAKCAMAAAC+Ge+yAAAACVBMVEUAAAC7u7v///9etNz6AAAAI0lEQVQI133GsQ3AMAAEoXv2H9qNJacKFbEaWTQJ+uQB/nMdEaYAXeJkZ9AAAAAASUVORK5CYII='/></div>
+    <div><a href='#' onclick='c(this)'>Vila17</a> 95% 	<img src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAMAAAC67D+PAAAADFBMVEUAAAAAtgD///8AAADV1YIHAAAAA3RSTlMAAAD6dsTeAAAAHUlEQVR4AWMAAmYgYGBkArHAAMoEYnQmMxSQywQAKvMA3+mlSFAAAAAASUVORK5CYII='/></div>
+    <div><a href='#'>LilRidingHoodz</a> 100% 			<img src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAMAAAC67D+PAAAABlBMVEUAAAD///+l2Z/dAAAAIklEQVR4AWNgZGRkAAIQBURQDEZAgM5kgAJGEAQDwkxkbQAOhgBBk64+mQAAAABJRU5ErkJggg=='/></div>
+    <div><a href='#'>Marcelica</a> 100% 				<img src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAMAAAC67D+PAAAACVBMVEUAAAC7u7v///9etNz6AAAAJ0lEQVR4AY3GsREAIBSDUD77D63x4tlKw0MdmD0ijTO9f6SFnv7YXB4qAIVn0xoMAAAAAElFTkSuQmCC'/></div>
+    <div><a href='#'>PMica</a> 110% 					<img src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAANlBMVEUAAAD///8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADl82K3AAAAEXRSTlMAABUbPD94e7G3vcDD5PD5/Mw7MxAAAABQSURBVHgBrck5FoAgEATRBmQBZen7X1acN6KJmRX+gsHMp1qTx8wIBErhBj96dC72sSkc8hC4KzTaCyybAgmJ/IDCVRHgKwVov8KTQOYqw5weJgaXesJX/wAAAABJRU5ErkJggg=='/></div>
+	<br/>
+    <form method='get' action='wifisave'><input id='s' name='s' length=32 placeholder='SSID'><br/><input id='p' name='p' length=64 placeholder='password'><br/><button type='submit'>save</button></form>
+    <br/>
+    <form action=\"/wifi\" method=\"get\"><button>Configure WiFi</button></form><br/>
+    <form action=\"/0wifi\" method=\"get\"><button>Configure WiFi (No Scan)</button></form>
+    </div>
+</body></html>

keywords.txt

@@ -0,0 +1,29 @@
+#######################################
+# Syntax Coloring Map For WifiManager
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+WiFiManager	KEYWORD1
+
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+autoConnect	KEYWORD2
+getSSID	KEYWORD2
+getPassword	KEYWORD2
+resetSettings	KEYWORD2
+urldecode	KEYWORD2
+setTimeout	KEYWORD2
+setDebugOutput	KEYWORD2
+setAPConfig	KEYWORD2
+setAPCallback	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+
+#	LITERAL1

library.json

@@ -0,0 +1,19 @@
+{
+  "name": "WifiManager",
+  "keywords": "wifi, wi-fi, ESP8266",
+  "description": "ESP8266 WiFi Connection manager with fallback web configuration portal",
+  "repository":
+  {
+    "type": "git",
+    "url": "https://github.com/tzapu/WiFiManager.git"
+  },
+  "authors":
+  {
+    "name": "tzapu",
+    "url": "http://tzapu.com"
+  },
+  "frameworks": "arduino",
+  "platforms": "esp8266"
+  "version": "0.6", 
+  "architecture": "esp8266",
+}

library.properties

@@ -0,0 +1,9 @@
+name=WiFiManager
+version=0.6
+author=tzapu
+maintainer=tzapu
+sentence=ESP8266 WiFi Connection manager with fallback web configuration portal
+paragraph=Library for configuring ESP8266 modules WiFi credentials at runtime.
+category=Communication
+url=https://github.com/tzapu/WiFiManager.git
+architectures=esp8266