Finish alarm; night-off and day-off; un-off (briefly light dark tubes); timer interval mode. (All untested)

Author: clockspot

README.md

@@ -14,13 +14,13 @@ _In these instructions, **Select** is the main pushbutton, and **Adjust** can be
 
 | Function | Looks like | Notes |
 | --- | --- | --- |
-| **Time** | `12 34 56` | The time of day. You can choose 12h or 24h format in Options. When setting, it's in 24h format (so you can tell AM from PM) and the seconds will reset to :00 when you save. The clock keeps time during power outages, and its timekeeping is corrected for temperature changes. |
+| **Time** | `12 34 56` | The time of day. You can choose 12h or 24h format in Options. When setting, it's in 24h format (so you can tell AM from PM) and the seconds will reset to :00 when you save. The clock keeps time during power outages and compensates for temperature effects. |
 | **Date** | `_2 _4 _0`<br/>(for&nbsp;Sun&nbsp;2/4) | You can choose month/date or date/month format in the options menu (2). Setting is done in three stages: first year, then month, then date.<br/>Weekdays are: 0=Sun, 1=Mon, 2=Tue, 3=Wed, 4=Thu, 5=Fri, 6=Sat |
-| **Timer** | `__ __ _0` | A countdown timer, in hours, minutes, and seconds; or `0` when stopped. Can be set to the minute, up to 18 hours. Begins running as soon as you set it, and will continue to run in the background if you change to a different function. To cancel while running, hold **Select**. When timer runs out, press **Select** to silence the beeper. If power is lost, the timer will reset to `0`. |
-| **Day counter** | `_1 23 __` | Shows the number of days until/since a date you specify. The target date is set the same way as **Date.** |
+| **Alarm** | `_7 00 1_` | Shows alarm time (always in 24hr format) and on/off status on 5th tube (1=on, 0=off) and by display brightness (bright=on, dim=off). Use **Adjust** to switch on/off. Hold **Select** to set time (same way as **Time**). When alarm sounds, press **Select** to snooze, or hold for 1sec (followed by a short beep) to silence the alarm for the day. Options menu lets you restrict the alarm to your workweek or weekend only. In a power outage, the alarm will remain set, but it will not sound if power is disconnected at alarm time. |
+| **Timer** | `__ __ _0` | A countdown timer, in hours, minutes, and seconds; or `0` when stopped. Can be set to the minute, up to 18 hours. Begins running as soon as you set it, and will continue to run in the background if you change to a different function. To cancel while running, hold **Select**. When timer runs out, press **Select** to silence. If power is lost, the timer will reset to `0`. |
+| **Day counter** | `_1 23 __` | Shows the number of days until/since a date you specify. Set the same way as **Date.** |
 | **Thermometer** | `__ 38 25` | Shows the temperature of the onboard DS3231 chip (e.g. 38.25°C – I think). May not be very useful as it tends to read higher than ambient temperature and its tolerance is low. |
 | **Cleaner** | `88 88 88` | Cycles all the digits on all the tubes. A quick and dirty anti-cathode-poisoning mode, until automatic digit cycling is implemented. |
-| **Alarm** | `_7 00 1_` | _Not yet implemented._<br/>Shows alarm time and status. Use **Adjust** to switch on/off; status is shown on 5th tube (1=on, 0=off) and by display brightness (bright=on, dim=off). Hold **Select** to set the time the same way as **Time**. When alarm sounds, press **Select** to snooze, or hold for 1sec (followed by a short beep) to silence the alarm for the day. Options menu lets you restrict the alarm to your workweek or weekend only. In a power outage, the alarm will remain set, but it will not sound if power is disconnected at alarm time. |
 
 ### Options Menu
 
@@ -31,30 +31,30 @@ _In these instructions, **Select** is the main pushbutton, and **Adjust** can be
 
 | Option | Settings |
 | --- | --- |
-| **Timekeeping and display** | |
+| | **Timekeeping and display** |
 | 1. Time format | 1 = 12-hour<br/>2 = 24-hour<br/>(time-of-day display only; setting times is always done in 24h) |
 | 2. Date format | 1 = month/date<br/>2 = date/month |
 | 3. Display date during time? | 0 = never<br/>1 = date instead of seconds<br/>2 = full date (as above) every minute at :30 seconds |
 | 4. Leading zero in hour, date, and month? | 0 = no<br/>1 = yes |
 | 5. Digit fade | _Not yet implemented._<br/>0–50 (in hundredths of a second) |
 | 6. 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) |
-| **Alarms and sounds** | |
-| 7. Alarm days | 0 = every day<br/>1 = workweek only (per workdays setting below)<br/>2 = weekend only |
+| | **Alarms and sounds** |
+| 7. Alarm days | 0 = every day<br/>1 = work week only (per settings below)<br/>2 = weekend only |
 | 8. Alarm snooze | 0–60 minutes. 0 disables snooze. |
 | 9. Alarm tone pitch | _Not yet implemented._<br/>[Note number on a piano keyboard](https://en.wikipedia.org/wiki/Piano_key_frequencies), from 49 (A4) to 88 (C8). Some are louder than others. |
-| 10. Timer interval mode | _Not yet implemented._<br/>What happens when the timer reaches 0.<br/>0 = stop and sound continuously<br/>1 = restart and sound a single tone (interval timer) |
+| 10. Timer interval mode | What happens when the timer reaches 0.<br/>0 = stop and sound continuously<br/>1 = restart and sound a single tone (interval timer) |
 | 11. Timer tone pitch | _Not yet implemented._<br/>Set the same way as the alarm tone pitch, above. |
 | 12. Hourly strike | _Not yet implemented._<br/>0 = off<br/>1 = double tone<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.) |
 | 13. Hourly strike pitch | _Not yet implemented._<br/>Set the same way as the alarm tone pitch, above. |
-| **Night-off and day-off** | |
-| 14. Night-off | _Not yet implemented._<br/>To save tube life and/or preserve your sleep, dim or shut off tubes nightly when you're not around or sleeping.<br/>0 = none (tubes fully on at night)<br/>1 = dim tubes at night<br/>2 = shut off tubes at night<br/>When off, you can press **Select** to light the tubes briefly. |
-| 15. Night starts at | _Not yet implemented._<br/>Time of day. |
-| 16. Night ends at | _Not yet implemented._<br/>Time of day. Set to 0:00 to use the alarm time. At this time (whether night-off/alarm is enabled or not), all tubes will briefly cycle through all digits at full brightness to help prevent [cathode poisoning](http://www.tube-tester.com/sites/nixie/different/cathode%20poisoning/cathode-poisoning.htm). |
-| 17. Day-off | _Not yet implemented._<br/>To further save tube life, shut off tubes during the day when you're not around.<br/>0 = none (tubes fully on during the day)<br/>1 = clock at work (shut off all day on weekends)<br/>2 = clock at home (shut off during work hours)<br/>When off, you can press **Select** to light the tubes briefly. |
+| | **Night-off and day-off** |
+| 14. Night-off | To save tube life and/or preserve your sleep, dim or shut off tubes nightly when you're not around or sleeping.<br/>0 = none (tubes fully on at night)<br/>1 = dim tubes at night<br/>2 = shut off tubes at night<br/>When off, you can press **Select** to illuminate the tubes briefly. |
+| 15. Night starts at | Time of day. |
+| 16. Night ends at | Time of day. Set to 0:00 to use the alarm time. At this time (whether night-off/alarm is enabled or not), all tubes will briefly cycle through all digits at full brightness to help prevent [cathode poisoning](http://www.tube-tester.com/sites/nixie/different/cathode%20poisoning/cathode-poisoning.htm) _(not yet implemented)_. |
+| 17. Day-off | To further save tube life, shut off tubes during the day when you're not around.<br/>0 = none (tubes fully on during the day)<br/>1 = clock at work (shut off all day on weekends)<br/>2 = clock at home (shut off during work hours)<br/>When off, you can press **Select** to illuminuate the tubes briefly. |
 | 18. First day of work week | 0–6 (Sunday–Saturday) |
 | 19. Last day of work week | 0–6 (Sunday–Saturday) |
-| 20. Work starts at | _Not yet implemented._<br/>Time of day. |
-| 21. Work ends at | _Not yet implemented._<br/>Time of day. |
+| 20. Work starts at | Time of day. |
+| 21. Work ends at | Time of day. |
 
 ### Factory Reset
 

sixtube_lm/sixtube_lm.ino

@@ -80,6 +80,8 @@ const byte alarmRadio = 0;
 //     When timer is running, output will stay on until timer runs down.
 const byte alarmDur = 1;
 
+const byte unoffDur = 10; //when display is dim/off, a press will light the tubes for this many seconds
+
 const byte displaySize = 6; //number of tubes
 
 // How long (in ms) are the button hold durations?
@@ -163,7 +165,9 @@ word soundRemain = 0; //alarm/timer sound timeout counter, seconds
 word snoozeRemain = 0; //snooze timeout counter, seconds
 word timerInitial = 0; //timer original setting, seconds - up to 18 hours (64,800 seconds - fits just inside a word)
 word timerRemain = 0; //timer actual counter
+word unoffRemain = 0; //un-off (briefly turn on tubes during full night-off or day-off) timeout counter, seconds
 byte displayNext[6] = {15,15,15,15,15,15}; //Internal representation of display. Blank to start. Change this to change tubes.
+byte displayDim = 2; //dim per display or function: 2=normal, 1=dim, 0=off
 
 
 ////////// Main code control //////////
@@ -308,6 +312,14 @@ void ctrlEvt(byte ctrl, byte evt){
     return;
   }
 
+  //Is it a press for an un-off?
+  if(displayDim==0 && evt==1) {
+    unoffRemain = unoffDur;
+    updateDisplay();
+    btnStop();
+    return;
+  }
+  
   if(fn < fnOpts) { //normal fn running/setting (not in options menu)
 
     if(evt==3 && ctrl==mainSel) { //mainSel long hold: enter options menu
@@ -643,7 +655,14 @@ void checkRTC(bool force){
       //If timer has time on it, decrement and trigger beeper if we reach zero
       if(timerRemain>0) {
         timerRemain--;
-        if(timerRemain<=0) { fnSetPg = 0; fn = fnIsTimer; inputLast = pollLast; soundRemain = alarmDur*60; } //TODO radio mode
+        if(timerRemain<=0) { //timer has elasped
+          if(readEEPROM(25,false)) { //interval timer: sound for 1sec and restart; don't change to timer fn
+            soundRemain = 1; timerRemain = timerInitial;
+          } else {
+            fnSetPg = 0; fn = fnIsTimer; inputLast = pollLast; soundRemain = alarmDur*60;
+          }
+          //TODO radio mode
+        } //end timer elapsed
       }
       //If beeper has time on it, decrement and sound the beeper for 1/2 second
       if(soundRemain>0) {
@@ -658,6 +677,9 @@ void checkRTC(bool force){
         snoozeRemain--;
         if(snoozeRemain<=0 && readEEPROM(2,false)) { fnSetPg = 0; fn = fnIsTime; soundRemain = alarmDur*60; }
       }
+      if(unoffRemain>0) {
+        unoffRemain--; //updateDisplay will naturally put it back to off state if applicable
+      }
     } //end natural second
 
     //Finally, whether natural tick or not, if we're not setting anything, update the display
@@ -729,6 +751,7 @@ void updateDisplay(){
   //Run as needed to update display when the value being shown on it has changed
   //This formats the new value and puts it in displayNext[] for cycleDisplay() to pick up
   if(fnSetPg) { //setting value, for either fn or option
+    displayDim = 2;
     blankDisplay(4, 5);
     if(fnSetValMax==1439) { //Time of day (0-1439 mins, 0:00–23:59): show hrs/mins
       editDisplay(fnSetVal/60, 0, 1, readEEPROM(19,false)); //hours with leading zero
@@ -740,12 +763,24 @@ void updateDisplay(){
     } else editDisplay(fnSetVal, 0, 3, false); //some other type of value
   }
   else if(fn >= fnOpts){ //options menu, but not setting a value
+    displayDim = 2;
     editDisplay(fn-fnOpts+1,0,1,0); //display option number (1-index) on hour tubes
     blankDisplay(2,5);
   } else { //fn running
+    //Set displayDim per night-off and day-off settings - fnIsAlarm may override this
+    word todmins = tod.hour()*60+tod.minute();
+    if(unoffDur > 0) {
+      displayDim = 2;
+    } else if(readEEPROM(27,false) && (todmins>=readEEPROM(28,true) || todmins<(readEEPROM(30,true)==0?readEEPROM(0,true):readEEPROM(30,true)))) { //night-off
+      displayDim = (readEEPROM(27,false)==1?1:0); //dim or off
+    } else if(readEEPROM(32,false)==1 && toddow<readEEPROM(33,false) && toddow>readEEPROM(34,false)) { //day-off all day on weekends
+      displayDim = 0;
+    } else if(readEEPROM(32,false)==2 && toddow>=readEEPROM(33,false) && toddow<=readEEPROM(34,false) && todmins>=readEEPROM(35,true) && todmins<readEEPROM(37,true)) { //day-off during office hours
+      displayDim = 0;
+    } else displayDim = 2;
     switch(fn){
       case fnIsTime:
-      byte hr; hr = tod.hour();
+        byte hr; hr = tod.hour();
         if(readEEPROM(16,false)==1) hr = (hr==0?12:(hr>12?hr-12:hr));
         editDisplay(hr, 0, 1, readEEPROM(19,false));
         editDisplay(tod.minute(), 2, 3, true);
@@ -770,10 +805,12 @@ void updateDisplay(){
         blankDisplay(4,5);
         break;
       case fnIsAlarm: //alarm
-        //TODO this isn't a real display
-        editDisplay(0,0,1,readEEPROM(19,false)); //hrs
-        editDisplay(0,2,3,true); //mins
-        editDisplay(0,4,5,false); //status
+        word almTime; almTime = readEEPROM(0,true);
+        editDisplay(almTime/60, 0, 1, readEEPROM(19,false)); //hours with leading zero
+        editDisplay(almTime%60, 2, 3, true);
+        editDisplay(readEEPROM(2,false),4,4,false); //status 1/0
+        displayDim = (readEEPROM(2,false)?2:1); //status bright/dim
+        blankDisplay(5,5);
         break;
       case fnIsTimer: //timer - display time left.
         //Relative unit positioning: when t <1h, display min/sec in place of hr/min on 4-tube displays
@@ -850,43 +887,47 @@ void initOutputs() {
 }
 
 void cycleDisplay(){
-  bool dim = 0;//(opts[2]>0?true:false); //Under normal circumstances, dim constantly if the time is right
-  if(fnSetPg>0) { //but if we're setting, dim for every other 500ms since we started setting
+  //Other display code decides whether we should dim per function or time of day
+  bool dim = (displayDim==1?1:0);
+  //But if we're setting, decide here to dim for every other 500ms since we started setting
+  if(fnSetPg>0) {
     if(setStartLast==0) setStartLast = millis();
     dim = 1-(((millis()-setStartLast)/500)%2);
   } else {
     if(setStartLast>0) setStartLast=0;
   }
 
-  //Anode channel 0: tubes #2 (min x10) and #5 (sec x1)
-  setCathodes(displayLast[2],displayLast[5]); //Via d2b decoder chip, set cathodes to old digits
-  digitalWrite(anodes[0], HIGH); //Turn on tubes
-  delay(displayLastFade[0]/(dim?4:1)); //Display for fade-out cycles
-  setCathodes(displayNext[2],displayNext[5]); //Switch cathodes to new digits
-  delay(displayNextFade[0]/(dim?4:1)); //Display for fade-in cycles
-  digitalWrite(anodes[0], LOW); //Turn off tubes
+  if(displayDim !== 0) { //if other display code says to shut off entirely, skip this part
+    //Anode channel 0: tubes #2 (min x10) and #5 (sec x1)
+    setCathodes(displayLast[2],displayLast[5]); //Via d2b decoder chip, set cathodes to old digits
+    digitalWrite(anodes[0], HIGH); //Turn on tubes
+    delay(displayLastFade[0]/(dim?4:1)); //Display for fade-out cycles
+    setCathodes(displayNext[2],displayNext[5]); //Switch cathodes to new digits
+    delay(displayNextFade[0]/(dim?4:1)); //Display for fade-in cycles
+    digitalWrite(anodes[0], LOW); //Turn off tubes
 
-  if(dim) delay(fadeMax/1.5);
+    if(dim) delay(fadeMax/1.5);
 
-  //Anode channel 1: tubes #4 (sec x10) and #1 (hour x1)
-  setCathodes(displayLast[4],displayLast[1]);
-  digitalWrite(anodes[1], HIGH);
-  delay(displayLastFade[1]/(dim?4:1));
-  setCathodes(displayNext[4],displayNext[1]);
-  delay(displayNextFade[1]/(dim?4:1));
-  digitalWrite(anodes[1], LOW);
+    //Anode channel 1: tubes #4 (sec x10) and #1 (hour x1)
+    setCathodes(displayLast[4],displayLast[1]);
+    digitalWrite(anodes[1], HIGH);
+    delay(displayLastFade[1]/(dim?4:1));
+    setCathodes(displayNext[4],displayNext[1]);
+    delay(displayNextFade[1]/(dim?4:1));
+    digitalWrite(anodes[1], LOW);
 
-  if(dim) delay(fadeMax/1.5);
+    if(dim) delay(fadeMax/1.5);
 
-  //Anode channel 2: tubes #0 (hour x10) and #3 (min x1)
-  setCathodes(displayLast[0],displayLast[3]);
-  digitalWrite(anodes[2], HIGH);
-  delay(displayLastFade[2]/(dim?4:1));
-  setCathodes(displayNext[0],displayNext[3]);
-  delay(displayNextFade[2]/(dim?4:1));
-  digitalWrite(anodes[2], LOW);
+    //Anode channel 2: tubes #0 (hour x10) and #3 (min x1)
+    setCathodes(displayLast[0],displayLast[3]);
+    digitalWrite(anodes[2], HIGH);
+    delay(displayLastFade[2]/(dim?4:1));
+    setCathodes(displayNext[0],displayNext[3]);
+    delay(displayNextFade[2]/(dim?4:1));
+    digitalWrite(anodes[2], LOW);
 
-  if(dim) delay(fadeMax*0.75);
+    if(dim) delay(fadeMax*0.75);
+  } //end if displayDim !== 0
 
   // Loop thru and update all the arrays, and fades.
   for( byte i = 0 ; i < 6 ; i ++ ) {