Add Overkiz AtlanticPassAPCDHW

homeassistant/components/overkiz/const.py

@@ -32,6 +32,7 @@
     Platform.SENSOR,
     Platform.SIREN,
     Platform.SWITCH,
+    Platform.WATER_HEATER,
 ]
 
 IGNORED_OVERKIZ_DEVICES: list[UIClass | UIWidget] = [
@@ -77,6 +78,7 @@
     UIWidget.STATEFUL_ALARM_CONTROLLER: Platform.ALARM_CONTROL_PANEL,  # widgetName, uiClass is Alarm (not supported)
     UIWidget.STATELESS_EXTERIOR_HEATING: Platform.SWITCH,  # widgetName, uiClass is ExteriorHeatingSystem (not supported)
     UIWidget.TSKALARM_CONTROLLER: Platform.ALARM_CONTROL_PANEL,  # widgetName, uiClass is Alarm (not supported)
+    UIWidget.ATLANTIC_PASS_APC_DHW: Platform.WATER_HEATER,  # widgetName, uiClass is Water heater (not supported)
 }
 
 # Map Overkiz camelCase to Home Assistant snake_case for translation

homeassistant/components/overkiz/executor.py

@@ -95,6 +95,17 @@ async def async_execute_command(self, command_name: str, *args: Any) -> None:
 
         await self.coordinator.async_refresh()
 
+    async def async_execute_commands(self, commands: list[Command]) -> None:
+        """Execute device commands in async context."""
+
+        await self.coordinator.client.execute_commands(
+            self.device.device_url,
+            commands,
+            "Home Assistant",
+        )
+
+        await self.coordinator.async_refresh()
+
     async def async_cancel_command(
         self, commands_to_cancel: list[OverkizCommand]
     ) -> bool:

homeassistant/components/overkiz/water_heater.py

@@ -0,0 +1,28 @@
+"""Support for Overkiz water heater devices."""
+from __future__ import annotations
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from . import HomeAssistantOverkizData
+from .const import DOMAIN
+from .water_heater_entities import WIDGET_TO_WATER_HEATER_ENTITY
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up the Overkiz DHW from a config entry."""
+    data: HomeAssistantOverkizData = hass.data[DOMAIN][entry.entry_id]
+
+    async_add_entities(
+        WIDGET_TO_WATER_HEATER_ENTITY[device.widget](
+            device.device_url, data.coordinator
+        )
+        for device in data.platforms[Platform.WATER_HEATER]
+        if device.widget in WIDGET_TO_WATER_HEATER_ENTITY
+    )

homeassistant/components/overkiz/water_heater_entities/__init__.py

@@ -0,0 +1,8 @@
+"""Water heater entities for the Overkiz (by Somfy) integration."""
+from pyoverkiz.enums.ui import UIWidget
+
+from .atlantic_pass_apc_dhw import AtlanticPassAPCDHW
+
+WIDGET_TO_WATER_HEATER_ENTITY = {
+    UIWidget.ATLANTIC_PASS_APC_DHW: AtlanticPassAPCDHW,
+}

homeassistant/components/overkiz/water_heater_entities/atlantic_pass_apc_dhw.py

@@ -0,0 +1,102 @@
+"""Support for Atlantic Pass APC Zone Control."""
+from pyoverkiz.enums import OverkizCommand, OverkizCommandParam, OverkizState
+from pyoverkiz.models import Command
+
+from homeassistant.components.water_heater import (
+    STATE_HEAT_PUMP,
+    STATE_PERFORMANCE,
+    WaterHeaterEntity,
+    WaterHeaterEntityFeature,
+)
+from homeassistant.const import STATE_OFF, TEMP_CELSIUS
+
+from ..entity import OverkizEntity
+
+OPERATION_LIST = [STATE_OFF, STATE_HEAT_PUMP, STATE_PERFORMANCE]
+
+
+class AtlanticPassAPCDHW(OverkizEntity, WaterHeaterEntity):
+    """Representation of Atlantic Pass APC DHW."""
+
+    _attr_temperature_unit = TEMP_CELSIUS
+    _attr_supported_features = (
+        WaterHeaterEntityFeature.OPERATION_MODE | WaterHeaterEntityFeature.AWAY_MODE
+    )
+    _attr_operation_list = OPERATION_LIST
+
+    @property
+    def current_operation(self) -> str:
+        """Return current operation."""
+        if self.is_boost_mode_on:
+            return STATE_PERFORMANCE
+        if self.is_away_mode_on:
+            return STATE_OFF
+        return STATE_HEAT_PUMP
+
+    @property
+    def is_boost_mode_on(self) -> bool:
+        """Return true if away mode is on."""
+        return (
+            self.executor.select_state(OverkizState.CORE_BOOST_ON_OFF)
+            == OverkizCommandParam.ON
+        )
+
+    @property
+    def is_away_mode_on(self) -> bool:
+        """Return true if away mode is on."""
+        return (
+            self.executor.select_state(OverkizState.CORE_DWH_ON_OFF)
+            == OverkizCommandParam.OFF
+        )
+
+    async def async_set_operation_mode(self, operation_mode: str) -> None:
+        """Set new operation mode."""
+
+        boost_state = OverkizCommandParam.OFF
+        regular_state = OverkizCommandParam.OFF
+        if operation_mode == STATE_PERFORMANCE:
+            boost_state = OverkizCommandParam.ON
+            regular_state = OverkizCommandParam.ON
+        elif operation_mode == STATE_HEAT_PUMP:
+            regular_state = OverkizCommandParam.ON
+
+        commands = [
+            Command(
+                OverkizCommand.SET_BOOST_ON_OFF_STATE,
+                [boost_state],
+            ),
+            Command(
+                OverkizCommand.SET_DHW_ON_OFF_STATE,
+                [regular_state],
+            ),
+        ]
+        await self.executor.async_execute_commands(commands)
+
+    async def async_turn_away_mode_on(self) -> None:
+        """Turn away mode on."""
+        commands = [
+            Command(
+                OverkizCommand.SET_BOOST_ON_OFF_STATE,
+                [OverkizCommandParam.OFF],
+            ),
+            Command(
+                OverkizCommand.SET_DHW_ON_OFF_STATE,
+                [OverkizCommandParam.OFF],
+            ),
+        ]
+        await self.executor.async_execute_commands(commands)
+
+    async def async_turn_away_mode_off(self) -> None:
+        """Turn away mode off."""
+        commands = [
+            Command(
+                OverkizCommand.SET_BOOST_ON_OFF_STATE,
+                [OverkizCommandParam.OFF],
+            ),
+            Command(
+                OverkizCommand.SET_DHW_ON_OFF_STATE,
+                [OverkizCommandParam.ON],
+            ),
+        ]
+
+        await self.executor.async_execute_commands(commands)