Rename to arduino-clock, v2.0.0 (if a bit buggy)!

Author: clockspot

README.md

@@ -34,13 +34,13 @@ Written to support [RLB Designs’](http://rlb-designs.com/) Universal Nixie Dri
 * Switch and pulse signals supported on UNDB v9+
 * Nano 33 IoT support coming on future versions
 
-[The latest release can be downloaded here.](https://github.com/clockspot/arduino-clock/releases/latest)
+[The latest release can be downloaded here.](https://github.com/clockspot/arduino-clock/releases) Please note [known bugs and to-dos.](https://github.com/clockspot/arduino-clock/blob/master/TODO.md)
 
 # Configuration, compilation, and upload
 
-Various options, such as enabled functionality, RTC, display, I/O pins, timeouts, and control behaviors, are specified in a config file. This allows you to maintain configs for multiple clock hardware profiles, and simply include the relevant config at the top of `arduino-nixie.h` before compiling. Several [example configs](https://github.com/clockspot/arduino-clock/tree/master/arduino-clock/configs) are provided, and [`~sample.h`](https://github.com/clockspot/arduino-clock/blob/master/arduino-clock/configs/%7Esample.h) includes all possible options with detailed comments.
+Various options, such as enabled functionality, RTC, display, I/O pins, timeouts, and control behaviors, are specified in a config file. This allows you to maintain configs for multiple clock hardware profiles, and simply include the relevant config at the top of `arduino-clock.h` before compiling. Several [example configs](https://github.com/clockspot/arduino-clock/tree/master/arduino-clock/configs) are provided, and [`~sample.h`](https://github.com/clockspot/arduino-clock/blob/master/arduino-clock/configs/%7Esample.h) includes all possible options with detailed comments.
 
-You may also wish to adjust the defaults for the clock’s user-configurable values to best suit its intended use, in case the user performs a hard reset. Some of these are specified in the config; others, for now, are hardcoded in `arduino-nixie.ino` (`optsDef[]` for [settings](https://github.com/clockspot/arduino-clock/blob/master/INSTRUCTIONS.md#settings-menu) and `initEEPROM()` for other values).
+You may also wish to adjust the defaults for the clock’s user-configurable values to best suit its intended use, in case the user performs a hard reset. Some of these are specified in the config; others, for now, are hardcoded in `arduino-clock.ino` (`optsDef[]` for [settings](https://github.com/clockspot/arduino-clock/blob/master/INSTRUCTIONS.md#settings-menu) and `initEEPROM()` for other values).
 
 I use the Arduino IDE to compile and upload, due to the use of various Arduino and Arduino-oriented libraries. Make sure the relevant libraries are installed in the Library Manager, per the config in use.
 

TODO.md

@@ -1,14 +1,13 @@
 # To-dos
 
-* Rename project to arduino-clock with first push of v2+ - replace instances of arduino-nixie within
+* Startup SEL hold doesn't seem to work with IMU
 * Reintroduce nixie clean and scroll
 * Persistent storage on EEPROM - find a solution that writes to flash less often
 * Network/NTP
-	* Persistent storage for wi-fi credentials!
 	* Why does the page sometimes drop?
 	* wi-fi credential save fails if keys are part of the string?
 	* DST calc may behave unpredictably between 1–2am on fallback day
-	* Redo NTP on startup if it failed (networkStartWifi())
+	* Redo NTP if it failed (networkStartWifi()) - per bad response - how to make it wait a retry period
 	* Make [2036-ready](https://en.wikipedia.org/wiki/Year_2038_problem#Network_Time_Protocol_timestamps)
 	* Notice when a leap second is coming and handle it
 	* When setting page is used to set day counter and date, and the month changes, set date max. For 2/29 it should just do 3/1 probably.

arduino-nixie/arduino-nixie.h renamed to arduino-clock/arduino-clock.h

@@ -4,8 +4,7 @@
 ////////// Hardware configuration //////////
 //Include the config file that matches your hardware setup. If needed, duplicate an existing one.
 
-#include "configs/led-iot.h"
-//#include "configs/undb-v9-relay.h"
+#include "configs/undb-v9.h"
 
 ////////////////////////////////////////////
 

arduino-nixie/arduino-nixie.ino renamed to arduino-clock/arduino-clock.ino

@@ -4,13 +4,13 @@
 // Inspired by original sketch by Robin Birtles (rlb-designs.com) and Chris Gerekos
 
 #include <arduino.h>
-#include "arduino-nixie.h";
+#include "arduino-clock.h";
 
 ////////// Software version //////////
-const byte vMajor = 1;
-const byte vMinor = 9;
+const byte vMajor = 2;
+const byte vMinor = 0;
 const byte vPatch = 0;
-const bool vDev = 1;
+const bool vDev = 0;
 
 ////////// Includes //////////
 
@@ -155,10 +155,10 @@ unsigned int tempValDispLast = 0;
 ////////// Main code control //////////
 
 void setup(){
-  Serial.begin(9600);
-  #ifndef __AVR__ //SAMD only
-  while(!Serial);
-  #endif
+  // Serial.begin(9600);
+  // #ifndef __AVR__ //SAMD only
+  // while(!Serial);
+  // #endif
   rtcInit();
   initStorage(); //pulls persistent storage data into volatile vars - see storage.cpp
   byte changed = initEEPROM(false); //do a soft init to make sure vals in range

arduino-nixie/configs/led-iot.h renamed to arduino-clock/configs/led-iot.h

@@ -1,7 +1,7 @@
 #include <arduino.h>
-#include "arduino-nixie.h"
+#include "arduino-clock.h"
 
-#ifdef DISP_MAX7219 //see arduino-nixie.ino Includes section
+#ifdef DISP_MAX7219 //see arduino-clock.ino Includes section
 
 #include "dispMAX7219.h"
 #include <SPI.h> //Arduino - for SPI access to MAX7219

arduino-nixie/configs/undb-v5.h renamed to arduino-clock/configs/undb-v5.h

@@ -1,7 +1,7 @@
 #include <arduino.h>
-#include "arduino-nixie.h"
+#include "arduino-clock.h"
 
-#ifdef DISP_NIXIE //see arduino-nixie.ino Includes section
+#ifdef DISP_NIXIE //see arduino-clock.ino Includes section
 
 #include "dispNixie.h"
 

arduino-nixie/configs/undb-v8-simplified.h renamed to arduino-clock/configs/undb-v8-simplified.h

@@ -1,5 +1,5 @@
 #include <arduino.h>
-#include "arduino-nixie.h"
+#include "arduino-clock.h"
 
 #include "input.h"
 

arduino-nixie/configs/undb-v8.h renamed to arduino-clock/configs/undb-v8.h

@@ -1,5 +1,5 @@
 #include <arduino.h>
-#include "arduino-nixie.h"
+#include "arduino-clock.h"
 
 #ifndef __AVR__ //TODO better sensor
 //do stuff for wifinina
@@ -41,7 +41,7 @@ WiFiServer server(80);
 bool networkSupported(){ return true; }
 
 void initNetwork(){
-  Serial.println(F("Hello world from network.cpp"));
+  //Serial.println(F("Hello world from network.cpp"));
   //Check status of wifi module up front
   //if(WiFi.status()==WL_NO_MODULE){ Serial.println(F("Communication with WiFi module failed!")); while(true); }
   //else if(WiFi.firmwareVersion()<WIFI_FIRMWARE_LATEST_VERSION) Serial.println(F("Please upgrade the firmware"));
@@ -50,9 +50,9 @@ void initNetwork(){
   for(byte i=0; i<32; i++){ if(readEEPROM(55+i,false)=='\0') break; wssid.concat((char)(readEEPROM(55+i,false))); } //Read in the SSID
   for(byte i=0; i<64; i++){ if(readEEPROM(87+i,false)=='\0') break; wpass.concat((char)(readEEPROM(87+i,false))); } //Read in the pass
   wki = readEEPROM(151,false); //Read in the wki
-  Serial.print(F("wssid=")); Serial.println(wssid);
-  Serial.print(F("wpass=")); Serial.println(wpass);
-  Serial.print(F("wki=")); Serial.println(wki);
+  //Serial.print(F("wssid=")); Serial.println(wssid);
+  //Serial.print(F("wpass=")); Serial.println(wpass);
+  //Serial.print(F("wki=")); Serial.println(wki);
   networkStartWiFi();
 }
 void cycleNetwork(){
@@ -84,7 +84,7 @@ void checkForWiFiStatusChange(){
 
 void networkStartWiFi(){
   WiFi.end(); //if AP is going, stop it
-  if(wssid==F("")){ Serial.println(F("no start wifi")); return; } //don't try to connect if there's no creds
+  if(wssid==F("")) return; //don't try to connect if there's no creds
   checkForWiFiStatusChange(); //just for serial logging
   //Serial.print(millis(),DEC); Serial.println(F("blank display per start wifi"));
   blankDisplay(0,5,false); //I'm guessing if it hangs, nixies won't be able to display anyway
@@ -401,9 +401,9 @@ void checkClients(){
           client.print(F("."));
           client.print(getVersionPart(2),DEC);
           if(getVersionPart(3)) //don't link directly to anything, just the project
-            client.print(F("-dev (<a href='https://github.com/clockspot/arduino-nixie' target='_blank'>details</a>)"));
+            client.print(F("-dev (<a href='https://github.com/clockspot/arduino-clock' target='_blank'>details</a>)"));
           else { //link directly to the release of this version
-            client.print(F(" (<a href='https://github.com/clockspot/arduino-nixie/releases/tag/v")); //TODO needs fix after rename
+            client.print(F(" (<a href='https://github.com/clockspot/arduino-clock/releases/tag/v")); //TODO needs fix after rename
             client.print(getVersionPart(0),DEC);
             client.print(F("."));
             client.print(getVersionPart(1),DEC);
@@ -791,8 +791,8 @@ void checkClients(){
           wki = currentLine.substring(startPos).toInt();
           //Persistent storage - see wssid/wpass definitions above
           for(byte i=0; i<97; i++) writeEEPROM(55+i,0,false,false); //Clear out the old values (32+64+1)
-          for(byte i=0; i<wssid.length(); i++) writeEEPROM(55+i,wssid[i],false,false); //Write in the SSID
-          for(byte i=0; i<wpass.length(); i++) writeEEPROM(87+i,wpass[i],false,false); //Write in the pass
+          for(byte i=0; i<wssid.length(); i++) { if(i<55+32) writeEEPROM(55+i,wssid[i],false,false); } //Write in the SSID
+          for(byte i=0; i<wpass.length(); i++) { if(i<87+64) writeEEPROM(87+i,wpass[i],false,false); } //Write in the pass
           writeEEPROM(151,wki,false,false); //Write in the wki
           commitEEPROM(); //commit all the above
           requestType = 3; //triggers an admin restart after the client is closed, below

arduino-nixie/configs/undb-v9-relay.h renamed to arduino-clock/configs/undb-v9-relay.h

@@ -1,7 +1,7 @@
 #include <arduino.h>
-#include "arduino-nixie.h"
+#include "arduino-clock.h"
 
-#ifdef RTC_DS3231 //see arduino-nixie.ino Includes section
+#ifdef RTC_DS3231 //see arduino-clock.ino Includes section
 
 #include "rtcDS3231.h"
 #include <Wire.h> //Arduino - GNU LPGL - for I2C access to DS3231

arduino-nixie/configs/undb-v9-simplified.h renamed to arduino-clock/configs/undb-v9-simplified.h

@@ -1,7 +1,7 @@
 #include <arduino.h>
-#include "arduino-nixie.h"
+#include "arduino-clock.h"
 
-#ifdef RTC_MILLIS //see arduino-nixie.ino Includes section
+#ifdef RTC_MILLIS //see arduino-clock.ino Includes section
 
 #include "rtcMillis.h"
 

arduino-nixie/configs/undb-v9.h renamed to arduino-clock/configs/undb-v9.h

@@ -0,0 +1,84 @@
+// Persistent storage
+
+// This project was originally written to use the AVR Arduino's EEPROM for persistent storage, and would frequently read it directly during runtime (not just at startup). I wanted to abstract that away, partly to add support for SAMD flash memory, and partly to protect against runtime errors due to EEPROM/flash failure.
+// This code serves those values out of a volatile array of bytes, which are backed by EEPROM/flash for the sole purpose of recovery after a power failure. It reads them from EEPROM/flash at startup, and sets them when changed.
+// Flash support is via cmaglie's FlashStorage library. It offers an EEPROM emulation mode, which I'm currently using, but I don't like that it writes the entire "EEPROM" data to flash (not just the value being updated) with every commit() – I think it will wear out unnecessarily. TODO address this.
+// Note that flash data is necessarily wiped out when the sketch is (re)uploaded.
+
+#include <arduino.h>
+#include "arduino-clock.h"
+
+#include "storage.h"
+
+#ifdef __AVR__
+  #include <EEPROM.h> //Arduino - GNU LPGL
+#else //SAMD - is there a better way to detect EEPROM availability? TODO
+  #define FLASH_AS_EEPROM
+  //cmaglie's FlashStorage library - https://github.com/cmaglie/FlashStorage/
+  #include <FlashAsEEPROM.h> //EEPROM mode
+  //#include <FlashStorage.h> //regular mode
+#endif
+
+#define STORAGE_SPACE 152 //number of bytes
+byte storageBytes[STORAGE_SPACE]; //the volatile array of bytes
+#define COMMIT_TO_EEPROM 1 //1 for production
+
+void initStorage(){
+  //If this is SAMD, write starting values if unused
+  #ifdef FLASH_AS_EEPROM
+  //Serial.println(F("Hello world from storage.cpp"));
+  //Serial.print(F("valid=")); Serial.println(EEPROM.isValid(),DEC);
+  //Serial.print(F("16=")); Serial.println(EEPROM.read(16));
+  if(!EEPROM.isValid() || EEPROM.read(16)==0 || EEPROM.read(16)==255){ //invalid eeprom, wipe it out
+    for(byte i=0; i<STORAGE_SPACE; i++) EEPROM.update(i,0);
+    if(COMMIT_TO_EEPROM){
+      EEPROM.commit();
+      //Serial.println(F("WARNING: FLASH EEPROM COMMIT per init"));
+    }
+  }
+  #endif
+  //Read from real persistent storage into storageBytes
+  for(byte i=0; i<STORAGE_SPACE; i++) storageBytes[i] = EEPROM.read(i);
+}
+
+int readEEPROM(int loc, bool isInt){
+  //Read from the volatile array, either a byte or a signed int
+  //Must read int as 16-bit, since on SAMD int is 32-bit and negatives aren't read correctly
+  if(isInt) return (int16_t)(storageBytes[loc]<<8)+storageBytes[loc+1];
+  else return storageBytes[loc];
+}
+
+bool writeEEPROM(int loc, int val, bool isInt, bool commit){
+  //Update the volatile array and the real persistent storage for posterity
+  //Eiither a byte or a signed int
+  //Serial.print(F("Set ")); Serial.print(loc); Serial.print(F("=")); Serial.print(val,DEC);
+  if(readEEPROM(loc,isInt)==val){
+    //Serial.println(F(": nothing doing"));
+    return false;
+  }
+  //Serial.println(F(": ok (probably)"));
+  if(isInt){
+    storageBytes[loc] = highByte(val);
+    storageBytes[loc+1] = lowByte(val);
+    EEPROM.update(loc,highByte(val));
+    EEPROM.update(loc+1,lowByte(val));
+  } else {
+    storageBytes[loc] = val;
+    EEPROM.update(loc,val);
+  }
+  #ifdef FLASH_AS_EEPROM
+    if(commit && COMMIT_TO_EEPROM){
+      EEPROM.commit(); //bad!! See TODO in storage.h
+      //Serial.println(F("WARNING: FLASH EEPROM COMMIT per write"));
+    }
+  #endif
+  return true; //a value was changed
+}
+void commitEEPROM(){
+  #ifdef FLASH_AS_EEPROM
+  if(COMMIT_TO_EEPROM){
+    EEPROM.commit(); //bad!! See TODO in storage.h
+    //Serial.println(F("WARNING: FLASH EEPROM COMMIT by request"));
+  }
+  #endif
+}

arduino-nixie/configs/~sample.h renamed to arduino-clock/configs/~sample.h

@@ -0,0 +1,9 @@
+#ifndef STORAGE_H
+#define STORAGE_H
+
+void initStorage(); //Read from real persistent storage into storageBytes
+int readEEPROM(int loc, bool isInt); //Read from the volatile array
+bool writeEEPROM(int loc, int val, bool isInt, bool commit=1); //Update the volatile array and the real persistent storage for posterity
+void commitEEPROM();
+
+#endif //STORAGE_H