Add support for AtlanticPassAPCDHW (WaterHeatingSystem) (#281)

Co-authored-by: Mick Vleeshouwer <[email protected]>
Co-authored-by: Vincent Le Bourlot <[email protected]>

custom_components/tahoma/climate.py

@@ -3,6 +3,7 @@
 from homeassistant.components.climate import DOMAIN as CLIMATE
 
 from .climate_devices.atlantic_electrical_heater import AtlanticElectricalHeater
+from .climate_devices.atlantic_pass_apcdhw import AtlanticPassAPCDHW
 from .climate_devices.dimmer_exterior_heating import DimmerExteriorHeating
 from .climate_devices.somfy_thermostat import SomfyThermostat
 from .climate_devices.stateless_exterior_heating import StatelessExteriorHeating
@@ -13,6 +14,7 @@
     "SomfyThermostat": SomfyThermostat,
     "DimmerExteriorHeating": DimmerExteriorHeating,
     "StatelessExteriorHeating": StatelessExteriorHeating,
+    "AtlanticPassAPCDHW": AtlanticPassAPCDHW,
 }
 
 SERVICE_CLIMATE_MY_POSITION = "set_climate_my_position"

custom_components/tahoma/climate_devices/atlantic_pass_apcdhw.py

@@ -0,0 +1,183 @@
+"""Support for AtlanticPassAPCDHWComponement."""
+from typing import List, Optional
+
+from homeassistant.components.climate import (
+    HVAC_MODE_HEAT,
+    HVAC_MODE_OFF,
+    SUPPORT_PRESET_MODE,
+    SUPPORT_TARGET_TEMPERATURE,
+    ClimateEntity,
+)
+from homeassistant.components.climate.const import (
+    PRESET_BOOST,
+    PRESET_COMFORT,
+    PRESET_ECO,
+)
+from homeassistant.const import ATTR_TEMPERATURE, TEMP_CELSIUS
+
+from ..tahoma_device import TahomaDevice
+
+BOOST_ON_STATE = "on"
+BOOST_OFF_STATE = "off"
+
+COMMAND_REFRESH_COMFORT_TARGET_DWH_TEMPERATURE = "refreshComfortTargetDHWTemperature"
+COMMAND_REFRESH_ECO_TARGET_DWH_TEMPERATURE = "refreshEcoTargetDHWTemperature"
+COMMAND_REFRESH_TARGET_DWH_TEMPERATURE = "refreshTargetDHWTemperature"
+COMMAND_SET_BOOST_ON_OFF_STATE = "setBoostOnOffState"
+COMMAND_SET_COMFORT_TARGET_DWH_TEMPERATURE = "setComfortTargetDHWTemperature"
+COMMAND_SET_DWH_ON_OFF_STATE = "setDHWOnOffState"
+COMMAND_SET_ECO_TARGET_DWH_TEMPERATURE = "setEcoTargetDHWTemperature"
+COMMAND_SET_PASS_APCDHW_MODE = "setPassAPCDHWMode"
+
+
+CORE_BOOST_ON_OFF_STATE = "core:BoostOnOffState"
+CORE_COMFORT_TARGET_DWH_TEMPERATURE_STATE = "core:ComfortTargetDHWTemperatureState"
+CORE_DHW_DEROGATION_AVAILABILITY_STATE = "core:DHWDerogationAvailabilityState"
+CORE_DWH_ON_OFF_STATE = "core:DHWOnOffState"
+CORE_ECO_TARGET_DWH_TEMPERATURE_STATE = "core:EcoTargetDHWTemperatureState"
+CORE_STATUS_STATE = "core:StatusState"
+CORE_TARGET_DWH_TEMPERATURE_STATE = "core:TargetDHWTemperatureState"
+
+CUSTOM_PRESET_OFF = "Off"
+CUSTOM_PRESET_PROG = "Prog"
+
+DWH_OFF_STATE = "off"
+DHW_ON_STATE = "on"
+
+IO_PASS_APCDHW_CONFIGURATION_STATE = "io:PassAPCDHWConfigurationState"
+IO_PASS_APCDWH_MODE_STATE = "io:PassAPCDHWModeState"
+IO_PASS_APCDHW_PROFILE_STATE = "io:PassAPCDHWProfileState"
+
+PASS_APCDHW_MODE_COMFORT = "comfort"
+PASS_APCDHW_MODE_ECO = "eco"
+PASS_APCDWH_MODE_INTERNAL_SCHEDULING = "internalScheduling"
+PASS_APCDHW_MODE_STOP = "stop"
+
+
+MAP_HVAC_MODES = {
+    DHW_ON_STATE: HVAC_MODE_HEAT,
+    DWH_OFF_STATE: HVAC_MODE_OFF,
+}
+MAP_REVERSE_HVAC_MODES = {v: k for k, v in MAP_HVAC_MODES.items()}
+
+MAP_PRESET_MODES = {
+    PASS_APCDHW_MODE_ECO: PRESET_ECO,
+    PASS_APCDHW_MODE_COMFORT: PRESET_COMFORT,
+    PRESET_BOOST: PRESET_BOOST,
+    PASS_APCDWH_MODE_INTERNAL_SCHEDULING: CUSTOM_PRESET_PROG,
+    PASS_APCDHW_MODE_STOP: CUSTOM_PRESET_OFF,
+}
+MAP_REVERSE_PRESET_MODES = {v: k for k, v in MAP_PRESET_MODES.items()}
+
+
+class AtlanticPassAPCDHW(TahomaDevice, ClimateEntity):
+    """Representation of TaHoma IO Atlantic Electrical Heater."""
+
+    @property
+    def temperature_unit(self) -> str:
+        """Return the unit of measurement used by the platform."""
+        return TEMP_CELSIUS
+
+    @property
+    def supported_features(self) -> int:
+        """Return the list of supported features."""
+        return SUPPORT_PRESET_MODE | SUPPORT_TARGET_TEMPERATURE
+
+    @property
+    def min_temp(self) -> float:
+        """Return minimum temperature."""
+        return 30
+
+    @property
+    def max_temp(self) -> float:
+        """Return maximum temperature."""
+        return 65
+
+    @property
+    def preset_mode(self) -> Optional[str]:
+        """Return the current preset mode, e.g., home, away, temp."""
+        if self.select_state(IO_PASS_APCDWH_MODE_STATE) in [
+            PASS_APCDHW_MODE_ECO,
+            PASS_APCDWH_MODE_INTERNAL_SCHEDULING,
+            PASS_APCDHW_MODE_STOP,
+        ]:
+            return MAP_PRESET_MODES[self.select_state(IO_PASS_APCDWH_MODE_STATE)]
+
+        if self.select_state(CORE_BOOST_ON_OFF_STATE) == BOOST_ON_STATE:
+            return PRESET_BOOST
+
+        return PRESET_COMFORT
+
+    @property
+    def preset_modes(self) -> Optional[List[str]]:
+        """Return a list of available preset modes."""
+        return [*MAP_REVERSE_PRESET_MODES]
+
+    async def async_set_preset_mode(self, preset_mode: str) -> None:
+        """Set new preset mode."""
+        if preset_mode in [
+            PRESET_COMFORT,
+            PRESET_ECO,
+            CUSTOM_PRESET_OFF,
+            CUSTOM_PRESET_PROG,
+        ]:
+            preset_mode_to_set = MAP_REVERSE_PRESET_MODES[preset_mode]
+            boost_mode_to_set = BOOST_OFF_STATE
+        elif preset_mode == PRESET_BOOST:
+            preset_mode_to_set = MAP_REVERSE_PRESET_MODES[PRESET_COMFORT]
+            boost_mode_to_set = BOOST_ON_STATE
+
+        await self.async_execute_command(
+            COMMAND_SET_BOOST_ON_OFF_STATE, boost_mode_to_set
+        )
+        await self.async_execute_command(
+            COMMAND_SET_PASS_APCDHW_MODE, preset_mode_to_set
+        )
+        await self.async_execute_command(COMMAND_REFRESH_TARGET_DWH_TEMPERATURE)
+
+    @property
+    def hvac_mode(self) -> str:
+        """Return hvac operation ie. heat, cool mode."""
+        return MAP_HVAC_MODES[self.select_state(CORE_DWH_ON_OFF_STATE)]
+
+    @property
+    def hvac_modes(self) -> List[str]:
+        """Return the list of available hvac operation modes."""
+        return [*MAP_REVERSE_HVAC_MODES]
+
+    async def async_set_hvac_mode(self, hvac_mode: str) -> None:
+        """Set new target hvac mode."""
+        await self.async_execute_command(
+            COMMAND_SET_DWH_ON_OFF_STATE, MAP_REVERSE_HVAC_MODES[hvac_mode]
+        )
+
+    @property
+    def target_temperature(self) -> None:
+        """Return the temperature corresponding to the PRESET."""
+        if self.preset_mode == PRESET_ECO:
+            return self.select_state(CORE_ECO_TARGET_DWH_TEMPERATURE_STATE)
+
+        if self.preset_mode in [PRESET_COMFORT, PRESET_BOOST]:
+            return self.select_state(CORE_COMFORT_TARGET_DWH_TEMPERATURE_STATE)
+
+        return self.select_state(CORE_TARGET_DWH_TEMPERATURE_STATE)
+
+    @property
+    def current_temperature(self):
+        """Return current temperature."""
+        return self.target_temperature
+
+    async def async_set_temperature(self, **kwargs) -> None:
+        """Set new temperature for current preset."""
+        temperature = kwargs.get(ATTR_TEMPERATURE)
+        if self.preset_mode == PRESET_ECO:
+            await self.async_execute_command(
+                COMMAND_SET_ECO_TARGET_DWH_TEMPERATURE, temperature
+            )
+
+        if self.preset_mode in [PRESET_COMFORT, PRESET_BOOST]:
+            await self.async_execute_command(
+                COMMAND_SET_COMFORT_TARGET_DWH_TEMPERATURE, temperature
+            )
+
+        await self.async_execute_command(COMMAND_REFRESH_TARGET_DWH_TEMPERATURE)

custom_components/tahoma/const.py

@@ -25,6 +25,7 @@
     "AirSensor": SENSOR,
     "Alarm": ALARM_CONTROL_PANEL,
     "AtlanticElectricalHeater": CLIMATE,  # widgetName, uiClass is HeatingSystem (not supported)
+    "AtlanticPassAPCDHW": CLIMATE,  # widgetName, uiClass is WaterHeatingSystem (not supported)
     "Awning": COVER,
     "CarButtonSensor": BINARY_SENSOR,
     "ConsumptionSensor": SENSOR,