From d8b76b1c82e229072659c15269b29b25850a4772 Mon Sep 17 00:00:00 2001
From: Adam Matthews <adam@wonkatron.com>
Date: Mon, 6 May 2024 14:36:37 +0100
Subject: [PATCH] Update Usermod: Battery

Issue:
When taking the initial voltage reading while first powering on, voltage hasn't had chance to stabilize so the reading can be inaccurate, which in turn may incorrectly trigger the low-power preset. (Manifests when the user has selected a low read interval and/or is using a capacitor).

Resolution:
A non-blocking, fixed 10 second delay has been added to the initial voltage reading to give the voltage time to stabilize.
---
 usermods/Battery/usermod_v2_Battery.h | 30 ++++++++++++++++++++++++---
 1 file changed, 27 insertions(+), 3 deletions(-)

diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index be3d8748bf..d0f78c84da 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -19,6 +19,12 @@ class UsermodBattery : public Usermod
     unsigned long readingInterval = USERMOD_BATTERY_MEASUREMENT_INTERVAL;
     unsigned long nextReadTime = 0;
     unsigned long lastReadTime = 0;
+    // Initial delay before first reading (in milliseconds)
+    unsigned long initialDelay = 10000;
+    // Flag to check if the initial delay is completed
+    bool initialDelayComplete = false;
+    // Flag to check if the initial reading is complete
+    bool isFirstReading = true;
     // battery min. voltage
     float minBatteryVoltage = USERMOD_BATTERY_MIN_VOLTAGE;
     // battery max. voltage
@@ -141,7 +147,6 @@ class UsermodBattery : public Usermod
           if (pinManager.allocatePin(batteryPin, false, PinOwner::UM_Battery)) {
             DEBUG_PRINTLN(F("Battery pin allocation succeeded."));
             success = true;
-            voltage = readVoltage();
           }
 
         if (!success) {
@@ -152,10 +157,10 @@ class UsermodBattery : public Usermod
         }
       #else //ESP8266 boards have only one analog input pin A0
         pinMode(batteryPin, INPUT);
-        voltage = readVoltage();
       #endif
 
-      nextReadTime = millis() + readingInterval;
+      // Delay the first voltage reading to allow voltage stabilization after powering up
+      nextReadTime = millis() + initialDelay;
       lastReadTime = millis();
 
       initDone = true;
@@ -182,6 +187,25 @@ class UsermodBattery : public Usermod
 
       lowPowerIndicator();
 
+      // Handling the initial delay
+      if (!initialDelayComplete && millis() < nextReadTime)
+        return; // Continue to return until the initial delay is over
+
+      // Once the initial delay is over, set it as complete
+      if (!initialDelayComplete)
+        {
+          initialDelayComplete = true;
+          // Set the regular interval after initial delay
+          nextReadTime = millis() + readingInterval;
+        }
+
+      // Make the first voltage reading once the initial delay has elapsed
+      if (isFirstReading)
+        {
+          voltage = readVoltage();
+          isFirstReading = false;
+        }
+
       // check the battery level every USERMOD_BATTERY_MEASUREMENT_INTERVAL (ms)
       if (millis() < nextReadTime) return;