Merge pull request #1137 from liudger/copilot/fix-1136

Author: liudger

examples/control.py

@@ -17,6 +17,7 @@
     State,
     StaticState,
 )
+from bsblan.models import DHWTimeSwitchPrograms
 
 
 async def get_attribute(
@@ -157,6 +158,27 @@ async def print_hot_water_state(hot_water_state: HotWaterState) -> None:
         "Current Temperature": await get_attribute(
             hot_water_state.dhw_actual_value_top_temperature, "value", "N/A"
         ),
+        "Time Program Monday": await get_attribute(
+            hot_water_state.dhw_time_program_monday, "value", "N/A"
+        ),
+        "Time Program Tuesday": await get_attribute(
+            hot_water_state.dhw_time_program_tuesday, "value", "N/A"
+        ),
+        "Time Program Wednesday": await get_attribute(
+            hot_water_state.dhw_time_program_wednesday, "value", "N/A"
+        ),
+        "Time Program Thursday": await get_attribute(
+            hot_water_state.dhw_time_program_thursday, "value", "N/A"
+        ),
+        "Time Program Friday": await get_attribute(
+            hot_water_state.dhw_time_program_friday, "value", "N/A"
+        ),
+        "Time Program Saturday": await get_attribute(
+            hot_water_state.dhw_time_program_saturday, "value", "N/A"
+        ),
+        "Time Program Sunday": await get_attribute(
+            hot_water_state.dhw_time_program_sunday, "value", "N/A"
+        ),
     }
     print_attributes("Hot Water State", attributes)
 
@@ -202,6 +224,14 @@ async def main() -> None:
         hot_water_state: HotWaterState = await bsblan.hot_water_state()
         await print_hot_water_state(hot_water_state)
 
+        # Example: Set DHW time program for Monday
+        print("\nSetting DHW time program for Monday to 13:00-14:00")
+
+        dhw_programs = DHWTimeSwitchPrograms(
+            monday="13:00-14:00 ##:##-##:## ##:##-##:##"
+        )
+        await bsblan.set_hot_water(dhw_time_programs=dhw_programs)
+
 
 if __name__ == "__main__":
     asyncio.run(main())

src/bsblan/__init__.py

@@ -2,13 +2,22 @@
 
 from .bsblan import BSBLAN, BSBLANConfig
 from .exceptions import BSBLANConnectionError, BSBLANError
-from .models import Device, HotWaterState, Info, Sensor, State, StaticState
+from .models import (
+    Device,
+    DHWTimeSwitchPrograms,
+    HotWaterState,
+    Info,
+    Sensor,
+    State,
+    StaticState,
+)
 
 __all__ = [
     "BSBLAN",
     "BSBLANConfig",
     "BSBLANConnectionError",
     "BSBLANError",
+    "DHWTimeSwitchPrograms",
     "Info",
     "State",
     "Device",

src/bsblan/bsblan.py

@@ -34,7 +34,15 @@
     BSBLANInvalidParameterError,
     BSBLANVersionError,
 )
-from .models import Device, HotWaterState, Info, Sensor, State, StaticState
+from .models import (
+    Device,
+    DHWTimeSwitchPrograms,
+    HotWaterState,
+    Info,
+    Sensor,
+    State,
+    StaticState,
+)
 from .utility import APIValidator
 
 if TYPE_CHECKING:
@@ -558,25 +566,50 @@ async def set_hot_water(
         nominal_setpoint: float | None = None,
         reduced_setpoint: float | None = None,
         operating_mode: str | None = None,
+        dhw_time_programs: DHWTimeSwitchPrograms | None = None,
     ) -> None:
         """Change the state of the hot water system through BSB-Lan.
 
         Args:
             nominal_setpoint (float | None): The nominal setpoint temperature to set.
             reduced_setpoint (float | None): The reduced setpoint temperature to set.
+            operating_mode (str | None): The operating mode to set.
+            dhw_time_programs (DHWTimeSwitchPrograms | None): Time switch programs.
 
         """
+        # Validate only one parameter is being set
+        time_program_params = []
+        if dhw_time_programs:
+            if dhw_time_programs.monday:
+                time_program_params.append(dhw_time_programs.monday)
+            if dhw_time_programs.tuesday:
+                time_program_params.append(dhw_time_programs.tuesday)
+            if dhw_time_programs.wednesday:
+                time_program_params.append(dhw_time_programs.wednesday)
+            if dhw_time_programs.thursday:
+                time_program_params.append(dhw_time_programs.thursday)
+            if dhw_time_programs.friday:
+                time_program_params.append(dhw_time_programs.friday)
+            if dhw_time_programs.saturday:
+                time_program_params.append(dhw_time_programs.saturday)
+            if dhw_time_programs.sunday:
+                time_program_params.append(dhw_time_programs.sunday)
+            if dhw_time_programs.standard_values:
+                time_program_params.append(dhw_time_programs.standard_values)
+
         self._validate_single_parameter(
             nominal_setpoint,
             reduced_setpoint,
             operating_mode,
+            *time_program_params,
             error_msg=MULTI_PARAMETER_ERROR_MSG,
         )
 
         state = self._prepare_hot_water_state(
             nominal_setpoint,
             reduced_setpoint,
             operating_mode,
+            dhw_time_programs,
         )
         await self._set_hot_water_state(state)
 
@@ -585,12 +618,15 @@ def _prepare_hot_water_state(
         nominal_setpoint: float | None,
         reduced_setpoint: float | None,
         operating_mode: str | None,
+        dhw_time_programs: DHWTimeSwitchPrograms | None = None,
     ) -> dict[str, Any]:
         """Prepare the hot water state for setting.
 
         Args:
             nominal_setpoint (float | None): The nominal setpoint temperature to set.
             reduced_setpoint (float | None): The reduced setpoint temperature to set.
+            operating_mode (str | None): The operating mode to set.
+            dhw_time_programs (DHWTimeSwitchPrograms | None): Time switch programs.
 
         Returns:
             dict[str, Any]: The prepared state for the hot water.
@@ -616,6 +652,23 @@ def _prepare_hot_water_state(
                     "Type": "1",
                 },
             )
+
+        if dhw_time_programs:
+            time_program_mapping = {
+                "561": dhw_time_programs.monday,
+                "562": dhw_time_programs.tuesday,
+                "563": dhw_time_programs.wednesday,
+                "564": dhw_time_programs.thursday,
+                "565": dhw_time_programs.friday,
+                "566": dhw_time_programs.saturday,
+                "567": dhw_time_programs.sunday,
+                "576": dhw_time_programs.standard_values,
+            }
+
+            for param, value in time_program_mapping.items():
+                if value is not None:
+                    state.update({"Parameter": param, "Value": value, "Type": "1"})
+
         if not state:
             raise BSBLANError(NO_STATE_ERROR_MSG)
         return state

src/bsblan/constants.py

@@ -62,6 +62,14 @@ class APIConfig(TypedDict):
         "1643": "legionella_function_time",
         "8830": "dhw_actual_value_top_temperature",
         "8820": "state_dhw_pump",
+        "561": "dhw_time_program_monday",
+        "562": "dhw_time_program_tuesday",
+        "563": "dhw_time_program_wednesday",
+        "564": "dhw_time_program_thursday",
+        "565": "dhw_time_program_friday",
+        "566": "dhw_time_program_saturday",
+        "567": "dhw_time_program_sunday",
+        "576": "dhw_time_program_standard_values",
     },
 }
 
@@ -101,6 +109,14 @@ class APIConfig(TypedDict):
         "1644": "legionella_function_time",
         "8830": "dhw_actual_value_top_temperature",
         "8820": "state_dhw_pump",
+        "561": "dhw_time_program_monday",
+        "562": "dhw_time_program_tuesday",
+        "563": "dhw_time_program_wednesday",
+        "564": "dhw_time_program_thursday",
+        "565": "dhw_time_program_friday",
+        "566": "dhw_time_program_saturday",
+        "567": "dhw_time_program_sunday",
+        "576": "dhw_time_program_standard_values",
     },
 }
 

src/bsblan/models.py

@@ -14,6 +14,20 @@
 from bsblan.constants import TEMPERATURE_UNITS
 
 
+@dataclass
+class DHWTimeSwitchPrograms:
+    """Dataclass for DHW time switch programs."""
+
+    monday: str | None = None
+    tuesday: str | None = None
+    wednesday: str | None = None
+    thursday: str | None = None
+    friday: str | None = None
+    saturday: str | None = None
+    sunday: str | None = None
+    standard_values: str | None = None
+
+
 class DataType(IntEnum):
     """Enumeration of BSB-LAN data types."""
 
@@ -163,7 +177,7 @@ class Sensor(DataClassJSONMixin):
 
 
 @dataclass
-class HotWaterState(DataClassJSONMixin):
+class HotWaterState(DataClassJSONMixin):  # pylint: disable=too-many-instance-attributes
     """Object holds info about object for hot water climate."""
 
     operating_mode: EntityInfo | None = None
@@ -178,6 +192,14 @@ class HotWaterState(DataClassJSONMixin):
     legionella_function_time: EntityInfo | None = None
     dhw_actual_value_top_temperature: EntityInfo | None = None
     state_dhw_pump: EntityInfo | None = None
+    dhw_time_program_monday: EntityInfo | None = None
+    dhw_time_program_tuesday: EntityInfo | None = None
+    dhw_time_program_wednesday: EntityInfo | None = None
+    dhw_time_program_thursday: EntityInfo | None = None
+    dhw_time_program_friday: EntityInfo | None = None
+    dhw_time_program_saturday: EntityInfo | None = None
+    dhw_time_program_sunday: EntityInfo | None = None
+    dhw_time_program_standard_values: EntityInfo | None = None
 
 
 @dataclass