Make the tuning screen update delay configurable over Wi-Fi

Author: max-arnold

ats-mini/Common.h

@@ -129,6 +129,7 @@ extern TFT_eSprite spr;
 extern TFT_eSPI tft;
 
 extern bool tuning_flag;
+extern uint8_t tuneHoldOff;
 extern bool pushAndRotate;
 extern bool seekStop;
 extern uint8_t rssi;

ats-mini/Draw.cpp

@@ -426,6 +426,9 @@ void drawScreen(const char *statusLine1, const char *statusLine2)
 {
   if(sleepOn()) return;
 
+  // Do not update the screen while tuning (if enabled)
+  if(tuneHoldOff && tuning_flag) return;
+
   // Clear screen buffer
   spr.fillSprite(TH.bg);
 
@@ -446,14 +449,5 @@ void drawScreen(const char *statusLine1, const char *statusLine2)
       break;
   }
 
-#ifdef ENABLE_HOLDOFF
-  // Update if not tuning
-  if(!tuning_flag)
-  {
-    spr.pushSprite(0, 0);
-  }
-#else
-  // No hold off
   spr.pushSprite(0, 0);
-#endif
 }

ats-mini/Makefile

@@ -9,15 +9,10 @@ PORT	?= /dev/cu.usbmodem1101
 DEBUG_LEVEL ?= 0
 
 #
-# ENABLE_HOLDOFF  : Hold off display updates while tuning
 # HALF_STEP       : Enable encoder half-steps
 #
 DEFINES = -DDEBUG=$(DEBUG_LEVEL)
 
-ifdef ENABLE_HOLDOFF
-	DEFINES += -DENABLE_HOLDOFF
-endif
-
 ifdef HALF_STEP
         DEFINES += -DHALF_STEP
 endif

ats-mini/Network.cpp

@@ -387,8 +387,9 @@ void webSetConfig(AsyncWebServerRequest *request)
     prefsSave |= SAVE_SETTINGS;
   }
 
-  // Save scroll direction and menu zoom
+  // Save scroll direction, tuning hold off, and menu zoom
   scrollDirection = request->hasParam("scroll", true)? -1 : 1;
+  tuneHoldOff     = request->getParam("holdoff", true)->value().toInt();
   zoomMenu        = request->hasParam("zoom", true);
   prefsSave |= SAVE_SETTINGS;
 
@@ -691,6 +692,11 @@ const String webConfigPage()
     (scrollDirection<0? " CHECKED ":"") + "></TD>"
   "</TR>"
   "<TR>"
+    "<TD CLASS='LABEL'>Tuning Display Delay</TD>"
+    "<TD><INPUT TYPE='NUMBER' NAME='holdoff' VALUE='" +
+tuneHoldOff + "' MIN='0' MAX='255'></TD>"
+  "</TR>"
+   "<TR>"
     "<TD CLASS='LABEL'>Zoomed Menu</TD>"
     "<TD><INPUT TYPE='CHECKBOX' NAME='zoom' VALUE='on'" +
     (zoomMenu? " CHECKED ":"") + "></TD>"

ats-mini/Storage.cpp

@@ -185,6 +185,7 @@ void prefsSave(uint32_t items)
     prefs.putUChar("SleepMode",   sleepModeIdx);   // Sleep mode
     prefs.putUChar("ZoomMenu",    zoomMenu);       // TRUE: Zoom menu
     prefs.putBool("ScrollDir", scrollDirection<0); // TRUE: Reverse scroll
+    prefs.putBool("TuneHoldOff",  tuneHoldOff);    // Tuning hold off
     prefs.putUChar("UTCOffset",   utcOffsetIdx);   // UTC Offset
     prefs.putUChar("Squelch",     currentSquelch); // Squelch
     prefs.putUChar("FmRegion",    FmRegionIdx);    // FM region
@@ -258,6 +259,7 @@ bool prefsLoad(uint32_t items)
     sleepModeIdx   = prefs.getUChar("SleepMode", sleepModeIdx); // Sleep mode
     zoomMenu       = prefs.getUChar("ZoomMenu", zoomMenu);      // TRUE: Zoom menu
     scrollDirection = prefs.getBool("ScrollDir", scrollDirection<0)? -1:1; // TRUE: Reverse scroll
+    tuneHoldOff     = prefs.getBool("TuneHoldOff", tuneHoldOff); // Tuning hold off
     utcOffsetIdx   = prefs.getUChar("UTCOffset", utcOffsetIdx); // UTC Offset
     currentSquelch = prefs.getUChar("Squelch", currentSquelch); // Squelch
     FmRegionIdx    = prefs.getUChar("FmRegion", FmRegionIdx);   // FM region

ats-mini/ats-mini.ino

@@ -25,7 +25,6 @@
 #define NTP_CHECK_TIME       60000  // NTP time refresh period (ms)
 #define SCHEDULE_CHECK_TIME   2000  // How often to identify the same frequency (ms)
 #define BACKGROUND_REFRESH_TIME 5000    // Background screen refresh time. Covers the situation where there are no other events causing a refresh
-#define TUNE_HOLDOFF_TIME       90  // Timer to hold off display whilst tuning
 
 // =================================
 // CONSTANTS AND VARIABLES
@@ -80,6 +79,7 @@ int8_t scrollDirection = 1;             // Menu scroll direction
 uint32_t background_timer = millis();   // Background screen refresh timer.
 uint32_t tuning_timer = millis();       // Tuning hold off timer.
 bool tuning_flag = false;               // Flag to indicate tuning
+uint8_t tuneHoldOff = 90;               // Timer to hold off display whilst tuning
 
 //
 // Current parameters
@@ -336,32 +336,6 @@ void useBand(const Band *band)
   snr  = 0;
 }
 
-// This function is called by the seek function process.
-bool checkStopSeeking()
-{
-  // Returns true if the user rotates the encoder
-  if(seekStop) return true;
-
-  // Checking isPressed without debouncing because this callback
-  // is not invoked often enough to register a click
-  if(pb1.update(digitalRead(ENCODER_PUSH_BUTTON) == LOW, 0).isPressed)
-  {
-    // Wait till the button is released, otherwise the main loop will register a click
-    while(pb1.update(digitalRead(ENCODER_PUSH_BUTTON) == LOW).isPressed)
-      delay(100);
-    return true;
-  }
-
-  return false;
-}
-
-// This function is called by the seek function process.
-void showFrequencySeek(uint16_t freq)
-{
-  currentFrequency = freq;
-  drawScreen();
-}
-
 //
 // Tune using BFO, using algorithm from Goshante's ATS-20_EX firmware
 //
@@ -452,6 +426,45 @@ bool updateFrequency(int newFreq, bool wrap)
   return true;
 }
 
+// This function is called by the seek function process.
+bool checkStopSeeking()
+{
+  // Returns true if the user rotates the encoder
+  if(seekStop) return true;
+
+  // Checking isPressed without debouncing because this callback
+  // is not invoked often enough to register a click
+  if(pb1.update(digitalRead(ENCODER_PUSH_BUTTON) == LOW, 0).isPressed)
+  {
+    // Wait till the button is released, otherwise the main loop will register a click
+    while(pb1.update(digitalRead(ENCODER_PUSH_BUTTON) == LOW).isPressed)
+      delay(100);
+    return true;
+  }
+
+  return false;
+}
+
+// This function is called by the seek function process.
+void showFrequencySeek(uint16_t freq)
+{
+  // Check if tuning flag is set
+  if(tuneHoldOff)
+  {
+    if(tuning_flag)
+    {
+      if((millis() - tuning_timer) > tuneHoldOff)
+        tuning_flag = false;
+    }
+    else
+    {
+      tuning_timer = millis();
+      tuning_flag = true;
+    }
+  }
+  currentFrequency = freq;
+  drawScreen();
+}
 
 //
 // Handle encoder rotation in seek mode
@@ -464,11 +477,12 @@ bool doSeek(int8_t dir)
   {
     if(isSSB())
     {
-#ifdef ENABLE_HOLDOFF
-      // Tuning timer to hold off (FM/AM) display updates
-      tuning_flag = true;
-      tuning_timer = millis();
-#endif
+      if(tuneHoldOff)
+      {
+        // Tuning timer to hold off (FM/AM) display updates
+        tuning_flag = true;
+        tuning_timer = millis();
+      }
 
       updateBFO(currentBFO + dir * getCurrentStep(true)->step, true);
     }
@@ -481,6 +495,7 @@ bool doSeek(int8_t dir)
       // Flag is set by rotary encoder and cleared on seek/scan entry
       seekStop = false;
       rx.seekStationProgress(showFrequencySeek, checkStopSeeking, dir>0? 1 : 0);
+      if(tuneHoldOff) tuning_flag = false;
       updateFrequency(rx.getFrequency(), true);
     }
   }
@@ -518,11 +533,12 @@ bool doTune(int8_t dir, bool fast = false)
   //
   if(isSSB())
   {
-#ifdef ENABLE_HOLDOFF
-    // Tuning timer to hold off (SSB) display updates
-    tuning_flag = true;
-    tuning_timer = millis();
-#endif
+    if(tuneHoldOff)
+    {
+      // Tuning timer to hold off (SSB) display updates
+      tuning_flag = true;
+      tuning_timer = millis();
+    }
 
     uint32_t step = getCurrentStep(fast)->step;
     uint32_t stepAdjust = (currentFrequency * 1000 + currentBFO) % step;
@@ -536,11 +552,12 @@ bool doTune(int8_t dir, bool fast = false)
   //
   else
   {
-#ifdef ENABLE_HOLDOFF
-    // Tuning timer to hold off (FM/AM) display updates
-    tuning_flag = true;
-    tuning_timer = millis();
-#endif
+    if(tuneHoldOff)
+    {
+      // Tuning timer to hold off (FM/AM) display updates
+      tuning_flag = true;
+      tuning_timer = millis();
+    }
 
     uint16_t step = getCurrentStep(fast)->step;
     uint16_t stepAdjust = currentFrequency % step;
@@ -569,11 +586,12 @@ bool doDigit(int8_t dir)
   // SSB tuning
   if(isSSB())
   {
-#ifdef ENABLE_HOLDOFF
-    // Tuning timer to hold off (SSB) display updates
-    tuning_flag = true;
-    tuning_timer = millis();
-#endif
+    if(tuneHoldOff)
+    {
+      // Tuning timer to hold off (SSB) display updates
+      tuning_flag = true;
+      tuning_timer = millis();
+    }
 
     updated = updateBFO(currentBFO + dir * getFreqInputStep(), false);
   }
@@ -583,11 +601,12 @@ bool doDigit(int8_t dir)
   //
   else
   {
-#ifdef ENABLE_HOLDOFF
-    // Tuning timer to hold off (FM/AM) display updates
-    tuning_flag = true;
-    tuning_timer = millis();
-#endif
+    if(tuneHoldOff)
+    {
+      // Tuning timer to hold off (FM/AM) display updates
+      tuning_flag = true;
+      tuning_timer = millis();
+    }
 
     // Tune to a new frequency
     updated = updateFrequency(currentFrequency + getFreqInputStep() * dir, false);
@@ -913,14 +932,12 @@ void loop()
   // Tick NETWORK time, connecting to WiFi if requested
   netTickTime();
 
-#ifdef ENABLE_HOLDOFF
   // Check if tuning flag is set
-  if(tuning_flag && ((currentTime - tuning_timer) > TUNE_HOLDOFF_TIME))
+  if(tuneHoldOff && tuning_flag && ((currentTime - tuning_timer) > tuneHoldOff))
   {
     tuning_flag = false;
     needRedraw = true;
   }
-#endif
 
   // Run clock
   needRedraw |= clockTickTime();

changelog/+holdoff.changed.md

@@ -0,0 +1 @@
+Screen update delay while tuning is now configurable via Wi-Fi settings page (previously it was a compile-time option).

docs/source/development.md

@@ -23,13 +23,12 @@ arduino-cli compile --clean -e -p COM_PORT -u ats-mini
 
 The available options are:
 
-* `ENABLE_HOLDOFF` - enable delayed screen update while tuning
 * `HALF_STEP` - enable encoder half-steps (useful for EC11E encoder)
 
 To set an option, add the `--build-property` command line argument like this:
 
 ```shell
-arduino-cli compile --build-property "compiler.cpp.extra_flags=-DENABLE_HOLDOFF" --clean -e -p COM_PORT -u ats-mini
+arduino-cli compile --build-property "compiler.cpp.extra_flags=-DHALF_STEP" --clean -e -p COM_PORT -u ats-mini
 ```
 
 ## Enabling the pre-commit hooks
@@ -43,7 +42,7 @@ arduino-cli compile --build-property "compiler.cpp.extra_flags=-DENABLE_HOLDOFF"
 You can do all of the above using the `make` command as well:
 
 ```shell
-ENABLE_HOLDOFF=1 PORT=/dev/tty.usbmodem14401 make upload
+HALF_STEP=1 PORT=/dev/tty.usbmodem14401 make upload
 ```
 
 ## Decoding stack traces

docs/source/manual.md

@@ -113,6 +113,10 @@ From now on you can switch the modes as you want and connect to your receiver ei
 When on the go, you can set up a mobile Wi-Fi hotspot on your smartphone and use it to connect the receiver to the internet.
 ```
 
+### Receiver settings available via Wi-Fi only
+
+* **Tuning Display Delay** - time in milliseconds to delay screen updates while tuning/seeking, 0 (disabled) ... 255. Makes the tuning process a bit faster because the screen is updated less often.
+
 ## Schedule
 
 The receiver can download the [EiBi](http://eibispace.de/dx/eibi.txt) shortwave schedule and use it to display broadcasting stations, allowing you to quickly tune to them. Here’s how it works: