Footer, info pro ESP32, lepsi reset stranka

README.md

@@ -2,4 +2,4 @@
 
 ![Screenshot](doc/images/Screenshot_20180507-100906.png)
 
-Knihovna pro konfiguraci WiFi rozhraní modulu ESP8266
+Knihovna pro konfiguraci WiFi rozhraní modulu ESP8266 a ESP32, obsahující Captive portal.

examples/WiFiConfig_simple_test/WiFiConfig_simple_test.ino

@@ -2,8 +2,9 @@
 #include <ESP8266WebServer.h>
 #include <ArduinoOTA.h>
 #include <EEPROM.h>
-#include "src/espnbns/espnbns.h"
-#include "src/WiFiConfig/WiFiConfig.h"
+#include <ESP8266NetBIOS.h>
+#include <WiFiConfig.h>
+#include <encipheredEEPROMStrings.h>
 
 // Plati pro desticku Witty s modulem ESP-12E
 #define PIN_FORCE_CONFIG 4
@@ -14,9 +15,21 @@
 //#define DEBUG_OUT(a) {}
 #define DEBUG_OUT(a) Serial.print(a)
 
+// Definice obsazeni EEPROM
+#define elementSize(type, element) sizeof(((type *)0)->element)
+#define countof(a) (sizeof(a) / sizeof(a[0]))
+typedef struct
+{
+  char devname[32 + 2]; // jmeno zarizeni (pro NBNS plati jen 16 znaku)
+} eepromconfig_t;
+
+#define EEPROM_SIZE (sizeof(wificonfigarea_t) + sizeof(eepromconfig_t) + 10) // velikost EEPROM oblasti (POZOR!!! zbytecnym zvetsovanim se zaroven zmensuje velikost RAM kvuli zrcadlu!!!)
+#define EEPROM_WIFICONFIG_ORIGIN (EEPROM_SIZE - sizeof(wificonfigarea_t)) // pocatek oblasti, pouzivane WiFiConfig (alokovano odzadu)
+#define EEPROM_CONFIG_ORIGIN (0)
+
+char WiFiDeviceName[elementSize(eepromconfig_t, devname)]; // misto pro jmeno zarizeni (dodane do DNS, DHCP NBNS apod...)
 ESP8266WebServer wwwserver(80); // webovy server
 String content;
-NBNS nbns; // Netbios (xPablo.cz)
 
 static void handleRoot(void)
 {
@@ -53,23 +66,27 @@ void ICACHE_FLASH_ATTR wcb(wificonfigstate_t state)
   }
 }
 
-void saveServer(const char *param)
+void ICACHE_FLASH_ATTR saveDevname(const char *param)
 {
+  String p = param;
 
-  DEBUG_OUT(param);
+  EES_storeString(EEPROM_CONFIG_ORIGIN + offsetof(eepromconfig_t, devname), elementSize(eepromconfig_t, devname), p);
 }
 
 void ICACHE_FLASH_ATTR setup()
 {
   WiFiConfig wifi; // konfigurace ESP modulu
-  WiFiConfigUsrParameter testOnly("server", "adresa serveru", "Default server", 32, saveServer);
+  WiFiConfigUsrParameter devname("devname", "Jméno zařízení", (const char *)WiFiDeviceName, 32, saveDevname);
 
-  EEPROM.begin(512); // zahajujeme praci s EEPROM
+  EEPROM.begin(EEPROM_SIZE); // zahajujeme praci s EEPROM
   pinMode(PIN_FORCE_CONFIG, INPUT_PULLUP); // pin, co slouzi jako vstup tlacitka
   int fc = digitalRead(PIN_FORCE_CONFIG); // pozadavek na vynucene vyvolani konfigurace
   Serial.begin(9600);
-  wifi.addParameter(&testOnly);
-  if (WCR_OK != wifi.begin(0, fc, wcb)) // startujeme pripojeni
+  String dn = EES_readString(EEPROM_CONFIG_ORIGIN + offsetof(eepromconfig_t, devname), elementSize(eepromconfig_t, devname));
+  strcpy(WiFiDeviceName, dn.c_str());
+  wifi.addParameter(&devname);
+
+  if (WCR_OK != wifi.begin(EEPROM_WIFICONFIG_ORIGIN, fc, wcb)) // startujeme pripojeni
     ESP.restart();
 
   wwwserver.on("/", handleRoot);
@@ -77,7 +94,7 @@ void ICACHE_FLASH_ATTR setup()
 
   if (strlen(WiFiDeviceName) > 0)
   {
-    nbns.begin(WiFiDeviceName);
+    NBNS.begin(WiFiDeviceName);
     ArduinoOTA.setHostname(WiFiDeviceName);
   }
 
@@ -125,5 +142,4 @@ void loop()
 {
   wwwserver.handleClient(); // osetrujeme praci serveru
   ArduinoOTA.handle();
-  nbns.poll();
 }

library.json

@@ -1,7 +1,7 @@
 {
   "name":"WiFiConfig",
-  "description":"Web based WiFi part configuration for the ESP8266 SoC",
-  "keywords":"wifi,configuration",
+  "description":"Web based WiFi part configuration for the ESP8266 and ESP32 SoC",
+  "keywords":"wifi, configuration",
   "authors":
   {
     "name": "Pavel Brychta",
@@ -12,10 +12,10 @@
     "type": "git",
     "url": "http://git.xpablo.cz/pablo2048/WiFiConfig.git"
   },
-  "version": "5.5",
+  "version": "6.3.1",
   "license": "MIT",
   "frameworks": "arduino",
-  "platforms": "espressif8266",
+  "platforms": ["espressif8266", "espressif32"],
   "build": {
     "libCompatMode": 2
   }

library.properties

@@ -1,9 +1,9 @@
 name=WiFiConfig
-version=5.4.0
+version=6.3.1
 author=Pavel Brychta
 maintainer=Pavel Brychta <Pablo@xpablo.cz>
 sentence=Enables seamless module configuration.
-paragraph=With this library you can enable your ESP8266 module to be configured over network. Includes Captive Portal for easy configuration.
+paragraph=With this library you can enable your ESP8266 or ESP32 module to be configured over WiFi. Includes Captive Portal for easy configuration.
 category=Other
 url=http://www.xpablo.cz
-architectures=esp8266
+architectures=esp8266,esp32

src/WiFiConfig.h

@@ -2,7 +2,7 @@
  * @file WiFiConfig.h
  * @author Pavel Brychta, http://www.xpablo.cz
  *
- * Copyright (c) 2015,16,17 Pavel Brychta. All rights reserved.
+ * Copyright (c) 2015-19 Pavel Brychta. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -24,12 +24,17 @@
  * 1. Pokud je forceConfigure ==0, tak se aktivuje WiFi v rezimu AP a cele ESP je mozne nastavit webovym rozhranim (pocitam s prenosem hodnoty nouzoveho tlacitka pri startu).
  * 2. Neni-li tlacitko stisknute, tak se vezme rezim prace a AP se nastavi dle nej (WIFI_STA a WIFI_AP)
  * 3. Pokud byl rezim prace WIFI_STA a ESP se nepripoji k zadne siti do casu WIFI_STA_CONNECT_TIMEOUT, tak se pokracuje jako kdyby bylo stisknute rekonfiguracni tlacitko
+ * Podrobnejsi informace o upravach chovani v jednotlivych verzich jsou v zahlavi .cpp souboru.
  */
 
 #ifndef __WiFiConfig_h__
 #define __WiFiConfig_h__
 
-#include <ESP8266WiFi.h>
+#if defined(ESP8266)
+ #include <ESP8266WiFi.h>
+#else
+ #include <WiFi.h>
+#endif
 #include <memory>
 
 #define elementSize(type, element) sizeof(((type *)0)->element)
@@ -41,9 +46,8 @@ typedef struct
 {
 	uint8_t mode; // rezim prace AP/STA
 	uint8_t ip; // konfigurace ip (staticka/DHCP)
-	char ssid[32]; // SSID site
-	char pass[64]; // heslo
-	char devname[32]; // jmeno zarizeni (pro NBNS plati jen 16 znaku)
+	char ssid[32 + 2]; // SSID site
+	char pass[64 + 2]; // heslo
 	uint32_t ipaddr; // ip adresa v pripade staticke konfigurace
 	uint32_t netmask; // sitova maska v pripade staticke konfigurace
 	uint32_t gateway; // sitova brana v pripade staticke konfigurace
@@ -93,7 +97,7 @@ typedef void (*storeparam_cb)(const char *newvalue); // callback pro ulozeni uzi
  *  \param [in] len Delka retezce
  *  \return Vycteny retezec
  */
-String getEEPROMString(int start, int len);
+String getEEPROMString(unsigned int start, size_t len);
 
 /**
  *  \brief Ulozeni retezce do EEPROM
@@ -102,7 +106,7 @@ String getEEPROMString(int start, int len);
  *  \param [in] len Maximalni delka ulozeneho retezce
  *  \param [in] string Ukladany retezec
  */
-void setEEPROMString(int start, int len, String string);
+void setEEPROMString(unsigned int start, size_t len, String &string);
 
 /**
  *  \brief Ziskani nasi ip adresy
@@ -121,32 +125,43 @@ IPAddress getOurIP(void);
  */
 uint8_t * getOurMAC(uint8_t *mac);
 
+/**
+ * @brief      Ziskani 32 bitoveho cisla z EEPROM
+ *
+ * @param[in]  start  Pocatecni adresa, ze ktere se ziskava cislo.
+ *
+ * @return     Ziskane cislo.
+ */
 uint32_t getEEPROMuint32(int start);
 
+/**
+ * @brief      Ulozeni 32 bitoveho cisla do EEPROM
+ *
+ * @param[in]  start  Pocatecni adresa, kam cislo ukladame.
+ * @param[in]  val    Ukladana hodnota
+ */
 void setEEPROMuint32(int start, uint32_t val);
 
-extern char WiFiDeviceName[]; // jmeno zarizeni, pouzivane i pro DHCP
-
 class WiFiConfigUsrParameter
 {
   public:
-    WiFiConfigUsrParameter(const char *id, const char *label, const char *defaultValue, int length, storeparam_cb cb);
+    WiFiConfigUsrParameter(const char *id, const char *label, const char *defaultValue, unsigned int length, storeparam_cb cb);
 
     const char *getID();
     const char *getValue();
     const char *getLabel();
-    int         getValueLength();
-	  void         setNext(WiFiConfigUsrParameter *n);
+    int        getValueLength();
+	  void       setNext(WiFiConfigUsrParameter *n);
 	  WiFiConfigUsrParameter *getNext();
-	  void		setNewValue(const char *newval);
+	  void		   setNewValue(const char *newval);
   private:
     const char *_id;
     const char *_label;
     char       *_value;
     int         _length;
 
-	storeparam_cb _cb;
-	WiFiConfigUsrParameter *_next;
+	  storeparam_cb _cb;
+	  WiFiConfigUsrParameter *_next;
 
     friend class WiFiConfig;
 };
@@ -155,9 +170,9 @@ class WiFiConfig
 {
 public:
 	WiFiConfig(): _params(NULL), _timeout(0) {}
-	wificonfigresult_t begin(int configarea, uint8_t forceConfigure, wificonfig_cb cb);
-	wificonfigresult_t begin(int configarea, uint8_t forceConfigure, int timeout, wificonfig_cb cb);
-    void addParameter(WiFiConfigUsrParameter *p);
+	wificonfigresult_t begin(int configarea, int forceConfigure, wificonfig_cb cb);
+	wificonfigresult_t begin(int configarea, int forceConfigure, int timeout, wificonfig_cb cb);
+  void addParameter(WiFiConfigUsrParameter *p);
 private:
 	wificonfigresult_t _setupAP(wificonfig_cb cb);
 	void _handleDisplayAP(void);
@@ -167,8 +182,9 @@ private:
 	void _handleNotFound(); // CaptivePortal redirector
   void _handleRoot(); // jen jednoducha stranka kvuli CaptivePortalu umoznuje prejit na spravnou stranku (ale nedela to...)
   bool _testWifi(wificonfig_cb cb);
+  bool _storeString(unsigned int start, size_t maxlen, String &string); // sifrovany retezec, max 255 znaku
+  String _readString(unsigned int start, size_t maxlen); // sifrovany retezec, max. 255 znaku
 	WiFiConfigUsrParameter *_searchUsrParameter(const char *name);
-	void _plusDecode(String &s);
 
 	WiFiConfigUsrParameter *_params; // ukazatel na posledni zadany uzivatelsky parametr
 	int _timeout; // timeout pri cekani na konfiguraci

src/embHTML.h

@@ -1,5 +1,6 @@
-// file:///I:/MyProjects/PB_ESP8266_WiFiConfig_Vyvoj/doc/_testy/s?_s=SSID1&_p=heslo&_n=jmeno_zarizeni&_a=on&_st=on&_i=192.168.1.1&_m=255.255.255.0&_g=192.168.1.3&_d=192.168.1.3&{n}={v}
+// HTML data
 static const char TEXTHTML[] PROGMEM = "text/html";
+static const char TEXTPLAIN[] PROGMEM = "text/plain";
 
 static const char PAGE_INDEX1[] PROGMEM = R"=====(
 <!DOCTYPE html><html lang="en"><head><meta charset= "utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
@@ -25,17 +26,17 @@ function hSC(){if (document.getElementById('_st').checked){document.getElementBy
 
 /* Polozky nalezenych SSID
 {v} - SSID
-{a} - RSSI (primo v dBm)
+{a} - RSSI (%)
 {s} - bud nic, nebo 'l'>
+Rozsahy otestovany zde https://css-tricks.com/html5-meter-element/
 */
 static const char SSID_ITEM[] PROGMEM = R"=====(
-<div><a href='#p' onclick='c(this)'>{v}</a>&nbsp;<span class='q {s}'><meter value="{a}" min="0" max="100" low="30" high="80" optimum="50" style="width: 70%;"></meter></span></div>
+<div><a href='#p' onclick='c(this)'>{v}</a>&nbsp;<span class='q {s}'><meter value="{a}" min="0" low="30" optimum="70" high="60" max="100" style="width: 70%;"></meter></span></div>
 )=====";
 
 /* Zacatek formulare pro vyplneni
 {s} - SSID
 {p} - password
-{n} - Netbios name
 {a} - AP mode (checkbox)
 {ch}- cislo kanalu AP
 {c} - staticka IP konfigurace (checkbox)
@@ -46,9 +47,8 @@ static const char SSID_ITEM[] PROGMEM = R"=====(
 */
 static const char PAGE_INDEX2[] PROGMEM = R"=====(
 <form method='post' action='s'>
-<label>SSID<br><input id='_s' name='_s' maxlength=32 required {s}></label><br>
-<label>Heslo<br><input id='_p' name='_p' maxlength=64 {p} type='password'></label><br>
-<label>Jméno zařízení<br><input name='_n' maxlength=32 pattern='^[a-zA-Z][a-zA-Z0-9-_\\.]{1,32}$' title='Jméno dle NetBios konvence (max. 16 znaků písmena, čísla a znaky "_.")' {n}></label><br>
+<label>SSID<br><input id='_s' name='_s' maxlength=32 required placeholder='SSID' {s}></label><br>
+<label>Heslo<br><input id='_p' name='_p' maxlength=64 {p} type='password' placeholder='heslo'></label><br>
 <div>
 <label><input id='_a' name='_a' type='checkbox' style="width: 10%; float: left; margin-top: 5px;" onclick='hAP();' {a}>Režim AP</label>
 <div id="apconfig">
@@ -56,12 +56,12 @@ static const char PAGE_INDEX2[] PROGMEM = R"=====(
 </div>
 </div>
 <div>
-<label><input id='_st' name='_st' type='checkbox' style="width: 10%; float: left; margin-top: 5px;" onclick='hSC();' {a}>Staticka IP konfigurace</label>
+<label><input id='_st' name='_st' type='checkbox' style="width: 10%; float: left; margin-top: 5px;" onclick='hSC();' {c}>Statická IP konfigurace</label>
 <div id="staticip">
-<label>IP adresa<br><input type="text" name="_i" pattern='((^|\.)((25[0-5])|(2[0-4]\d)|(1\d\d)|([1-9]?\d))){4}$' title='ip adresa ve formatu <cislo>.<cislo>.<cislo>.<cislo>' value='{i}'></label><br>
-<label>Síťová maska<br><input type="text" name="_m" pattern='((^|\.)((25[0-5])|(2[0-4]\d)|(1\d\d)|([1-9]?\d))){4}$' title='ip adresa ve formatu <cislo>.<cislo>.<cislo>.<cislo>' value='{m}'></label><br>
-<label>Síťová brána<br><input type="text" name="_g" pattern='((^|\.)((25[0-5])|(2[0-4]\d)|(1\d\d)|([1-9]?\d))){4}$' title='ip adresa ve formatu <cislo>.<cislo>.<cislo>.<cislo>' value='{g}'></label><br>
-<label>Server DNS<br><input type="text" name="_d" pattern='((^|\.)((25[0-5])|(2[0-4]\d)|(1\d\d)|([1-9]?\d))){4}$' title='ip adresa ve formatu <cislo>.<cislo>.<cislo>.<cislo>' value='{d}'></label><br>
+<label>IP adresa<br><input type="text" name="_i" value='{i}'></label><br>
+<label>Síťová maska<br><input type="text" name="_m" value='{m}'></label><br>
+<label>Síťová brána<br><input type="text" name="_g" value='{g}'></label><br>
+<label>Server DNS<br><input type="text" name="_d" value='{d}'></label><br>
 </div>
 </div>
 <script>hAP();hSC();</script>
@@ -81,9 +81,22 @@ static const char PAGE_PARAM[] PROGMEM = R"=====(
 static const char PAGE_END[] PROGMEM = R"=====(
 <br>
 <button type='submit'>Uložit a restartovat</button></form>
-</div></body></html>
+</div>)====="
+#if defined APP_NAME && defined APP_VERSION
+R"=====(<div style='text-align:right;font-size:11px;'><hr/>)====="
+APP_NAME
+" v"
+APP_VERSION
+R"=====(</div>
+)====="
+#else
+R"=====(<div style='text-align:right;font-size:11px;'><hr/><a href='http://xpablo.cz' target='_blank' style='color:#aaa;'>WiFiConfig by xPablo</a></div>)====="
+#endif
+R"=====(</body></html>
 )=====";
-
+/*
+<div style='text-align:right;font-size:11px;'><hr/><a href='http://xpablo.cz' target='_blank' style='color:#aaa;'>WiFiConfig by xPablo</a></div>
+ */
 // Nenalezeno zadne SSID
 static const char PAGE_NO_SSID[] PROGMEM = R"=====(
 <div>Nenalezená žádná síť. Občerstvi stránku pro nové hledání.</div>
@@ -91,13 +104,13 @@ static const char PAGE_NO_SSID[] PROGMEM = R"=====(
 
 // Konfigurace ulozena - restartuji...
 static const char PAGE_SAVED[] PROGMEM = R"=====(
-<!DOCTYPE html><html lang="cs"><head><meta http-equiv="refresh" content="10;url=/"/>
+<!DOCTYPE html><html lang="cs"><head><meta http-equiv="refresh" content="5;url=/"/>
 <meta charset="utf-8" name="viewport" content="width=device-width, initial-scale=1"/>
 <title>xPablo Setup - Konfigurace uložena</title>
 <style>div,input {margin-bottom: 5px;}body{width:200px;display:block;margin-left:auto;margin-right:auto;}</style>
 </head><body>
 Uloženo do EEPROM...<br/>
-Restart za 10 sekund.
+Restart za 5 sekund.
 </body></html>
 )=====";
 
@@ -111,11 +124,29 @@ static const char PAGE_CAPTIVEPORTALCATCH[] PROGMEM = R"=====(
 <form action="/config" method="get"><button>Konfigurace WiFi</button></form><br/><form action="/i" method="get"><button>Informace o modulu</button></form><br/><form action="/r" method="post"><button class="red">Reset</button></form><br>
 )=====";
 
-// druha cast (mezi 1. a druhou cast muzeme doplnit dodatecne informace)
+// druha cast (mezi 1. a 2. cast muzeme doplnit dodatecne informace)
 static const char PAGE_CAPTIVEPORTALCATCH2[] PROGMEM = R"=====(
-</div></body></html>
+</div>
+)====="
+#if defined APP_NAME && defined APP_VERSION
+R"=====(<div style='text-align:right;font-size:11px;'><hr/>)====="
+APP_NAME
+" v"
+APP_VERSION
+R"=====(</div>
+)====="
+#else
+R"=====(<div style='text-align:right;font-size:11px;'><hr/><a href='http://xpablo.cz' target='_blank' style='color:#aaa;'>WiFiConfig by xPablo</a></div>)====="
+#endif
+R"=====(</body></html>
 )=====";
 
 static const char PAGE_RESTART[] PROGMEM = R"=====(
-  Restartuji...
+<!DOCTYPE html><html lang="cs"><head><meta http-equiv="refresh" content="5;url=/"/>
+<meta charset="utf-8" name="viewport" content="width=device-width, initial-scale=1"/>
+<title>xPablo Setup - Restart</title>
+<style>div,input {margin-bottom: 5px;}body{width:200px;display:block;margin-left:auto;margin-right:auto;}</style>
+</head><body>
+Restartuji...
+</body></html>
 )=====";