Merge branch 'feature/ipChange' of pablo2048/WiFiConfig into master

examples/WiFiConfig_simple_test/WiFiConfig_simple_test.ino

@@ -4,6 +4,7 @@
 #include <EEPROM.h>
 #include <ESP8266NetBIOS.h>
 #include <WiFiConfig.h>
+#include <encipheredEEPROMStrings.h>
 
 // Plati pro desticku Witty s modulem ESP-12E
 #define PIN_FORCE_CONFIG 4
@@ -14,6 +15,19 @@
 //#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;
 
@@ -52,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);

library.json

@@ -12,7 +12,7 @@
     "type": "git",
     "url": "http://git.xpablo.cz/pablo2048/WiFiConfig.git"
   },
-  "version": "6.0",
+  "version": "6.3",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": ["espressif8266", "espressif32"],

library.properties

@@ -1,5 +1,5 @@
 name=WiFiConfig
-version=6.0
+version=6.3
 author=Pavel Brychta
 maintainer=Pavel Brychta <Pablo@xpablo.cz>
 sentence=Enables seamless module configuration.

src/WiFiConfig.cpp

@@ -1,4 +1,12 @@
 /*
+ * V6.3 - 12.8.2019 - IP adresa Captive portalu je zmenena na 172.217.28.1 kvuli funkcnosti na Android zarizenich (viz. zmena zde https://github.com/esp8266/Arduino/blob/master/libraries/DNSServer/examples/CaptivePortal/CaptivePortal.ino)
+ *             ladici vypis pri zachyceni presmerovani v Captive portalu.
+ *
+ * V6.2 - 12.12.2018- Nastaveni jmena zarizeni nadale NENI soucasti WiFiConfig a je treba ho pridat jako uzivatelsky parametr. Je to proto, protoze
+ *             se ukazalo, ze neni dobre z externiho kodu sahat do vnitrni struktury WiFiConfig (napr. pri ukladani noveho jmena).
+ *
+ * V6.1 - 11.12.2018- Sifrovani retezcu vytazeno mimo WiFiConfig do knihovny encipheredEEPROMStrings (dostupna na gitu) kvuli pristupu i jinych modulu
+ *
  * V6.0 - 20.11.2018- Verze i pro ESP32
  *
  * V5.9 - 18.7.2018 - Retezce, ukladane do EEPROM jsou primitivnim zpusobem sifrovany pro ztizeni odhaleni SSID a hesla pri dumpu pameti
@@ -16,7 +24,7 @@
  *
  * V5.3 - 8.12.2017 - prepracovano presmerovani v Captive portalu, DEBUG_MSG makro upraveno na posledni pouzivanou verzi, scitani retezcu prepracovano na .concat. Pripsany Informace o modulu, reakce na Reset
  *
- * V5.2 - 20.4.2017 - Pokud je pouzite v timeoutu EC_DONT_RUN_CONFIGAP tak se vracime okamzite a necekame na pripojeni k WiFi (take nevolame zadnou callback metodu).
+ * V5.2 - 20.4.2017 - Pokud je pouzite v timeoutu WC_DONT_RUN_CONFIGAP tak se vracime okamzite a necekame na pripojeni k WiFi (take nevolame zadnou callback metodu).
  *            Navratovy kod je pak WCR_CONFIGAP_NOT_STARTED .
  *
  * V5.1 - 3.4.2017  - Webove rozhrani upravene pro snadnejsi ovladani na telefonu/tabletu, sila signalu AP zobrazena jako barevne odliseny indikator.
@@ -78,6 +86,7 @@
 #include "WiFiConfig.h"
 #include <EEPROM.h>
 #include <Ticker.h>
+#include <encipheredEEPROMStrings.h>
 #include "embHTML.h"
 
 #ifdef DEBUG_ESP_PORT
@@ -98,7 +107,7 @@
 
 #define DNS_PORT 53
 
-char WiFiDeviceName[elementSize(wificonfigarea_t, devname)]; // misto pro jmeno zarizeni (dodane do DNS, DHCP NBNS apod...)
+extern char WiFiDeviceName[];
 
 enum
 {
@@ -117,9 +126,9 @@ static int configBase; // musi byt trvale ulozene, aby fungovaly metody pro zisk
 
 static std::unique_ptr<DNSServer> dnsServer;
 #if defined(ESP8266)
- static std::unique_ptr<ESP8266WebServer> server;
+static std::unique_ptr<ESP8266WebServer> server;
 #else
- static std::unique_ptr<WebServer> server;
+static std::unique_ptr<WebServer> server;
 #endif
 static std::unique_ptr<Ticker> rsttick;
 
@@ -142,7 +151,7 @@ IPAddress getOurIP(void)
     break;
 
   default:
-	  ipa = IPAddress(0,0,0,0); // nelze urcit ip adresu (bud je AP + STA aktivni, nebo je vypnute WiFi)
+    ipa = IPAddress(0, 0, 0, 0); // nelze urcit ip adresu (bud je AP + STA aktivni, nebo je vypnute WiFi)
     break;
   }
   return ipa;
@@ -161,7 +170,7 @@ uint32_t getEEPROMuint32(unsigned int start)
 {
   uint32_t result = 0;
 
-	for (uint32_t i=0; i<4; ++i)
+  for (uint32_t i = 0; i < 4; ++i)
   {
     result <<= 8;
     result += EEPROM.read(start);
@@ -173,7 +182,7 @@ uint32_t getEEPROMuint32(unsigned int start)
 void setEEPROMuint32(unsigned int start, uint32_t val)
 {
 
-	for (unsigned int i=0; i<4; ++i)
+  for (unsigned int i = 0; i < 4; ++i)
   {
     EEPROM.write(start + 3 - i, (uint8_t)val);
     val >>= 8;
@@ -307,7 +316,13 @@ void WiFiConfig::_handleNotFound(void)
   }
   else
   {
-    	server->sendHeader(F("Location"), String(F("http://")) + server->client().localIP().toString() + String(F("/index.htm")), true);
+    String redirect;
+    redirect.reserve(256);
+    redirect = F("http://");
+    redirect.concat(server->client().localIP().toString());
+    redirect.concat(F("/index.htm"));
+    DEBUG_MSG("Redirection to: %s\r\n", redirect.c_str());
+    server->sendHeader(F("Location"), redirect, true);
     server->send_P(302, TEXTPLAIN, PSTR("Redirect"));
   }
 }
@@ -382,11 +397,6 @@ void WiFiConfig::_handleInfo(void)
   reply.concat(buff);
 #endif
 
-  reply.concat(F("<TR><TD>Timeout:<TD>"));
-  reply.concat(_timeout);
-  reply.concat(F("/"));
-  reply.concat(_time);
-
 #if defined(ESP8266)
   uint8_t stations = wifi_softap_get_station_num();
 
@@ -493,21 +503,16 @@ void WiFiConfig::_handleDisplayAP(void)
     }
   }
   s = FPSTR(PAGE_INDEX2);
-	v = _readString(configBase + offsetof(wificonfigarea_t, ssid), elementSize(wificonfigarea_t, ssid));
+  v = EES_readString(configBase + offsetof(wificonfigarea_t, ssid), elementSize(wificonfigarea_t, ssid));
   if (v.length())
     s.replace(F("{s}"), String(FPSTR(VALUE)) + v + F("'"));
   else
-		s.replace(F("{s}"), F("placeholder='SSID'"));
-	v = _readString(configBase + offsetof(wificonfigarea_t, pass), elementSize(wificonfigarea_t, pass));
+    s.replace(F("{s}"), F(""));
+  v = EES_readString(configBase + offsetof(wificonfigarea_t, pass), elementSize(wificonfigarea_t, pass));
   if (v.length())
     s.replace(F("{p}"), String(FPSTR(VALUE)) + v + F("'"));
   else
-		s.replace(F("{p}"), F("placeholder='password'"));
-	v = _readString(configBase + offsetof(wificonfigarea_t, devname), elementSize(wificonfigarea_t, devname));
-	if (v.length())
-		s.replace(F("{n}"), String(FPSTR(VALUE)) + v + F("'"));
-	else
-		s.replace(F("{n}"), F("placeholder='name'"));
+    s.replace(F("{p}"), F(""));
   if (EEPROM.read(configBase + offsetof(wificonfigarea_t, mode)) == WIFIMODE_AP)
     s.replace(F("{a}"), FPSTR(CHECKED));
   else
@@ -560,13 +565,10 @@ void WiFiConfig::_handleSetAP(void)
   str = server->arg(F("_s"));
   if (str.length() > 0)
   {
-		_storeString(configBase + offsetof(wificonfigarea_t, ssid), elementSize(wificonfigarea_t, ssid), str);
+    EES_storeString(configBase + offsetof(wificonfigarea_t, ssid), elementSize(wificonfigarea_t, ssid), str);
 
     str = server->arg(F("_p"));
-		_storeString(configBase + offsetof(wificonfigarea_t, pass), elementSize(wificonfigarea_t, pass), str);
-
-		str = server->arg(F("_n"));
-		_storeString(configBase + offsetof(wificonfigarea_t, devname), elementSize(wificonfigarea_t, devname), str);
+    EES_storeString(configBase + offsetof(wificonfigarea_t, pass), elementSize(wificonfigarea_t, pass), str);
 
     str = server->arg(F("_a"));
     if (str.length() > 0)
@@ -622,10 +624,8 @@ void WiFiConfig::_handleSetAP(void)
   WiFi.disconnect(); // vsechno odpojime
   WiFi.persistent(true); // chceme, aby si modul zapamatoval konfiguraci
 
-	String s = _readString(configBase + offsetof(wificonfigarea_t, devname), elementSize(wificonfigarea_t, devname));
-	strcpy(WiFiDeviceName, s.c_str());
-	s = _readString(configBase + offsetof(wificonfigarea_t, ssid), elementSize(wificonfigarea_t, ssid));
-	String pass =  _readString(configBase + offsetof(wificonfigarea_t, pass), elementSize(wificonfigarea_t, pass));
+  String s = EES_readString(configBase + offsetof(wificonfigarea_t, ssid), elementSize(wificonfigarea_t, ssid));
+  String pass =  EES_readString(configBase + offsetof(wificonfigarea_t, pass), elementSize(wificonfigarea_t, pass));
 
   switch (EEPROM.read(configBase + offsetof(wificonfigarea_t, mode)))
   {
@@ -706,7 +706,7 @@ wificonfigresult_t WiFiConfig::_setupAP(wificonfig_cb cb)
 #endif
 
   /* Soft AP network parameters */
-	IPAddress apIP(192, 168, 4, 1);
+  IPAddress apIP(172, 217, 28, 1);
   IPAddress netMsk(255, 255, 255, 0);
 
   WiFi.disconnect(); // pro jistotu se odpojime
@@ -715,12 +715,8 @@ wificonfigresult_t WiFiConfig::_setupAP(wificonfig_cb cb)
   WiFi.softAPConfig(apIP, apIP, netMsk);
   if (ssid.endsWith(F("?")))
   {
-  		//uint8_t amac[6];
     char lmac[16];
 
-  		//WiFi.softAPmacAddress(amac);
-  		//sprintf_P(lmac, PSTR("%02X%02X%02X"), amac[3], amac[4], amac[5]);
-
     sprintf_P(lmac, PSTR("%06X"), ESP_getChipId());
     ssid.replace(F("?"), String(lmac));
   }
@@ -763,80 +759,6 @@ wificonfigresult_t WiFiConfig::_setupAP(wificonfig_cb cb)
   return WCR_TIMEOUT; // nepripojeno, vyprsel timeout konfiguracniho AP
 }
 
-String WiFiConfig::_readString(unsigned int start, size_t maxlen)
-{
-  uint8_t key[4];
-  unsigned int enciphidx = 0;
-  String result;
-  unsigned int top = EEPROM.read(start);
-  unsigned int i;
-
-  result.reserve(maxlen);
-  uint32_t cid = ESP_getChipId();
-  uint32_t *pkey = (uint32_t *)&key[0];
-  *pkey = cid;
-  DEBUG_MSG("Key = %02X:%02X:%02X:%02X\r\n", key[0], key[1], key[2], key[3]);
-  if ((top > 0) && (top < (maxlen - 2)))
-  {
-    uint8_t b;
-    for (i = start + 1; i < + start + top + 1; ++i)
-    {
-      b = EEPROM.read(i);
-
-      b ^= key[enciphidx];
-      ++enciphidx;
-      enciphidx %= sizeof(key);
-
-      result.concat(char(b));
-    }
-    b = EEPROM.read(i) ^ key[enciphidx];
-    if (b != 0)
-    {
-      DEBUG_MSG("_readString error! (%s)\r\n", result.c_str());
-      result = F(""); // spatna ukoncovaci nula - neplatny retezec
-    }
-  }
-  return result;
-}
-
-bool WiFiConfig::_storeString(unsigned int start, size_t maxlen, String &string)
-{
-  uint8_t key[4];
-  unsigned int enciphidx = 0;
-  unsigned int si = 0;
-  unsigned int top;
-  char c;
-  bool result = false; // retezec nebyl ulozeny cely (nevesel s do bufferu)
-  unsigned int i;
-
-  if (string.length() > maxlen - 2)
-    top = maxlen - 2;
-  else
-  {
-    result = true; // retezec se do urceneho mista vejde
-    top = string.length();
-  }
-
-  uint32_t cid = ESP_getChipId();
-  uint32_t *pkey = (uint32_t *)&key[0];
-  *pkey = cid;
-  DEBUG_MSG("Key = %02X:%02X:%02X:%02X\r\n", key[0], key[1], key[2], key[3]);
-  EEPROM.write(start, (uint8_t)top); // ulozime delku retezce (pouzite pr kontrolu pri vycitani)
-  for (i = start + 1; i < start + top + 1; ++i)
-  {
-    c = string[si];
-    c ^= key[enciphidx];
-    ++enciphidx;
-    enciphidx %= sizeof(key);
-    EEPROM.write(i, c);
-    ++si;
-  }
-  c = 0 ^ key[enciphidx];
-  EEPROM.write(i, c); // ukoncovaci a kontrolni nula
-
-  return result;
-}
-
 // Testovani, zda se modul pripojil k AP
 bool WiFiConfig::_testWifi(wificonfig_cb cb)
 {
@@ -846,10 +768,8 @@ bool WiFiConfig::_testWifi(wificonfig_cb cb)
 // nakonfigurujeme ESP dle nove nastavenych parametru
   WiFi.disconnect(); // vsechno odpojime
 
-  String s = _readString(configBase + offsetof(wificonfigarea_t, devname), elementSize(wificonfigarea_t, devname));
-  strcpy(WiFiDeviceName, s.c_str());
-  s = _readString(configBase + offsetof(wificonfigarea_t, ssid), elementSize(wificonfigarea_t, ssid));
-  String pass =  _readString(configBase + offsetof(wificonfigarea_t, pass), elementSize(wificonfigarea_t, pass));
+  String s = EES_readString(configBase + offsetof(wificonfigarea_t, ssid), elementSize(wificonfigarea_t, ssid));
+  String pass =  EES_readString(configBase + offsetof(wificonfigarea_t, pass), elementSize(wificonfigarea_t, pass));
 
   switch (EEPROM.read(configBase + offsetof(wificonfigarea_t, mode)))
   {
@@ -947,9 +867,6 @@ wificonfigresult_t WiFiConfig::begin(int configarea, int forceConfigure, wificon
     else
 #endif
     {
-			String s = _readString(configBase + offsetof(wificonfigarea_t, devname), elementSize(wificonfigarea_t, devname));
-			strcpy(WiFiDeviceName, s.c_str());
-
       switch (EEPROM.read(configBase + offsetof(wificonfigarea_t, mode)))
       {
       case WIFIMODE_STA:
@@ -985,6 +902,14 @@ wificonfigresult_t WiFiConfig::begin(int configarea, int forceConfigure, wificon
         if (cb)
           cb(WCS_CONNECTSTART); // signalizujeme zacatek pokusu o pripojeni (zde se nic jineho stejne nestane...)
         break;
+
+#if !defined(ESP8266)
+      default:
+        DEBUG_MSG("Wrong config (%d)\r\n", EEPROM.read(configBase + offsetof(wificonfigarea_t, mode)));
+        _status = 0xfe;
+        result = _setupAP(cb);
+      break;
+#endif
       }
     }
   }
@@ -996,6 +921,8 @@ wificonfigresult_t WiFiConfig::begin(int configarea, int forceConfigure, int tim
 
   if ((timeout > 0) && (40 > timeout))
     timeout = 40; // timeout musi byt minimalne 40 sekund
+  if ((0 == forceConfigure) && (WC_DONT_RUN_CONFIGAP == timeout))
+    timeout = 40;
   _timeout = timeout;
   if (_timeout > 0)
     _time = millis() + (_timeout * 1000); // spocitame si novy cas, kdy budeme modul restartovat

src/WiFiConfig.h

@@ -48,7 +48,6 @@ typedef struct
 	uint8_t ip; // konfigurace ip (staticka/DHCP)
 	char ssid[32 + 2]; // SSID site
 	char pass[64 + 2]; // heslo
-	char devname[32 + 2]; // jmeno zarizeni (pro NBNS plati jen 16 znaku)
 	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
@@ -143,8 +142,6 @@ uint32_t getEEPROMuint32(int start);
  */
 void setEEPROMuint32(int start, uint32_t val);
 
-extern char WiFiDeviceName[]; // jmeno zarizeni, pouzivane i pro DHCP
-
 class WiFiConfigUsrParameter
 {
   public:

src/embHTML.h

@@ -37,7 +37,6 @@ static const char SSID_ITEM[] PROGMEM = R"=====(
 /* Zacatek formulare pro vyplneni
 {s} - SSID
 {p} - password
-{n} - Netbios name
 {a} - AP mode (checkbox)
 {ch}- cislo kanalu AP
 {c} - staticka IP konfigurace (checkbox)
@@ -48,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">
@@ -58,7 +56,7 @@ 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();' {c}>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>