Continue modularizing; reduce flash writes

Author: clockspot

arduino-nixie/arduino-nixie.h

@@ -0,0 +1,81 @@
+// Universal digital clock codebase for Arduino - https://github.com/clockspot/arduino-clock
+// Sketch by Luke McKenzie (luke@theclockspot.com)
+// Written to support RLB Designs’ Universal Nixie Driver Board
+// Inspired by original sketch by Robin Birtles (rlb-designs.com) and Chris Gerekos
+
+////////// 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"
+
+
+
+
+//Unique IDs for the functions - see also fnScroll
+#define FN_TOD 0 //time of day
+#define FN_CAL 1 //date, with optional day counter and sunrise/sunset pages
+#define FN_ALARM 2 //alarm time
+#define FN_TIMER 3 //countdown timer and chronograph
+#define FN_THERM 4 //temperature per rtc – will likely read high
+#define FN_TUBETEST 5 //simply cycles all digits for nixie tube testing
+#define FN_OPTS 201 //fn values from here to 255 correspond to settings in the settings menu
+
+void setup();
+void loop();
+void ctrlEvt(byte ctrl, byte evt, byte evtLast);
+void fnScroll(byte dir);
+void fnOptScroll(byte dir);
+void goToFn(byte thefn, byte thefnPg=0);
+void switchAlarmState(byte dir);
+void setAlarmState(byte state);
+byte getAlarmState();
+void switchPower(byte dir);
+void startSet(int n, int m, int x, byte p);
+void doSet(int delta);
+void clearSet();
+bool initEEPROM(bool hard);
+void findFnAndPageNumbers();
+void checkRTC(bool force);
+void fibonacci(byte h, byte m, byte s);
+void autoDST();
+bool isDST(int y, byte m, byte d);
+bool isDSTByHour(int y, byte m, byte d, byte h, bool setFlag);
+byte nthSunday(int y, byte m, byte nth);
+byte daysInMonth(word y, byte m);
+int daysInYear(word y);
+int dateToDayCount(word y, byte m, byte d);
+byte dayOfWeek(word y, byte m, byte d);
+int dateComp(int y, byte m, byte d, byte mt, byte dt, bool countUp);
+bool isTimeInRange(word tstart, word tend, word ttest);
+bool isDayInRange(byte dstart, byte dend, byte dtest);
+void millisCheckDrift();
+void millisApplyDrift();
+void millisReset();
+unsigned long ms();
+void timerStart();
+void timerStop();
+void timerClear();
+void timerLap();
+void timerRunoutToggle();
+void cycleTimer();
+void timerSleepSwitch(bool on);
+byte getTimerState();
+void setTimerState(char pos, bool val);
+void tempDisplay(int i0, int i1=0, int i2=0, int i3=0);
+void updateDisplay();
+void calcSun();
+void displaySun(byte which, int d, int tod);
+void displayWeather(byte which);
+void initOutputs();
+void signalStart(byte sigFn, byte sigDur);
+void signalStop();
+void cycleSignal();
+word getSignalPitch();
+word getHz(byte note);
+byte getSignalOutput();
+byte getSignalPattern();
+void quickBeep(int pitch);
+void quickBeepPattern(int source, int pattern);
+void updateBacklight();
+void cycleBacklight();

arduino-nixie/arduino-nixie.ino

@@ -88,7 +88,7 @@
 
 //Soft power switches
 #define ENABLE_SOFT_ALARM_SWITCH 1
-// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (FN_ALARM).
 // 0 = no. Alarm will be permanently on. Use with switch signal if the appliance has its own switch on this circuit (and note that, if another signal type(s) is available and selected for the alarm, the user won't be able to switch it off). Also disables skip feature. Note that the instructions do not reflect this option.
 #define ENABLE_SOFT_POWER_SWITCH 1 //switch signal only
 // 1 = yes. Switch signal can be toggled on and off directly with Alt button at any time (except in settings menu). This is useful if connecting an appliance (e.g. radio) that doesn't have its own switch, or if replacing the clock unit in a clock radio where the clock does all the switching (e.g. Telechron).

arduino-nixie/configs/led-iot.h

@@ -101,7 +101,7 @@
 
 //Soft power switches
 #define ENABLE_SOFT_ALARM_SWITCH 1
-// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (FN_ALARM).
 // 0 = no. Alarm will be permanently on. Use with switch signal if the appliance has its own switch on this circuit (and note that, if another signal type(s) is available and selected for the alarm, the user won't be able to switch it off). Also disables skip feature. Note that the instructions do not reflect this option.
 #define ENABLE_SOFT_POWER_SWITCH 1 //switch signal only
 // 1 = yes. Switch signal can be toggled on and off directly with Alt button at any time (except in settings menu). This is useful if connecting an appliance (e.g. radio) that doesn't have its own switch, or if replacing the clock unit in a clock radio where the clock does all the switching (e.g. Telechron).

arduino-nixie/configs/undb-v5.h

@@ -109,7 +109,7 @@
 
 //Soft power switches
 #define ENABLE_SOFT_ALARM_SWITCH 1
-// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (FN_ALARM).
 // 0 = no. Alarm will be permanently on. Use with switch signal if the appliance has its own switch on this circuit (and note that, if another signal type(s) is available and selected for the alarm, the user won't be able to switch it off). Also disables skip feature. Note that the instructions do not reflect this option.
 #define ENABLE_SOFT_POWER_SWITCH 1 //switch signal only
 // 1 = yes. Switch signal can be toggled on and off directly with Alt button at any time (except in settings menu). This is useful if connecting an appliance (e.g. radio) that doesn't have its own switch, or if replacing the clock unit in a clock radio where the clock does all the switching (e.g. Telechron).

arduino-nixie/configs/undb-v8-simplified.h

@@ -109,7 +109,7 @@
 
 //Soft power switches
 #define ENABLE_SOFT_ALARM_SWITCH 1
-// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (FN_ALARM).
 // 0 = no. Alarm will be permanently on. Use with switch signal if the appliance has its own switch on this circuit (and note that, if another signal type(s) is available and selected for the alarm, the user won't be able to switch it off). Also disables skip feature. Note that the instructions do not reflect this option.
 #define ENABLE_SOFT_POWER_SWITCH 1 //switch signal only
 // 1 = yes. Switch signal can be toggled on and off directly with Alt button at any time (except in settings menu). This is useful if connecting an appliance (e.g. radio) that doesn't have its own switch, or if replacing the clock unit in a clock radio where the clock does all the switching (e.g. Telechron).

arduino-nixie/configs/undb-v8.h

@@ -110,7 +110,7 @@
 
 //Soft power switches
 #define ENABLE_SOFT_ALARM_SWITCH 1
-// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (FN_ALARM).
 // 0 = no. Alarm will be permanently on. Use with switch signal if the appliance has its own switch on this circuit (and note that, if another signal type(s) is available and selected for the alarm, the user won't be able to switch it off). Also disables skip feature. Note that the instructions do not reflect this option.
 #define ENABLE_SOFT_POWER_SWITCH 1 //switch signal only
 // 1 = yes. Switch signal can be toggled on and off directly with Alt button at any time (except in settings menu). This is useful if connecting an appliance (e.g. radio) that doesn't have its own switch, or if replacing the clock unit in a clock radio where the clock does all the switching (e.g. Telechron).

arduino-nixie/configs/undb-v9-relay.h

@@ -110,7 +110,7 @@
 
 //Soft power switches
 #define ENABLE_SOFT_ALARM_SWITCH 1
-// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (FN_ALARM).
 // 0 = no. Alarm will be permanently on. Use with switch signal if the appliance has its own switch on this circuit (and note that, if another signal type(s) is available and selected for the alarm, the user won't be able to switch it off). Also disables skip feature. Note that the instructions do not reflect this option.
 #define ENABLE_SOFT_POWER_SWITCH 1 //switch signal only
 // 1 = yes. Switch signal can be toggled on and off directly with Alt button at any time (except in settings menu). This is useful if connecting an appliance (e.g. radio) that doesn't have its own switch, or if replacing the clock unit in a clock radio where the clock does all the switching (e.g. Telechron).

arduino-nixie/configs/undb-v9-simplified.h

@@ -110,7 +110,7 @@
 
 //Soft power switches
 #define ENABLE_SOFT_ALARM_SWITCH 1
-// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (FN_ALARM).
 // 0 = no. Alarm will be permanently on. Use with switch signal if the appliance has its own switch on this circuit (and note that, if another signal type(s) is available and selected for the alarm, the user won't be able to switch it off). Also disables skip feature. Note that the instructions do not reflect this option.
 #define ENABLE_SOFT_POWER_SWITCH 1 //switch signal only
 // 1 = yes. Switch signal can be toggled on and off directly with Alt button at any time (except in settings menu). This is useful if connecting an appliance (e.g. radio) that doesn't have its own switch, or if replacing the clock unit in a clock radio where the clock does all the switching (e.g. Telechron).

arduino-nixie/configs/undb-v9.h

@@ -147,7 +147,7 @@
 
 //Soft power switches
 #define ENABLE_SOFT_ALARM_SWITCH 1
-// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (FN_ALARM).
 // 0 = no. Alarm will be permanently on. Use with switch signal if the appliance has its own switch on this circuit (and note that, if another signal type(s) is available and selected for the alarm, the user won't be able to switch it off). Also disables skip feature. Note that the instructions do not reflect this option.
 #define ENABLE_SOFT_POWER_SWITCH 1 //switch signal only
 // 1 = yes. Switch signal can be toggled on and off directly with Alt button at any time (except in settings menu). This is useful if connecting an appliance (e.g. radio) that doesn't have its own switch, or if replacing the clock unit in a clock radio where the clock does all the switching (e.g. Telechron).