iboost running fixes (#1302)

* iboost running fixes

#1283

* [pre-commit.ci lite] apply automatic fixes

* Update customisation.md

* Typo

* [pre-commit.ci lite] apply automatic fixes

* Typo

* [pre-commit.ci lite] apply automatic fixes

* Fix naming issue with iboost sensor with 2 cars

* [pre-commit.ci lite] apply automatic fixes

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

Author: springfall2008

apps/predbat/predbat.py

@@ -2102,6 +2102,8 @@ def run_prediction(self, charge_limit, charge_window, discharge_window, discharg
         self.car_charging_soc_next = pred.car_charging_soc_next
         self.iboost_next = pred.iboost_next
         self.iboost_running = pred.iboost_running
+        self.iboost_running_solar = pred.iboost_running_solar
+        self.iboost_running_full = pred.iboost_running_full
         if save or self.debug_enable:
             predict_soc_time = pred.predict_soc_time
             first_charge = pred.first_charge
@@ -2623,9 +2625,9 @@ def run_prediction(self, charge_limit, charge_window, discharge_window, discharg
                     },
                 )
                 self.dashboard_item(
-                    "binary_sensor." + self.prefix + "_iboost_active" + postfix,
+                    "binary_sensor." + self.prefix + "_iboost_active",
                     state=self.iboost_running,
-                    attributes={"friendly_name": "iBoost active", "icon": "mdi:water-boiler"},
+                    attributes={"friendly_name": "iBoost active", "icon": "mdi:water-boiler", "solar": self.iboost_running_solar, "full": self.iboost_running_full},
                 )
                 self.find_spare_energy(self.predict_soc, predict_export, step, first_charge)
                 if self.carbon_enable:
@@ -5257,6 +5259,9 @@ def reset(self):
         self.iboost_rate_threshold_export = 9999
         self.iboost_plan = []
         self.iboost_energy_subtract = True
+        self.iboost_running = False
+        self.iboost_running_full = False
+        self.iboost_running_solar = False
 
         self.config_root = "./"
         for root in CONFIG_ROOTS:
@@ -8530,7 +8535,7 @@ def execute_plan(self):
 
             # Iboost running?
             boostHolding = False
-            if self.iboost_enable and self.iboost_prevent_discharge and self.iboost_running and status not in ["Discharging", "Charging"]:
+            if self.iboost_enable and self.iboost_prevent_discharge and self.iboost_running_full and status not in ["Discharging", "Charging"]:
                 inverter.adjust_discharge_rate(0)
                 inverter.adjust_pause_mode(pause_discharge=True)
                 resetDischarge = False
@@ -9703,6 +9708,8 @@ def fetch_config_options(self):
         self.iboost_energy_subtract = self.get_arg("iboost_energy_subtract")
         self.iboost_next = self.iboost_today
         self.iboost_running = False
+        self.iboost_running_solar = False
+        self.iboost_running_full = False
         self.iboost_energy_today = {}
         self.iboost_plan = []
 

apps/predbat/prediction.py

@@ -134,7 +134,6 @@ def __init__(self, base=None, pv_forecast_minute_step=None, pv_forecast_minute10
             self.iboost_min_soc = base.iboost_min_soc
             self.iboost_solar = base.iboost_solar
             self.iboost_charging = base.iboost_charging
-            self.iboost_running = base.iboost_running
             self.iboost_plan = base.iboost_plan
             self.iboost_gas = base.iboost_gas
             self.iboost_gas_export = base.iboost_gas_export
@@ -167,6 +166,9 @@ def __init__(self, base=None, pv_forecast_minute_step=None, pv_forecast_minute10
             self.load_minutes_step = load_minutes_step
             self.load_minutes_step10 = load_minutes_step10
             self.carbon_intensity = base.carbon_intensity
+            self.iboost_running = base.iboost_running
+            self.iboost_running_solar = base.iboost_running_solar
+            self.iboost_running_full = base.iboost_running_full
 
             # Store this dictionary in global so we can reconstruct it in the thread without passing the data
             PRED_GLOBAL["dict"] = self.__dict__.copy()
@@ -315,6 +317,9 @@ def run_prediction(self, charge_limit, charge_window, discharge_window, discharg
         self.predict_metric_best = {}
         self.predict_iboost_best = {}
         self.predict_carbon_best = {}
+        self.iboost_running = False
+        self.iboost_running_solar = False
+        self.iboost_running_full = False
 
         predict_export = {}
         predict_battery_power = {}
@@ -540,6 +545,10 @@ def run_prediction(self, charge_limit, charge_window, discharge_window, discharg
                     iboost_freeze = True
                     discharge_rate_now = self.battery_rate_min  # 0
 
+                # Iboost running
+                if iboost_amount > 0 and minute == 0:
+                    self.iboost_running_full = True
+
                 # Iboost load added
                 load_yesterday += iboost_amount
 
@@ -781,6 +790,8 @@ def run_prediction(self, charge_limit, charge_window, discharge_window, discharg
                         iboost_pv_amount = min(pv_ac, max(self.iboost_max_power * step - iboost_amount, 0), max(self.iboost_max_energy - iboost_today_kwh - iboost_amount, 0))
                         pv_ac -= iboost_pv_amount
                         iboost_amount += iboost_pv_amount
+                        if iboost_pv_amount > 0 and minute == 0:
+                            self.iboost_running_solar = True
 
                 # Cumulative iBoost energy
                 iboost_today_kwh += iboost_amount
@@ -790,13 +801,11 @@ def run_prediction(self, charge_limit, charge_window, discharge_window, discharg
                     iboost_today_kwh = 0
 
                 # Save iBoost next prediction
-                if minute == 0 and save in ["best", "test"]:
+                if minute == 0:
                     scaled_boost = (iboost_amount / step) * RUN_EVERY
                     self.iboost_next = round(self.iboost_today + scaled_boost, 3)
                     if iboost_amount > 0:
                         self.iboost_running = True
-                    else:
-                        self.iboost_running = False
 
             # Count battery cycles
             battery_cycle = battery_cycle + abs(battery_draw)

apps/predbat/unit_test.py

@@ -321,6 +321,9 @@ def simple_scenario(
     iboost_enable=False,
     iboost_on_discharge=False,
     iboost_prevent_discharge=False,
+    assert_iboost_running=False,
+    assert_iboost_running_solar=False,
+    assert_iboost_running_full=False,
 ):
     """
     No PV, No Load
@@ -462,6 +465,15 @@ def simple_scenario(
     if abs(metric_keep - assert_keep) >= 0.1:
         print("ERROR: Metric keep {} should be {}".format(metric_keep, assert_keep))
         failed = True
+    if assert_iboost_running != prediction.iboost_running:
+        print("ERROR: iBoost running should be {}".format(assert_iboost_running))
+        failed = True
+    if assert_iboost_running_solar != prediction.iboost_running_solar:
+        print("ERROR: iBoost running solar should be {}".format(assert_iboost_running_solar))
+        failed = True
+    if assert_iboost_running_full != prediction.iboost_running_full:
+        print("ERROR: iBoost running full should be {}".format(assert_iboost_running_full))
+        failed = True
 
     if failed:
         prediction.run_prediction(charge_limit_best, charge_window_best, discharge_window_best, discharge_limit_best, pv10, end_record=(my_predbat.end_record), save="test")
@@ -1636,7 +1648,18 @@ def run_model_tests(my_predbat):
         inverter_limit=2.0,
     )
     failed |= simple_scenario(
-        "iboost_pv", my_predbat, 0, 1, assert_final_metric=0, assert_final_soc=0, with_battery=False, iboost_enable=True, iboost_solar=True, assert_final_iboost=24
+        "iboost_pv",
+        my_predbat,
+        0,
+        1,
+        assert_final_metric=0,
+        assert_final_soc=0,
+        with_battery=False,
+        iboost_enable=True,
+        iboost_solar=True,
+        assert_final_iboost=24,
+        assert_iboost_running=True,
+        assert_iboost_running_solar=True,
     )
     failed |= simple_scenario(
         "iboost_gas1",
@@ -1668,6 +1691,8 @@ def run_model_tests(my_predbat):
         iboost_charging=False,
         export_limit=10,
         assert_final_iboost=200,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_gas3",
@@ -1700,6 +1725,8 @@ def run_model_tests(my_predbat):
         iboost_charging=False,
         export_limit=10,
         assert_final_iboost=200,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_rate1",
@@ -1728,6 +1755,8 @@ def run_model_tests(my_predbat):
         iboost_charging=False,
         export_limit=10,
         assert_final_iboost=200,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_rate3",
@@ -1742,6 +1771,8 @@ def run_model_tests(my_predbat):
         iboost_charging=False,
         export_limit=10,
         assert_final_iboost=200,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_rate3",
@@ -1772,6 +1803,8 @@ def run_model_tests(my_predbat):
         assert_final_iboost=12,
         charge_period_divide=2,
         export_limit=1,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_charge2",
@@ -1787,6 +1820,8 @@ def run_model_tests(my_predbat):
         iboost_charging=True,
         assert_final_iboost=100,
         end_record=12 * 60,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_charge3",
@@ -1803,6 +1838,8 @@ def run_model_tests(my_predbat):
         iboost_charging=True,
         assert_final_iboost=100,
         end_record=12 * 60,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_charge4",
@@ -1865,6 +1902,8 @@ def run_model_tests(my_predbat):
         iboost_on_discharge=True,
         export_limit=1,
         assert_final_iboost=24,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_prevent_discharge1",
@@ -1881,6 +1920,8 @@ def run_model_tests(my_predbat):
         iboost_prevent_discharge=False,
         export_limit=1,
         assert_final_iboost=24,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_prevent_discharge2",
@@ -1897,6 +1938,8 @@ def run_model_tests(my_predbat):
         iboost_prevent_discharge=True,
         export_limit=1,
         assert_final_iboost=24,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "keep_discharge1",
@@ -1928,6 +1971,8 @@ def run_model_tests(my_predbat):
         iboost_rate_threshold=import_rate,
         iboost_charging=False,
         assert_final_iboost=120,
+        assert_iboost_running=True,
+        assert_iboost_running_full=True,
     )
     failed |= simple_scenario(
         "iboost_rate_pv1",
@@ -1943,6 +1988,8 @@ def run_model_tests(my_predbat):
         iboost_charging=False,
         assert_final_iboost=12,
         export_limit=1,
+        assert_iboost_running=True,
+        assert_iboost_running_solar=True,
     )
     failed |= simple_scenario(
         "iboost_rate_pv2",
@@ -1958,6 +2005,8 @@ def run_model_tests(my_predbat):
         iboost_charging=False,
         assert_final_iboost=12 * 1,
         export_limit=2,
+        assert_iboost_running=True,
+        assert_iboost_running_solar=True,
     )
     failed |= simple_scenario(
         "iboost_rate_pv3",
@@ -1973,6 +2022,8 @@ def run_model_tests(my_predbat):
         iboost_charging=False,
         assert_final_iboost=12 * 2,
         export_limit=2,
+        assert_iboost_running=True,
+        assert_iboost_running_solar=True,
     )
 
     if failed:

docs/customisation.md

@@ -500,6 +500,9 @@ You will see **input_number.predbat_iboost_today** entity which tracks the estim
 
 The **binary_sensor.predbat_iboost_active** entity will be enabled when the solar diverter should be active, can be used for automations to trigger the immersion heater boost.
 
+The attributes within this sensor include 'solar' which includes Solar diversion should be active and 'full' which indicates iboost should run at maximum rate (could be
+during a charge cycle or grid import).
+
 Example template automation for controlling the solar diverter:
 
 ```yaml