Calendar pages, sunrise/sunset, alarm skip, and more!

TODO.md

@@ -2,7 +2,6 @@
 
 * Timer count up, ending options - maybe separate chrono and timer à la Timex?
 * Different setting option for pushbutton (à la Timex) vs. rotary (à la microwave ovens) - external file?
-* Set current DST state in EEPROM so when the clock is connected to power, it can determine whether correction is needed
 * Option to display weekdays as Sun=0 or Sun=1 (per Portuguese!)
 * When setting times of day, make 1439 (minutes) roll over to 0 and vice versa
 * Implement options for full date every 5 minutes
@@ -16,10 +15,8 @@
 * Should functions have their own options menu?
 * I2C display to help with setting?
 * I2C multicolor LED to indicate which function we're in?
-* Display firmware version, correlating to release on github
 * Metronome function
 * Alarm option should be beeping patterns, including a slow wake which defeats the 2 minute delay
-* Alarm should have a way to override the auto-setting for the next wake time – maybe press the dedicated alarm button!
 * Signalstart should create a situation where there's time on the counter, but doesn't make sound since the rtc can do that. Other beepable actions would probably cancel that counter anyway
 
 See other TODOs throughout code.

arduino-nixie/configs/v5-4tube.h

@@ -7,11 +7,10 @@ const byte fnIsTime = 0;
 const byte fnIsDate = 1;
 const byte fnIsAlarm = 2;
 const byte fnIsTimer = 3;
-const byte fnIsDayCount = 4;
-const byte fnIsTemp = 5;
-const byte fnIsTubeTester = 6; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
+const byte fnIsTemp = 4;
+const byte fnIsTubeTester = 5; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
 // functions enabled in this clock, in their display order. Only fnIsTime is required
-const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer, fnIsDayCount}; //, fnIsTemp, fnIsTubeTester
+const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer}; //, fnIsTemp, fnIsTubeTester
 // To control which of these display persistently vs. switch back to Time after a few seconds, search "Temporary-display mode timeout"
 
 // These are the UNDB v5 board connections to Arduino analog input pins.

arduino-nixie/configs/v5-6tube.h

@@ -7,11 +7,10 @@ const byte fnIsTime = 0;
 const byte fnIsDate = 1;
 const byte fnIsAlarm = 2;
 const byte fnIsTimer = 3;
-const byte fnIsDayCount = 4;
 const byte fnIsTemp = 5;
 const byte fnIsTubeTester = 6; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
 // functions enabled in this clock, in their display order. Only fnIsTime is required
-const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer, fnIsDayCount}; //, fnIsTemp, fnIsTubeTester
+const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer}; //, fnIsTemp, fnIsTubeTester
 // To control which of these display persistently vs. switch back to Time after a few seconds, search "Temporary-display mode timeout"
 
 // These are the UNDB v5 board connections to Arduino analog input pins.

arduino-nixie/configs/v8-4tube.h

@@ -7,11 +7,10 @@ const byte fnIsTime = 0;
 const byte fnIsDate = 1;
 const byte fnIsAlarm = 2;
 const byte fnIsTimer = 3;
-const byte fnIsDayCount = 4;
-const byte fnIsTemp = 5;
-const byte fnIsTubeTester = 6; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
+const byte fnIsTemp = 4;
+const byte fnIsTubeTester = 5; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
 // functions enabled in this clock, in their display order. Only fnIsTime is required
-const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer, fnIsDayCount}; //, fnIsTemp, fnIsTubeTester
+const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer}; //, fnIsTemp, fnIsTubeTester
 // To control which of these display persistently vs. switch back to Time after a few seconds, search "Temporary-display mode timeout"
 
 // These are the RLB board connections to Arduino analog input pins.

arduino-nixie/configs/v8-6tube.h

@@ -7,11 +7,10 @@ const byte fnIsTime = 0;
 const byte fnIsDate = 1;
 const byte fnIsAlarm = 2;
 const byte fnIsTimer = 3;
-const byte fnIsDayCount = 4;
-const byte fnIsTemp = 5;
-const byte fnIsTubeTester = 6; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
+const byte fnIsTemp = 4;
+const byte fnIsTubeTester = 5; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
 // functions enabled in this clock, in their display order. Only fnIsTime is required
-const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer, fnIsDayCount}; //, fnIsTemp, fnIsTubeTester
+const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer}; //, fnIsTemp, fnIsTubeTester
 // To control which of these display persistently vs. switch back to Time after a few seconds, search "Temporary-display mode timeout"
 
 // These are the RLB board connections to Arduino analog input pins.

arduino-nixie/configs/v8c-6tube-relayswitch-pwm.h → arduino-nixie/configs/v8c-6tube-relay.h

@@ -1,4 +1,4 @@
-//UNDB v8 modified to v9 spec (put Sel/Alt on A6/A7, Up/Down on A0/A1, relay on A3, led on 9, and cathode B4 on A2), buttons as labeled, with 6-digit display.
+//UNDB v8 modified to v9 spec (put Sel/Alt on A6/A7, Up/Down on A0/A1, relay on A3, led on 9, and cathode B4 on A2), relay enabled, buttons as labeled, with 6-digit display.
 
 const byte displaySize = 6; //number of tubes in display module. Small display adjustments are made for 4-tube clocks
 
@@ -7,11 +7,10 @@ const byte fnIsTime = 0;
 const byte fnIsDate = 1;
 const byte fnIsAlarm = 2;
 const byte fnIsTimer = 3;
-const byte fnIsDayCount = 4;
-const byte fnIsTemp = 5;
-const byte fnIsTubeTester = 6; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
+const byte fnIsTemp = 4;
+const byte fnIsTubeTester = 5; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
 // functions enabled in this clock, in their display order. Only fnIsTime is required
-const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer, fnIsDayCount}; //, fnIsTemp, fnIsTubeTester
+const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer}; //, fnIsTemp, fnIsTubeTester
 // To control which of these display persistently vs. switch back to Time after a few seconds, search "Temporary-display mode timeout"
 
 // These are the RLB board connections to Arduino analog input pins.

arduino-nixie/configs/v8c-6tube-top-relay.h

@@ -0,0 +1,93 @@
+//UNDB v8 modified to v9 spec (put Sel/Alt on A7/A6, Up/Down on A0/A1, relay on A3, led on 9, and cathode B4 on A2), relay enabled, Sel/Alt buttons reversed, with 6-digit display.
+
+const byte displaySize = 6; //number of tubes in display module. Small display adjustments are made for 4-tube clocks
+
+// available clock functions, and unique IDs (between 0 and 200)
+const byte fnIsTime = 0;
+const byte fnIsDate = 1;
+const byte fnIsAlarm = 2;
+const byte fnIsTimer = 3;
+const byte fnIsTemp = 4;
+const byte fnIsTubeTester = 5; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
+// functions enabled in this clock, in their display order. Only fnIsTime is required
+const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer}; //, fnIsTemp, fnIsTubeTester
+// To control which of these display persistently vs. switch back to Time after a few seconds, search "Temporary-display mode timeout"
+
+// These are the RLB board connections to Arduino analog input pins.
+// S1/PL13 = Reset
+// S2/PL5 = A1
+// S3/PL6 = A0
+// S4/PL7 = A6
+// S5/PL8 = A3
+// S6/PL9 = A2
+// S7/PL14 = A7
+// A6-A7 are analog-only pins that aren't quite as responsive and require a physical pullup resistor (1K to +5V), and can't be used with rotary encoders because they don't support pin change interrupts.
+
+// What input is associated with each control?
+const byte mainSel = A7;
+const byte mainAdjUp = A0;
+const byte mainAdjDn = A1;
+const byte altSel = A6; //if not equipped, set to 0
+
+// What type of adj controls are equipped?
+// 1 = momentary buttons. 2 = quadrature rotary encoder (not currently supported).
+const byte mainAdjType = 1;
+
+//What are the signal pin(s) connected to?
+const char piezoPin = 10;
+const char relayPin = A3;
+// -1 to disable feature (no relay item equipped); A3 if equipped (UNDB v8)
+const byte relayMode = 0; //If relay is equipped, what does it do?
+// 0 = switched mode: the relay will be switched to control an appliance like a radio or light fixture. If used with timer, it will switch on while timer is running (like a "sleep" function). If used with alarm, it will switch on when alarm trips; specify duration of this in switchDur.
+// 1 = pulsed mode: the relay will be pulsed, like the beeper is, to control an intermittent signaling device like a solenoid or indicator lamp. Specify pulse duration in relayPulse.
+const word signalDur = 180; //sec - when pulsed signal is going, pulses are sent once/sec for this period (e.g. 180 = 3min)
+const word switchDur = 7200; //sec - when alarm triggers switched relay, it's switched on for this period (e.g. 7200 = 2hr)
+const word piezoPulse = 500; //ms - used with piezo via tone()
+const word relayPulse = 200; //ms - used with pulsed relay
+
+//Soft power switches
+const byte enableSoftAlarmSwitch = 1;
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 0 = no. Alarm will be permanently on. Use with switched relay if the appliance has its own switch on this relay circuit.
+const byte enableSoftPowerSwitch = 1; //works with switched relay only
+// 1 = yes. Relay can be switched on and off directly with Alt button at any time (except in options 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).
+// 0 = no. Use if the connected appliance has its own power switch (independent of this relay circuit) or does not need to be manually switched. In this case (and/or if there is no switched relay) Alt will act as a function preset.
+
+//LED circuit control with PWM
+const char ledPin = 9;
+// -1 to disable feature; 11 if equipped (UNDB v8 modded)
+
+//When display is dim/off, a press will light the tubes for how long?
+const byte unoffDur = 10; //sec
+
+// How long (in ms) are the button hold durations?
+const word btnShortHold = 1000; //for setting the displayed feataure
+const word btnLongHold = 3000; //for for entering options menu
+const byte velThreshold = 150; //ms
+// When an adj up/down input (btn or rot) follows another in less than this time, value will change more (10 vs 1).
+// Recommend ~150 for rotaries. If you want to use this feature with buttons, extend to ~400.
+
+// What is the "frame rate" of the tube cleaning and display scrolling? up to 65535 ms
+const word cleanSpeed = 200; //ms
+const word scrollSpeed = 100; //ms - e.g. scroll-in-and-out date at :30 - to give the illusion of a slow scroll that doesn't pause, use (timeoutTempFn*1000)/(displaySize+1) - e.g. 714 for displaySize=6 and timeoutTempFn=5
+
+// What are the timeouts for setting and temporarily-displayed functions? up to 65535 sec
+const unsigned long timeoutSet = 120; //sec
+const unsigned long timeoutTempFn = 5; //sec
+
+//This clock is 2x3 multiplexed: two tubes powered at a time.
+//The anode channel determines which two tubes are powered,
+//and the two SN74141 cathode driver chips determine which digits are lit.
+//4 pins out to each SN74141, representing a binary number with values [1,2,4,8]
+const char outA1 = 2;
+const char outA2 = 3;
+const char outA3 = 4;
+const char outA4 = 5;
+const char outB1 = 6;
+const char outB2 = 7;
+const char outB3 = 8;
+const char outB4 = 16; //A2 - was 9 before PWM fix pt2
+//3 pins out to anode channel switches
+const char anode1 = 11;
+const char anode2 = 12;
+const char anode3 = 13;

arduino-nixie/configs/v8c-6tube-relayswitch-pwm-top.h → arduino-nixie/configs/v8c-6tube-top.h

@@ -7,11 +7,10 @@ const byte fnIsTime = 0;
 const byte fnIsDate = 1;
 const byte fnIsAlarm = 2;
 const byte fnIsTimer = 3;
-const byte fnIsDayCount = 4;
-const byte fnIsTemp = 5;
-const byte fnIsTubeTester = 6; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
+const byte fnIsTemp = 4;
+const byte fnIsTubeTester = 5; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
 // functions enabled in this clock, in their display order. Only fnIsTime is required
-const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer, fnIsDayCount}; //, fnIsTemp, fnIsTubeTester
+const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer}; //, fnIsTemp, fnIsTubeTester
 // To control which of these display persistently vs. switch back to Time after a few seconds, search "Temporary-display mode timeout"
 
 // These are the RLB board connections to Arduino analog input pins.

arduino-nixie/configs/v8c-6tube.h

@@ -0,0 +1,93 @@
+//UNDB v8 modified to v9 spec (put Sel/Alt on A6/A7, Up/Down on A0/A1, relay on A3, led on 9, and cathode B4 on A2), relay disabled, buttons as labeled, with 6-digit display.
+
+const byte displaySize = 6; //number of tubes in display module. Small display adjustments are made for 4-tube clocks
+
+// available clock functions, and unique IDs (between 0 and 200)
+const byte fnIsTime = 0;
+const byte fnIsDate = 1;
+const byte fnIsAlarm = 2;
+const byte fnIsTimer = 3;
+const byte fnIsTemp = 4;
+const byte fnIsTubeTester = 5; //cycles all digits on all tubes 1/second, similar to anti-cathode-poisoning cleaner
+// functions enabled in this clock, in their display order. Only fnIsTime is required
+const byte fnsEnabled[] = {fnIsTime, fnIsDate, fnIsAlarm, fnIsTimer}; //, fnIsTemp, fnIsTubeTester
+// To control which of these display persistently vs. switch back to Time after a few seconds, search "Temporary-display mode timeout"
+
+// These are the RLB board connections to Arduino analog input pins.
+// S1/PL13 = Reset
+// S2/PL5 = A1
+// S3/PL6 = A0
+// S4/PL7 = A6
+// S5/PL8 = A3
+// S6/PL9 = A2
+// S7/PL14 = A7
+// A6-A7 are analog-only pins that aren't quite as responsive and require a physical pullup resistor (1K to +5V), and can't be used with rotary encoders because they don't support pin change interrupts.
+
+// What input is associated with each control?
+const byte mainSel = A6;
+const byte mainAdjUp = A0;
+const byte mainAdjDn = A1;
+const byte altSel = A7; //if not equipped, set to 0
+
+// What type of adj controls are equipped?
+// 1 = momentary buttons. 2 = quadrature rotary encoder (not currently supported).
+const byte mainAdjType = 1;
+
+//What are the signal pin(s) connected to?
+const char piezoPin = 10;
+const char relayPin = -1;
+// -1 to disable feature (no relay item equipped); A3 if equipped (UNDB v8)
+const byte relayMode = 0; //If relay is equipped, what does it do?
+// 0 = switched mode: the relay will be switched to control an appliance like a radio or light fixture. If used with timer, it will switch on while timer is running (like a "sleep" function). If used with alarm, it will switch on when alarm trips; specify duration of this in switchDur.
+// 1 = pulsed mode: the relay will be pulsed, like the beeper is, to control an intermittent signaling device like a solenoid or indicator lamp. Specify pulse duration in relayPulse.
+const word signalDur = 180; //sec - when pulsed signal is going, pulses are sent once/sec for this period (e.g. 180 = 3min)
+const word switchDur = 7200; //sec - when alarm triggers switched relay, it's switched on for this period (e.g. 7200 = 2hr)
+const word piezoPulse = 500; //ms - used with piezo via tone()
+const word relayPulse = 200; //ms - used with pulsed relay
+
+//Soft power switches
+const byte enableSoftAlarmSwitch = 1;
+// 1 = yes. Alarm can be switched on and off when clock is displaying the alarm time (fnIsAlarm).
+// 0 = no. Alarm will be permanently on. Use with switched relay if the appliance has its own switch on this relay circuit.
+const byte enableSoftPowerSwitch = 1; //works with switched relay only
+// 1 = yes. Relay can be switched on and off directly with Alt button at any time (except in options 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).
+// 0 = no. Use if the connected appliance has its own power switch (independent of this relay circuit) or does not need to be manually switched. In this case (and/or if there is no switched relay) Alt will act as a function preset.
+
+//LED circuit control with PWM
+const char ledPin = 9;
+// -1 to disable feature; 11 if equipped (UNDB v8 modded)
+
+//When display is dim/off, a press will light the tubes for how long?
+const byte unoffDur = 10; //sec
+
+// How long (in ms) are the button hold durations?
+const word btnShortHold = 1000; //for setting the displayed feataure
+const word btnLongHold = 3000; //for for entering options menu
+const byte velThreshold = 150; //ms
+// When an adj up/down input (btn or rot) follows another in less than this time, value will change more (10 vs 1).
+// Recommend ~150 for rotaries. If you want to use this feature with buttons, extend to ~400.
+
+// What is the "frame rate" of the tube cleaning and display scrolling? up to 65535 ms
+const word cleanSpeed = 200; //ms
+const word scrollSpeed = 100; //ms - e.g. scroll-in-and-out date at :30 - to give the illusion of a slow scroll that doesn't pause, use (timeoutTempFn*1000)/(displaySize+1) - e.g. 714 for displaySize=6 and timeoutTempFn=5
+
+// What are the timeouts for setting and temporarily-displayed functions? up to 65535 sec
+const unsigned long timeoutSet = 120; //sec
+const unsigned long timeoutTempFn = 5; //sec
+
+//This clock is 2x3 multiplexed: two tubes powered at a time.
+//The anode channel determines which two tubes are powered,
+//and the two SN74141 cathode driver chips determine which digits are lit.
+//4 pins out to each SN74141, representing a binary number with values [1,2,4,8]
+const char outA1 = 2;
+const char outA2 = 3;
+const char outA3 = 4;
+const char outA4 = 5;
+const char outB1 = 6;
+const char outB2 = 7;
+const char outB3 = 8;
+const char outB4 = 16; //A2 - was 9 before PWM fix pt2
+//3 pins out to anode channel switches
+const char anode1 = 11;
+const char anode2 = 12;
+const char anode3 = 13;

arduino-nixie/version.h

@@ -0,0 +1,3 @@
+const byte vMajor = 1;
+const byte vMinor = 6;
+const byte vPatch = 0;