From 8dd17451495fa96cc87fe6f9a145d7c041b35e86 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Thu, 5 Jan 2023 19:48:53 +0100
Subject: [PATCH 01/18] =?UTF-8?q?Add=20base=20battery=20=F0=9F=94=8B=20cla?=
 =?UTF-8?q?ss,=20Add=20Lipo,=20Lion=20class?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 usermods/Battery/battery.h            | 149 +++++++++++++++++
 usermods/Battery/battery_defaults.h   |  11 +-
 usermods/Battery/lion.h               |  37 +++++
 usermods/Battery/lipo.h               |  51 ++++++
 usermods/Battery/usermod_v2_Battery.h | 221 +++++---------------------
 5 files changed, 290 insertions(+), 179 deletions(-)
 create mode 100644 usermods/Battery/battery.h
 create mode 100644 usermods/Battery/lion.h
 create mode 100644 usermods/Battery/lipo.h

diff --git a/usermods/Battery/battery.h b/usermods/Battery/battery.h
new file mode 100644
index 000000000..f3daf05c4
--- /dev/null
+++ b/usermods/Battery/battery.h
@@ -0,0 +1,149 @@
+#ifndef UMBBattery_h
+#define UMBBattery_h
+
+#include "battery_defaults.h"
+
+/**
+ *  Battery base class
+ *  all other battery classes should inherit from this
+ */
+class Battery
+{
+    private:
+
+    protected:
+        float minVoltage = USERMOD_BATTERY_MIN_VOLTAGE;
+        float maxVoltage = USERMOD_BATTERY_MAX_VOLTAGE;
+        unsigned int capacity = USERMOD_BATTERY_TOTAL_CAPACITY; // current capacity
+        float voltage = this->maxVoltage;                       // current voltage
+        int8_t level = 100;                                     // current level
+        float calibration = USERMOD_BATTERY_CALIBRATION;        // offset or calibration value to fine tune the calculated voltage
+        
+        float linearMapping(float v, float min, float max, float oMin = 0.0f, float oMax = 100.0f)
+        {
+            return (v-min) * (oMax-oMin) / (max-min) + oMin;
+        }
+
+    public:
+        Battery()
+        {
+
+        }
+
+        /**
+         * Corresponding battery curves
+         * calculates the capacity in % (0-100) with given voltage and possible voltage range
+         */
+        virtual float mapVoltage(float v, float min, float max) = 0;
+        // { 
+        //     example implementation, linear mapping
+        //     return (v-min) * 100 / (max-min);
+        // };
+
+        virtual void calculateAndSetLevel(float voltage) = 0;
+
+
+
+        /*
+        *
+        * Getter and Setter
+        *
+        */
+
+        /*
+        * Get lowest configured battery voltage
+        */
+        virtual float getMinVoltage()
+        {
+            return this->minVoltage;
+        }
+
+        /*
+        * Set lowest battery voltage
+        * can't be below 0 volt
+        */
+        virtual void setMinVoltage(float voltage)
+        {
+            this->minVoltage = max(0.0f, voltage);
+        }
+
+        /*
+        * Get highest configured battery voltage
+        */
+        virtual float getMaxVoltage()
+        {
+            return this->maxVoltage;
+        }
+
+        /*
+        * Set highest battery voltage
+        * can't be below minVoltage
+        */
+        virtual void setMaxVoltage(float voltage)
+        {
+            #ifdef USERMOD_BATTERY_USE_LIPO
+                this->maxVoltage = max(getMinVoltage()+0.7f, voltage);
+            #else
+                this->maxVoltage = max(getMinVoltage()+1.0f, voltage);
+            #endif
+        }
+
+        /*
+        * Get the capacity of all cells in parralel sumed up
+        * unit: mAh
+        */
+        unsigned int getCapacity()
+        {
+            return this->capacity;
+        }
+
+        void setCapacity(unsigned int capacity)
+        {
+            this->capacity = capacity;
+        }
+
+        float getVoltage()
+        {
+            return this->voltage;
+        }
+
+        /**
+         * check if voltage is within specified voltage range, allow 10% over/under voltage
+         */
+        void setVoltage(float voltage)
+        {
+            this->voltage = ( (voltage < this->getMinVoltage() * 0.85f) || (voltage > this->getMaxVoltage() * 1.1f) ) 
+                ? -1.0f 
+                : voltage;
+        }
+
+        float getLevel()
+        {
+            return this->level;
+        }
+
+        void setLevel(float level)
+        {
+            this->level = constrain(level, 0.0f, 110.0f);;
+        }
+
+        /*
+        * Get the configured calibration value
+        * a offset value to fine-tune the calculated voltage.
+        */
+        virtual float getCalibration()
+        {
+            return calibration;
+        }
+
+        /*
+        * Set the voltage calibration offset value
+        * a offset value to fine-tune the calculated voltage.
+        */
+        virtual void setCalibration(float offset)
+        {
+            calibration = offset;
+        }
+};
+
+#endif
\ No newline at end of file
diff --git a/usermods/Battery/battery_defaults.h b/usermods/Battery/battery_defaults.h
index c682cb45d..73f14f62a 100644
--- a/usermods/Battery/battery_defaults.h
+++ b/usermods/Battery/battery_defaults.h
@@ -14,6 +14,15 @@
   #define USERMOD_BATTERY_MEASUREMENT_INTERVAL 30000
 #endif
 
+
+/* Default Battery Type
+ * 1 = Lipo
+ * 2 = Lion
+ */
+#ifndef USERMOB_BATTERY_DEFAULT_TYPE
+  #define USERMOB_BATTERY_DEFAULT_TYPE 1
+#endif
+
 // default for 18650 battery
 // https://batterybro.com/blogs/18650-wholesale-battery-reviews/18852515-when-to-recycle-18650-batteries-and-how-to-start-a-collection-center-in-your-vape-shop
 // Discharge voltage: 2.5 volt + .1 for personal safety
@@ -69,4 +78,4 @@
 
 #ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION
   #define USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION 5
-#endif
\ No newline at end of file
+#endif
diff --git a/usermods/Battery/lion.h b/usermods/Battery/lion.h
new file mode 100644
index 000000000..e8d78cc72
--- /dev/null
+++ b/usermods/Battery/lion.h
@@ -0,0 +1,37 @@
+#ifndef UMBLion_h
+#define UMBLion_h
+
+#include "battery_defaults.h"
+#include "battery.h"
+
+/**
+ *  Lion Battery
+ * 
+ */
+class Lion : public Battery
+{
+    private:
+
+    public:
+        Lion() : Battery()
+        {
+
+        }
+
+        float mapVoltage(float v, float min, float max) override
+        {
+            return 0.0f;
+        };
+
+        void calculateAndSetLevel(float voltage) override
+        {
+
+        };
+
+        virtual void setMaxVoltage(float voltage) override
+        {
+            this->maxVoltage = max(getMinVoltage()+1.0f, voltage);
+        }
+};
+
+#endif
\ No newline at end of file
diff --git a/usermods/Battery/lipo.h b/usermods/Battery/lipo.h
new file mode 100644
index 000000000..4e9b0be7c
--- /dev/null
+++ b/usermods/Battery/lipo.h
@@ -0,0 +1,51 @@
+#ifndef UMBLipo_h
+#define UMBLipo_h
+
+#include "battery_defaults.h"
+#include "battery.h"
+
+/**
+ * Lipo Battery
+ * 
+ */
+class Lipo : public Battery
+{
+    private:
+
+    public:
+        Lipo() : Battery()
+        {
+
+        }
+
+        /**
+         * LiPo batteries have a differnt dischargin curve, see 
+         * https://blog.ampow.com/lipo-voltage-chart/
+         */
+        float mapVoltage(float v, float min, float max) override 
+        {
+            float lvl = 0.0f;
+            lvl = this->linearMapping(v, min, max); // basic mapping
+
+            if (lvl < 40.0f) 
+                lvl = this->linearMapping(lvl, 0, 40, 0, 12);         // last 45% -> drops very quickly
+            else {
+            if (lvl < 90.0f)
+                lvl = this->linearMapping(lvl, 40, 90, 12, 95);   // 90% ... 40% -> almost linear drop
+            else // level >  90%
+                lvl = this->linearMapping(lvl, 90, 105, 95, 100); // highest 15% -> drop slowly
+            }
+        };
+
+        void calculateAndSetLevel(float voltage) override
+        {
+            this->setLevel(this->mapVoltage(voltage, this->getMinVoltage(), this->getMaxVoltage()));
+        };
+
+        virtual void setMaxVoltage(float voltage) override
+        {
+            this->maxVoltage = max(getMinVoltage()+0.7f, voltage);
+        }
+};
+
+#endif
\ No newline at end of file
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index ac34a7e4d..4c77ca5dd 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -2,6 +2,9 @@
 
 #include "wled.h"
 #include "battery_defaults.h"
+#include "battery.h"
+#include "lion.h"
+#include "lipo.h"
 
 /*
  * Usermod by Maximilian Mewes
@@ -15,28 +18,12 @@ class UsermodBattery : public Usermod
   private:
     // battery pin can be defined in my_config.h
     int8_t batteryPin = USERMOD_BATTERY_MEASUREMENT_PIN;
+    // Battery object
+    Battery* bat;
     // how often to read the battery voltage
     unsigned long readingInterval = USERMOD_BATTERY_MEASUREMENT_INTERVAL;
     unsigned long nextReadTime = 0;
     unsigned long lastReadTime = 0;
-    // battery min. voltage
-    float minBatteryVoltage = USERMOD_BATTERY_MIN_VOLTAGE;
-    // battery max. voltage
-    float maxBatteryVoltage = USERMOD_BATTERY_MAX_VOLTAGE;
-    // all battery cells summed up
-    unsigned int totalBatteryCapacity = USERMOD_BATTERY_TOTAL_CAPACITY;
-    // raw analog reading 
-    float rawValue = 0.0f;
-    // calculated voltage            
-    float voltage = maxBatteryVoltage;
-    // mapped battery level based on voltage
-    int8_t batteryLevel = 100;
-    // offset or calibration value to fine tune the calculated voltage
-    float calibration = USERMOD_BATTERY_CALIBRATION;
-    
-    // time left estimation feature
-    // bool calculateTimeLeftEnabled = USERMOD_BATTERY_CALCULATE_TIME_LEFT_ENABLED;
-    // float estimatedTimeLeft = 0.0;
 
     // auto shutdown/shutoff/master off feature
     bool autoOffEnabled = USERMOD_BATTERY_AUTO_OFF_ENABLED;
@@ -63,14 +50,6 @@ class UsermodBattery : public Usermod
     static const char _preset[];
     static const char _duration[];
     static const char _init[];
-    
-
-    // custom map function
-    // https://forum.arduino.cc/t/floating-point-using-map-function/348113/2
-    double mapf(double x, double in_min, double in_max, double out_min, double out_max) 
-    {
-      return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
-    }
 
     float dot2round(float x) 
     {
@@ -94,8 +73,8 @@ class UsermodBattery : public Usermod
     {
       if (!lowPowerIndicatorEnabled) return;
       if (batteryPin < 0) return;  // no measurement
-      if (lowPowerIndicationDone && lowPowerIndicatorReactivationThreshold <= batteryLevel) lowPowerIndicationDone = false;
-      if (lowPowerIndicatorThreshold <= batteryLevel) return;
+      if (lowPowerIndicationDone && lowPowerIndicatorReactivationThreshold <= bat->getLevel()) lowPowerIndicationDone = false;
+      if (lowPowerIndicatorThreshold <= bat->getLevel()) return;
       if (lowPowerIndicationDone) return;
       if (lowPowerActivationTime <= 1) {
         lowPowerActivationTime = millis();
@@ -139,6 +118,16 @@ class UsermodBattery : public Usermod
         pinMode(batteryPin, INPUT);
       #endif
 
+      // this could also be handled with a factory class but for only 2 types now it should be sufficient
+     if(USERMOB_BATTERY_DEFAULT_TYPE == 1) {
+      bat = new Lipo();
+     } else 
+     if(USERMOB_BATTERY_DEFAULT_TYPE == 2) {
+      bat = new Lion();
+     } else {
+      bat = new Lipo();
+     }
+
       nextReadTime = millis() + readingInterval;
       lastReadTime = millis();
 
@@ -174,8 +163,9 @@ class UsermodBattery : public Usermod
 
       if (batteryPin < 0) return;  // nothing to read
 
-      initializing = false;
-
+      initializing = false;     
+      float voltage = -1.0f;
+      float rawValue = 0.0f;
 #ifdef ARDUINO_ARCH_ESP32
       // use calibrated millivolts analogread on esp32 (150 mV ~ 2450 mV)
       rawValue = analogReadMilliVolts(batteryPin);
@@ -188,40 +178,15 @@ class UsermodBattery : public Usermod
       rawValue = analogRead(batteryPin);
 
       // calculate the voltage     
-      voltage = ((rawValue / getAdcPrecision()) * maxBatteryVoltage) + calibration;
+      voltage = ((rawValue / getAdcPrecision()) * bat->getMaxVoltage()) + bat->getCalibration();
 #endif
-      // check if voltage is within specified voltage range, allow 10% over/under voltage
-      voltage = ((voltage < minBatteryVoltage * 0.85f) || (voltage > maxBatteryVoltage * 1.1f)) ? -1.0f : voltage;
 
+      bat->setVoltage(voltage);
       // translate battery voltage into percentage
-      /*
-        the standard "map" function doesn't work
-        https://www.arduino.cc/reference/en/language/functions/math/map/  notes and warnings at the bottom
-      */
-      #ifdef USERMOD_BATTERY_USE_LIPO
-        batteryLevel = mapf(voltage, minBatteryVoltage, maxBatteryVoltage, 0, 100); // basic mapping
-        // LiPo batteries have a differnt dischargin curve, see 
-        //  https://blog.ampow.com/lipo-voltage-chart/
-        if (batteryLevel < 40.0f) 
-          batteryLevel = mapf(batteryLevel, 0, 40, 0, 12);       // last 45% -> drops very quickly
-        else {
-          if (batteryLevel < 90.0f)
-            batteryLevel = mapf(batteryLevel, 40, 90, 12, 95);   // 90% ... 40% -> almost linear drop
-          else // level >  90%
-            batteryLevel = mapf(batteryLevel, 90, 105, 95, 100); // highest 15% -> drop slowly
-        }
-      #else
-        batteryLevel = mapf(voltage, minBatteryVoltage, maxBatteryVoltage, 0, 100);
-      #endif
-      if (voltage > -1.0f) batteryLevel = constrain(batteryLevel, 0.0f, 110.0f);
-
-      // if (calculateTimeLeftEnabled) {
-      //   float currentBatteryCapacity = totalBatteryCapacity;
-      //   estimatedTimeLeft = (currentBatteryCapacity/strip.currentMilliamps)*60;
-      // }
+      bat->calculateAndSetLevel(voltage);
 
       // Auto off -- Master power off
-      if (autoOffEnabled && (autoOffThreshold >= batteryLevel))
+      if (autoOffEnabled && (autoOffThreshold >= bat->getLevel()))
         turnOff();
 
       // SmartHome stuff
@@ -254,16 +219,6 @@ class UsermodBattery : public Usermod
       // info modal display names
       JsonArray infoPercentage = user.createNestedArray(F("Battery level"));
       JsonArray infoVoltage = user.createNestedArray(F("Battery voltage"));
-      // if (calculateTimeLeftEnabled)
-      // {
-      //   JsonArray infoEstimatedTimeLeft = user.createNestedArray(F("Estimated time left"));
-      //   if (initializing) {
-      //     infoEstimatedTimeLeft.add(FPSTR(_init));
-      //   } else {
-      //     infoEstimatedTimeLeft.add(estimatedTimeLeft);
-      //     infoEstimatedTimeLeft.add(F(" min"));
-      //   }
-      // }
       JsonArray infoNextUpdate = user.createNestedArray(F("Next update"));
 
       infoNextUpdate.add((nextReadTime - millis()) / 1000);
@@ -275,17 +230,17 @@ class UsermodBattery : public Usermod
         return;
       }
 
-      if (batteryLevel < 0) {
+      if (bat->getLevel() < 0) {
         infoPercentage.add(F("invalid"));
       } else {
-        infoPercentage.add(batteryLevel);
+        infoPercentage.add(bat->getLevel());
       }
       infoPercentage.add(F(" %"));
 
-      if (voltage < 0) {
+      if (bat->getVoltage() < 0) {
         infoVoltage.add(F("invalid"));
       } else {
-        infoVoltage.add(dot2round(voltage));
+        infoVoltage.add(dot2round(bat->getVoltage()));
       }
       infoVoltage.add(F(" V"));
     }
@@ -298,7 +253,7 @@ class UsermodBattery : public Usermod
     /*
     void addToJsonState(JsonObject& root)
     {
-
+      // TBD
     }
     */
 
@@ -310,6 +265,7 @@ class UsermodBattery : public Usermod
     /*
     void readFromJsonState(JsonObject& root)
     {
+      // TBD
     }
     */
 
@@ -356,18 +312,17 @@ class UsermodBattery : public Usermod
         battery[F("pin")] = batteryPin;
       #endif
 
-      // battery[F("time-left")] = calculateTimeLeftEnabled;
-      battery[F("min-voltage")] = minBatteryVoltage;
-      battery[F("max-voltage")] = maxBatteryVoltage;
-      battery[F("capacity")] = totalBatteryCapacity;
-      battery[F("calibration")] = calibration;
+      battery[F("min-voltage")] = bat->getMinVoltage();
+      battery[F("max-voltage")] = bat->getMaxVoltage();
+      battery[F("capacity")] = bat->getCapacity();
+      battery[F("calibration")] = bat->getCalibration();
       battery[FPSTR(_readInterval)] = readingInterval;
       
-      JsonObject ao = battery.createNestedObject(F("auto-off"));               // auto off section
+      JsonObject ao = battery.createNestedObject(F("auto-off"));  // auto off section
       ao[FPSTR(_enabled)] = autoOffEnabled;
       ao[FPSTR(_threshold)] = autoOffThreshold;
 
-      JsonObject lp = battery.createNestedObject(F("indicator"));    // low power section
+      JsonObject lp = battery.createNestedObject(F("indicator")); // low power section
       lp[FPSTR(_enabled)] = lowPowerIndicatorEnabled;
       lp[FPSTR(_preset)] = lowPowerIndicatorPreset; // dropdown trickery (String)lowPowerIndicatorPreset; 
       lp[FPSTR(_threshold)] = lowPowerIndicatorThreshold;
@@ -432,11 +387,11 @@ class UsermodBattery : public Usermod
       #ifdef ARDUINO_ARCH_ESP32
         newBatteryPin     = battery[F("pin")] | newBatteryPin;
       #endif
-      // calculateTimeLeftEnabled = battery[F("time-left")] | calculateTimeLeftEnabled;
-      setMinBatteryVoltage(battery[F("min-voltage")] | minBatteryVoltage);
-      setMaxBatteryVoltage(battery[F("max-voltage")] | maxBatteryVoltage);
-      setTotalBatteryCapacity(battery[F("capacity")] | totalBatteryCapacity);
-      setCalibration(battery[F("calibration")] | calibration);
+
+      bat->setMinVoltage(battery[F("min-voltage")] | bat->getMinVoltage());
+      bat->setMaxVoltage(battery[F("max-voltage")] | bat->getMaxVoltage());
+      bat->setCapacity(battery[F("capacity")] | bat->getCapacity());
+      bat->setCalibration(battery[F("calibration")] | bat->getCalibration());
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
 
       JsonObject ao = battery[F("auto-off")];
@@ -479,7 +434,8 @@ class UsermodBattery : public Usermod
     }
 
     /*
-     * Generate a preset sample for low power indication 
+     * TBD: Generate a preset sample for low power indication
+     * a button on the config page would be cool, currently not possible
      */
     void generateExamplePreset()
     {
@@ -539,60 +495,6 @@ class UsermodBattery : public Usermod
       readingInterval = max((unsigned long)3000, newReadingInterval);
     }
 
-
-    /*
-     * Get lowest configured battery voltage
-     */
-    float getMinBatteryVoltage()
-    {
-      return minBatteryVoltage;
-    }
-
-    /*
-     * Set lowest battery voltage
-     * can't be below 0 volt
-     */
-    void setMinBatteryVoltage(float voltage)
-    {
-      minBatteryVoltage = max(0.0f, voltage);
-    }
-
-    /*
-     * Get highest configured battery voltage
-     */
-    float getMaxBatteryVoltage()
-    {
-      return maxBatteryVoltage;
-    }
-    
-    /*
-     * Set highest battery voltage
-     * can't be below minBatteryVoltage
-     */
-    void setMaxBatteryVoltage(float voltage)
-    {
-      #ifdef USERMOD_BATTERY_USE_LIPO
-        maxBatteryVoltage = max(getMinBatteryVoltage()+0.7f, voltage);
-      #else
-        maxBatteryVoltage = max(getMinBatteryVoltage()+1.0f, voltage);
-      #endif
-    }
-
-
-    /*
-     * Get the capacity of all cells in parralel sumed up
-     * unit: mAh
-     */
-    unsigned int getTotalBatteryCapacity()
-    {
-      return totalBatteryCapacity;
-    }
-
-    void setTotalBatteryCapacity(unsigned int capacity)
-    {
-      totalBatteryCapacity = capacity;
-    }
-
     /*
      * Get the choosen adc precision
      * esp8266 = 10bit resolution = 1024.0f 
@@ -609,43 +511,6 @@ class UsermodBattery : public Usermod
       #endif
     }
 
-    /*
-     * Get the calculated voltage
-     * formula: (adc pin value / adc precision * max voltage) + calibration
-     */
-    float getVoltage()
-    {
-      return voltage;
-    }
-
-    /*
-     * Get the mapped battery level (0 - 100) based on voltage
-     * important: voltage can drop when a load is applied, so its only an estimate
-     */
-    int8_t getBatteryLevel()
-    {
-      return batteryLevel;
-    }
-
-    /*
-     * Get the configured calibration value
-     * a offset value to fine-tune the calculated voltage.
-     */
-    float getCalibration()
-    {
-      return calibration;
-    }
-
-    /*
-     * Set the voltage calibration offset value
-     * a offset value to fine-tune the calculated voltage.
-     */
-    void setCalibration(float offset)
-    {
-      calibration = offset;
-    }
-
-
     /*
      * Get auto-off feature enabled status
      * is auto-off enabled, true/false

From 4c8b490c89635a647b9b7e30a519b8a358a1fc47 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Thu, 5 Jan 2023 20:38:55 +0100
Subject: [PATCH 02/18] minor changes

---
 usermods/Battery/battery.h            |  6 +-----
 usermods/Battery/battery_defaults.h   |  7 +------
 usermods/Battery/lion.h               |  4 ++--
 usermods/Battery/lipo.h               |  2 ++
 usermods/Battery/usermod_v2_Battery.h | 18 ++++++++++++++----
 5 files changed, 20 insertions(+), 17 deletions(-)

diff --git a/usermods/Battery/battery.h b/usermods/Battery/battery.h
index f3daf05c4..c678f775d 100644
--- a/usermods/Battery/battery.h
+++ b/usermods/Battery/battery.h
@@ -81,11 +81,7 @@ class Battery
         */
         virtual void setMaxVoltage(float voltage)
         {
-            #ifdef USERMOD_BATTERY_USE_LIPO
-                this->maxVoltage = max(getMinVoltage()+0.7f, voltage);
-            #else
-                this->maxVoltage = max(getMinVoltage()+1.0f, voltage);
-            #endif
+            this->maxVoltage = max(getMinVoltage()+.5f, voltage);
         }
 
         /*
diff --git a/usermods/Battery/battery_defaults.h b/usermods/Battery/battery_defaults.h
index 73f14f62a..4a04ac352 100644
--- a/usermods/Battery/battery_defaults.h
+++ b/usermods/Battery/battery_defaults.h
@@ -27,7 +27,7 @@
 // https://batterybro.com/blogs/18650-wholesale-battery-reviews/18852515-when-to-recycle-18650-batteries-and-how-to-start-a-collection-center-in-your-vape-shop
 // Discharge voltage: 2.5 volt + .1 for personal safety
 #ifndef USERMOD_BATTERY_MIN_VOLTAGE
-  #ifdef USERMOD_BATTERY_USE_LIPO
+  #if USERMOB_BATTERY_DEFAULT_TYPE == 1
     // LiPo "1S" Batteries should not be dischared below 3V !!
     #define USERMOD_BATTERY_MIN_VOLTAGE 3.2f
   #else
@@ -49,11 +49,6 @@
   #define USERMOD_BATTERY_CALIBRATION 0
 #endif
 
-// calculate remaining time / the time that is left before the battery runs out of power
-// #ifndef USERMOD_BATTERY_CALCULATE_TIME_LEFT_ENABLED
-//   #define USERMOD_BATTERY_CALCULATE_TIME_LEFT_ENABLED false
-// #endif
-
 // auto-off feature
 #ifndef USERMOD_BATTERY_AUTO_OFF_ENABLED
   #define USERMOD_BATTERY_AUTO_OFF_ENABLED true
diff --git a/usermods/Battery/lion.h b/usermods/Battery/lion.h
index e8d78cc72..69095ac09 100644
--- a/usermods/Battery/lion.h
+++ b/usermods/Battery/lion.h
@@ -20,12 +20,12 @@ class Lion : public Battery
 
         float mapVoltage(float v, float min, float max) override
         {
-            return 0.0f;
+            return this->linearMapping(v, min, max); // basic mapping
         };
 
         void calculateAndSetLevel(float voltage) override
         {
-
+            this->setLevel(this->mapVoltage(voltage, this->getMinVoltage(), this->getMaxVoltage()));
         };
 
         virtual void setMaxVoltage(float voltage) override
diff --git a/usermods/Battery/lipo.h b/usermods/Battery/lipo.h
index 4e9b0be7c..92ede8f81 100644
--- a/usermods/Battery/lipo.h
+++ b/usermods/Battery/lipo.h
@@ -35,6 +35,8 @@ class Lipo : public Battery
             else // level >  90%
                 lvl = this->linearMapping(lvl, 90, 105, 95, 100); // highest 15% -> drop slowly
             }
+
+            return lvl;
         };
 
         void calculateAndSetLevel(float voltage) override
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index 4c77ca5dd..87b73ec6d 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -18,8 +18,11 @@ class UsermodBattery : public Usermod
   private:
     // battery pin can be defined in my_config.h
     int8_t batteryPin = USERMOD_BATTERY_MEASUREMENT_PIN;
+
+    int8_t batteryType = USERMOB_BATTERY_DEFAULT_TYPE;
     // Battery object
     Battery* bat;
+    
     // how often to read the battery voltage
     unsigned long readingInterval = USERMOD_BATTERY_MEASUREMENT_INTERVAL;
     unsigned long nextReadTime = 0;
@@ -118,14 +121,14 @@ class UsermodBattery : public Usermod
         pinMode(batteryPin, INPUT);
       #endif
 
-      // this could also be handled with a factory class but for only 2 types now it should be sufficient
-     if(USERMOB_BATTERY_DEFAULT_TYPE == 1) {
+      // this could also be handled with a factory class but for only 2 types it should be sufficient for now
+     if(batteryType == 1) {
       bat = new Lipo();
      } else 
-     if(USERMOB_BATTERY_DEFAULT_TYPE == 2) {
+     if(batteryType == 2) {
       bat = new Lion();
      } else {
-      bat = new Lipo();
+      bat = new Lipo(); // in the future one could create a nullObject
      }
 
       nextReadTime = millis() + readingInterval;
@@ -317,6 +320,10 @@ class UsermodBattery : public Usermod
       battery[F("capacity")] = bat->getCapacity();
       battery[F("calibration")] = bat->getCalibration();
       battery[FPSTR(_readInterval)] = readingInterval;
+
+      // JsonArray type = battery[F("Type")];
+      // type[0] = 1;
+      // type[1] = 2;
       
       JsonObject ao = battery.createNestedObject(F("auto-off"));  // auto off section
       ao[FPSTR(_enabled)] = autoOffEnabled;
@@ -393,6 +400,9 @@ class UsermodBattery : public Usermod
       bat->setCapacity(battery[F("capacity")] | bat->getCapacity());
       bat->setCalibration(battery[F("calibration")] | bat->getCalibration());
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
+      
+      // JsonArray type = battery[F("Type")];
+      // batteryType = type["bt"] | batteryType;
 
       JsonObject ao = battery[F("auto-off")];
       setAutoOffEnabled(ao[FPSTR(_enabled)] | autoOffEnabled);

From 85d59945a0ffaaa8907ce69cc1cb3f7548de2775 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Fri, 6 Jan 2023 00:19:16 +0100
Subject: [PATCH 03/18] =?UTF-8?q?runtime=20exception=20fix=20=F0=9F=90=9B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 usermods/Battery/usermod_v2_Battery.h | 38 ++++++++++++++++-----------
 1 file changed, 22 insertions(+), 16 deletions(-)

diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index 87b73ec6d..f9bfc96fb 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -20,9 +20,15 @@ class UsermodBattery : public Usermod
     int8_t batteryPin = USERMOD_BATTERY_MEASUREMENT_PIN;
 
     int8_t batteryType = USERMOB_BATTERY_DEFAULT_TYPE;
-    // Battery object
-    Battery* bat;
-    
+
+    float minVoltage = USERMOD_BATTERY_MIN_VOLTAGE;
+    float maxVoltage = USERMOD_BATTERY_MAX_VOLTAGE;
+    unsigned int capacity = USERMOD_BATTERY_TOTAL_CAPACITY; // current capacity
+    float voltage = this->maxVoltage;                       // current voltage
+    int8_t level = 100;                                     // current level
+    float calibration = USERMOD_BATTERY_CALIBRATION;        // offset or calibration value to fine tune the calculated voltage
+    Battery* bat = nullptr;
+
     // how often to read the battery voltage
     unsigned long readingInterval = USERMOD_BATTERY_MEASUREMENT_INTERVAL;
     unsigned long nextReadTime = 0;
@@ -121,7 +127,7 @@ class UsermodBattery : public Usermod
         pinMode(batteryPin, INPUT);
       #endif
 
-      // this could also be handled with a factory class but for only 2 types it should be sufficient for now
+     //this could also be handled with a factory class but for only 2 types it should be sufficient for now
      if(batteryType == 1) {
       bat = new Lipo();
      } else 
@@ -315,15 +321,13 @@ class UsermodBattery : public Usermod
         battery[F("pin")] = batteryPin;
       #endif
 
-      battery[F("min-voltage")] = bat->getMinVoltage();
-      battery[F("max-voltage")] = bat->getMaxVoltage();
-      battery[F("capacity")] = bat->getCapacity();
-      battery[F("calibration")] = bat->getCalibration();
+      if(bat) {
+        battery[F("min-voltage")] = bat->getMinVoltage();
+        battery[F("max-voltage")] = bat->getMaxVoltage();
+        battery[F("capacity")] = bat->getCapacity();
+        battery[F("calibration")] = bat->getCalibration();
+      }
       battery[FPSTR(_readInterval)] = readingInterval;
-
-      // JsonArray type = battery[F("Type")];
-      // type[0] = 1;
-      // type[1] = 2;
       
       JsonObject ao = battery.createNestedObject(F("auto-off"));  // auto off section
       ao[FPSTR(_enabled)] = autoOffEnabled;
@@ -395,10 +399,12 @@ class UsermodBattery : public Usermod
         newBatteryPin     = battery[F("pin")] | newBatteryPin;
       #endif
 
-      bat->setMinVoltage(battery[F("min-voltage")] | bat->getMinVoltage());
-      bat->setMaxVoltage(battery[F("max-voltage")] | bat->getMaxVoltage());
-      bat->setCapacity(battery[F("capacity")] | bat->getCapacity());
-      bat->setCalibration(battery[F("calibration")] | bat->getCalibration());
+      if(bat) {
+        bat->setMinVoltage(battery[F("min-voltage")] | bat->getMinVoltage());
+        bat->setMaxVoltage(battery[F("max-voltage")] | bat->getMaxVoltage());
+        bat->setCapacity(battery[F("capacity")] | bat->getCapacity());
+        bat->setCalibration(battery[F("calibration")] | bat->getCalibration());
+      }
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
       
       // JsonArray type = battery[F("Type")];

From 375907144966e37e9a8dad3efc92343fec892052 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Fri, 6 Jan 2023 17:00:29 +0100
Subject: [PATCH 04/18] =?UTF-8?q?Fix=20previous=20bug=20again=20?=
 =?UTF-8?q?=F0=9F=90=9B,=20Add=20Type=20Dropdown=20to=20config=20page?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 usermods/Battery/battery.h            |  21 +++--
 usermods/Battery/battery_defaults.h   | 111 +++++++++++++++++++-------
 usermods/Battery/lion.h               |   8 +-
 usermods/Battery/lipo.h               |  10 ++-
 usermods/Battery/unkown.h             |  36 +++++++++
 usermods/Battery/usermod_v2_Battery.h |  62 +++++++-------
 6 files changed, 178 insertions(+), 70 deletions(-)
 create mode 100644 usermods/Battery/unkown.h

diff --git a/usermods/Battery/battery.h b/usermods/Battery/battery.h
index c678f775d..ad3fb2703 100644
--- a/usermods/Battery/battery.h
+++ b/usermods/Battery/battery.h
@@ -12,12 +12,12 @@ class Battery
     private:
 
     protected:
-        float minVoltage = USERMOD_BATTERY_MIN_VOLTAGE;
-        float maxVoltage = USERMOD_BATTERY_MAX_VOLTAGE;
-        unsigned int capacity = USERMOD_BATTERY_TOTAL_CAPACITY; // current capacity
-        float voltage = this->maxVoltage;                       // current voltage
-        int8_t level = 100;                                     // current level
-        float calibration = USERMOD_BATTERY_CALIBRATION;        // offset or calibration value to fine tune the calculated voltage
+        float minVoltage;
+        float maxVoltage;
+        unsigned int capacity;
+        float voltage;
+        int8_t level = 100;
+        float calibration; // offset or calibration value to fine tune the calculated voltage
         
         float linearMapping(float v, float min, float max, float oMin = 0.0f, float oMax = 100.0f)
         {
@@ -30,6 +30,15 @@ class Battery
 
         }
 
+        virtual void update(batteryConfig cfg)
+        {
+            if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage);
+            if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage);
+            if(cfg.calibration) this->setCapacity(cfg.calibration);
+            if(cfg.level) this->setLevel(cfg.level);
+            if(cfg.calibration) this->setCalibration(cfg.calibration);
+        }
+
         /**
          * Corresponding battery curves
          * calculates the capacity in % (0-100) with given voltage and possible voltage range
diff --git a/usermods/Battery/battery_defaults.h b/usermods/Battery/battery_defaults.h
index 4a04ac352..f4060ca60 100644
--- a/usermods/Battery/battery_defaults.h
+++ b/usermods/Battery/battery_defaults.h
@@ -1,3 +1,6 @@
+#ifndef UMBDefaults_h
+#define UMBDefaults_h
+
 // pin defaults
 // for the esp32 it is best to use the ADC1: GPIO32 - GPIO39
 // https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/adc.html
@@ -16,38 +19,70 @@
 
 
 /* Default Battery Type
+ * 0 = unkown
  * 1 = Lipo
  * 2 = Lion
  */
-#ifndef USERMOB_BATTERY_DEFAULT_TYPE
-  #define USERMOB_BATTERY_DEFAULT_TYPE 1
+#ifndef USERMOD_BATTERY_DEFAULT_TYPE
+  #define USERMOD_BATTERY_DEFAULT_TYPE 0
+#endif
+/*
+ *
+ *  Unkown 'Battery' defaults
+ *
+ */
+#ifndef USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE
+  #define USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE 3.3f
+#endif
+#ifndef USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE
+  #define USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE 4.2f
+#endif
+#ifndef USERMOD_BATTERY_UNKOWN_CAPACITY
+  #define USERMOD_BATTERY_UNKOWN_CAPACITY 2500
+#endif
+#ifndef USERMOD_BATTERY_UNKOWN_CALIBRATION
+  // offset or calibration value to fine tune the calculated voltage
+  #define USERMOD_BATTERY_UNKOWN_CALIBRATION 0
+#endif
+/*
+ *
+ *  Lithium polymer (Li-Po) defaults
+ *
+ */
+#ifndef USERMOD_BATTERY_LIPO_MIN_VOLTAGE
+  // LiPo "1S" Batteries should not be dischared below 3V !!
+  #define USERMOD_BATTERY_LIPO_MIN_VOLTAGE 3.2f
+#endif
+#ifndef USERMOD_BATTERY_LIPO_MAX_VOLTAGE
+  #define USERMOD_BATTERY_LIPO_MAX_VOLTAGE 4.2f
+#endif
+#ifndef USERMOD_BATTERY_LIPO_CAPACITY
+  #define USERMOD_BATTERY_LIPO_CAPACITY 5000
+#endif
+#ifndef USERMOD_BATTERY_LIPO_CALIBRATION
+  #define USERMOD_BATTERY_LIPO_CALIBRATION 0
+#endif
+/*
+ *
+ *  Lithium-ion (Li-Ion) defaults
+ *
+ */
+#ifndef USERMOD_BATTERY_LION_MIN_VOLTAGE
+  // default for 18650 battery
+  #define USERMOD_BATTERY_LION_MIN_VOLTAGE 2.6f
+#endif
+#ifndef USERMOD_BATTERY_LION_MAX_VOLTAGE
+  #define USERMOD_BATTERY_LION_MAX_VOLTAGE 4.2f
+#endif
+#ifndef USERMOD_BATTERY_LION_CAPACITY
+  // a common capacity for single 18650 battery cells is between 2500 and 3600 mAh
+  #define USERMOD_BATTERY_LION_CAPACITY 3100
+#endif
+#ifndef USERMOD_BATTERY_LION_CALIBRATION
+  // offset or calibration value to fine tune the calculated voltage
+  #define USERMOD_BATTERY_LION_CALIBRATION 0
 #endif
 
-// default for 18650 battery
-// https://batterybro.com/blogs/18650-wholesale-battery-reviews/18852515-when-to-recycle-18650-batteries-and-how-to-start-a-collection-center-in-your-vape-shop
-// Discharge voltage: 2.5 volt + .1 for personal safety
-#ifndef USERMOD_BATTERY_MIN_VOLTAGE
-  #if USERMOB_BATTERY_DEFAULT_TYPE == 1
-    // LiPo "1S" Batteries should not be dischared below 3V !!
-    #define USERMOD_BATTERY_MIN_VOLTAGE 3.2f
-  #else
-    #define USERMOD_BATTERY_MIN_VOLTAGE 2.6f
-  #endif
-#endif
-
-#ifndef USERMOD_BATTERY_MAX_VOLTAGE
-  #define USERMOD_BATTERY_MAX_VOLTAGE 4.2f
-#endif
-
-// a common capacity for single 18650 battery cells is between 2500 and 3600 mAh
-#ifndef USERMOD_BATTERY_TOTAL_CAPACITY
-  #define USERMOD_BATTERY_TOTAL_CAPACITY 3100
-#endif
-
-// offset or calibration value to fine tune the calculated voltage
-#ifndef USERMOD_BATTERY_CALIBRATION
-  #define USERMOD_BATTERY_CALIBRATION 0
-#endif
 
 // auto-off feature
 #ifndef USERMOD_BATTERY_AUTO_OFF_ENABLED
@@ -74,3 +109,25 @@
 #ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION
   #define USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION 5
 #endif
+
+typedef enum
+{
+  unknown=0,
+  lipo=1,
+  lion=2
+} batteryType;
+
+// used for initial configuration after boot 
+typedef struct bconfig_t 
+{
+  batteryType type;
+  float minVoltage;
+  float maxVoltage;
+  unsigned int capacity; // current capacity
+  float voltage;                       // current voltage
+  int8_t level;                                     // current level
+  float calibration;        // offset or calibration value to fine tune the calculated voltage
+} batteryConfig;
+
+
+#endif
\ No newline at end of file
diff --git a/usermods/Battery/lion.h b/usermods/Battery/lion.h
index 69095ac09..4016af7e3 100644
--- a/usermods/Battery/lion.h
+++ b/usermods/Battery/lion.h
@@ -13,9 +13,13 @@ class Lion : public Battery
     private:
 
     public:
-        Lion() : Battery()
+        Lion()
         {
-
+            this->setMinVoltage(USERMOD_BATTERY_LION_MIN_VOLTAGE);
+            this->setMaxVoltage(USERMOD_BATTERY_LION_MAX_VOLTAGE);
+            this->setCapacity(USERMOD_BATTERY_LION_CAPACITY);
+            this->setVoltage(this->getVoltage());
+            this->setCalibration(USERMOD_BATTERY_LION_CALIBRATION);
         }
 
         float mapVoltage(float v, float min, float max) override
diff --git a/usermods/Battery/lipo.h b/usermods/Battery/lipo.h
index 92ede8f81..03eed7b86 100644
--- a/usermods/Battery/lipo.h
+++ b/usermods/Battery/lipo.h
@@ -5,7 +5,7 @@
 #include "battery.h"
 
 /**
- * Lipo Battery
+ *  Lipo Battery
  * 
  */
 class Lipo : public Battery
@@ -13,9 +13,13 @@ class Lipo : public Battery
     private:
 
     public:
-        Lipo() : Battery()
+        Lipo()
         {
-
+            this->setMinVoltage(USERMOD_BATTERY_LIPO_MIN_VOLTAGE);
+            this->setMaxVoltage(USERMOD_BATTERY_LIPO_MAX_VOLTAGE);
+            this->setCapacity(USERMOD_BATTERY_LIPO_CAPACITY);
+            this->setVoltage(this->getVoltage());
+            this->setCalibration(USERMOD_BATTERY_LIPO_CALIBRATION);
         }
 
         /**
diff --git a/usermods/Battery/unkown.h b/usermods/Battery/unkown.h
new file mode 100644
index 000000000..63b2674f3
--- /dev/null
+++ b/usermods/Battery/unkown.h
@@ -0,0 +1,36 @@
+#ifndef UMBUnkown_h
+#define UMBUnkown_h
+
+#include "battery_defaults.h"
+#include "battery.h"
+
+/**
+ *  Lion Battery
+ * 
+ */
+class Unkown : public Battery
+{
+    private:
+
+    public:
+        Unkown()
+        {
+            this->setMinVoltage(USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE);
+            this->setMaxVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
+            this->setCapacity(USERMOD_BATTERY_UNKOWN_CAPACITY);
+            this->setVoltage(this->getVoltage());
+            this->setCalibration(USERMOD_BATTERY_UNKOWN_CALIBRATION);
+        }
+
+        float mapVoltage(float v, float min, float max) override
+        {
+            return this->linearMapping(v, min, max); // basic mapping
+        };
+
+        void calculateAndSetLevel(float voltage) override
+        {
+            this->setLevel(this->mapVoltage(voltage, this->getMinVoltage(), this->getMaxVoltage()));
+        };
+};
+
+#endif
\ No newline at end of file
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index f9bfc96fb..ab2ab908d 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -3,6 +3,7 @@
 #include "wled.h"
 #include "battery_defaults.h"
 #include "battery.h"
+#include "unkown.h"
 #include "lion.h"
 #include "lipo.h"
 
@@ -18,16 +19,9 @@ class UsermodBattery : public Usermod
   private:
     // battery pin can be defined in my_config.h
     int8_t batteryPin = USERMOD_BATTERY_MEASUREMENT_PIN;
-
-    int8_t batteryType = USERMOB_BATTERY_DEFAULT_TYPE;
-
-    float minVoltage = USERMOD_BATTERY_MIN_VOLTAGE;
-    float maxVoltage = USERMOD_BATTERY_MAX_VOLTAGE;
-    unsigned int capacity = USERMOD_BATTERY_TOTAL_CAPACITY; // current capacity
-    float voltage = this->maxVoltage;                       // current voltage
-    int8_t level = 100;                                     // current level
-    float calibration = USERMOD_BATTERY_CALIBRATION;        // offset or calibration value to fine tune the calculated voltage
+    
     Battery* bat = nullptr;
+    batteryConfig bcfg;
 
     // how often to read the battery voltage
     unsigned long readingInterval = USERMOD_BATTERY_MEASUREMENT_INTERVAL;
@@ -127,16 +121,17 @@ class UsermodBattery : public Usermod
         pinMode(batteryPin, INPUT);
       #endif
 
-     //this could also be handled with a factory class but for only 2 types it should be sufficient for now
-     if(batteryType == 1) {
-      bat = new Lipo();
-     } else 
-     if(batteryType == 2) {
-      bat = new Lion();
-     } else {
-      bat = new Lipo(); // in the future one could create a nullObject
-     }
+      //this could also be handled with a factory class but for only 2 types it should be sufficient for now
+      if(bcfg.type == (batteryType)lipo) {
+        bat = new Lipo();
+      } else 
+      if(bcfg.type == (batteryType)lion) {
+        bat = new Lion();
+      } else {
+        bat = new Unkown(); // nullObject
+      }
 
+      bat->update(bcfg);
       nextReadTime = millis() + readingInterval;
       lastReadTime = millis();
 
@@ -321,12 +316,11 @@ class UsermodBattery : public Usermod
         battery[F("pin")] = batteryPin;
       #endif
 
-      if(bat) {
-        battery[F("min-voltage")] = bat->getMinVoltage();
-        battery[F("max-voltage")] = bat->getMaxVoltage();
-        battery[F("capacity")] = bat->getCapacity();
-        battery[F("calibration")] = bat->getCalibration();
-      }
+      battery[F("type")] = (String)bcfg.type;
+      battery[F("min-voltage")] = bat->getMinVoltage();
+      battery[F("max-voltage")] = bat->getMaxVoltage();
+      battery[F("capacity")] = bat->getCapacity();
+      battery[F("calibration")] = bat->getCalibration();
       battery[FPSTR(_readInterval)] = readingInterval;
       
       JsonObject ao = battery.createNestedObject(F("auto-off"));  // auto off section
@@ -344,6 +338,11 @@ class UsermodBattery : public Usermod
 
     void appendConfigData()
     {
+      oappend(SET_F("td=addDropdown('Battery', 'type');"));
+      oappend(SET_F("addOption(td, 'Unkown', '0');"));
+      oappend(SET_F("addOption(td, 'LiPo', '1');"));
+      oappend(SET_F("addOption(td, 'LiOn', '2');"));
+      oappend(SET_F("addInfo('Battery:type',1,'<small style=\"color:orange\">requires reboot</small>');"));
       oappend(SET_F("addInfo('Battery:min-voltage', 1, 'v');"));
       oappend(SET_F("addInfo('Battery:max-voltage', 1, 'v');"));
       oappend(SET_F("addInfo('Battery:capacity', 1, 'mAh');"));
@@ -399,16 +398,15 @@ class UsermodBattery : public Usermod
         newBatteryPin     = battery[F("pin")] | newBatteryPin;
       #endif
 
-      if(bat) {
-        bat->setMinVoltage(battery[F("min-voltage")] | bat->getMinVoltage());
-        bat->setMaxVoltage(battery[F("max-voltage")] | bat->getMaxVoltage());
-        bat->setCapacity(battery[F("capacity")] | bat->getCapacity());
-        bat->setCalibration(battery[F("calibration")] | bat->getCalibration());
-      }
+      getJsonValue(battery[F("type")], bcfg.type);
+      getJsonValue(battery[F("min-voltage")], bcfg.minVoltage);
+      getJsonValue(battery[F("max-voltage")], bcfg.maxVoltage);
+      getJsonValue(battery[F("capacity")], bcfg.capacity);
+      getJsonValue(battery[F("calibration")], bcfg.calibration);
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
       
       // JsonArray type = battery[F("Type")];
-      // batteryType = type["bt"] | batteryType;
+      // batteryType = type["bt"] | btype;
 
       JsonObject ao = battery[F("auto-off")];
       setAutoOffEnabled(ao[FPSTR(_enabled)] | autoOffEnabled);
@@ -446,7 +444,7 @@ class UsermodBattery : public Usermod
         }
       #endif
 
-      return !battery[FPSTR(_readInterval)].isNull();
+      return !battery[F("min-voltage")].isNull();
     }
 
     /*

From 8ba5dfe447ac73111ff2a244be44a6ec08389417 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Fri, 6 Jan 2023 19:07:39 +0100
Subject: [PATCH 05/18] =?UTF-8?q?Another=20Bugfx=20=F0=9F=A7=91=E2=80=8D?=
 =?UTF-8?q?=F0=9F=94=A7?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 usermods/Battery/battery.h            |  9 +--------
 usermods/Battery/lion.h               |  9 +++++++++
 usermods/Battery/lipo.h               |  9 +++++++++
 usermods/Battery/usermod_v2_Battery.h | 11 ++++++-----
 4 files changed, 25 insertions(+), 13 deletions(-)

diff --git a/usermods/Battery/battery.h b/usermods/Battery/battery.h
index ad3fb2703..3a792aadb 100644
--- a/usermods/Battery/battery.h
+++ b/usermods/Battery/battery.h
@@ -30,14 +30,7 @@ class Battery
 
         }
 
-        virtual void update(batteryConfig cfg)
-        {
-            if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage);
-            if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage);
-            if(cfg.calibration) this->setCapacity(cfg.calibration);
-            if(cfg.level) this->setLevel(cfg.level);
-            if(cfg.calibration) this->setCalibration(cfg.calibration);
-        }
+        virtual void update(batteryConfig cfg) = 0;
 
         /**
          * Corresponding battery curves
diff --git a/usermods/Battery/lion.h b/usermods/Battery/lion.h
index 4016af7e3..17a4b3593 100644
--- a/usermods/Battery/lion.h
+++ b/usermods/Battery/lion.h
@@ -22,6 +22,15 @@ class Lion : public Battery
             this->setCalibration(USERMOD_BATTERY_LION_CALIBRATION);
         }
 
+        void update(batteryConfig cfg)
+        {
+            if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage);
+            if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage);
+            if(cfg.calibration) this->setCapacity(cfg.calibration);
+            if(cfg.level) this->setLevel(cfg.level);
+            if(cfg.calibration) this->setCalibration(cfg.calibration);
+        }
+
         float mapVoltage(float v, float min, float max) override
         {
             return this->linearMapping(v, min, max); // basic mapping
diff --git a/usermods/Battery/lipo.h b/usermods/Battery/lipo.h
index 03eed7b86..dcd44567f 100644
--- a/usermods/Battery/lipo.h
+++ b/usermods/Battery/lipo.h
@@ -22,6 +22,15 @@ class Lipo : public Battery
             this->setCalibration(USERMOD_BATTERY_LIPO_CALIBRATION);
         }
 
+        void update(batteryConfig cfg)
+        {
+            if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage);
+            if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage);
+            if(cfg.calibration) this->setCapacity(cfg.calibration);
+            if(cfg.level) this->setLevel(cfg.level);
+            if(cfg.calibration) this->setCalibration(cfg.calibration);
+        }
+
         /**
          * LiPo batteries have a differnt dischargin curve, see 
          * https://blog.ampow.com/lipo-voltage-chart/
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index ab2ab908d..5cf6ac792 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -132,6 +132,7 @@ class UsermodBattery : public Usermod
       }
 
       bat->update(bcfg);
+
       nextReadTime = millis() + readingInterval;
       lastReadTime = millis();
 
@@ -316,7 +317,7 @@ class UsermodBattery : public Usermod
         battery[F("pin")] = batteryPin;
       #endif
 
-      battery[F("type")] = (String)bcfg.type;
+      battery[F("type")] = (String)bcfg.type; // has to be a String otherwise it won't get converted to a Dropdown
       battery[F("min-voltage")] = bat->getMinVoltage();
       battery[F("max-voltage")] = bat->getMaxVoltage();
       battery[F("capacity")] = bat->getCapacity();
@@ -404,9 +405,6 @@ class UsermodBattery : public Usermod
       getJsonValue(battery[F("capacity")], bcfg.capacity);
       getJsonValue(battery[F("calibration")], bcfg.calibration);
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
-      
-      // JsonArray type = battery[F("Type")];
-      // batteryType = type["bt"] | btype;
 
       JsonObject ao = battery[F("auto-off")];
       setAutoOffEnabled(ao[FPSTR(_enabled)] | autoOffEnabled);
@@ -444,7 +442,10 @@ class UsermodBattery : public Usermod
         }
       #endif
 
-      return !battery[F("min-voltage")].isNull();
+      if(initDone) 
+        bat->update(bcfg);
+
+      return !battery[FPSTR(_readInterval)].isNull();
     }
 
     /*

From d16f9efeecd9f182a150354479f885eb9e2d9bee Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Fri, 6 Jan 2023 19:09:12 +0100
Subject: [PATCH 06/18] =?UTF-8?q?Added=20forgotten=20file=20=F0=9F=98=A5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 usermods/Battery/unkown.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/usermods/Battery/unkown.h b/usermods/Battery/unkown.h
index 63b2674f3..f36c3195e 100644
--- a/usermods/Battery/unkown.h
+++ b/usermods/Battery/unkown.h
@@ -22,6 +22,14 @@ class Unkown : public Battery
             this->setCalibration(USERMOD_BATTERY_UNKOWN_CALIBRATION);
         }
 
+        void update(batteryConfig cfg)
+        {
+            if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage); else this->setMinVoltage(USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE);
+            if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage); else this->setMaxVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
+            if(cfg.calibration) this->setCapacity(cfg.calibration); else this->setCapacity(USERMOD_BATTERY_UNKOWN_CAPACITY);
+            if(cfg.calibration) this->setCalibration(cfg.calibration); else this->setCalibration(USERMOD_BATTERY_UNKOWN_CALIBRATION);
+        }
+
         float mapVoltage(float v, float min, float max) override
         {
             return this->linearMapping(v, min, max); // basic mapping

From bb82bf762fd4becdf6dc1ed92b4e97eb03e18aed Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Thu, 12 Jan 2023 21:50:46 +0100
Subject: [PATCH 07/18] Update Readme, my_config type config options with
 examples

---
 usermods/Battery/battery_defaults.h |  2 ++
 usermods/Battery/readme.md          | 16 +++++++++++-----
 2 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/usermods/Battery/battery_defaults.h b/usermods/Battery/battery_defaults.h
index f4060ca60..fbdaf4877 100644
--- a/usermods/Battery/battery_defaults.h
+++ b/usermods/Battery/battery_defaults.h
@@ -1,6 +1,8 @@
 #ifndef UMBDefaults_h
 #define UMBDefaults_h
 
+#include "wled.h"
+
 // pin defaults
 // for the esp32 it is best to use the ADC1: GPIO32 - GPIO39
 // https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/adc.html
diff --git a/usermods/Battery/readme.md b/usermods/Battery/readme.md
index d55573abe..1ca229763 100644
--- a/usermods/Battery/readme.md
+++ b/usermods/Battery/readme.md
@@ -36,13 +36,12 @@ define `USERMOD_BATTERY` in `wled00/my_config.h`
 | Name                                            | Unit        | Description                                                                           |
 | ----------------------------------------------- | ----------- |-------------------------------------------------------------------------------------- |
 | `USERMOD_BATTERY`                               |             | define this (in `my_config.h`) to have this usermod included wled00\usermods_list.cpp |
-| `USERMOD_BATTERY_USE_LIPO`                      |             | define this (in `my_config.h`) if you use LiPo rechargeables (1S)                     |
 | `USERMOD_BATTERY_MEASUREMENT_PIN`               |             | defaults to A0 on ESP8266 and GPIO35 on ESP32                                         |
 | `USERMOD_BATTERY_MEASUREMENT_INTERVAL`          | ms          | battery check interval. defaults to 30 seconds                                        |
-| `USERMOD_BATTERY_MIN_VOLTAGE`                   | v           | minimum battery voltage. default is 2.6 (18650 battery standard)                      |
-| `USERMOD_BATTERY_MAX_VOLTAGE`                   | v           | maximum battery voltage. default is 4.2 (18650 battery standard)                      |
-| `USERMOD_BATTERY_TOTAL_CAPACITY`                | mAh         | the capacity of all cells in parralel sumed up                                        |
-| `USERMOD_BATTERY_CALIBRATION`                   |             | offset / calibration number, fine tune the measured voltage by the microcontroller    |
+| `USERMOD_BATTERY_{TYPE}_MIN_VOLTAGE`            | v           | minimum battery voltage. default is 2.6 (18650 battery standard)                      |
+| `USERMOD_BATTERY_{TYPE}_MAX_VOLTAGE`            | v           | maximum battery voltage. default is 4.2 (18650 battery standard)                      |
+| `USERMOD_BATTERY_{TYPE}_TOTAL_CAPACITY`         | mAh         | the capacity of all cells in parralel sumed up                                        |
+| `USERMOD_BATTERY_{TYPE}_CALIBRATION`            |             | offset / calibration number, fine tune the measured voltage by the microcontroller    |
 | Auto-Off                                        | ---         | ---                                                                                   |
 | `USERMOD_BATTERY_AUTO_OFF_ENABLED`              | true/false  | enables auto-off                                                                      |
 | `USERMOD_BATTERY_AUTO_OFF_THRESHOLD`            | % (0-100)   | when this threshold is reached master power turns off                                 |
@@ -54,6 +53,13 @@ define `USERMOD_BATTERY` in `wled00/my_config.h`
 
 All parameters can be configured at runtime via the Usermods settings page.
 
+**NOTICE:** Each Battery type can be pre-configured individualy (in `my_config.h`)
+
+| Name            | Alias         | `my_config.h` example                 |
+| --------------- | ------------- | ------------------------------------- |
+| Lithium Polymer | lipo (Li-Po)  | `USERMOD_BATTERY_lipo_MIN_VOLTAGE`    |
+| Lithium Ionen   | lion (Li-Ion) | `USERMOD_BATTERY_lion_TOTAL_CAPACITY` |
+
 ## ⚠️ Important
 
 - Make sure you know your battery specifications! All batteries are **NOT** the same!

From f97b79bc16a5027d35219e015162c7b58e154ef9 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Sat, 21 Jan 2023 00:39:51 +0100
Subject: [PATCH 08/18] Exposing the Battery state to JSON API - Part 1

---
 usermods/Battery/battery_defaults.h   |  9 +--
 usermods/Battery/usermod_v2_Battery.h | 99 +++++++++++++++------------
 2 files changed, 62 insertions(+), 46 deletions(-)

diff --git a/usermods/Battery/battery_defaults.h b/usermods/Battery/battery_defaults.h
index fbdaf4877..092e3dd36 100644
--- a/usermods/Battery/battery_defaults.h
+++ b/usermods/Battery/battery_defaults.h
@@ -34,6 +34,7 @@
  *
  */
 #ifndef USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE
+  // Extra save defaults
   #define USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE 3.3f
 #endif
 #ifndef USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE
@@ -125,10 +126,10 @@ typedef struct bconfig_t
   batteryType type;
   float minVoltage;
   float maxVoltage;
-  unsigned int capacity; // current capacity
-  float voltage;                       // current voltage
-  int8_t level;                                     // current level
-  float calibration;        // offset or calibration value to fine tune the calculated voltage
+  unsigned int capacity;  // current capacity
+  float voltage;          // current voltage
+  int8_t level;           // current level
+  float calibration;      // offset or calibration value to fine tune the calculated voltage
 } batteryConfig;
 
 
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index bf123a79d..390bd96b4 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -30,17 +30,17 @@ class UsermodBattery : public Usermod
 
     // auto shutdown/shutoff/master off feature
     bool autoOffEnabled = USERMOD_BATTERY_AUTO_OFF_ENABLED;
-    int8_t autoOffThreshold = USERMOD_BATTERY_AUTO_OFF_THRESHOLD;
+    uint8_t autoOffThreshold = USERMOD_BATTERY_AUTO_OFF_THRESHOLD;
 
     // low power indicator feature
     bool lowPowerIndicatorEnabled = USERMOD_BATTERY_LOW_POWER_INDICATOR_ENABLED;
-    int8_t lowPowerIndicatorPreset = USERMOD_BATTERY_LOW_POWER_INDICATOR_PRESET;
-    int8_t lowPowerIndicatorThreshold = USERMOD_BATTERY_LOW_POWER_INDICATOR_THRESHOLD;
-    int8_t lowPowerIndicatorReactivationThreshold = lowPowerIndicatorThreshold+10;
-    int8_t lowPowerIndicatorDuration = USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION;
+    uint8_t lowPowerIndicatorPreset = USERMOD_BATTERY_LOW_POWER_INDICATOR_PRESET;
+    uint8_t lowPowerIndicatorThreshold = USERMOD_BATTERY_LOW_POWER_INDICATOR_THRESHOLD;
+    uint8_t lowPowerIndicatorReactivationThreshold = lowPowerIndicatorThreshold+10;
+    uint8_t lowPowerIndicatorDuration = USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION;
     bool lowPowerIndicationDone = false;
     unsigned long lowPowerActivationTime = 0; // used temporary during active time
-    int8_t lastPreset = 0;
+    uint8_t lastPreset = 0;
 
     bool initDone = false;
     bool initializing = true;
@@ -128,7 +128,7 @@ class UsermodBattery : public Usermod
       if(bcfg.type == (batteryType)lion) {
         bat = new Lion();
       } else {
-        bat = new Unkown(); // nullObject
+        bat = new Unkown(); // nullObject pattern
       }
 
       bat->update(bcfg);
@@ -181,7 +181,6 @@ class UsermodBattery : public Usermod
 #else
       // read battery raw input
       rawValue = analogRead(batteryPin);
-
       // calculate the voltage     
       voltage = ((rawValue / getAdcPrecision()) * bat->getMaxVoltage()) + bat->getCalibration();
 #endif
@@ -252,17 +251,42 @@ class UsermodBattery : public Usermod
       infoVoltage.add(F(" V"));
     }
 
+    void addBatteryToJsonObject(JsonObject& battery, bool forJsonState)
+    {
+      if(forJsonState) { battery[F("type")] = bcfg.type; } else {battery[F("type")] = (String)bcfg.type; }  // has to be a String otherwise it won't get converted to a Dropdown
+      battery[F("min-voltage")] = bat->getMinVoltage();
+      battery[F("max-voltage")] = bat->getMaxVoltage();
+      battery[F("capacity")] = bat->getCapacity();
+      battery[F("calibration")] = bat->getCalibration();
+      battery[FPSTR(_readInterval)] = readingInterval;
+
+      JsonObject ao = battery.createNestedObject(F("auto-off"));  // auto off section
+      ao[FPSTR(_enabled)] = autoOffEnabled;
+      ao[FPSTR(_threshold)] = autoOffThreshold;
+
+      JsonObject lp = battery.createNestedObject(F("indicator")); // low power section
+      lp[FPSTR(_enabled)] = lowPowerIndicatorEnabled;
+      lp[FPSTR(_preset)] = lowPowerIndicatorPreset; // dropdown trickery (String)lowPowerIndicatorPreset; 
+      lp[FPSTR(_threshold)] = lowPowerIndicatorThreshold;
+      lp[FPSTR(_duration)] = lowPowerIndicatorDuration;
+    }
 
     /*
      * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    /*
     void addToJsonState(JsonObject& root)
     {
-      // TBD
+      JsonObject battery = root.createNestedObject(FPSTR(_name));
+
+      if (battery.isNull()) {
+        battery = root.createNestedObject(FPSTR(_name));
+      }
+      
+      addBatteryToJsonObject(battery, true);
+      
+      DEBUG_PRINTLN(F("Battery state exposed in JSON API."));
     }
-    */
 
 
     /*
@@ -314,48 +338,39 @@ class UsermodBattery : public Usermod
      */
     void addToConfig(JsonObject& root)
     {
-      JsonObject battery = root.createNestedObject(FPSTR(_name));           // usermodname
+      JsonObject battery = root.createNestedObject(FPSTR(_name));
+      
+      if (battery.isNull()) {
+        battery = root.createNestedObject(FPSTR(_name));
+      }
+
       #ifdef ARDUINO_ARCH_ESP32
         battery[F("pin")] = batteryPin;
       #endif
-
-      battery[F("type")] = (String)bcfg.type; // has to be a String otherwise it won't get converted to a Dropdown
-      battery[F("min-voltage")] = bat->getMinVoltage();
-      battery[F("max-voltage")] = bat->getMaxVoltage();
-      battery[F("capacity")] = bat->getCapacity();
-      battery[F("calibration")] = bat->getCalibration();
-      battery[FPSTR(_readInterval)] = readingInterval;
       
-      JsonObject ao = battery.createNestedObject(F("auto-off"));  // auto off section
-      ao[FPSTR(_enabled)] = autoOffEnabled;
-      ao[FPSTR(_threshold)] = autoOffThreshold;
-
-      JsonObject lp = battery.createNestedObject(F("indicator")); // low power section
-      lp[FPSTR(_enabled)] = lowPowerIndicatorEnabled;
-      lp[FPSTR(_preset)] = lowPowerIndicatorPreset; // dropdown trickery (String)lowPowerIndicatorPreset; 
-      lp[FPSTR(_threshold)] = lowPowerIndicatorThreshold;
-      lp[FPSTR(_duration)] = lowPowerIndicatorDuration;
+      addBatteryToJsonObject(battery, false);
 
       DEBUG_PRINTLN(F("Battery config saved."));
     }
 
     void appendConfigData()
     {
-      oappend(SET_F("td=addDropdown('Battery', 'type');"));
-      oappend(SET_F("addOption(td, 'Unkown', '0');"));
-      oappend(SET_F("addOption(td, 'LiPo', '1');"));
-      oappend(SET_F("addOption(td, 'LiOn', '2');"));
-      oappend(SET_F("addInfo('Battery:type',1,'<small style=\"color:orange\">requires reboot</small>');"));
-      oappend(SET_F("addInfo('Battery:min-voltage', 1, 'v');"));
-      oappend(SET_F("addInfo('Battery:max-voltage', 1, 'v');"));
-      oappend(SET_F("addInfo('Battery:capacity', 1, 'mAh');"));
-      oappend(SET_F("addInfo('Battery:interval', 1, 'ms');"));
-      oappend(SET_F("addInfo('Battery:auto-off:threshold', 1, '%');"));
-      oappend(SET_F("addInfo('Battery:indicator:threshold', 1, '%');"));
-      oappend(SET_F("addInfo('Battery:indicator:duration', 1, 's');"));
+      // Total: 501 Bytes
+      oappend(SET_F("td=addDropdown('Battery', 'type');"));               // 35 Bytes
+      oappend(SET_F("addOption(td, 'Unkown', '0');"));                    // 30 Bytes
+      oappend(SET_F("addOption(td, 'LiPo', '1');"));                      // 28 Bytes
+      oappend(SET_F("addOption(td, 'LiOn', '2');"));                      // 28 Bytes
+      oappend(SET_F("addInfo('Battery:type',1,'<small style=\"color:orange\">requires reboot</small>');")); // 81 Bytes
+      oappend(SET_F("addInfo('Battery:min-voltage', 1, 'v');"));          // 40 Bytes
+      oappend(SET_F("addInfo('Battery:max-voltage', 1, 'v');"));          // 40 Bytes
+      oappend(SET_F("addInfo('Battery:capacity', 1, 'mAh');"));           // 39 Bytes
+      oappend(SET_F("addInfo('Battery:interval', 1, 'ms');"));            // 38 Bytes
+      oappend(SET_F("addInfo('Battery:auto-off:threshold', 1, '%');"));   // 47 Bytes
+      oappend(SET_F("addInfo('Battery:indicator:threshold', 1, '%');"));  // 48 Bytes
+      oappend(SET_F("addInfo('Battery:indicator:duration', 1, 's');"));   // 47 Bytes
       
-      // cannot quite get this mf to work. its exeeding some buffer limit i think
-      // what i wanted is a list of all presets to select one from
+      // this option list would exeed the oappend() buffer
+      // a list of all presets to select one from
       // oappend(SET_F("bd=addDropdown('Battery:low-power-indicator', 'preset');"));
       // the loop generates: oappend(SET_F("addOption(bd, 'preset name', preset id);"));
       // for(int8_t i=1; i < 42; i++) {

From f78f8b6b127203295cc0e22965c51a1f71415915 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Sat, 21 Jan 2023 01:44:50 +0100
Subject: [PATCH 09/18] Exposing the Battery state to JSON API - Part 2

---
 usermods/Battery/usermod_v2_Battery.h | 59 +++++++++++++++------------
 1 file changed, 34 insertions(+), 25 deletions(-)

diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index 390bd96b4..bd4d7778c 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -271,6 +271,30 @@ class UsermodBattery : public Usermod
       lp[FPSTR(_duration)] = lowPowerIndicatorDuration;
     }
 
+    void getUsermodConfigFromJsonObject(JsonObject& battery)
+    {
+      getJsonValue(battery[F("type")], bcfg.type);
+      getJsonValue(battery[F("min-voltage")], bcfg.minVoltage);
+      getJsonValue(battery[F("max-voltage")], bcfg.maxVoltage);
+      getJsonValue(battery[F("capacity")], bcfg.capacity);
+      getJsonValue(battery[F("calibration")], bcfg.calibration);
+      setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
+
+      JsonObject ao = battery[F("auto-off")];
+      setAutoOffEnabled(ao[FPSTR(_enabled)] | autoOffEnabled);
+      setAutoOffThreshold(ao[FPSTR(_threshold)] | autoOffThreshold);
+
+      JsonObject lp = battery[F("indicator")];
+      setLowPowerIndicatorEnabled(lp[FPSTR(_enabled)] | lowPowerIndicatorEnabled);
+      setLowPowerIndicatorPreset(lp[FPSTR(_preset)] | lowPowerIndicatorPreset);
+      setLowPowerIndicatorThreshold(lp[FPSTR(_threshold)] | lowPowerIndicatorThreshold);
+      lowPowerIndicatorReactivationThreshold = lowPowerIndicatorThreshold+10;
+      setLowPowerIndicatorDuration(lp[FPSTR(_duration)] | lowPowerIndicatorDuration);
+      
+      if(initDone) 
+        bat->update(bcfg);
+    }
+
     /*
      * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
@@ -296,7 +320,15 @@ class UsermodBattery : public Usermod
     /*
     void readFromJsonState(JsonObject& root)
     {
-      // TBD
+      if (!initDone) return;  // prevent crash on boot applyPreset()
+
+      JsonObject battery = root[FPSTR(_name)];
+
+      if (!battery.isNull()) {
+        getUsermodConfigFromJsonObject(battery);
+      
+        DEBUG_PRINTLN(F("Battery state read from JSON API."));
+      }
     }
     */
 
@@ -416,25 +448,7 @@ class UsermodBattery : public Usermod
         newBatteryPin     = battery[F("pin")] | newBatteryPin;
       #endif
 
-      getJsonValue(battery[F("type")], bcfg.type);
-      getJsonValue(battery[F("min-voltage")], bcfg.minVoltage);
-      getJsonValue(battery[F("max-voltage")], bcfg.maxVoltage);
-      getJsonValue(battery[F("capacity")], bcfg.capacity);
-      getJsonValue(battery[F("calibration")], bcfg.calibration);
-      setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
-
-      JsonObject ao = battery[F("auto-off")];
-      setAutoOffEnabled(ao[FPSTR(_enabled)] | autoOffEnabled);
-      setAutoOffThreshold(ao[FPSTR(_threshold)] | autoOffThreshold);
-
-      JsonObject lp = battery[F("indicator")];
-      setLowPowerIndicatorEnabled(lp[FPSTR(_enabled)] | lowPowerIndicatorEnabled);
-      setLowPowerIndicatorPreset(lp[FPSTR(_preset)] | lowPowerIndicatorPreset); // dropdown trickery (int)lp["preset"]
-      setLowPowerIndicatorThreshold(lp[FPSTR(_threshold)] | lowPowerIndicatorThreshold);
-      lowPowerIndicatorReactivationThreshold = lowPowerIndicatorThreshold+10;
-      setLowPowerIndicatorDuration(lp[FPSTR(_duration)] | lowPowerIndicatorDuration);
-
-      DEBUG_PRINT(FPSTR(_name));
+      getUsermodConfigFromJsonObject(battery);
 
       #ifdef ARDUINO_ARCH_ESP32
         if (!initDone) 
@@ -459,9 +473,6 @@ class UsermodBattery : public Usermod
         }
       #endif
 
-      if(initDone) 
-        bat->update(bcfg);
-
       return !battery[FPSTR(_readInterval)].isNull();
     }
 
@@ -578,7 +589,6 @@ class UsermodBattery : public Usermod
       autoOffThreshold  = lowPowerIndicatorEnabled /*&& autoOffEnabled*/ ? min(lowPowerIndicatorThreshold-1, (int)autoOffThreshold) : autoOffThreshold;
     }
 
-
     /*
      * Get low-power-indicator feature enabled status
      * is the low-power-indicator enabled, true/false
@@ -648,7 +658,6 @@ class UsermodBattery : public Usermod
       lowPowerIndicatorDuration = duration;
     }
 
-
     /*
      * Get low-power-indicator status when the indication is done thsi returns true
      */

From b8c61b52366a567d57860ada080c30ced9725777 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Sat, 9 Sep 2023 21:01:55 +0200
Subject: [PATCH 10/18] =?UTF-8?q?Move=20battery=20types=20to=20a=20separat?=
 =?UTF-8?q?e=20folder=20=F0=9F=93=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 usermods/Battery/battery.h            |  17 +----
 usermods/Battery/battery_defaults.h   |  16 +---
 usermods/Battery/{ => types}/lion.h   |   6 +-
 usermods/Battery/{ => types}/lipo.h   |  14 ++--
 usermods/Battery/{ => types}/unkown.h |   6 +-
 usermods/Battery/usermod_v2_Battery.h | 105 ++++++--------------------
 6 files changed, 37 insertions(+), 127 deletions(-)
 rename usermods/Battery/{ => types}/lion.h (87%)
 rename usermods/Battery/{ => types}/lipo.h (82%)
 rename usermods/Battery/{ => types}/unkown.h (83%)

diff --git a/usermods/Battery/battery.h b/usermods/Battery/battery.h
index 3a792aadb..8a8042ff3 100644
--- a/usermods/Battery/battery.h
+++ b/usermods/Battery/battery.h
@@ -14,7 +14,6 @@ class Battery
     protected:
         float minVoltage;
         float maxVoltage;
-        unsigned int capacity;
         float voltage;
         int8_t level = 100;
         float calibration; // offset or calibration value to fine tune the calculated voltage
@@ -34,7 +33,7 @@ class Battery
 
         /**
          * Corresponding battery curves
-         * calculates the capacity in % (0-100) with given voltage and possible voltage range
+         * calculates the level in % (0-100) with given voltage and possible voltage range
          */
         virtual float mapVoltage(float v, float min, float max) = 0;
         // { 
@@ -86,20 +85,6 @@ class Battery
             this->maxVoltage = max(getMinVoltage()+.5f, voltage);
         }
 
-        /*
-        * Get the capacity of all cells in parralel sumed up
-        * unit: mAh
-        */
-        unsigned int getCapacity()
-        {
-            return this->capacity;
-        }
-
-        void setCapacity(unsigned int capacity)
-        {
-            this->capacity = capacity;
-        }
-
         float getVoltage()
         {
             return this->voltage;
diff --git a/usermods/Battery/battery_defaults.h b/usermods/Battery/battery_defaults.h
index 668009680..199ee3432 100644
--- a/usermods/Battery/battery_defaults.h
+++ b/usermods/Battery/battery_defaults.h
@@ -40,9 +40,6 @@
 #ifndef USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE
   #define USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE 4.2f
 #endif
-#ifndef USERMOD_BATTERY_UNKOWN_CAPACITY
-  #define USERMOD_BATTERY_UNKOWN_CAPACITY 2500
-#endif
 #ifndef USERMOD_BATTERY_UNKOWN_CALIBRATION
   // offset or calibration value to fine tune the calculated voltage
   #define USERMOD_BATTERY_UNKOWN_CALIBRATION 0
@@ -59,9 +56,6 @@
 #ifndef USERMOD_BATTERY_LIPO_MAX_VOLTAGE
   #define USERMOD_BATTERY_LIPO_MAX_VOLTAGE 4.2f
 #endif
-#ifndef USERMOD_BATTERY_LIPO_CAPACITY
-  #define USERMOD_BATTERY_LIPO_CAPACITY 5000
-#endif
 #ifndef USERMOD_BATTERY_LIPO_CALIBRATION
   #define USERMOD_BATTERY_LIPO_CALIBRATION 0
 #endif
@@ -77,10 +71,6 @@
 #ifndef USERMOD_BATTERY_LION_MAX_VOLTAGE
   #define USERMOD_BATTERY_LION_MAX_VOLTAGE 4.2f
 #endif
-#ifndef USERMOD_BATTERY_LION_CAPACITY
-  // a common capacity for single 18650 battery cells is between 2500 and 3600 mAh
-  #define USERMOD_BATTERY_LION_CAPACITY 3100
-#endif
 #ifndef USERMOD_BATTERY_LION_CALIBRATION
   // offset or calibration value to fine tune the calculated voltage
   #define USERMOD_BATTERY_LION_CALIBRATION 0
@@ -109,11 +99,6 @@
   #define USERMOD_BATTERY_CALIBRATION 0
 #endif
 
-// calculate remaining time / the time that is left before the battery runs out of power
-// #ifndef USERMOD_BATTERY_CALCULATE_TIME_LEFT_ENABLED
-//   #define USERMOD_BATTERY_CALCULATE_TIME_LEFT_ENABLED false
-// #endif
-
 // auto-off feature
 #ifndef USERMOD_BATTERY_AUTO_OFF_ENABLED
   #define USERMOD_BATTERY_AUTO_OFF_ENABLED true
@@ -157,6 +142,7 @@ typedef struct bconfig_t
   float voltage;          // current voltage
   int8_t level;           // current level
   float calibration;      // offset or calibration value to fine tune the calculated voltage
+  float voltageMultiplier;
 } batteryConfig;
 
 
diff --git a/usermods/Battery/lion.h b/usermods/Battery/types/lion.h
similarity index 87%
rename from usermods/Battery/lion.h
rename to usermods/Battery/types/lion.h
index 17a4b3593..2ff54a1ea 100644
--- a/usermods/Battery/lion.h
+++ b/usermods/Battery/types/lion.h
@@ -1,8 +1,8 @@
 #ifndef UMBLion_h
 #define UMBLion_h
 
-#include "battery_defaults.h"
-#include "battery.h"
+#include "../battery_defaults.h"
+#include "../battery.h"
 
 /**
  *  Lion Battery
@@ -17,7 +17,6 @@ class Lion : public Battery
         {
             this->setMinVoltage(USERMOD_BATTERY_LION_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_LION_MAX_VOLTAGE);
-            this->setCapacity(USERMOD_BATTERY_LION_CAPACITY);
             this->setVoltage(this->getVoltage());
             this->setCalibration(USERMOD_BATTERY_LION_CALIBRATION);
         }
@@ -26,7 +25,6 @@ class Lion : public Battery
         {
             if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage);
             if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage);
-            if(cfg.calibration) this->setCapacity(cfg.calibration);
             if(cfg.level) this->setLevel(cfg.level);
             if(cfg.calibration) this->setCalibration(cfg.calibration);
         }
diff --git a/usermods/Battery/lipo.h b/usermods/Battery/types/lipo.h
similarity index 82%
rename from usermods/Battery/lipo.h
rename to usermods/Battery/types/lipo.h
index dcd44567f..264d3251e 100644
--- a/usermods/Battery/lipo.h
+++ b/usermods/Battery/types/lipo.h
@@ -1,8 +1,8 @@
 #ifndef UMBLipo_h
 #define UMBLipo_h
 
-#include "battery_defaults.h"
-#include "battery.h"
+#include "../battery_defaults.h"
+#include "../battery.h"
 
 /**
  *  Lipo Battery
@@ -17,7 +17,6 @@ class Lipo : public Battery
         {
             this->setMinVoltage(USERMOD_BATTERY_LIPO_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_LIPO_MAX_VOLTAGE);
-            this->setCapacity(USERMOD_BATTERY_LIPO_CAPACITY);
             this->setVoltage(this->getVoltage());
             this->setCalibration(USERMOD_BATTERY_LIPO_CALIBRATION);
         }
@@ -26,13 +25,12 @@ class Lipo : public Battery
         {
             if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage);
             if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage);
-            if(cfg.calibration) this->setCapacity(cfg.calibration);
             if(cfg.level) this->setLevel(cfg.level);
             if(cfg.calibration) this->setCalibration(cfg.calibration);
         }
 
         /**
-         * LiPo batteries have a differnt dischargin curve, see 
+         * LiPo batteries have a differnt discharge curve, see 
          * https://blog.ampow.com/lipo-voltage-chart/
          */
         float mapVoltage(float v, float min, float max) override 
@@ -41,12 +39,12 @@ class Lipo : public Battery
             lvl = this->linearMapping(v, min, max); // basic mapping
 
             if (lvl < 40.0f) 
-                lvl = this->linearMapping(lvl, 0, 40, 0, 12);         // last 45% -> drops very quickly
+                lvl = this->linearMapping(lvl, 0, 40, 0, 12);       // last 45% -> drops very quickly
             else {
             if (lvl < 90.0f)
-                lvl = this->linearMapping(lvl, 40, 90, 12, 95);   // 90% ... 40% -> almost linear drop
+                lvl = this->linearMapping(lvl, 40, 90, 12, 95);     // 90% ... 40% -> almost linear drop
             else // level >  90%
-                lvl = this->linearMapping(lvl, 90, 105, 95, 100); // highest 15% -> drop slowly
+                lvl = this->linearMapping(lvl, 90, 105, 95, 100);   // highest 15% -> drop slowly
             }
 
             return lvl;
diff --git a/usermods/Battery/unkown.h b/usermods/Battery/types/unkown.h
similarity index 83%
rename from usermods/Battery/unkown.h
rename to usermods/Battery/types/unkown.h
index f36c3195e..2b38da96c 100644
--- a/usermods/Battery/unkown.h
+++ b/usermods/Battery/types/unkown.h
@@ -1,8 +1,8 @@
 #ifndef UMBUnkown_h
 #define UMBUnkown_h
 
-#include "battery_defaults.h"
-#include "battery.h"
+#include "../battery_defaults.h"
+#include "../battery.h"
 
 /**
  *  Lion Battery
@@ -17,7 +17,6 @@ class Unkown : public Battery
         {
             this->setMinVoltage(USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
-            this->setCapacity(USERMOD_BATTERY_UNKOWN_CAPACITY);
             this->setVoltage(this->getVoltage());
             this->setCalibration(USERMOD_BATTERY_UNKOWN_CALIBRATION);
         }
@@ -26,7 +25,6 @@ class Unkown : public Battery
         {
             if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage); else this->setMinVoltage(USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE);
             if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage); else this->setMaxVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
-            if(cfg.calibration) this->setCapacity(cfg.calibration); else this->setCapacity(USERMOD_BATTERY_UNKOWN_CAPACITY);
             if(cfg.calibration) this->setCalibration(cfg.calibration); else this->setCalibration(USERMOD_BATTERY_UNKOWN_CALIBRATION);
         }
 
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index 7f6738e10..a91331cb7 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -3,9 +3,9 @@
 #include "wled.h"
 #include "battery_defaults.h"
 #include "battery.h"
-#include "unkown.h"
-#include "lion.h"
-#include "lipo.h"
+#include "types/unkown.h"
+#include "types/lion.h"
+#include "types/lipo.h"
 
 /*
  * Usermod by Maximilian Mewes
@@ -28,7 +28,7 @@ class UsermodBattery : public Usermod
     unsigned long nextReadTime = 0;
     unsigned long lastReadTime = 0;
     // battery min. voltage
-    float minBatteryVoltage = USERMOD_BATTERY_MIN_VOLTAGE;
+    float minBatteryVoltage = 3.3f;
     // battery max. voltage
     float maxBatteryVoltage = USERMOD_BATTERY_MAX_VOLTAGE;
     // all battery cells summed up
@@ -39,16 +39,10 @@ class UsermodBattery : public Usermod
     float voltage = maxBatteryVoltage;
     // between 0 and 1, to control strength of voltage smoothing filter
     float alpha = 0.05f;
-    // multiplier for the voltage divider that is in place between ADC pin and battery, default will be 2 but might be adapted to readout voltages over ~5v ESP32 or ~6.6v ESP8266
-    float voltageMultiplier = USERMOD_BATTERY_VOLTAGE_MULTIPLIER;
     // mapped battery level based on voltage
     int8_t batteryLevel = 100;
     // offset or calibration value to fine tune the calculated voltage
     float calibration = USERMOD_BATTERY_CALIBRATION;
-    
-    // time left estimation feature
-    // bool calculateTimeLeftEnabled = USERMOD_BATTERY_CALCULATE_TIME_LEFT_ENABLED;
-    // float estimatedTimeLeft = 0.0;
 
     // auto shutdown/shutoff/master off feature
     bool autoOffEnabled = USERMOD_BATTERY_AUTO_OFF_ENABLED;
@@ -114,18 +108,22 @@ class UsermodBattery : public Usermod
       }      
     }
 
-    float readVoltage()
-    {
-      #ifdef ARDUINO_ARCH_ESP32
-        // use calibrated millivolts analogread on esp32 (150 mV ~ 2450 mV default attentuation) and divide by 1000 to get from milivolts to volts and multiply by voltage multiplier and apply calibration value
-        return (analogReadMilliVolts(batteryPin) / 1000.0f) * voltageMultiplier  + calibration;
-      #else
-        // use analog read on esp8266 ( 0V ~ 1V no attenuation options) and divide by ADC precision 1023 and multiply by voltage multiplier and apply calibration value
-        return (analogRead(batteryPin) / 1023.0f) * voltageMultiplier + calibration;
-      #endif
-    }
+    // float readVoltage()
+    // {
+    //   #ifdef ARDUINO_ARCH_ESP32
+    //     // use calibrated millivolts analogread on esp32 (150 mV ~ 2450 mV default attentuation) and divide by 1000 to get from milivolts to volts and multiply by voltage multiplier and apply calibration value
+    //     return (analogReadMilliVolts(batteryPin) / 1000.0f) * voltageMultiplier  + calibration;
+    //   #else
+    //     // use analog read on esp8266 ( 0V ~ 1V no attenuation options) and divide by ADC precision 1023 and multiply by voltage multiplier and apply calibration value
+    //     return (analogRead(batteryPin) / 1023.0f) * voltageMultiplier + calibration;
+    //   #endif
+    // }
 
   public:
+    UsermodBattery()
+    {
+      bat = new Unkown();
+    }
     //Functions called by WLED
 
     /*
@@ -152,14 +150,13 @@ class UsermodBattery : public Usermod
         }
       #else //ESP8266 boards have only one analog input pin A0
         pinMode(batteryPin, INPUT);
-        voltage = readVoltage();
+        // voltage = readVoltage();
       #endif
 
       //this could also be handled with a factory class but for only 2 types it should be sufficient for now
       if(bcfg.type == (batteryType)lipo) {
         bat = new Lipo();
-      } else 
-      if(bcfg.type == (batteryType)lion) {
+      } else if(bcfg.type == (batteryType)lion) {
         bat = new Lion();
       } else {
         bat = new Unkown(); // nullObject pattern
@@ -218,14 +215,8 @@ class UsermodBattery : public Usermod
       // calculate the voltage     
       voltage = ((rawValue / getAdcPrecision()) * bat->getMaxVoltage()) + bat->getCalibration();
 #endif
-      // initializing = false;
-
-      // rawValue = readVoltage();
-      // // filter with exponential smoothing because ADC in esp32 is fluctuating too much for a good single readout
-      // voltage = voltage + alpha * (rawValue - voltage);
-
-      // check if voltage is within specified voltage range, allow 10% over/under voltage - removed cause this just makes it hard for people to troubleshoot as the voltage in the web gui will say invalid instead of displaying a voltage
-      //voltage = ((voltage < minBatteryVoltage * 0.85f) || (voltage > maxBatteryVoltage * 1.1f)) ? -1.0f : voltage;
+      // filter with exponential smoothing because ADC in esp32 is fluctuating too much for a good single readout
+      voltage = voltage + alpha * (rawValue - voltage);
 
       bat->setVoltage(voltage);
       // translate battery voltage into percentage
@@ -298,7 +289,6 @@ class UsermodBattery : public Usermod
       if(forJsonState) { battery[F("type")] = bcfg.type; } else {battery[F("type")] = (String)bcfg.type; }  // has to be a String otherwise it won't get converted to a Dropdown
       battery[F("min-voltage")] = bat->getMinVoltage();
       battery[F("max-voltage")] = bat->getMaxVoltage();
-      battery[F("capacity")] = bat->getCapacity();
       battery[F("calibration")] = bat->getCalibration();
       battery[FPSTR(_readInterval)] = readingInterval;
 
@@ -318,8 +308,8 @@ class UsermodBattery : public Usermod
       getJsonValue(battery[F("type")], bcfg.type);
       getJsonValue(battery[F("min-voltage")], bcfg.minVoltage);
       getJsonValue(battery[F("max-voltage")], bcfg.maxVoltage);
-      getJsonValue(battery[F("capacity")], bcfg.capacity);
       getJsonValue(battery[F("calibration")], bcfg.calibration);
+    
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
 
       JsonObject ao = battery[F("auto-off")];
@@ -421,26 +411,18 @@ class UsermodBattery : public Usermod
       #ifdef ARDUINO_ARCH_ESP32
         battery[F("pin")] = batteryPin;
       #endif
-
-      // battery[F("time-left")] = calculateTimeLeftEnabled;
-      battery[F("min-voltage")] = minBatteryVoltage;
-      battery[F("max-voltage")] = maxBatteryVoltage;
-      battery[F("capacity")] = totalBatteryCapacity;
-      battery[F("calibration")] = calibration;
-      battery[F("voltage-multiplier")] = voltageMultiplier;
-      battery[FPSTR(_readInterval)] = readingInterval;
       
       addBatteryToJsonObject(battery, false);
 
       // read voltage in case calibration or voltage multiplier changed to see immediate effect
-      voltage = readVoltage();
+      // voltage = readVoltage();
 
       DEBUG_PRINTLN(F("Battery config saved."));
     }
 
     void appendConfigData()
     {
-      // Total: 501 Bytes
+      // Total: 462 Bytes
       oappend(SET_F("td=addDropdown('Battery', 'type');"));               // 35 Bytes
       oappend(SET_F("addOption(td, 'Unkown', '0');"));                    // 30 Bytes
       oappend(SET_F("addOption(td, 'LiPo', '1');"));                      // 28 Bytes
@@ -448,7 +430,6 @@ class UsermodBattery : public Usermod
       oappend(SET_F("addInfo('Battery:type',1,'<small style=\"color:orange\">requires reboot</small>');")); // 81 Bytes
       oappend(SET_F("addInfo('Battery:min-voltage', 1, 'v');"));          // 40 Bytes
       oappend(SET_F("addInfo('Battery:max-voltage', 1, 'v');"));          // 40 Bytes
-      oappend(SET_F("addInfo('Battery:capacity', 1, 'mAh');"));           // 39 Bytes
       oappend(SET_F("addInfo('Battery:interval', 1, 'ms');"));            // 38 Bytes
       oappend(SET_F("addInfo('Battery:auto-off:threshold', 1, '%');"));   // 47 Bytes
       oappend(SET_F("addInfo('Battery:indicator:threshold', 1, '%');"));  // 48 Bytes
@@ -503,9 +484,7 @@ class UsermodBattery : public Usermod
       // calculateTimeLeftEnabled = battery[F("time-left")] | calculateTimeLeftEnabled;
       setMinBatteryVoltage(battery[F("min-voltage")] | minBatteryVoltage);
       setMaxBatteryVoltage(battery[F("max-voltage")] | maxBatteryVoltage);
-      setTotalBatteryCapacity(battery[F("capacity")] | totalBatteryCapacity);
       setCalibration(battery[F("calibration")] | calibration);
-      setVoltageMultiplier(battery[F("voltage-multiplier")] | voltageMultiplier);
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
 
       getUsermodConfigFromJsonObject(battery);
@@ -655,22 +634,6 @@ class UsermodBattery : public Usermod
     }
 
 
-    /*
-     * Get the capacity of all cells in parralel sumed up
-     * unit: mAh
-     */
-    unsigned int getTotalBatteryCapacity()
-    {
-      return totalBatteryCapacity;
-    }
-
-    void setTotalBatteryCapacity(unsigned int capacity)
-    {
-      totalBatteryCapacity = capacity;
-    }
-
-
-
     /*
      * Get the calculated voltage
      * formula: (adc pin value / adc precision * max voltage) + calibration
@@ -707,24 +670,6 @@ class UsermodBattery : public Usermod
       calibration = offset;
     }
 
-    /*
-     * Set the voltage multiplier value
-     * A multiplier that may need adjusting for different voltage divider setups
-     */
-    void setVoltageMultiplier(float multiplier)
-    {
-      voltageMultiplier = multiplier;
-    }
-
-    /*
-     * Get the voltage multiplier value
-     * A multiplier that may need adjusting for different voltage divider setups
-     */
-    float getVoltageMultiplier()
-    {
-      return voltageMultiplier;
-    }
-
     /*
      * Get auto-off feature enabled status
      * is auto-off enabled, true/false

From a9d6a1592412a6f901afecc1e9e4e8934ef46b13 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Sat, 9 Sep 2023 21:50:30 +0200
Subject: [PATCH 11/18] Update Classes

---
 usermods/Battery/battery.h            |  23 ++-
 usermods/Battery/battery_defaults.h   |  25 +---
 usermods/Battery/types/lion.h         |   3 +-
 usermods/Battery/types/lipo.h         |   3 +-
 usermods/Battery/types/unkown.h       |   4 +-
 usermods/Battery/usermod_v2_Battery.h | 208 ++++++++++----------------
 6 files changed, 111 insertions(+), 155 deletions(-)

diff --git a/usermods/Battery/battery.h b/usermods/Battery/battery.h
index 8a8042ff3..4cdfb035f 100644
--- a/usermods/Battery/battery.h
+++ b/usermods/Battery/battery.h
@@ -17,6 +17,7 @@ class Battery
         float voltage;
         int8_t level = 100;
         float calibration; // offset or calibration value to fine tune the calculated voltage
+        float voltageMultiplier; // ratio for the voltage divider
         
         float linearMapping(float v, float min, float max, float oMin = 0.0f, float oMax = 100.0f)
         {
@@ -26,7 +27,9 @@ class Battery
     public:
         Battery()
         {
-
+            this->setVoltage(this->getVoltage());
+            this->setVoltageMultiplier(USERMOD_BATTERY_VOLTAGE_MULTIPLIER);
+            this->setCalibration(USERMOD_BATTERY_CALIBRATION);
         }
 
         virtual void update(batteryConfig cfg) = 0;
@@ -127,6 +130,24 @@ class Battery
         {
             calibration = offset;
         }
+
+        /*
+        * Get the configured calibration value
+        * a value to set the voltage divider ratio
+        */
+        virtual float getVoltageMultiplier()
+        {
+            return voltageMultiplier;
+        }
+
+        /*
+        * Set the voltage multiplier value
+        * a value to set the voltage divider ratio.
+        */
+        virtual void setVoltageMultiplier(float multiplier)
+        {
+            voltageMultiplier = voltageMultiplier;
+        }
 };
 
 #endif
\ No newline at end of file
diff --git a/usermods/Battery/battery_defaults.h b/usermods/Battery/battery_defaults.h
index 199ee3432..6d0a95dc4 100644
--- a/usermods/Battery/battery_defaults.h
+++ b/usermods/Battery/battery_defaults.h
@@ -40,10 +40,7 @@
 #ifndef USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE
   #define USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE 4.2f
 #endif
-#ifndef USERMOD_BATTERY_UNKOWN_CALIBRATION
-  // offset or calibration value to fine tune the calculated voltage
-  #define USERMOD_BATTERY_UNKOWN_CALIBRATION 0
-#endif
+
 /*
  *
  *  Lithium polymer (Li-Po) defaults
@@ -56,9 +53,7 @@
 #ifndef USERMOD_BATTERY_LIPO_MAX_VOLTAGE
   #define USERMOD_BATTERY_LIPO_MAX_VOLTAGE 4.2f
 #endif
-#ifndef USERMOD_BATTERY_LIPO_CALIBRATION
-  #define USERMOD_BATTERY_LIPO_CALIBRATION 0
-#endif
+
 /*
  *
  *  Lithium-ion (Li-Ion) defaults
@@ -71,12 +66,8 @@
 #ifndef USERMOD_BATTERY_LION_MAX_VOLTAGE
   #define USERMOD_BATTERY_LION_MAX_VOLTAGE 4.2f
 #endif
-#ifndef USERMOD_BATTERY_LION_CALIBRATION
-  // offset or calibration value to fine tune the calculated voltage
-  #define USERMOD_BATTERY_LION_CALIBRATION 0
-#endif
 
-//the default ratio for the voltage divider
+// the default ratio for the voltage divider
 #ifndef USERMOD_BATTERY_VOLTAGE_MULTIPLIER
   #ifdef ARDUINO_ARCH_ESP32
     #define USERMOD_BATTERY_VOLTAGE_MULTIPLIER 2.0f
@@ -85,13 +76,8 @@
   #endif
 #endif
 
-#ifndef USERMOD_BATTERY_MAX_VOLTAGE
-  #define USERMOD_BATTERY_MAX_VOLTAGE 4.2f
-#endif
-
-// a common capacity for single 18650 battery cells is between 2500 and 3600 mAh
-#ifndef USERMOD_BATTERY_TOTAL_CAPACITY
-  #define USERMOD_BATTERY_TOTAL_CAPACITY 3100
+#ifndef USERMOD_BATTERY_AVERAGING_ALPHA
+  #define USERMOD_BATTERY_AVERAGING_ALPHA 0.1f
 #endif
 
 // offset or calibration value to fine tune the calculated voltage
@@ -138,7 +124,6 @@ typedef struct bconfig_t
   batteryType type;
   float minVoltage;
   float maxVoltage;
-  unsigned int capacity;  // current capacity
   float voltage;          // current voltage
   int8_t level;           // current level
   float calibration;      // offset or calibration value to fine tune the calculated voltage
diff --git a/usermods/Battery/types/lion.h b/usermods/Battery/types/lion.h
index 2ff54a1ea..0d2325386 100644
--- a/usermods/Battery/types/lion.h
+++ b/usermods/Battery/types/lion.h
@@ -14,11 +14,10 @@ class Lion : public Battery
 
     public:
         Lion()
+        : Battery()
         {
             this->setMinVoltage(USERMOD_BATTERY_LION_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_LION_MAX_VOLTAGE);
-            this->setVoltage(this->getVoltage());
-            this->setCalibration(USERMOD_BATTERY_LION_CALIBRATION);
         }
 
         void update(batteryConfig cfg)
diff --git a/usermods/Battery/types/lipo.h b/usermods/Battery/types/lipo.h
index 264d3251e..f65ab12c5 100644
--- a/usermods/Battery/types/lipo.h
+++ b/usermods/Battery/types/lipo.h
@@ -14,11 +14,10 @@ class Lipo : public Battery
 
     public:
         Lipo()
+        : Battery()
         {
             this->setMinVoltage(USERMOD_BATTERY_LIPO_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_LIPO_MAX_VOLTAGE);
-            this->setVoltage(this->getVoltage());
-            this->setCalibration(USERMOD_BATTERY_LIPO_CALIBRATION);
         }
 
         void update(batteryConfig cfg)
diff --git a/usermods/Battery/types/unkown.h b/usermods/Battery/types/unkown.h
index 2b38da96c..edf220040 100644
--- a/usermods/Battery/types/unkown.h
+++ b/usermods/Battery/types/unkown.h
@@ -14,18 +14,16 @@ class Unkown : public Battery
 
     public:
         Unkown()
+        : Battery()
         {
             this->setMinVoltage(USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
-            this->setVoltage(this->getVoltage());
-            this->setCalibration(USERMOD_BATTERY_UNKOWN_CALIBRATION);
         }
 
         void update(batteryConfig cfg)
         {
             if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage); else this->setMinVoltage(USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE);
             if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage); else this->setMaxVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
-            if(cfg.calibration) this->setCalibration(cfg.calibration); else this->setCalibration(USERMOD_BATTERY_UNKOWN_CALIBRATION);
         }
 
         float mapVoltage(float v, float min, float max) override
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index a91331cb7..9b980d557 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -20,27 +20,15 @@ class UsermodBattery : public Usermod
     // battery pin can be defined in my_config.h
     int8_t batteryPin = USERMOD_BATTERY_MEASUREMENT_PIN;
     
-    Battery* bat = nullptr;
-    batteryConfig bcfg;
+    Battery* bat = new Unkown();
+    batteryConfig cfg;
 
     // how often to read the battery voltage
     unsigned long readingInterval = USERMOD_BATTERY_MEASUREMENT_INTERVAL;
     unsigned long nextReadTime = 0;
     unsigned long lastReadTime = 0;
-    // battery min. voltage
-    float minBatteryVoltage = 3.3f;
-    // battery max. voltage
-    float maxBatteryVoltage = USERMOD_BATTERY_MAX_VOLTAGE;
-    // all battery cells summed up
-    unsigned int totalBatteryCapacity = USERMOD_BATTERY_TOTAL_CAPACITY;
-    // raw analog reading 
-    float rawValue = 0.0f;
-    // calculated voltage            
-    float voltage = maxBatteryVoltage;
     // between 0 and 1, to control strength of voltage smoothing filter
-    float alpha = 0.05f;
-    // mapped battery level based on voltage
-    int8_t batteryLevel = 100;
+    float alpha = USERMOD_BATTERY_AVERAGING_ALPHA;
     // offset or calibration value to fine tune the calculated voltage
     float calibration = USERMOD_BATTERY_CALIBRATION;
 
@@ -70,13 +58,16 @@ class UsermodBattery : public Usermod
     static const char _duration[];
     static const char _init[];
 
+    /**
+     * Helper for rounding floating point values 
+     */
     float dot2round(float x) 
     {
       float nx = (int)(x * 100 + .5);
       return (float)(nx / 100);
     }
 
-    /*
+    /**
      * Turn off all leds
      */
     void turnOff()
@@ -85,7 +76,7 @@ class UsermodBattery : public Usermod
       stateUpdated(CALL_MODE_DIRECT_CHANGE);
     }
 
-    /*
+    /**
      * Indicate low power by activating a configured preset for a given time and then switching back to the preset that was selected previously
      */
     void lowPowerIndicator()
@@ -108,25 +99,24 @@ class UsermodBattery : public Usermod
       }      
     }
 
-    // float readVoltage()
-    // {
-    //   #ifdef ARDUINO_ARCH_ESP32
-    //     // use calibrated millivolts analogread on esp32 (150 mV ~ 2450 mV default attentuation) and divide by 1000 to get from milivolts to volts and multiply by voltage multiplier and apply calibration value
-    //     return (analogReadMilliVolts(batteryPin) / 1000.0f) * voltageMultiplier  + calibration;
-    //   #else
-    //     // use analog read on esp8266 ( 0V ~ 1V no attenuation options) and divide by ADC precision 1023 and multiply by voltage multiplier and apply calibration value
-    //     return (analogRead(batteryPin) / 1023.0f) * voltageMultiplier + calibration;
-    //   #endif
-    // }
+    /**
+     * read the battery voltage in different ways depending on the architecture 
+     */
+    float readVoltage()
+    {
+      #ifdef ARDUINO_ARCH_ESP32
+        // use calibrated millivolts analogread on esp32 (150 mV ~ 2450 mV default attentuation) and divide by 1000 to get from milivolts to volts and multiply by voltage multiplier and apply calibration value
+        return (analogReadMilliVolts(batteryPin) / 1000.0f) * bat->getVoltageMultiplier()  + bat->getCalibration();
+      #else
+        // use analog read on esp8266 ( 0V ~ 1V no attenuation options) and divide by ADC precision 1023 and multiply by voltage multiplier and apply calibration value
+        return (analogRead(batteryPin) / 1023.0f) * bat->getVoltageMultiplier() + bat->getCalibration();
+      #endif
+    }
 
   public:
-    UsermodBattery()
-    {
-      bat = new Unkown();
-    }
     //Functions called by WLED
 
-    /*
+    /**
      * setup() is called once at boot. WiFi is not yet connected at this point.
      * You can use it to initialize variables, sensors or similar.
      */
@@ -153,16 +143,15 @@ class UsermodBattery : public Usermod
         // voltage = readVoltage();
       #endif
 
-      //this could also be handled with a factory class but for only 2 types it should be sufficient for now
-      if(bcfg.type == (batteryType)lipo) {
+      // plug in the right battery type
+      if(cfg.type == (batteryType)lipo) {
         bat = new Lipo();
-      } else if(bcfg.type == (batteryType)lion) {
+      } else if(cfg.type == (batteryType)lion) {
         bat = new Lion();
-      } else {
-        bat = new Unkown(); // nullObject pattern
       }
 
-      bat->update(bcfg);
+      // update the choosen battery type with configured values
+      bat->update(cfg);
 
       nextReadTime = millis() + readingInterval;
       lastReadTime = millis();
@@ -171,7 +160,7 @@ class UsermodBattery : public Usermod
     }
 
 
-    /*
+    /**
      * connected() is called every time the WiFi is (re)connected
      * Use it to initialize network interfaces
      */
@@ -199,28 +188,15 @@ class UsermodBattery : public Usermod
 
       if (batteryPin < 0) return;  // nothing to read
 
-      initializing = false;     
-      float voltage = -1.0f;
-      float rawValue = 0.0f;
-#ifdef ARDUINO_ARCH_ESP32
-      // use calibrated millivolts analogread on esp32 (150 mV ~ 2450 mV)
-      rawValue = analogReadMilliVolts(batteryPin);
-      // calculate the voltage
-      voltage = (rawValue / 1000.0f) + calibration;
-      // usually a voltage divider (50%) is used on ESP32, so we need to multiply by 2
-      voltage *= 2.0f;
-#else
-      // read battery raw input
-      rawValue = analogRead(batteryPin);
-      // calculate the voltage     
-      voltage = ((rawValue / getAdcPrecision()) * bat->getMaxVoltage()) + bat->getCalibration();
-#endif
-      // filter with exponential smoothing because ADC in esp32 is fluctuating too much for a good single readout
-      voltage = voltage + alpha * (rawValue - voltage);
+      initializing = false;
+      float rawValue = readVoltage();
 
-      bat->setVoltage(voltage);
+      // filter with exponential smoothing because ADC in esp32 is fluctuating too much for a good single readout
+      float filteredVoltage = bat->getVoltage() + alpha * (rawValue - bat->getVoltage());
+
+      bat->setVoltage(filteredVoltage);
       // translate battery voltage into percentage
-      bat->calculateAndSetLevel(voltage);
+      bat->calculateAndSetLevel(filteredVoltage);
 
       // Auto off -- Master power off
       if (autoOffEnabled && (autoOffThreshold >= bat->getLevel()))
@@ -232,13 +208,13 @@ class UsermodBattery : public Usermod
       if (WLED_MQTT_CONNECTED) {
         char buf[64]; // buffer for snprintf()
         snprintf_P(buf, 63, PSTR("%s/voltage"), mqttDeviceTopic);
-        mqtt->publish(buf, 0, false, String(voltage).c_str());
+        mqtt->publish(buf, 0, false, String(bat->getVoltage()).c_str());
       }
 #endif
 
     }
 
-    /*
+    /**
      * addToJsonInfo() can be used to add custom entries to the /json/info part of the JSON API.
      * Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
      * Below it is shown how this could be used for e.g. a light sensor
@@ -286,7 +262,7 @@ class UsermodBattery : public Usermod
 
     void addBatteryToJsonObject(JsonObject& battery, bool forJsonState)
     {
-      if(forJsonState) { battery[F("type")] = bcfg.type; } else {battery[F("type")] = (String)bcfg.type; }  // has to be a String otherwise it won't get converted to a Dropdown
+      if(forJsonState) { battery[F("type")] = cfg.type; } else {battery[F("type")] = (String)cfg.type; }  // has to be a String otherwise it won't get converted to a Dropdown
       battery[F("min-voltage")] = bat->getMinVoltage();
       battery[F("max-voltage")] = bat->getMaxVoltage();
       battery[F("calibration")] = bat->getCalibration();
@@ -305,10 +281,10 @@ class UsermodBattery : public Usermod
 
     void getUsermodConfigFromJsonObject(JsonObject& battery)
     {
-      getJsonValue(battery[F("type")], bcfg.type);
-      getJsonValue(battery[F("min-voltage")], bcfg.minVoltage);
-      getJsonValue(battery[F("max-voltage")], bcfg.maxVoltage);
-      getJsonValue(battery[F("calibration")], bcfg.calibration);
+      getJsonValue(battery[F("type")], cfg.type);
+      getJsonValue(battery[F("min-voltage")], cfg.minVoltage);
+      getJsonValue(battery[F("max-voltage")], cfg.maxVoltage);
+      getJsonValue(battery[F("calibration")], cfg.calibration);
     
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
 
@@ -324,10 +300,10 @@ class UsermodBattery : public Usermod
       setLowPowerIndicatorDuration(lp[FPSTR(_duration)] | lowPowerIndicatorDuration);
       
       if(initDone) 
-        bat->update(bcfg);
+        bat->update(cfg);
     }
 
-    /*
+    /**
      * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
@@ -345,7 +321,7 @@ class UsermodBattery : public Usermod
     }
 
 
-    /*
+    /**
      * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
@@ -365,7 +341,7 @@ class UsermodBattery : public Usermod
     */
 
 
-    /*
+    /**
      * addToConfig() can be used to add custom persistent settings to the cfg.json file in the "um" (usermod) object.
      * It will be called by WLED when settings are actually saved (for example, LED settings are saved)
      * If you want to force saving the current state, use serializeConfig() in your loop().
@@ -449,7 +425,7 @@ class UsermodBattery : public Usermod
     }
 
 
-    /*
+    /**
      * readFromConfig() can be used to read back the custom settings you added with addToConfig().
      * This is called by WLED when settings are loaded (currently this only happens immediately after boot, or after saving on the Usermod Settings page)
      * 
@@ -482,8 +458,8 @@ class UsermodBattery : public Usermod
         newBatteryPin     = battery[F("pin")] | newBatteryPin;
       #endif
       // calculateTimeLeftEnabled = battery[F("time-left")] | calculateTimeLeftEnabled;
-      setMinBatteryVoltage(battery[F("min-voltage")] | minBatteryVoltage);
-      setMaxBatteryVoltage(battery[F("max-voltage")] | maxBatteryVoltage);
+      setMinBatteryVoltage(battery[F("min-voltage")] | bat->getMinVoltage());
+      setMaxBatteryVoltage(battery[F("max-voltage")] | bat->getMaxVoltage());
       setCalibration(battery[F("calibration")] | calibration);
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
 
@@ -515,7 +491,7 @@ class UsermodBattery : public Usermod
       return !battery[FPSTR(_readInterval)].isNull();
     }
 
-    /*
+    /**
      * TBD: Generate a preset sample for low power indication
      * a button on the config page would be cool, currently not possible
      */
@@ -554,7 +530,7 @@ class UsermodBattery : public Usermod
      *
      */
 
-    /*
+    /**
      * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
      * This could be used in the future for the system to determine whether your usermod is installed.
      */
@@ -569,7 +545,7 @@ class UsermodBattery : public Usermod
       return readingInterval;
     }
 
-    /*
+    /**
      * minimum repetition is 3000ms (3s) 
      */
     void setReadingInterval(unsigned long newReadingInterval)
@@ -577,100 +553,78 @@ class UsermodBattery : public Usermod
       readingInterval = max((unsigned long)3000, newReadingInterval);
     }
 
-    /*
-     * Get the choosen adc precision
-     * esp8266 = 10bit resolution = 1024.0f 
-     * esp32 = 12bit resolution = 4095.0f
-     */
-    float getAdcPrecision()
-    {
-      #ifdef ARDUINO_ARCH_ESP32
-        // esp32
-        return 4096.0f;
-      #else
-        // esp8266
-        return 1024.0f;
-      #endif
-    }
-
-    /*
-
-    /*
+    /**
      * Get lowest configured battery voltage
      */
     float getMinBatteryVoltage()
     {
-      return minBatteryVoltage;
+      return bat->getMinVoltage();
     }
 
-    /*
+    /**
      * Set lowest battery voltage
-     * can't be below 0 volt
+     * cant be below 0 volt
      */
     void setMinBatteryVoltage(float voltage)
     {
-      minBatteryVoltage = max(0.0f, voltage);
+      bat->setMinVoltage(voltage);
     }
 
-    /*
+    /**
      * Get highest configured battery voltage
      */
     float getMaxBatteryVoltage()
     {
-      return maxBatteryVoltage;
+      return bat->getMaxVoltage();
     }
     
-    /*
+    /**
      * Set highest battery voltage
      * can't be below minBatteryVoltage
      */
     void setMaxBatteryVoltage(float voltage)
     {
-      #ifdef USERMOD_BATTERY_USE_LIPO
-        maxBatteryVoltage = max(getMinBatteryVoltage()+0.7f, voltage);
-      #else
-        maxBatteryVoltage = max(getMinBatteryVoltage()+1.0f, voltage);
-      #endif
+      bat->setMaxVoltage(voltage);
     }
 
 
-    /*
+    /**
      * Get the calculated voltage
      * formula: (adc pin value / adc precision * max voltage) + calibration
      */
     float getVoltage()
     {
-      return voltage;
+      return bat->getVoltage();
     }
 
-    /*
+    /**
      * Get the mapped battery level (0 - 100) based on voltage
      * important: voltage can drop when a load is applied, so its only an estimate
      */
     int8_t getBatteryLevel()
     {
-      return batteryLevel;
+      return bat->getLevel();
     }
 
-    /*
+    /**
      * Get the configured calibration value
      * a offset value to fine-tune the calculated voltage.
      */
     float getCalibration()
     {
-      return calibration;
+      return bat->getCalibration();
     }
 
-    /*
+    /**
      * Set the voltage calibration offset value
      * a offset value to fine-tune the calculated voltage.
      */
     void setCalibration(float offset)
     {
-      calibration = offset;
+      bat->setCalibration(offset);
     }
 
-    /*
+    /**
      * Get auto-off feature enabled status
      * is auto-off enabled, true/false
      */
@@ -679,7 +633,7 @@ class UsermodBattery : public Usermod
       return autoOffEnabled;
     }
 
-    /*
+    /**
      * Set auto-off feature status 
      */
     void setAutoOffEnabled(bool enabled)
@@ -687,7 +641,7 @@ class UsermodBattery : public Usermod
       autoOffEnabled = enabled;
     }
     
-    /*
+    /**
      * Get auto-off threshold in percent (0-100)
      */
     int8_t getAutoOffThreshold()
@@ -695,7 +649,7 @@ class UsermodBattery : public Usermod
       return autoOffThreshold;
     }
 
-    /*
+    /**
      * Set auto-off threshold in percent (0-100) 
      */
     void setAutoOffThreshold(int8_t threshold)
@@ -705,7 +659,7 @@ class UsermodBattery : public Usermod
       autoOffThreshold  = lowPowerIndicatorEnabled /*&& autoOffEnabled*/ ? min(lowPowerIndicatorThreshold-1, (int)autoOffThreshold) : autoOffThreshold;
     }
 
-    /*
+    /**
      * Get low-power-indicator feature enabled status
      * is the low-power-indicator enabled, true/false
      */
@@ -714,7 +668,7 @@ class UsermodBattery : public Usermod
       return lowPowerIndicatorEnabled;
     }
 
-    /*
+    /**
      * Set low-power-indicator feature status 
      */
     void setLowPowerIndicatorEnabled(bool enabled)
@@ -722,7 +676,7 @@ class UsermodBattery : public Usermod
       lowPowerIndicatorEnabled = enabled;
     }
 
-    /*
+    /**
      * Get low-power-indicator preset to activate when low power is detected
      */
     int8_t getLowPowerIndicatorPreset()
@@ -730,7 +684,7 @@ class UsermodBattery : public Usermod
       return lowPowerIndicatorPreset;
     }
 
-    /* 
+    /** 
      * Set low-power-indicator preset to activate when low power is detected
      */
     void setLowPowerIndicatorPreset(int8_t presetId)
@@ -748,7 +702,7 @@ class UsermodBattery : public Usermod
       return lowPowerIndicatorThreshold;
     }
 
-    /*
+    /**
      * Set low-power-indicator threshold in percent (0-100)
      */
     void setLowPowerIndicatorThreshold(int8_t threshold)
@@ -758,7 +712,7 @@ class UsermodBattery : public Usermod
       lowPowerIndicatorThreshold  = autoOffEnabled /*&& lowPowerIndicatorEnabled*/ ? max(autoOffThreshold+1, (int)lowPowerIndicatorThreshold) : max(5, (int)lowPowerIndicatorThreshold);
     }
 
-    /*
+    /**
      * Get low-power-indicator duration in seconds
      */
     int8_t getLowPowerIndicatorDuration()
@@ -766,7 +720,7 @@ class UsermodBattery : public Usermod
       return lowPowerIndicatorDuration;
     }
 
-    /*
+    /**
      * Set low-power-indicator duration in seconds
      */
     void setLowPowerIndicatorDuration(int8_t duration)
@@ -774,7 +728,7 @@ class UsermodBattery : public Usermod
       lowPowerIndicatorDuration = duration;
     }
 
-    /*
+    /**
      * Get low-power-indicator status when the indication is done thsi returns true
      */
     bool getLowPowerIndicatorDone()

From bd69c24231153912e97ff31be399dcedd34567a5 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Tue, 30 Apr 2024 14:54:53 +0200
Subject: [PATCH 12/18] intermediate update

---
 usermods/Battery/battery_defaults.h   | 1 +
 usermods/Battery/readme.md            | 5 +++++
 usermods/Battery/types/lion.h         | 3 +--
 usermods/Battery/types/lipo.h         | 3 +--
 usermods/Battery/types/unkown.h       | 3 +--
 usermods/Battery/usermod_v2_Battery.h | 6 ++----
 6 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/usermods/Battery/battery_defaults.h b/usermods/Battery/battery_defaults.h
index 6d0a95dc4..ea01e8620 100644
--- a/usermods/Battery/battery_defaults.h
+++ b/usermods/Battery/battery_defaults.h
@@ -111,6 +111,7 @@
   #define USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION 5
 #endif
 
+// battery types
 typedef enum
 {
   unknown=0,
diff --git a/usermods/Battery/readme.md b/usermods/Battery/readme.md
index 1ca229763..e82378084 100644
--- a/usermods/Battery/readme.md
+++ b/usermods/Battery/readme.md
@@ -86,6 +86,11 @@ Specification from:  [Molicel INR18650-M35A, 3500mAh 10A Lithium-ion battery, 3.
 
 ## 📝 Change Log
 
+2024-04-30
+
+- integrate factory pattern to make it easier to add other / custom battery types
+- update readme
+
 2023-01-04
 
 - basic support for LiPo rechargeable batteries ( `-D USERMOD_BATTERY_USE_LIPO`)
diff --git a/usermods/Battery/types/lion.h b/usermods/Battery/types/lion.h
index 0d2325386..b3641e263 100644
--- a/usermods/Battery/types/lion.h
+++ b/usermods/Battery/types/lion.h
@@ -13,8 +13,7 @@ class Lion : public Battery
     private:
 
     public:
-        Lion()
-        : Battery()
+        Lion() : Battery()
         {
             this->setMinVoltage(USERMOD_BATTERY_LION_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_LION_MAX_VOLTAGE);
diff --git a/usermods/Battery/types/lipo.h b/usermods/Battery/types/lipo.h
index f65ab12c5..1deb6e7d3 100644
--- a/usermods/Battery/types/lipo.h
+++ b/usermods/Battery/types/lipo.h
@@ -13,8 +13,7 @@ class Lipo : public Battery
     private:
 
     public:
-        Lipo()
-        : Battery()
+        Lipo() : Battery()
         {
             this->setMinVoltage(USERMOD_BATTERY_LIPO_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_LIPO_MAX_VOLTAGE);
diff --git a/usermods/Battery/types/unkown.h b/usermods/Battery/types/unkown.h
index edf220040..32a1bfe42 100644
--- a/usermods/Battery/types/unkown.h
+++ b/usermods/Battery/types/unkown.h
@@ -13,8 +13,7 @@ class Unkown : public Battery
     private:
 
     public:
-        Unkown()
-        : Battery()
+        Unkown() : Battery()
         {
             this->setMinVoltage(USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index 9b980d557..a82a46667 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -9,9 +9,8 @@
 
 /*
  * Usermod by Maximilian Mewes
- * Mail: mewes.maximilian@gmx.de
- * GitHub: itCarl
- * Date: 25.12.2022
+ * E-mail: mewes.maximilian@gmx.de
+ * Created at: 25.12.2022
  * If you have any questions, please feel free to contact me.
  */
 class UsermodBattery : public Usermod 
@@ -140,7 +139,6 @@ class UsermodBattery : public Usermod
         }
       #else //ESP8266 boards have only one analog input pin A0
         pinMode(batteryPin, INPUT);
-        // voltage = readVoltage();
       #endif
 
       // plug in the right battery type

From a13f1a9bee52ad637cf6903546f1bac4ef3df3da Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Tue, 30 Apr 2024 15:24:02 +0200
Subject: [PATCH 13/18] bug fixes

---
 usermods/Battery/battery.h            | 61 +++++++++++++++------------
 usermods/Battery/types/lion.h         |  8 ----
 usermods/Battery/types/lipo.h         |  8 ----
 usermods/Battery/usermod_v2_Battery.h | 43 ++++++++++++++++++-
 4 files changed, 75 insertions(+), 45 deletions(-)

diff --git a/usermods/Battery/battery.h b/usermods/Battery/battery.h
index 4cdfb035f..084e6c0aa 100644
--- a/usermods/Battery/battery.h
+++ b/usermods/Battery/battery.h
@@ -32,7 +32,14 @@ class Battery
             this->setCalibration(USERMOD_BATTERY_CALIBRATION);
         }
 
-        virtual void update(batteryConfig cfg) = 0;
+        virtual void update(batteryConfig cfg)
+        {
+            if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage);
+            if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage);
+            if(cfg.level) this->setLevel(cfg.level);
+            if(cfg.calibration) this->setCalibration(cfg.calibration);
+            if(cfg.voltageMultiplier) this->setVoltageMultiplier(cfg.voltageMultiplier);
+        }
 
         /**
          * Corresponding battery curves
@@ -49,10 +56,10 @@ class Battery
 
 
         /*
-        *
-        * Getter and Setter
-        *
-        */
+         *
+         * Getter and Setter
+         *
+         */
 
         /*
         * Get lowest configured battery voltage
@@ -63,26 +70,26 @@ class Battery
         }
 
         /*
-        * Set lowest battery voltage
-        * can't be below 0 volt
-        */
+         * Set lowest battery voltage
+         * can't be below 0 volt
+         */
         virtual void setMinVoltage(float voltage)
         {
             this->minVoltage = max(0.0f, voltage);
         }
 
         /*
-        * Get highest configured battery voltage
-        */
+         * Get highest configured battery voltage
+         */
         virtual float getMaxVoltage()
         {
             return this->maxVoltage;
         }
 
         /*
-        * Set highest battery voltage
-        * can't be below minVoltage
-        */
+         * Set highest battery voltage
+         * can't be below minVoltage
+         */
         virtual void setMaxVoltage(float voltage)
         {
             this->maxVoltage = max(getMinVoltage()+.5f, voltage);
@@ -110,43 +117,43 @@ class Battery
 
         void setLevel(float level)
         {
-            this->level = constrain(level, 0.0f, 110.0f);;
+            this->level = constrain(level, 0.0f, 110.0f);
         }
 
         /*
-        * Get the configured calibration value
-        * a offset value to fine-tune the calculated voltage.
-        */
+         * Get the configured calibration value
+         * a offset value to fine-tune the calculated voltage.
+         */
         virtual float getCalibration()
         {
             return calibration;
         }
 
         /*
-        * Set the voltage calibration offset value
-        * a offset value to fine-tune the calculated voltage.
-        */
+         * Set the voltage calibration offset value
+         * a offset value to fine-tune the calculated voltage.
+         */
         virtual void setCalibration(float offset)
         {
             calibration = offset;
         }
 
         /*
-        * Get the configured calibration value
-        * a value to set the voltage divider ratio
-        */
+         * Get the configured calibration value
+         * a value to set the voltage divider ratio
+         */
         virtual float getVoltageMultiplier()
         {
             return voltageMultiplier;
         }
 
         /*
-        * Set the voltage multiplier value
-        * a value to set the voltage divider ratio.
-        */
+         * Set the voltage multiplier value
+         * a value to set the voltage divider ratio.
+         */
         virtual void setVoltageMultiplier(float multiplier)
         {
-            voltageMultiplier = voltageMultiplier;
+            voltageMultiplier = multiplier;
         }
 };
 
diff --git a/usermods/Battery/types/lion.h b/usermods/Battery/types/lion.h
index b3641e263..e77266164 100644
--- a/usermods/Battery/types/lion.h
+++ b/usermods/Battery/types/lion.h
@@ -19,14 +19,6 @@ class Lion : public Battery
             this->setMaxVoltage(USERMOD_BATTERY_LION_MAX_VOLTAGE);
         }
 
-        void update(batteryConfig cfg)
-        {
-            if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage);
-            if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage);
-            if(cfg.level) this->setLevel(cfg.level);
-            if(cfg.calibration) this->setCalibration(cfg.calibration);
-        }
-
         float mapVoltage(float v, float min, float max) override
         {
             return this->linearMapping(v, min, max); // basic mapping
diff --git a/usermods/Battery/types/lipo.h b/usermods/Battery/types/lipo.h
index 1deb6e7d3..d732cf4da 100644
--- a/usermods/Battery/types/lipo.h
+++ b/usermods/Battery/types/lipo.h
@@ -19,14 +19,6 @@ class Lipo : public Battery
             this->setMaxVoltage(USERMOD_BATTERY_LIPO_MAX_VOLTAGE);
         }
 
-        void update(batteryConfig cfg)
-        {
-            if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage);
-            if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage);
-            if(cfg.level) this->setLevel(cfg.level);
-            if(cfg.calibration) this->setCalibration(cfg.calibration);
-        }
-
         /**
          * LiPo batteries have a differnt discharge curve, see 
          * https://blog.ampow.com/lipo-voltage-chart/
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index a82a46667..b9631d6db 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -264,6 +264,7 @@ class UsermodBattery : public Usermod
       battery[F("min-voltage")] = bat->getMinVoltage();
       battery[F("max-voltage")] = bat->getMaxVoltage();
       battery[F("calibration")] = bat->getCalibration();
+      battery[F("voltage-multiplier")] = bat->getVoltageMultiplier();
       battery[FPSTR(_readInterval)] = readingInterval;
 
       JsonObject ao = battery.createNestedObject(F("auto-off"));  // auto off section
@@ -283,6 +284,7 @@ class UsermodBattery : public Usermod
       getJsonValue(battery[F("min-voltage")], cfg.minVoltage);
       getJsonValue(battery[F("max-voltage")], cfg.maxVoltage);
       getJsonValue(battery[F("calibration")], cfg.calibration);
+      getJsonValue(battery[F("voltage-multiplier")], cfg.voltageMultiplier);
     
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
 
@@ -459,6 +461,7 @@ class UsermodBattery : public Usermod
       setMinBatteryVoltage(battery[F("min-voltage")] | bat->getMinVoltage());
       setMaxBatteryVoltage(battery[F("max-voltage")] | bat->getMaxVoltage());
       setCalibration(battery[F("calibration")] | calibration);
+      setVoltageMultiplier(battery[F("voltage-multiplier")] | voltageMultiplier);
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
 
       getUsermodConfigFromJsonObject(battery);
@@ -537,7 +540,25 @@ class UsermodBattery : public Usermod
       return USERMOD_ID_BATTERY;
     }
 
+    /**
+     * get currently active battery type
+     */
+    batteryType getBatteryType()
+    {
+      return cfg.type;
+    }
 
+    /**
+     * Set currently active battery type
+     */
+    batteryType setBatteryType(batteryType type)
+    {
+      cfg.type = type;
+    }
+
+    /**
+     * 
+     */
     unsigned long getReadingInterval()
     {
       return readingInterval;
@@ -561,7 +582,7 @@ class UsermodBattery : public Usermod
 
     /**
      * Set lowest battery voltage
-     * cant be below 0 volt
+     * can't be below 0 volt
      */
     void setMinBatteryVoltage(float voltage)
     {
@@ -622,6 +643,24 @@ class UsermodBattery : public Usermod
       bat->setCalibration(offset);
     }
 
+    /**
+     * Set the voltage multiplier value
+     * A multiplier that may need adjusting for different voltage divider setups
+     */
+    void setVoltageMultiplier(float multiplier)
+    {
+      bat->setVoltageMultiplier(multiplier);
+    }
+
+    /*
+     * Get the voltage multiplier value
+     * A multiplier that may need adjusting for different voltage divider setups
+     */
+    float getVoltageMultiplier()
+    {
+      return bat->getVoltageMultiplier();
+    }
+
     /**
      * Get auto-off feature enabled status
      * is auto-off enabled, true/false
@@ -727,7 +766,7 @@ class UsermodBattery : public Usermod
     }
 
     /**
-     * Get low-power-indicator status when the indication is done thsi returns true
+     * Get low-power-indicator status when the indication is done this returns true
      */
     bool getLowPowerIndicatorDone()
     {

From 2245ee6fce23343cacfd6cd424a6339be0f1fada Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Tue, 30 Apr 2024 17:02:57 +0200
Subject: [PATCH 14/18] bugfixes

---
 usermods/Battery/battery.h            |  9 +++++----
 usermods/Battery/usermod_v2_Battery.h | 18 ++++--------------
 2 files changed, 9 insertions(+), 18 deletions(-)

diff --git a/usermods/Battery/battery.h b/usermods/Battery/battery.h
index 084e6c0aa..31e2e0755 100644
--- a/usermods/Battery/battery.h
+++ b/usermods/Battery/battery.h
@@ -27,7 +27,7 @@ class Battery
     public:
         Battery()
         {
-            this->setVoltage(this->getVoltage());
+            this->setVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
             this->setVoltageMultiplier(USERMOD_BATTERY_VOLTAGE_MULTIPLIER);
             this->setCalibration(USERMOD_BATTERY_CALIBRATION);
         }
@@ -105,9 +105,10 @@ class Battery
          */
         void setVoltage(float voltage)
         {
-            this->voltage = ( (voltage < this->getMinVoltage() * 0.85f) || (voltage > this->getMaxVoltage() * 1.1f) ) 
-                ? -1.0f 
-                : voltage;
+            // this->voltage = ( (voltage < this->getMinVoltage() * 0.85f) || (voltage > this->getMaxVoltage() * 1.1f) ) 
+            //     ? -1.0f 
+            //     : voltage;
+            this->voltage = voltage;
         }
 
         float getLevel()
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index b9631d6db..31c31f066 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -28,8 +28,6 @@ class UsermodBattery : public Usermod
     unsigned long lastReadTime = 0;
     // between 0 and 1, to control strength of voltage smoothing filter
     float alpha = USERMOD_BATTERY_AVERAGING_ALPHA;
-    // offset or calibration value to fine tune the calculated voltage
-    float calibration = USERMOD_BATTERY_CALIBRATION;
 
     // auto shutdown/shutoff/master off feature
     bool autoOffEnabled = USERMOD_BATTERY_AUTO_OFF_ENABLED;
@@ -45,6 +43,7 @@ class UsermodBattery : public Usermod
     unsigned long lowPowerActivationTime = 0; // used temporary during active time
     uint8_t lastPreset = 0;
 
+    //
     bool initDone = false;
     bool initializing = true;
 
@@ -311,9 +310,8 @@ class UsermodBattery : public Usermod
     {
       JsonObject battery = root.createNestedObject(FPSTR(_name));
 
-      if (battery.isNull()) {
+      if (battery.isNull())
         battery = root.createNestedObject(FPSTR(_name));
-      }
       
       addBatteryToJsonObject(battery, true);
       
@@ -460,8 +458,8 @@ class UsermodBattery : public Usermod
       // calculateTimeLeftEnabled = battery[F("time-left")] | calculateTimeLeftEnabled;
       setMinBatteryVoltage(battery[F("min-voltage")] | bat->getMinVoltage());
       setMaxBatteryVoltage(battery[F("max-voltage")] | bat->getMaxVoltage());
-      setCalibration(battery[F("calibration")] | calibration);
-      setVoltageMultiplier(battery[F("voltage-multiplier")] | voltageMultiplier);
+      setCalibration(battery[F("calibration")] | bat->getCalibration());
+      setVoltageMultiplier(battery[F("voltage-multiplier")] | bat->getVoltageMultiplier());
       setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
 
       getUsermodConfigFromJsonObject(battery);
@@ -548,14 +546,6 @@ class UsermodBattery : public Usermod
       return cfg.type;
     }
 
-    /**
-     * Set currently active battery type
-     */
-    batteryType setBatteryType(batteryType type)
-    {
-      cfg.type = type;
-    }
-
     /**
      * 
      */

From 05a8c692f29f2439a96027433ee6440f71a84c7b Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Tue, 30 Apr 2024 18:11:18 +0200
Subject: [PATCH 15/18] read initial voltage correctly

---
 usermods/Battery/battery.h            | 1 -
 usermods/Battery/usermod_v2_Battery.h | 4 +++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/usermods/Battery/battery.h b/usermods/Battery/battery.h
index 31e2e0755..2ddd84149 100644
--- a/usermods/Battery/battery.h
+++ b/usermods/Battery/battery.h
@@ -27,7 +27,6 @@ class Battery
     public:
         Battery()
         {
-            this->setVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
             this->setVoltageMultiplier(USERMOD_BATTERY_VOLTAGE_MULTIPLIER);
             this->setCalibration(USERMOD_BATTERY_CALIBRATION);
         }
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index 31c31f066..7b6b038a6 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -150,6 +150,8 @@ class UsermodBattery : public Usermod
       // update the choosen battery type with configured values
       bat->update(cfg);
 
+      bat->setVoltage(readVoltage());
+
       nextReadTime = millis() + readingInterval;
       lastReadTime = millis();
 
@@ -389,7 +391,7 @@ class UsermodBattery : public Usermod
       addBatteryToJsonObject(battery, false);
 
       // read voltage in case calibration or voltage multiplier changed to see immediate effect
-      // voltage = readVoltage();
+      bat->setVoltage(readVoltage());
 
       DEBUG_PRINTLN(F("Battery config saved."));
     }

From 18e9f9c304482e3506e8982805b5df33a2bbf6c4 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Mon, 6 May 2024 17:39:40 +0200
Subject: [PATCH 16/18] Rename Battery classes

---
 usermods/Battery/{battery.h => UMBattery.h}        |  4 ++--
 usermods/Battery/battery_defaults.h                |  1 -
 usermods/Battery/types/{lion.h => LionUMBattery.h} |  8 ++++----
 usermods/Battery/types/{lipo.h => LipoUMBattery.h} |  8 ++++----
 .../Battery/types/{unkown.h => UnkownUMBattery.h}  |  8 ++++----
 usermods/Battery/usermod_v2_Battery.h              | 14 +++++++-------
 6 files changed, 21 insertions(+), 22 deletions(-)
 rename usermods/Battery/{battery.h => UMBattery.h} (99%)
 rename usermods/Battery/types/{lion.h => LionUMBattery.h} (86%)
 rename usermods/Battery/types/{lipo.h => LipoUMBattery.h} (92%)
 rename usermods/Battery/types/{unkown.h => UnkownUMBattery.h} (87%)

diff --git a/usermods/Battery/battery.h b/usermods/Battery/UMBattery.h
similarity index 99%
rename from usermods/Battery/battery.h
rename to usermods/Battery/UMBattery.h
index 2ddd84149..8a8ad891e 100644
--- a/usermods/Battery/battery.h
+++ b/usermods/Battery/UMBattery.h
@@ -7,7 +7,7 @@
  *  Battery base class
  *  all other battery classes should inherit from this
  */
-class Battery
+class UMBattery
 {
     private:
 
@@ -25,7 +25,7 @@ class Battery
         }
 
     public:
-        Battery()
+        UMBattery()
         {
             this->setVoltageMultiplier(USERMOD_BATTERY_VOLTAGE_MULTIPLIER);
             this->setCalibration(USERMOD_BATTERY_CALIBRATION);
diff --git a/usermods/Battery/battery_defaults.h b/usermods/Battery/battery_defaults.h
index ea01e8620..8b56c6014 100644
--- a/usermods/Battery/battery_defaults.h
+++ b/usermods/Battery/battery_defaults.h
@@ -131,5 +131,4 @@ typedef struct bconfig_t
   float voltageMultiplier;
 } batteryConfig;
 
-
 #endif
\ No newline at end of file
diff --git a/usermods/Battery/types/lion.h b/usermods/Battery/types/LionUMBattery.h
similarity index 86%
rename from usermods/Battery/types/lion.h
rename to usermods/Battery/types/LionUMBattery.h
index e77266164..801faee7c 100644
--- a/usermods/Battery/types/lion.h
+++ b/usermods/Battery/types/LionUMBattery.h
@@ -2,18 +2,18 @@
 #define UMBLion_h
 
 #include "../battery_defaults.h"
-#include "../battery.h"
+#include "../UMBattery.h"
 
 /**
- *  Lion Battery
+ *  LiOn Battery
  * 
  */
-class Lion : public Battery
+class LionUMBattery : public UMBattery
 {
     private:
 
     public:
-        Lion() : Battery()
+        LionUMBattery() : UMBattery()
         {
             this->setMinVoltage(USERMOD_BATTERY_LION_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_LION_MAX_VOLTAGE);
diff --git a/usermods/Battery/types/lipo.h b/usermods/Battery/types/LipoUMBattery.h
similarity index 92%
rename from usermods/Battery/types/lipo.h
rename to usermods/Battery/types/LipoUMBattery.h
index d732cf4da..bb6a6ef94 100644
--- a/usermods/Battery/types/lipo.h
+++ b/usermods/Battery/types/LipoUMBattery.h
@@ -2,18 +2,18 @@
 #define UMBLipo_h
 
 #include "../battery_defaults.h"
-#include "../battery.h"
+#include "../UMBattery.h"
 
 /**
- *  Lipo Battery
+ *  LiPo Battery
  * 
  */
-class Lipo : public Battery
+class LipoUMBattery : public UMBattery
 {
     private:
 
     public:
-        Lipo() : Battery()
+        LipoUMBattery() : UMBattery()
         {
             this->setMinVoltage(USERMOD_BATTERY_LIPO_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_LIPO_MAX_VOLTAGE);
diff --git a/usermods/Battery/types/unkown.h b/usermods/Battery/types/UnkownUMBattery.h
similarity index 87%
rename from usermods/Battery/types/unkown.h
rename to usermods/Battery/types/UnkownUMBattery.h
index 32a1bfe42..ede5ffd88 100644
--- a/usermods/Battery/types/unkown.h
+++ b/usermods/Battery/types/UnkownUMBattery.h
@@ -2,18 +2,18 @@
 #define UMBUnkown_h
 
 #include "../battery_defaults.h"
-#include "../battery.h"
+#include "../UMBattery.h"
 
 /**
- *  Lion Battery
+ *  Unkown / Default Battery
  * 
  */
-class Unkown : public Battery
+class UnkownUMBattery : public UMBattery
 {
     private:
 
     public:
-        Unkown() : Battery()
+        UnkownUMBattery() : UMBattery()
         {
             this->setMinVoltage(USERMOD_BATTERY_UNKOWN_MIN_VOLTAGE);
             this->setMaxVoltage(USERMOD_BATTERY_UNKOWN_MAX_VOLTAGE);
diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index 7b6b038a6..c70babf53 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -2,10 +2,10 @@
 
 #include "wled.h"
 #include "battery_defaults.h"
-#include "battery.h"
-#include "types/unkown.h"
-#include "types/lion.h"
-#include "types/lipo.h"
+#include "UMBattery.h"
+#include "types/UnkownUMBattery.h"
+#include "types/LionUMBattery.h"
+#include "types/LiPoUMBattery.h"
 
 /*
  * Usermod by Maximilian Mewes
@@ -19,7 +19,7 @@ class UsermodBattery : public Usermod
     // battery pin can be defined in my_config.h
     int8_t batteryPin = USERMOD_BATTERY_MEASUREMENT_PIN;
     
-    Battery* bat = new Unkown();
+    UMBattery* bat = new UnkownUMBattery();
     batteryConfig cfg;
 
     // how often to read the battery voltage
@@ -142,9 +142,9 @@ class UsermodBattery : public Usermod
 
       // plug in the right battery type
       if(cfg.type == (batteryType)lipo) {
-        bat = new Lipo();
+        bat = new LipoUMBattery();
       } else if(cfg.type == (batteryType)lion) {
-        bat = new Lion();
+        bat = new LipoUMBattery();
       }
 
       // update the choosen battery type with configured values

From d33651c25bfdc3ab4457c6e95496914fb924bad1 Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Mon, 6 May 2024 17:45:02 +0200
Subject: [PATCH 17/18] Update setup method

---
 usermods/Battery/usermod_v2_Battery.h | 41 +++++++++++++--------------
 1 file changed, 20 insertions(+), 21 deletions(-)

diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index c70babf53..09be3ccc6 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -120,26 +120,6 @@ class UsermodBattery : public Usermod
      */
     void setup() 
     {
-      #ifdef ARDUINO_ARCH_ESP32
-        bool success = false;
-        DEBUG_PRINTLN(F("Allocating battery pin..."));
-        if (batteryPin >= 0 && digitalPinToAnalogChannel(batteryPin) >= 0) 
-          if (pinManager.allocatePin(batteryPin, false, PinOwner::UM_Battery)) {
-            DEBUG_PRINTLN(F("Battery pin allocation succeeded."));
-            success = true;
-            voltage = readVoltage();
-          }
-
-        if (!success) {
-          DEBUG_PRINTLN(F("Battery pin allocation failed."));
-          batteryPin = -1;  // allocation failed
-        } else {
-          pinMode(batteryPin, INPUT);
-        }
-      #else //ESP8266 boards have only one analog input pin A0
-        pinMode(batteryPin, INPUT);
-      #endif
-
       // plug in the right battery type
       if(cfg.type == (batteryType)lipo) {
         bat = new LipoUMBattery();
@@ -150,7 +130,26 @@ class UsermodBattery : public Usermod
       // update the choosen battery type with configured values
       bat->update(cfg);
 
-      bat->setVoltage(readVoltage());
+      #ifdef ARDUINO_ARCH_ESP32
+        bool success = false;
+        DEBUG_PRINTLN(F("Allocating battery pin..."));
+        if (batteryPin >= 0 && digitalPinToAnalogChannel(batteryPin) >= 0) 
+          if (pinManager.allocatePin(batteryPin, false, PinOwner::UM_Battery)) {
+            DEBUG_PRINTLN(F("Battery pin allocation succeeded."));
+            success = true;
+            bat->setVoltage(readVoltage());
+          }
+
+        if (!success) {
+          DEBUG_PRINTLN(F("Battery pin allocation failed."));
+          batteryPin = -1;  // allocation failed
+        } else {
+          pinMode(batteryPin, INPUT);
+        }
+      #else //ESP8266 boards have only one analog input pin A0
+        pinMode(batteryPin, INPUT);
+        bat->setVoltage(readVoltage());
+      #endif
 
       nextReadTime = millis() + readingInterval;
       lastReadTime = millis();

From 52020cbe269e39dae3493e387bacbd35eefdc92b Mon Sep 17 00:00:00 2001
From: Maximilian Mewes <mewes.maximilian@gmx.de>
Date: Mon, 6 May 2024 17:46:26 +0200
Subject: [PATCH 18/18] CP fix

---
 usermods/Battery/usermod_v2_Battery.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/usermods/Battery/usermod_v2_Battery.h b/usermods/Battery/usermod_v2_Battery.h
index 09be3ccc6..88a879b72 100644
--- a/usermods/Battery/usermod_v2_Battery.h
+++ b/usermods/Battery/usermod_v2_Battery.h
@@ -124,7 +124,7 @@ class UsermodBattery : public Usermod
       if(cfg.type == (batteryType)lipo) {
         bat = new LipoUMBattery();
       } else if(cfg.type == (batteryType)lion) {
-        bat = new LipoUMBattery();
+        bat = new LionUMBattery();
       }
 
       // update the choosen battery type with configured values