Bugfix/enhancements to half-minute date triggering and scrolling

Author: clockspot

arduino-nixie/arduino-nixie.ino

@@ -198,28 +198,9 @@ void setup(){
   initOutputs(); //depends on some EEPROM settings
 }
 
-unsigned long pollCleanLast = 0; //every cleanSpeed ms
-unsigned long pollScrollLast = 0; //every scrollSpeed ms
 void loop(){
-  unsigned long now = millis();
-  //If we're running a tube cleaning, advance it every cleanSpeed ms.
-  if(cleanRemain && (unsigned long)(now-pollCleanLast)>=cleanSpeed) { //account for rollover
-    pollCleanLast=now;
-    cleanRemain--;
-    if(cleanRemain<1) calcSun(tod.year(),tod.month(),tod.day()); //take this opportunity to perform a calculation that blanks the display for a bit
-    updateDisplay();
-  }
-  //If we're scrolling an animation, advance it every scrollSpeed ms.
-  else if(scrollRemain!=0 && scrollRemain!=-128 && (unsigned long)(now-pollScrollLast)>=scrollSpeed) {
-    pollScrollLast=now;
-    if(scrollRemain<0) {
-      scrollRemain++; updateDisplay();
-    } else {
-      scrollRemain--; updateDisplay();
-      if(scrollRemain==0) scrollRemain=-128;
-    }
-  }
   //Every loop cycle, check the RTC and inputs (previously polled, but works fine without and less flicker)
+  checkEffects(false); //cleaning and scrolling display effects - not handled by checkRTC since they have their own timing
   checkRTC(false); //if clock has ticked, decrement timer if running, and updateDisplay
   millisApplyDrift();
   checkInputs(); //if inputs have changed, this will do things + updateDisplay as needed
@@ -334,6 +315,25 @@ void ctrlEvt(byte ctrl, byte evt){
     updateDisplay();
     return;
   }
+  //If a scroll is waiting to scroll out, cancel it, and let the button event do what it will
+  if(scrollRemain==-128 && evt==1){
+    scrollRemain = 0;
+  }
+  //If a scroll is going, fast-forward to end of scroll in/out - see also checkRTC
+  else if(scrollRemain!=0 && evt==1){
+    btnStop();
+    if(scrollRemain>0) scrollRemain = 1;
+    else scrollRemain = -1;
+    checkEffects(true);
+    return;
+  }
+  //If the version display is going, any press should cancel it, with a display update
+  if(versionRemain>0 && evt==1){
+    versionRemain = 0;
+    btnStop();
+    updateDisplay();
+    return;
+  }
 
   //Is it a press for an un-off?
   unoffRemain = unoffDur; //always do this so continued button presses during an unoff keep it alive
@@ -845,13 +845,18 @@ void checkRTC(bool force){
   }
   //Paged-display function timeout //TODO change fnIsDate to consts? //TODO timeoutPageFn var
   else if(fn==fnIsDate && (unsigned long)(now-inputLast)>=3000) { //3sec per date page
+    //If a scroll in is going, fast-forward to end - see also ctrlEvt
+    if(scrollRemain>0) {
+      scrollRemain = 1;
+      checkEffects(true);
+    }
     //Here we just have to increment the page and decide when to reset. updateDisplay() will do the rendering
     fnPg++; inputLast+=3000; //but leave inputLastTODMins alone so the subsequent page displays will be based on the same TOD
     while(fnPg<fnDatePages && fnPg<200 && ( //skip inapplicable date pages. The 200 is an extra failsafe
         (!readEEPROM(10,true) && !readEEPROM(12,true) && //if no lat+long specified, skip weather/rise/set
           (fnPg==fnDateWeathernow || fnPg==fnDateWeathernext || fnPg==fnDateSunlast || fnPg==fnDateSunnext))
       )) fnPg++;
-    if(fnPg >= fnDatePages){ fnPg = 0; fn = fnIsTime; }
+    if(fnPg >= fnDatePages){ fnPg = 0; fn = fnIsTime; } // when we run out of pages, go back to time. When the half-minute date is triggered, fnPg is set to 254, so it will be 255 here and be cancelled after just the one page.
     force=true;
   }
   //Temporary-display function timeout: if we're *not* in a permanent one (time, or running/signaling timer)
@@ -922,7 +927,7 @@ void checkRTC(bool force){
       } //end alarm trigger
     }
     //At bottom of minute, see if we should show the date
-    if(tod.second()==30 && fn==fnIsTime && fnSetPg==0 && unoffRemain==0) {
+    if(tod.second()==30 && fn==fnIsTime && fnSetPg==0 && unoffRemain==0 && cleanRemain==0 && scrollRemain==0 && versionRemain==0) {
       if(readEEPROM(18,false)>=2) { fn = fnIsDate; inputLast = now; inputLastTODMins = tod.hour()*60+tod.minute(); fnPg = 254; updateDisplay(); }
       if(readEEPROM(18,false)==3) { startScroll(); }
     }
@@ -1292,6 +1297,30 @@ byte displayNext[6] = {15,15,15,15,15,15}; //Internal representation of display.
 byte displayLast[6] = {11,11,11,11,11,11}; //for noticing changes to displayNext and fading the display to it
 byte scrollDisplay[6] = {15,15,15,15,15,15}; //For animating a value into displayNext from right, and out to left
 
+unsigned long pollCleanLast = 0; //every cleanSpeed ms
+unsigned long pollScrollLast = 0; //every scrollSpeed ms
+void checkEffects(bool force){
+  //control the cleaning/scrolling effects - similar to checkRTC but it has its own timings
+  unsigned long now = millis();
+  //If we're running a tube cleaning, advance it every cleanSpeed ms.
+  if(cleanRemain && (unsigned long)(now-pollCleanLast)>=cleanSpeed) { //account for rollover
+    pollCleanLast=now;
+    cleanRemain--;
+    if(cleanRemain<1) calcSun(tod.year(),tod.month(),tod.day()); //take this opportunity to perform a calculation that blanks the display for a bit
+    updateDisplay();
+  }
+  //If we're scrolling an animation, advance it every scrollSpeed ms.
+  else if(scrollRemain!=0 && scrollRemain!=-128 && ((unsigned long)(now-pollScrollLast)>=scrollSpeed || force)) {
+    pollScrollLast=now;
+    if(scrollRemain<0) {
+      scrollRemain++; updateDisplay();
+    } else {
+      scrollRemain--; updateDisplay();
+      if(scrollRemain==0) scrollRemain = -128;
+    }
+  }
+}
+
 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

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

@@ -67,7 +67,7 @@ const word velThreshold = 0; //ms
 
 // 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
+const word scrollSpeed = 100; //ms - e.g. scroll-in-and-out date at :30
 
 // What are the timeouts for setting and temporarily-displayed functions? up to 65535 sec
 const unsigned long timeoutSet = 300; //sec

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

@@ -67,7 +67,7 @@ const word velThreshold = 0; //ms
 
 // 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
+const word scrollSpeed = 100; //ms - e.g. scroll-in-and-out date at :30
 
 // What are the timeouts for setting and temporarily-displayed functions? up to 65535 sec
 const unsigned long timeoutSet = 300; //sec

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

@@ -73,7 +73,7 @@ const word velThreshold = 0; //ms
 
 // 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
+const word scrollSpeed = 100; //ms - e.g. scroll-in-and-out date at :30
 
 // What are the timeouts for setting and temporarily-displayed functions? up to 65535 sec
 const unsigned long timeoutSet = 300; //sec

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

@@ -73,7 +73,7 @@ const word velThreshold = 0; //ms
 
 // 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
+const word scrollSpeed = 100; //ms - e.g. scroll-in-and-out date at :30
 
 // What are the timeouts for setting and temporarily-displayed functions? up to 65535 sec
 const unsigned long timeoutSet = 300; //sec

arduino-nixie/configs/v9-6tube-relay.h

@@ -74,7 +74,7 @@ const word velThreshold = 0; //ms
 
 // 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
+const word scrollSpeed = 100; //ms - e.g. scroll-in-and-out date at :30
 
 // What are the timeouts for setting and temporarily-displayed functions? up to 65535 sec
 const unsigned long timeoutSet = 300; //sec

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

@@ -74,7 +74,7 @@ const word velThreshold = 0; //ms
 
 // 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
+const word scrollSpeed = 100; //ms - e.g. scroll-in-and-out date at :30
 
 // What are the timeouts for setting and temporarily-displayed functions? up to 65535 sec
 const unsigned long timeoutSet = 300; //sec