Merge pull request #804 from BenPru/chore/upstream-datatypes-mk3-celsius

chore(lux_overrides): 🔧 adopt upstream datatypes for the Mk3 timer block, limit temperatures and counters

Author: rhammen

custom_components/luxtronik2/lux_overrides.py

@@ -14,6 +14,7 @@
     Percent,
     Percent2,
     Power,
+    Seconds,
     SelectionBase,
     SwitchoffFile,
     Timestamp,
@@ -450,22 +451,45 @@ def update_Luxtronik_Parameters():
     Parameters.parameters.update(parameters_to_add_update)  # pyright: ignore[reportCallIssue, reportArgumentType]
     Calculations.calculations.update(calculations_to_add_update)  # pyright: ignore[reportCallIssue, reportArgumentType]
 
-    # example bulk update of parameter classes for a range of numbers
-    Celsius_numbers = [14, 15, 16, 141, 142, 143, 774, 775, 776] + [17, 47, 90, 93, 111]
+    # Temperature settings stored as tenths of a degree. The last six are
+    # limit temperatures upstream `main` types as Celsius too; all 30 units
+    # in the diagnostics corpus hold plausible tenths there: 84 at 650-700,
+    # 87 at 350-650, 91 at 350-450, 92 at -200/-220, 94 at 1150-1400 and
+    # 96 at 500 on every unit.
+    Celsius_numbers = (
+        [14, 15, 16, 141, 142, 143, 774, 775, 776]
+        + [17, 47, 90, 93, 111]
+        + [84, 87, 91, 92, 94, 96]
+    )
     update_Luxtronik_Parameter_Classes(Celsius_numbers, Celsius)
 
     # Kelvin temperature-difference parameters stored as tenths.
     delta_temperature_numbers = [88, 89]
     update_Luxtronik_Parameter_Classes(delta_temperature_numbers, Kelvin)
 
+    # Operating-time counters (ID_Zaehler_BetrZeit*) in seconds, the
+    # parameter-side mirrors of calculations 56-66, and the heat-quantity
+    # date (ID_Waermemenge_Datum) as a Unix timestamp - eight corpus units
+    # sit on its 2018-01-01 factory default, eight more on 0, which the
+    # library's Timestamp renders as 1970-01-01 (as it does for 6/7/731/732).
+    # Typed as upstream `main` does; nothing reads them, this only makes
+    # diagnostics dumps readable.
+    operating_time_numbers = [668, 669, 670, 671, 672, 673, 728, 729, 730, 859]
+    update_Luxtronik_Parameter_Classes(operating_time_numbers, Seconds)
+    update_Luxtronik_Parameter_Classes([880], Timestamp)
+
     # Timer program schedule parameters: mostly TimeOfDay entries, with a
     # handful of TimerProgram mode selectors interspersed. 162-667 holds the
-    # heating, mixing, DHW, circulation-pump and pool circuits.
+    # heating, mixing circuits 1/2, DHW, circulation-pump and pool circuits;
+    # mixing circuit 3 sits apart at 788 (selector) and 789-848 (times).
     # 607 is named ID_Einst_SuSwb_akt upstream but holds a time of day on
     # every unit seen with a non-zero value there (06:30/07:00/07:30, each
     # followed by an end time in 608 - #789), so it stays in the time range.
-    timer_program_numbers = {222, 283, 344, 405, 506}
-    time_of_day_numbers = [n for n in range(162, 668) if n not in timer_program_numbers]
+    timer_program_numbers = {222, 283, 344, 405, 506, 788}
+    schedule_numbers = list(range(162, 668)) + list(range(788, 849))
+    time_of_day_numbers = [
+        n for n in schedule_numbers if n not in timer_program_numbers
+    ]
     update_Luxtronik_Parameter_Classes(time_of_day_numbers, TimeOfDay)
     update_Luxtronik_Parameter_Classes(list(timer_program_numbers), TimerProgram)
     # The ventilation circuit sits apart at 895 (selector) and 896-955, and

tests/test_lux_overrides.py

@@ -843,6 +843,121 @@ def test_heating_block_is_still_covered(self):
         for number in (223, 282):
             assert isinstance(parameters[number], TimeOfDay), number
 
+    def test_mixing_circuit_3_block_is_covered(self):
+        """788-848 is the Mk3 circuit, apart from the 162-667 run.
+
+        Same selector + WO/25/TG shape as the others (upstream `main` types
+        it that way); two corpus units carry 34200 / 18000 (09:30 / 05:00)
+        in 789, the rest hold 0.
+        """
+        from custom_components.luxtronik2.lux_overrides import (
+            TimeOfDay,
+            TimerProgram,
+        )
+
+        parameters = self._applied()
+        selector = parameters[788]
+        assert selector.name == "ID_Einst_SuMk3_akt2"
+        assert isinstance(selector, TimerProgram)
+        assert selector.from_heatpump(0) == "week"
+        for number in (789, 848):
+            assert isinstance(parameters[number], TimeOfDay), number
+        assert parameters[789].name == "ID_Einst_SuMk3Wo_zeit_0_0"
+        assert parameters[789].from_heatpump(34200) == "09:30"
+        assert parameters[848].name == "ID_Einst_SuMk3Tg_zeit_2_13"
+        # The block is 788-848: 787 (ID_SU_FstdMK3) and 849
+        # (ID_Ba_Hz_MK3_saved) are not schedule registers.
+        assert not isinstance(parameters[787], TimeOfDay | TimerProgram)
+        assert not isinstance(parameters[849], TimeOfDay | TimerProgram)
+
+
+class TestUpstreamCelsiusParameters:
+    """Six limit temperatures upstream `main` types as Celsius (tenths).
+
+    All 30 corpus units store plausible tenths (84 at 650-700, 87 at
+    350-650, 91 at 350-450, 92 at -200/-220, 94 at 1150-1400, 96 at 500
+    everywhere), which also matches the setting each one names.
+    """
+
+    _EXPECTED = {
+        84: ("ID_Sollwert_TLG_max", 700, 70.0),
+        87: ("ID_Einst_TRBegr_akt", 560, 56.0),
+        91: ("ID_Einst_TAmax_akt", 350, 35.0),
+        92: ("ID_Einst_TAmin_akt", -200, -20.0),
+        94: ("ID_Einst_THGmax_akt", 1150, 115.0),
+        96: ("ID_Einst_TV2VDBW_akt", 500, 50.0),
+    }
+
+    def test_are_celsius_in_tenths(self):
+        from luxtronik.datatypes import Celsius
+        from luxtronik.parameters import Parameters
+
+        from custom_components.luxtronik2.lux_overrides import (
+            update_Luxtronik_Parameters,
+        )
+
+        update_Luxtronik_Parameters()
+        for number, (name, raw, value) in self._EXPECTED.items():
+            parameter = Parameters.parameters[number]
+            assert parameter.name == name, number
+            assert isinstance(parameter, Celsius), number
+            assert parameter.from_heatpump(raw) == value, number
+
+
+class TestUpstreamCounterParameters:
+    """Operating-time counters and the heat-quantity date, typed as upstream
+    `main` does. Nothing in the integration reads these registers (the
+    sensors use the calculation mirrors 56-66); this only makes diagnostics
+    dumps readable.
+    """
+
+    _SECONDS = {
+        668: "ID_Zaehler_BetrZeitWP",
+        669: "ID_Zaehler_BetrZeitVD1",
+        670: "ID_Zaehler_BetrZeitVD2",
+        671: "ID_Zaehler_BetrZeitZWE1",
+        672: "ID_Zaehler_BetrZeitZWE2",
+        673: "ID_Zaehler_BetrZeitZWE3",
+        728: "ID_Zaehler_BetrZeitHz",
+        729: "ID_Zaehler_BetrZeitBW",
+        730: "ID_Zaehler_BetrZeitKue",
+        859: "ID_Zaehler_BetrZeitSW",
+    }
+
+    def _applied(self):
+        from luxtronik.parameters import Parameters
+
+        from custom_components.luxtronik2.lux_overrides import (
+            update_Luxtronik_Parameters,
+        )
+
+        update_Luxtronik_Parameters()
+        return Parameters.parameters
+
+    def test_operating_time_counters_are_seconds(self):
+        from luxtronik.datatypes import Seconds
+
+        parameters = self._applied()
+        for number, name in self._SECONDS.items():
+            assert parameters[number].name == name, number
+            assert isinstance(parameters[number], Seconds), number
+        # 60515833 s on one corpus unit, i.e. about 700 days of runtime.
+        assert parameters[668].from_heatpump(60515833) == 60515833
+
+    def test_heat_quantity_date_is_a_timestamp(self):
+        from datetime import date, datetime
+
+        from luxtronik.datatypes import Timestamp
+
+        parameter = self._applied()[880]
+        assert parameter.name == "ID_Waermemenge_Datum"
+        assert isinstance(parameter, Timestamp)
+        # Eight corpus units sit on the 2018-01-01 factory default
+        # (01:00 UTC; the library renders it in the host's local zone).
+        rendered = parameter.from_heatpump(1514768400)
+        assert isinstance(rendered, datetime)
+        assert rendered.date() in (date(2017, 12, 31), date(2018, 1, 1))
+
 
 class TestSmartGridMode:
     """P1030 is a four-option mode selector, so it needs a real datatype.