python-bsblan 1.2.2__tar.gz → 2.0.0__tar.gz

{python_bsblan-1.2.2 → python_bsblan-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-bsblan
-Version: 1.2.2
+Version: 2.0.0
 Summary: Asynchronous Python client for BSBLAN API
 License: MIT
 Keywords: bsblan,thermostat,client,api,async
@@ -20,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: aiohttp (>=3.8.1)
-Requires-Dist: async-timeout (>=4.0.3,<5.0.0)
+Requires-Dist: async-timeout (>=5.0.0,<6.0.0)
 Requires-Dist: backoff (>=2.2.1,<3.0.0)
 Requires-Dist: mashumaro (>=3.13.1,<4.0.0)
 Requires-Dist: orjson (>=3.9.10,<4.0.0)

{python_bsblan-1.2.2 → python_bsblan-2.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-bsblan"
-version = "1.2.2"
+version = "2.0.0"
 description = "Asynchronous Python client for BSBLAN API"
 authors = ["Willem-Jan van Rootselaar <liudgervr@gmail.com>"]
 maintainers = ["Willem-Jan van Rootselaar <liudgervr@gmail.com>"]
@@ -31,7 +31,7 @@ aiohttp = ">=3.8.1"
 yarl = ">=1.7.2"
 packaging = ">=21.3"
 backoff = "^2.2.1"
-async-timeout = "^4.0.3"
+async-timeout = "^5.0.0"
 mashumaro = "^3.13.1"
 orjson = "^3.9.10"
 
@@ -40,29 +40,29 @@ orjson = "^3.9.10"
 Changelog = "https://github.com/liudger/python-bsblan/releases"
 
 [tool.poetry.group.dev.dependencies]
-covdefaults = "^2.3.0"
-ruff = "^0.7.0"
-aresponses = "^3.0.0"
-black = "^25.0.0"
-blacken-docs = "^1.13.0"
-coverage = "^7.0.5"
-flake8 = "^7.0.0"
-isort = "^6.0.0"
-mypy = "^1.0.0"
-pre-commit = "^4.0.0"
-pre-commit-hooks = "^5.0.0"
-pylint = "^3.0.0"
-pytest = "^8.0.0"
-pytest-asyncio = "^0.25.0"
-pytest-cov = "^6.0.0"
-yamllint = "^1.29.0"
-pyupgrade = "^3.3.1"
-flake8-simplify = "^0.21.0"
-vulture = "^2.7"
-darglint = "^1.8.1"
-safety = "^3.0.0"
-codespell = "^2.2.2"
-bandit = "^1.7.4"
+covdefaults = "2.3.0"
+ruff = "0.7.4"
+aresponses = "3.0.0"
+black = "25.1.0"
+blacken-docs = "1.19.1"
+coverage = "7.8.2"
+flake8 = "7.2.0"
+isort = "6.0.1"
+mypy = "1.16.0"
+pre-commit = "4.2.0"
+pre-commit-hooks = "5.0.0"
+pylint = "3.3.7"
+pytest = "8.3.5"
+pytest-asyncio = "0.26.0"
+pytest-cov = "6.1.1"
+yamllint = "1.37.1"
+pyupgrade = "3.19.1"
+flake8-simplify = "0.22.0"
+vulture = "2.14"
+darglint = "1.8.1"
+safety = "3.5.1"
+codespell = "2.4.1"
+bandit = "1.8.3"
 
 
 [tool.coverage.run]

{python_bsblan-1.2.2 → python_bsblan-2.0.0}/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",

{python_bsblan-1.2.2 → python_bsblan-2.0.0}/src/bsblan/bsblan.py

@@ -5,7 +5,10 @@ from __future__ import annotations
 import asyncio
 import logging
 from dataclasses import dataclass, field
-from typing import TYPE_CHECKING, Any, Literal, Mapping, cast
+from typing import TYPE_CHECKING, Any, Literal, cast
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
 
 import aiohttp
 from aiohttp.hdrs import METH_POST
@@ -34,7 +37,15 @@ from .exceptions import (
     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:
@@ -200,6 +211,9 @@ class BSBLAN:
         version = pkg_version.parse(self._firmware_version)
         if version < pkg_version.parse("1.2.0"):
             self._api_version = "v1"
+        elif version >= pkg_version.parse("5.0.0"):
+            # BSB-LAN 5.0+ has breaking changes but uses v3-compatible API
+            self._api_version = "v3"
         elif version >= pkg_version.parse("3.0.0"):
             self._api_version = "v3"
         else:
@@ -298,7 +312,8 @@ class BSBLAN:
                     headers=headers,
                 ) as response:
                     response.raise_for_status()
-                    return cast(dict[str, Any], await response.json())
+                    response_data = cast("dict[str, Any]", await response.json())
+                    return self._process_response(response_data, base_path)
         except asyncio.TimeoutError as e:
             raise BSBLANConnectionError(BSBLANConnectionError.message_timeout) from e
         except aiohttp.ClientError as e:
@@ -306,6 +321,38 @@ class BSBLAN:
         except ValueError as e:
             raise BSBLANError(str(e)) from e
 
+    def _process_response(
+        self, response_data: dict[str, Any], base_path: str
+    ) -> dict[str, Any]:
+        """Process response data based on firmware version.
+
+        BSB-LAN 5.0+ includes additional 'payload' field in /JQ responses
+        that needs to be handled for compatibility.
+
+        Args:
+            response_data: Raw response data from BSB-LAN
+            base_path: The API endpoint that was called
+
+        Returns:
+            Processed response data compatible with existing code
+
+        """
+        # For non-JQ endpoints, return response as-is
+        if base_path != "/JQ":
+            return response_data
+
+        # Check if we have a firmware version to determine processing
+        if not self._firmware_version:
+            return response_data
+
+        # For BSB-LAN 5.0+, remove 'payload' field if present as it's for debugging
+        version = pkg_version.parse(self._firmware_version)
+        if version >= pkg_version.parse("5.0.0") and "payload" in response_data:
+            # Remove payload field if present - it's added for debugging in 5.0+
+            return {k: v for k, v in response_data.items() if k != "payload"}
+
+        return response_data
+
     def _build_url(self, base_path: str) -> URL:
         """Build the URL for the request.
 
@@ -553,23 +600,75 @@ class BSBLAN:
         data = dict(zip(params["list"], list(data.values()), strict=True))
         return HotWaterState.from_dict(data)
 
-    async def set_hot_water(
+    async def set_hot_water(  # noqa: PLR0913
         self,
         nominal_setpoint: float | None = None,
         reduced_setpoint: float | None = None,
         operating_mode: str | None = None,
-    ) -> None:
+        dhw_time_programs: DHWTimeSwitchPrograms | None = None,
+        eco_mode_selection: str | None = None,
+        dhw_charging_priority: str | None = None,
+        legionella_dwelling_time: float | None = None,
+        legionella_circulation_pump: str | None = None,
+        legionella_circulation_temp_diff: float | None = None,
+        dhw_circulation_pump_release: str | None = None,
+        dhw_circulation_pump_cycling: float | None = None,
+        dhw_circulation_setpoint: float | None = None,
+        operating_mode_changeover: str | None = None,
+    ) -> None:  # pylint: disable=too-many-arguments,too-many-positional-arguments,too-many-locals
         """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.
+            eco_mode_selection (str | None): Eco mode selection.
+            dhw_charging_priority (str | None): DHW charging priority.
+            legionella_dwelling_time (float | None): Legionella dwelling time.
+            legionella_circulation_pump (str | None): Legionella circulation pump.
+            legionella_circulation_temp_diff (float | None): Legionella circulation
+                temperature difference.
+            dhw_circulation_pump_release (str | None): DHW circulation pump release.
+            dhw_circulation_pump_cycling (float | None): DHW circulation pump cycling.
+            dhw_circulation_setpoint (float | None): DHW circulation setpoint.
+            operating_mode_changeover (str | None): Operating mode changeover.
 
         """
+        # 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,
+            eco_mode_selection,
+            dhw_charging_priority,
+            legionella_dwelling_time,
+            legionella_circulation_pump,
+            legionella_circulation_temp_diff,
+            dhw_circulation_pump_release,
+            dhw_circulation_pump_cycling,
+            dhw_circulation_setpoint,
+            operating_mode_changeover,
+            *time_program_params,
             error_msg=MULTI_PARAMETER_ERROR_MSG,
         )
 
@@ -577,20 +676,52 @@ class BSBLAN:
             nominal_setpoint,
             reduced_setpoint,
             operating_mode,
+            dhw_time_programs,
+            eco_mode_selection,
+            dhw_charging_priority,
+            legionella_dwelling_time,
+            legionella_circulation_pump,
+            legionella_circulation_temp_diff,
+            dhw_circulation_pump_release,
+            dhw_circulation_pump_cycling,
+            dhw_circulation_setpoint,
+            operating_mode_changeover,
         )
         await self._set_hot_water_state(state)
 
-    def _prepare_hot_water_state(
+    def _prepare_hot_water_state(  # noqa: PLR0913, PLR0912
         self,
         nominal_setpoint: float | None,
         reduced_setpoint: float | None,
         operating_mode: str | None,
-    ) -> dict[str, Any]:
+        dhw_time_programs: DHWTimeSwitchPrograms | None = None,
+        eco_mode_selection: str | None = None,
+        dhw_charging_priority: str | None = None,
+        legionella_dwelling_time: float | None = None,
+        legionella_circulation_pump: str | None = None,
+        legionella_circulation_temp_diff: float | None = None,
+        dhw_circulation_pump_release: str | None = None,
+        dhw_circulation_pump_cycling: float | None = None,
+        dhw_circulation_setpoint: float | None = None,
+        operating_mode_changeover: str | None = None,
+    ) -> dict[str, Any]:  # pylint: disable=too-many-arguments,too-many-positional-arguments,too-many-locals,too-many-branches
         """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.
+            eco_mode_selection (str | None): Eco mode selection.
+            dhw_charging_priority (str | None): DHW charging priority.
+            legionella_dwelling_time (float | None): Legionella dwelling time.
+            legionella_circulation_pump (str | None): Legionella circulation pump.
+            legionella_circulation_temp_diff (float | None): Legionella circulation
+                temperature difference.
+            dhw_circulation_pump_release (str | None): DHW circulation pump release.
+            dhw_circulation_pump_cycling (float | None): DHW circulation pump cycling.
+            dhw_circulation_setpoint (float | None): DHW circulation setpoint.
+            operating_mode_changeover (str | None): Operating mode changeover.
 
         Returns:
             dict[str, Any]: The prepared state for the hot water.
@@ -616,6 +747,95 @@ class BSBLAN:
                     "Type": "1",
                 },
             )
+        if eco_mode_selection is not None:
+            state.update(
+                {
+                    "Parameter": "1601",
+                    "EnumValue": eco_mode_selection,
+                    "Type": "1",
+                },
+            )
+        if dhw_charging_priority is not None:
+            state.update(
+                {
+                    "Parameter": "1630",
+                    "EnumValue": dhw_charging_priority,
+                    "Type": "1",
+                },
+            )
+        if legionella_dwelling_time is not None:
+            state.update(
+                {
+                    "Parameter": "1646",
+                    "Value": str(legionella_dwelling_time),
+                    "Type": "1",
+                },
+            )
+        if legionella_circulation_pump is not None:
+            state.update(
+                {
+                    "Parameter": "1647",
+                    "EnumValue": legionella_circulation_pump,
+                    "Type": "1",
+                },
+            )
+        if legionella_circulation_temp_diff is not None:
+            state.update(
+                {
+                    "Parameter": "1648",
+                    "Value": str(legionella_circulation_temp_diff),
+                    "Type": "1",
+                },
+            )
+        if dhw_circulation_pump_release is not None:
+            state.update(
+                {
+                    "Parameter": "1660",
+                    "EnumValue": dhw_circulation_pump_release,
+                    "Type": "1",
+                },
+            )
+        if dhw_circulation_pump_cycling is not None:
+            state.update(
+                {
+                    "Parameter": "1661",
+                    "Value": str(dhw_circulation_pump_cycling),
+                    "Type": "1",
+                },
+            )
+        if dhw_circulation_setpoint is not None:
+            state.update(
+                {
+                    "Parameter": "1663",
+                    "Value": str(dhw_circulation_setpoint),
+                    "Type": "1",
+                },
+            )
+        if operating_mode_changeover is not None:
+            state.update(
+                {
+                    "Parameter": "1680",
+                    "EnumValue": operating_mode_changeover,
+                    "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

{python_bsblan-1.2.2 → python_bsblan-2.0.0}/src/bsblan/constants.py

@@ -51,17 +51,34 @@ API_V1: Final[APIConfig] = {
     },
     "hot_water": {
         "1600": "operating_mode",
+        "1601": "eco_mode_selection",
         "1610": "nominal_setpoint",
         "1614": "nominal_setpoint_max",
         "1612": "reduced_setpoint",
         "1620": "release",
+        "1630": "dhw_charging_priority",
         "1640": "legionella_function",
         "1645": "legionella_setpoint",
         "1641": "legionella_periodicity",
         "1642": "legionella_function_day",
         "1643": "legionella_function_time",
+        "1646": "legionella_dwelling_time",
+        "1647": "legionella_circulation_pump",
+        "1648": "legionella_circulation_temp_diff",
+        "1660": "dhw_circulation_pump_release",
+        "1661": "dhw_circulation_pump_cycling",
+        "1663": "dhw_circulation_setpoint",
+        "1680": "operating_mode_changeover",
         "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",
     },
 }
 
@@ -90,17 +107,34 @@ API_V3: Final[APIConfig] = {
     },
     "hot_water": {
         "1600": "operating_mode",
+        "1601": "eco_mode_selection",
         "1610": "nominal_setpoint",
         "1614": "nominal_setpoint_max",
         "1612": "reduced_setpoint",
         "1620": "release",
+        "1630": "dhw_charging_priority",
         "1640": "legionella_function",
         "1645": "legionella_setpoint",
         "1641": "legionella_periodicity",
         "1642": "legionella_function_day",
         "1644": "legionella_function_time",
+        "1646": "legionella_dwelling_time",
+        "1647": "legionella_circulation_pump",
+        "1648": "legionella_circulation_temp_diff",
+        "1660": "dhw_circulation_pump_release",
+        "1661": "dhw_circulation_pump_cycling",
+        "1663": "dhw_circulation_setpoint",
+        "1680": "operating_mode_changeover",
         "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",
     },
 }
 

{python_bsblan-1.2.2 → python_bsblan-2.0.0}/src/bsblan/models.py

@@ -14,6 +14,20 @@ from mashumaro.mixins.json import DataClassJSONMixin
 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,21 +177,38 @@ 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
+    eco_mode_selection: EntityInfo | None = None
     nominal_setpoint: EntityInfo | None = None
     nominal_setpoint_max: EntityInfo | None = None
     reduced_setpoint: EntityInfo | None = None
     release: EntityInfo | None = None
+    dhw_charging_priority: EntityInfo | None = None
     legionella_function: EntityInfo | None = None
     legionella_setpoint: EntityInfo | None = None
     legionella_periodicity: EntityInfo | None = None
     legionella_function_day: EntityInfo | None = None
     legionella_function_time: EntityInfo | None = None
+    legionella_dwelling_time: EntityInfo | None = None
+    legionella_circulation_pump: EntityInfo | None = None
+    legionella_circulation_temp_diff: EntityInfo | None = None
+    dhw_circulation_pump_release: EntityInfo | None = None
+    dhw_circulation_pump_cycling: EntityInfo | None = None
+    dhw_circulation_setpoint: EntityInfo | None = None
+    operating_mode_changeover: 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