Bump python-bsblan to v3.1.3 (home-assistant#157626)

Author: liudger

homeassistant/components/bsblan/climate.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, Final
 
 from bsblan import BSBLANError
 
@@ -17,7 +17,7 @@
 )
 from homeassistant.const import ATTR_TEMPERATURE
 from homeassistant.core import HomeAssistant
-from homeassistant.exceptions import HomeAssistantError, ServiceValidationError
+from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers.device_registry import format_mac
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 from homeassistant.util.enum import try_parse_enum
@@ -39,6 +39,22 @@
     PRESET_NONE,
 ]
 
+# Mapping from Home Assistant HVACMode to BSB-Lan integer values
+# BSB-Lan uses: 0=off, 1=auto, 2=eco/reduced, 3=heat/comfort
+HA_TO_BSBLAN_HVAC_MODE: Final[dict[HVACMode, int]] = {
+    HVACMode.OFF: 0,
+    HVACMode.AUTO: 1,
+    HVACMode.HEAT: 3,
+}
+
+# Mapping from BSB-Lan integer values to Home Assistant HVACMode
+BSBLAN_TO_HA_HVAC_MODE: Final[dict[int, HVACMode]] = {
+    0: HVACMode.OFF,
+    1: HVACMode.AUTO,
+    2: HVACMode.AUTO,  # eco/reduced maps to AUTO with preset
+    3: HVACMode.HEAT,
+}
+
 
 async def async_setup_entry(
     hass: HomeAssistant,
@@ -98,17 +114,20 @@ def target_temperature(self) -> float | None:
     @property
     def hvac_mode(self) -> HVACMode | None:
         """Return hvac operation ie. heat, cool mode."""
-        if self.coordinator.data.state.hvac_mode.value == PRESET_ECO:
-            return HVACMode.AUTO
-        return try_parse_enum(HVACMode, self.coordinator.data.state.hvac_mode.value)
+        hvac_mode_value = self.coordinator.data.state.hvac_mode.value
+        if hvac_mode_value is None:
+            return None
+        # BSB-Lan returns integer values: 0=off, 1=auto, 2=eco, 3=heat
+        if isinstance(hvac_mode_value, int):
+            return BSBLAN_TO_HA_HVAC_MODE.get(hvac_mode_value)
+        return try_parse_enum(HVACMode, hvac_mode_value)
 
     @property
     def preset_mode(self) -> str | None:
         """Return the current preset mode."""
-        if (
-            self.hvac_mode == HVACMode.AUTO
-            and self.coordinator.data.state.hvac_mode.value == PRESET_ECO
-        ):
+        hvac_mode_value = self.coordinator.data.state.hvac_mode.value
+        # BSB-Lan mode 2 is eco/reduced mode
+        if hvac_mode_value == 2:
             return PRESET_ECO
         return PRESET_NONE
 
@@ -118,13 +137,6 @@ async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
 
     async def async_set_preset_mode(self, preset_mode: str) -> None:
         """Set preset mode."""
-        if self.hvac_mode != HVACMode.AUTO and preset_mode != PRESET_NONE:
-            raise ServiceValidationError(
-                "Preset mode can only be set when HVAC mode is set to 'auto'",
-                translation_domain=DOMAIN,
-                translation_key="set_preset_mode_error",
-                translation_placeholders={"preset_mode": preset_mode},
-            )
         await self.async_set_data(preset_mode=preset_mode)
 
     async def async_set_temperature(self, **kwargs: Any) -> None:
@@ -133,16 +145,17 @@ async def async_set_temperature(self, **kwargs: Any) -> None:
 
     async def async_set_data(self, **kwargs: Any) -> None:
         """Set device settings using BSBLAN."""
-        data = {}
+        data: dict[str, Any] = {}
         if ATTR_TEMPERATURE in kwargs:
             data[ATTR_TARGET_TEMPERATURE] = kwargs[ATTR_TEMPERATURE]
         if ATTR_HVAC_MODE in kwargs:
-            data[ATTR_HVAC_MODE] = kwargs[ATTR_HVAC_MODE]
+            data[ATTR_HVAC_MODE] = HA_TO_BSBLAN_HVAC_MODE[kwargs[ATTR_HVAC_MODE]]
         if ATTR_PRESET_MODE in kwargs:
+            # eco preset uses BSB-Lan mode 2, none preset uses mode 1 (auto)
             if kwargs[ATTR_PRESET_MODE] == PRESET_ECO:
-                data[ATTR_HVAC_MODE] = PRESET_ECO
+                data[ATTR_HVAC_MODE] = 2
             elif kwargs[ATTR_PRESET_MODE] == PRESET_NONE:
-                data[ATTR_HVAC_MODE] = PRESET_NONE
+                data[ATTR_HVAC_MODE] = 1
 
         try:
             await self.coordinator.client.thermostat(**data)

homeassistant/components/bsblan/manifest.json

@@ -7,7 +7,7 @@
   "integration_type": "device",
   "iot_class": "local_polling",
   "loggers": ["bsblan"],
-  "requirements": ["python-bsblan==3.1.1"],
+  "requirements": ["python-bsblan==3.1.3"],
   "zeroconf": [
     {
       "name": "bsb-lan*",

homeassistant/components/bsblan/water_heater.py

@@ -4,7 +4,7 @@
 
 from typing import Any
 
-from bsblan import BSBLANError
+from bsblan import BSBLANError, SetHotWaterParam
 
 from homeassistant.components.water_heater import (
     STATE_ECO,
@@ -131,7 +131,9 @@ async def async_set_temperature(self, **kwargs: Any) -> None:
         """Set new target temperature."""
         temperature = kwargs.get(ATTR_TEMPERATURE)
         try:
-            await self.coordinator.client.set_hot_water(nominal_setpoint=temperature)
+            await self.coordinator.client.set_hot_water(
+                SetHotWaterParam(nominal_setpoint=temperature)
+            )
         except BSBLANError as err:
             raise HomeAssistantError(
                 translation_domain=DOMAIN,
@@ -144,7 +146,9 @@ async def async_set_operation_mode(self, operation_mode: str) -> None:
         """Set new operation mode."""
         bsblan_mode = OPERATION_MODES_REVERSE.get(operation_mode)
         try:
-            await self.coordinator.client.set_hot_water(operating_mode=bsblan_mode)
+            await self.coordinator.client.set_hot_water(
+                SetHotWaterParam(operating_mode=bsblan_mode)
+            )
         except BSBLANError as err:
             raise HomeAssistantError(
                 translation_domain=DOMAIN,

requirements_all.txt

@@ -2,7 +2,7 @@
   "hvac_mode": {
     "name": "Operating mode",
     "error": 0,
-    "value": "heat",
+    "value": 3,
     "desc": "Komfort",
     "dataType": 1,
     "readonly": 0,

requirements_test_all.txt

@@ -121,7 +121,7 @@
           'readonly': 0,
           'readwrite': 0,
           'unit': '',
-          'value': 'heat',
+          'value': 3,
         }),
         'hvac_mode_changeover': None,
         'room1_temp_setpoint_boost': dict({
@@ -243,7 +243,6 @@
         }),
         'legionella_circulation_pump': None,
         'legionella_circulation_temp_diff': None,
-        'legionella_dwelling_time': None,
         'legionella_function': dict({
           'data_type': 1,
           'desc': 'Off',
@@ -256,29 +255,10 @@
           'value': 0,
         }),
         'legionella_function_day': None,
+        'legionella_function_dwelling_time': None,
+        'legionella_function_periodicity': None,
+        'legionella_function_setpoint': None,
         'legionella_function_time': None,
-        'legionella_periodicity': dict({
-          'data_type': 1,
-          'desc': 'Weekly',
-          'error': 0,
-          'name': 'Legionella function periodicity',
-          'precision': None,
-          'readonly': 0,
-          'readwrite': 0,
-          'unit': '',
-          'value': 7,
-        }),
-        'legionella_setpoint': dict({
-          'data_type': 0,
-          'desc': '',
-          'error': 0,
-          'name': 'Legionella function setpoint',
-          'precision': None,
-          'readonly': 0,
-          'readwrite': 0,
-          'unit': '°C',
-          'value': 60.0,
-        }),
         'nominal_setpoint_max': dict({
           'data_type': 0,
           'desc': '',