refactor settings

Author: buxtronix

esp8266-ledclock/esp8266-ledclock.ino

@@ -9,39 +9,32 @@
 #include <WiFiClient.h>
 #include <ESP8266WebServer.h>
 
+#include "settings.h"
 #include "mainPage.h"
 
-#define CLOCK_NAME "ESP-CLOCK"
-#define WIFI_AP_NAME CLOCK_NAME
-
 #define SETUP_PIN 3
 
 #define MODE_SETUP 0
 #define MODE_CLOCK 1
 int clockMode;
-time_t syncInterval = 3600;
 
 ESP8266WebServer server (80);
 
-String clockName = "";
-String w_ssid;
-String w_psk;
 String httpUpdateResponse;
-long timezone;
-IPAddress timeServer(129, 6, 15, 28);
+
 time_t prevDisplay = 0;
 
 void handleRoot() {
   String s = MAIN_page;
-  s.replace("@@SSID@@", w_ssid);
-  s.replace("@@PSK@@", w_psk);
-  s.replace("@@TZ@@", String(timezone));
+  s.replace("@@SSID@@", settings.ssid);
+  s.replace("@@PSK@@", settings.psk);
+  s.replace("@@TZ@@", String(settings.timezone));
   s.replace("@@HOUR@@", String(hour()));
   s.replace("@@MIN@@", String(minute()));
-  s.replace("@@NTPSRV@@", ipToString(timeServer));
-  s.replace("@@NTPINT@@", String(syncInterval));
+  s.replace("@@NTPSRV@@", settings.timeserver);
+  s.replace("@@NTPINT@@", String(settings.interval));
   s.replace("@@SYNCSTATUS@@", timeStatus() == timeSet ? "OK" : "Overdue");
-  s.replace("@@CLOCKNAME@@", clockName);
+  s.replace("@@CLOCKNAME@@", settings.name);
   s.replace("@@UPDATERESPONSE@@", httpUpdateResponse);
   httpUpdateResponse = "";
   server.send(200, "text/html", s);
@@ -51,31 +44,34 @@ void handleForm() {
   String update_wifi = server.arg("update_wifi");
   String t_ssid = server.arg("ssid");
   String t_psk = server.arg("psk");
-  timeServer = parseIP(server.arg("ntpsrv"));
+  String t_timeserver = server.arg("ntpsrv");
+  t_timeserver.toCharArray(settings.timeserver, EEPROM_TIMESERVER_LENGTH, 0);
   if (update_wifi == "1") {
-    w_ssid = t_ssid;
-    w_psk = t_psk;
+    settings.ssid = t_ssid;
+    settings.psk = t_psk;
   }
   String tz = server.arg("timezone");
 
   if (tz.length()) {
-    timezone = tz.toInt();
+    settings.timezone = tz.toInt();
   }
 
   time_t newTime = getNtpTime();
   if (newTime) {
     setTime(newTime);
   }
   String syncInt = server.arg("ntpint");
-  syncInterval = syncInt.toInt();
+  settings.interval = syncInt.toInt();
+
+  settings.name = server.arg("clockname");
+  settings.name.replace("+", " ");
 
-  clockName = server.arg("clockname");
   httpUpdateResponse = "The configuration was updated.";
 
   server.sendHeader("Location", "/");
   server.send(302, "text/plain", "Moved");
 
-  saveSettings();
+  settings.Save();
   if (update_wifi == "1") {
     delay(500);
     setupWiFi();
@@ -107,11 +103,11 @@ void loop() {
 }
 
 void setupWiFi() {
-  readSettings();
+  settings.Load();
   // Wait up to 5s for GPIO0 to go low to enter AP/setup mode.
   displayBusy(0);
   while (millis() < 5000) {
-    if (digitalRead(SETUP_PIN) == 0 || !w_ssid.length()) {
+    if (digitalRead(SETUP_PIN) == 0 || !settings.ssid.length()) {
       stopDisplayBusy();
       return setupAP();
     }
@@ -121,103 +117,6 @@ void setupWiFi() {
   setupSTA();
 }
 
-#define EEPROM_WIFI_SIZE 512
-#define EEPROM_MAGIC "NtPc"
-#define EEPROM_MAGIC_OFFSET 0
-#define EEPROM_MAGIC_LENGTH 4
-#define EEPROM_SSID_OFFSET EEPROM_MAGIC_OFFSET + EEPROM_MAGIC_LENGTH
-#define EEPROM_SSID_LENGTH 32
-#define EEPROM_PSK_OFFSET EEPROM_SSID_OFFSET + EEPROM_SSID_LENGTH
-#define EEPROM_PSK_LENGTH 64
-#define EEPROM_TZ_OFFSET EEPROM_PSK_OFFSET + EEPROM_PSK_LENGTH
-#define EEPROM_TIMESERVER_OFFSET EEPROM_TZ_OFFSET + 1
-#define EEPROM_TIMESERVER_LENGTH 4
-#define EEPROM_INTERVAL_OFFSET EEPROM_TIMESERVER_OFFSET + EEPROM_TIMESERVER_LENGTH
-#define EEPROM_INTERVAL_LENGTH 2
-#define EEPROM_NAME_OFFSET EEPROM_INTERVAL_OFFSET + EEPROM_INTERVAL_LENGTH
-#define EEPROM_NAME_LENGTH 32
-
-void readSettings() {
-  EEPROM.begin(EEPROM_WIFI_SIZE);
-  // Read the magic header and validate it.
-  String magic;
-  for (int i = 0 ; i < EEPROM_MAGIC_LENGTH ; i++) {
-    magic += char(EEPROM.read(EEPROM_MAGIC_OFFSET + i));
-  }
-  if (magic != EEPROM_MAGIC) return; // Invalid settings.
-  w_ssid = "";
-  w_psk = "";
-  for (int i = EEPROM_SSID_OFFSET ;  i < EEPROM_SSID_LENGTH ; i++) {
-    char c = char(EEPROM.read(i));
-    if (c) {
-      w_ssid += c;
-    }
-  }
-  for (int i = EEPROM_PSK_OFFSET ; i < EEPROM_PSK_LENGTH ; i++) {
-    char c = char(EEPROM.read(i));
-    if (c) {
-      w_psk += c;
-    }
-  }
-  timezone = long(EEPROM.read(EEPROM_TZ_OFFSET));
-  uint32_t ntpAddr;
-  ntpAddr = EEPROM.read(EEPROM_TIMESERVER_OFFSET) << 24;
-  ntpAddr |= uint32_t(EEPROM.read(EEPROM_TIMESERVER_OFFSET+1)) << 16;
-  ntpAddr |= uint32_t(EEPROM.read(EEPROM_TIMESERVER_OFFSET+2)) << 8;
-  ntpAddr |= uint32_t(EEPROM.read(EEPROM_TIMESERVER_OFFSET+3));
-  if (ntpAddr > 0) {
-    timeServer = IPAddress(ntpAddr);
-  }
-  syncInterval;
-  syncInterval = time_t(EEPROM.read(EEPROM_INTERVAL_OFFSET)) << 8;
-  syncInterval |= EEPROM.read(EEPROM_INTERVAL_OFFSET+1);
-
-  clockName = "";
-  for (int i = 0 ; i < EEPROM_NAME_LENGTH ; i++) {
-    char c = EEPROM.read(EEPROM_NAME_OFFSET + i);
-    if (c) {
-      clockName += c;
-    }
-  }
-  clockName.replace("+", " ");
-  EEPROM.end();
-}
-
-void saveSettings() {
-  EEPROM.begin(EEPROM_WIFI_SIZE);
-  // Zero the eeprom.
-  for (int i = 0 ; i < EEPROM_WIFI_SIZE ; i++) {
-    EEPROM.write(i, 0);
-  }
-  // Write the magic header.
-  for (int i = 0 ; i < EEPROM_MAGIC_LENGTH ; i++) {
-    EEPROM.write(EEPROM_MAGIC_OFFSET + i, EEPROM_MAGIC[i]);
-  }
-  // Write the SSID.
-  for (int i = 0 ; i < w_ssid.length() ; i++) {
-    EEPROM.write(i + EEPROM_SSID_OFFSET, w_ssid.charAt(i));
-  }
-  // Write the PSK.
-  for (int i = 0 ; i < w_psk.length() ; i++) {
-    EEPROM.write(i + EEPROM_PSK_OFFSET, w_psk.charAt(i));
-  }
-  // Write the TZ offset.
-  EEPROM.write(EEPROM_TZ_OFFSET, timezone);
-  // Write the timeserver IP.
-  EEPROM.write(EEPROM_TIMESERVER_OFFSET, timeServer >> 24);
-  EEPROM.write(EEPROM_TIMESERVER_OFFSET+1, (timeServer >> 16) & 0xff);
-  EEPROM.write(EEPROM_TIMESERVER_OFFSET+2, (timeServer >> 8) & 0xff);
-  EEPROM.write(EEPROM_TIMESERVER_OFFSET+3, timeServer & 0xff);
-  // Write the interval.
-  EEPROM.write(EEPROM_INTERVAL_OFFSET, (syncInterval >> 8) & 0xff);
-  EEPROM.write(EEPROM_INTERVAL_OFFSET+1, syncInterval & 0xff);
-  // Write the clock name.
-  for (int i = 0 ; i < clockName.length() ; i++) {
-    EEPROM.write(EEPROM_NAME_OFFSET + i, clockName.charAt(i));
-  }
-  EEPROM.end();
-}
-
 void setupSTA()
 {
   char ssid[32];
@@ -228,9 +127,9 @@ void setupSTA()
 
   clockMode = MODE_CLOCK;
   WiFi.mode(WIFI_STA);
-  w_ssid.toCharArray(ssid, 32);
-  w_psk.toCharArray(psk, 64);
-  if (w_psk.length()) {
+  settings.ssid.toCharArray(ssid, 32);
+  settings.psk.toCharArray(psk, 64);
+  if (settings.psk.length()) {
     WiFi.begin(ssid, psk);
   } else {
     WiFi.begin(ssid);

esp8266-ledclock/ntp.ino

@@ -9,46 +9,9 @@ byte sendBuffer[] = {
   0xEC,                // Clock precision.
   0x0, 0x0, 0x0, 0x0}; // Reference ...
 
-String ipToString(IPAddress ip) {
-  uint32_t addr = ip;
-  String ret;
-  ret = String(addr & 0xff) + "." + String(addr >> 8 & 0xff) + "." + String(addr >> 16 & 0xff) + "." + String(addr >> 24);
-  return ret;
-}
-
-IPAddress parseIP(String ipaddr) {
- // charArray of ipaddr.
- char ip[16];
- uint32_t address = 0;
- int o = 0;
- char octet[3];
- char digits = 0; // per octet.
- if (ipaddr.length() > 16) goto badIP;
- ipaddr.toCharArray(ip, 16);
- for (int i = 0 ; ip[i] != '\0' ; i++) {
-   if (ip[i] == '.') {
-     uint8_t oct = atoi(octet);
-     if (digits < 1 || digits > 3 || oct > 0xff) {
-       goto badIP;
-     }
-     address |= oct << (8 * o);
-     if (o++ > 2) goto badIP;
-     memset(octet, 0, 4); digits = 0;
-   } else if (ip[i] < '0' || ip[i] > '9' || digits > 2) {
-    goto badIP;
-   } else {
-     octet[digits++] = ip[i];
-   }
- }
- address |= atoi(octet) << 24;
- return IPAddress(address);
- badIP:
- return IPAddress(0, 0, 0, 0);
-}
-
 void setupTime() {
   setSyncProvider(getNtpTime);
-  setSyncInterval(syncInterval);
+  setSyncInterval(settings.interval);
 }
 
 time_t getNtpTime()
@@ -57,7 +20,7 @@ time_t getNtpTime()
   udp.begin(localPort);
   while (udp.parsePacket() > 0) ; // discard any previously received packets
   for (int i = 0 ; i < 5 ; i++) { // 5 retries.
-    sendNTPpacket(&udp, timeServer);
+    sendNTPpacket(&udp);
     uint32_t beginWait = millis();
     while (millis() - beginWait < 1500) {
       if (udp.parsePacket()) {
@@ -67,21 +30,21 @@ time_t getNtpTime()
          unsigned long lowWord = word(packetBuffer[42], packetBuffer[43]);
          unsigned long secSince1900 = highWord << 16 | lowWord;
          udp.flush();
-         return secSince1900 - 2208988800UL + timezone * SECS_PER_HOUR;
+         return secSince1900 - 2208988800UL + settings.timezone * SECS_PER_HOUR;
       }
       delay(10);
     }
   }
   return 0; // return 0 if unable to get the time
 }
 
-
-void sendNTPpacket(WiFiUDP *u, IPAddress &address) {
+void sendNTPpacket(WiFiUDP *u) {
   // Zeroise the buffer.
   memset(packetBuffer, 0, NTP_PACKET_SIZE);
   memcpy(packetBuffer, sendBuffer, 16);
 
-  u->beginPacket(address, 123);  // Port 123.
-  u->write(packetBuffer, NTP_PACKET_SIZE);
-  u->endPacket();
+  if (u->beginPacket(settings.timeserver, 123)) {
+    u->write(packetBuffer, NTP_PACKET_SIZE);
+    u->endPacket();
+  }
 }