Time blink fix, date (buggy), setup menu (buggy), EEPROM, setting cleanup, function prototypes, readme updates

Author: clockspot

README.md

@@ -2,79 +2,34 @@
 Code for Arduino Nano in RLB Designs IN-12/17 clock v5.0
 featuring timekeeping by DS1307 RTC and six digits multiplexed 3x2 via two SN74141 driver chips
 
-This is an alternate codebase that is very much in progress!
+**This is an alternate codebase that is very much in progress!** The instructions below are the goal; not all may work yet.
 
-## Current instructions (WIP)
+## Instructions
 
-**As of this commit:**
+_In these instructions, "Select" is the main pushbutton, and "Adjust" can be either a knob (rotary encoder) or a pair of up/down buttons (hold to set faster). Other variations may apply depending on the options selected in the code._
 
-* Normal running mode shows time of day.
-  * To set time, hold S6 'til display flashes; push/hold S2/S3 to set the time up/down (in 24h format), and push S6 save at top of minute (seconds will set to :00).
-
-* To enter the **Setup** menu, hold S6 for 3 seconds.
-  * Shows option number on small tubes, and current setting on big tubes.
-  * Push S6 to cycle through options (listed below); push S2/S3 to set up/down; pass all options or hold S6 to exit.
-
-| Option | Possible Settings |
-| --- | --- |
-| 1. Time format | 12- or 24-hour (time display only; setting is always done in 24h) |
-| 2. n/a | |
-| 3. n/a | |
-| 4. Leading zero in hour, date, and month? | 0 = no<br/>1 = yes |
-| 5. A number | (no effect) |
-
-## Todos
-
-* Add support for rotary encoders
-  * Add velocity
-  * Configurable run controls
-  * Test
-* Flesh out menu
-  * Make settings save in eeprom(?)
-  * Make it loop
-* Date
-  * Make settable
-* Alarm
-  * Make settable
-  * Make trigger/switch, snooze, and silence
-* Timer
-  * Make settable (opens to last setting)
-  * Make run, trigger/switch, silence
-* Auto display reset
-  * When on a mode other than clock or running timer, reset to clock after 5 sec
-  * When in setting mode or setup menu, exit without saving after 120 seconds
-* "Maybe later" features
-  * Thermometer?
-  * Countdown to date?
-  * Sunrise/sunset calc per lat/long?
-
-## Proposed instructions
-
-_These instructions are for a clock equipped with a single knob/button (rotary encoder). Instructions will vary with the controls equipped and options selected in code. If a hardware alarm switch is equipped, **Alarm** may have no software switch._
-
-**Turn the knob to see each of the clock's functions:**
+**Use Adjust to see each of the clock's functions:**
 
 * **Time**
   * Shows the current time of day. (Choose 12h or 24h format in Setup.)
-  * To set time, hold 'til display flashes; turn to set (in 24h format), and push to save at top of minute (seconds will set to :00).
+  * To set time, hold Select 'til display flashes; use Adjust to set (in 24h format), and push Select to save at the top of minute (seconds will set to :00).
 * **Date**
   * Shows month, date, and weekday as 0=Sunday, 6=Saturday. (Choose month/date or date/month in Setup.)
-  * To set date, hold 'til display flashes; then set year, then month, then date.
+  * To set date, hold Select 'til display flashes; then set year, then month, then date, pushing Select to save each.
 * **Alarm**
   * Shows alarm time (in 24h format) and whether the alarm is on (1) or off (0).
-  * To turn alarm on or off, push the knob.
-  * To set alarm, hold 'til display flashes; turn to set (in 24h format), and push to save.
-  * When alarm goes off, push to snooze, or hold to silence until tomorrow.
+  * To turn alarm on or off, press Select.
+  * To set alarm, hold Select 'til display flashes; use Adjust to set (in 24h format), and push Select to save.
+  * When alarm goes off, push Select to snooze, or hold to silence until tomorrow.
 * **Timer**
   * Shows a countdown timer (or 0min 00sec when idle).
-  * To set timer, hold 'til display flashes; set time (in hrs, min, sec); and press to start. Hold to cancel.
-  * When timer goes off, push to silence.
+  * To set timer, hold Select 'til display flashes; set time (in hrs, min, sec); and push Select to start. Hold to cancel.
+  * When timer goes off, push Select to silence.
 
 **Additional settings are available in the Setup menu.**
 
-* To enter **Setup**, hold for 3 seconds.
-  * Shows option number on small tubes, and current setting on big tubes.
-  * Push to cycle through options (listed below); turn to set; hold to exit.
+* To enter **Setup**, hold Select for 3 seconds, until "1" appears on the small tubes, which indicates the 1st option (see below). Its current setting is shown on the big tubes.
+  * Push Select to cycle through options; use Adjust to set; hold Select to exit.
 
 | Option | Possible Settings |
 | --- | --- |
@@ -86,14 +41,13 @@ _These instructions are for a clock equipped with a single knob/button (rotary e
 | 6. Digit cycle (prevents [cathode poisoning](http://www.tube-tester.com/sites/nixie/different/cathode%20poisoning/cathode-poisoning.htm)) | 0 = before midnight and/or before day-off<br/>1 = every hour before :01 minute |
 | 7. Auto DST | Add 1h for daylight saving time between these dates (at 2am):<br/>0 = off<br/>1 = second Sunday in March to first Sunday in November (US/CA)<br/>2 = last Sunday in March to last Sunday in October (UK/EU)<br/>3 = first Sunday in April to last Sunday in October (MX)<br/>4 = last Sunday in September to first Sunday in April (NZ)<br/>5 = first Sunday in October to first Sunday in April (AU)<br/>6 = third Sunday in October to third Sunday in February (BZ) |
 | 8. Hourly strike | 0 = off<br/>1 = double beep<br/>2 = pips<br/>3 = strike the hour<br/>4 = ship's bell<br/>(Clocks without radio/timer control only. Will not sound during day-off or night-off.) |
-| 9. Alarm sound | 0 = double beeps at alarm time<br/>1 = 20-minute progressive beeps<br/>(Clocks without radio/timer control only.)
-| 10. Snooze duration | 0–60 minutes. 0 disables snooze. |
-| 11. Fine regulation | Adjusts clock's timekeeping in tenths of a second per week. 500 is "normal." (e.g.: 503 causes clock to run 0.3s faster per week.) |
-| 12. Night-off | 0 = normal (tubes fully on at night)<br/>1 = dim tubes at night<br/>2 = shut off tubes at night |
-| 13. Night starts at | Time of day |
-| 14. Night ends at | Time of day. Set to 99:99 to use the alarm time. |
-| 15. Day-off | To save tube life, shut off tubes during the day when you're not around.<br/>0 = normal (no day-off)<br/>1 = clock at work (shut off all day on weekends)<br/>2 = clock at home (shut off during work hours) |
-| 16. First day of work week | 0–6 (Sunday–Saturday) |
-| 17. Last day of work week | 0–6 (Sunday–Saturday) |
-| 18. Work starts at | Time of day |
-| 19. Work ends at | Time of day |
+| 9. Snooze duration | 0–60 minutes. 0 disables snooze. |
+| 10. Fine regulation | Adjusts clock's timekeeping in tenths of a second per week. 500 is "normal." (e.g.: 503 causes clock to run 0.3s faster per week.) |
+| 11. Night-off | 0 = normal (tubes fully on at night)<br/>1 = dim tubes at night<br/>2 = shut off tubes at night |
+| 12. Night starts at | Time of day |
+| 13. Night ends at | Time of day. Set to 0:00 to use the alarm time. |
+| 14. Day-off | To save tube life, shut off tubes during the day when you're not around.<br/>0 = normal (no day-off)<br/>1 = clock at work (shut off all day on weekends)<br/>2 = clock at home (shut off during work hours) |
+| 15. First day of work week | 0–6 (Sunday–Saturday) |
+| 16. Last day of work week | 0–6 (Sunday–Saturday) |
+| 17. Work starts at | Time of day |
+| 18. Work ends at | Time of day |