Add Switcher button platform (#81245)

homeassistant/components/switcher_kis/button.py

@@ -0,0 +1,159 @@
+"""Switcher integration Button platform."""
+from __future__ import annotations
+
+import asyncio
+from collections.abc import Callable
+from dataclasses import dataclass
+
+from aioswitcher.api import (
+    DeviceState,
+    SwitcherBaseResponse,
+    SwitcherType2Api,
+    ThermostatSwing,
+)
+from aioswitcher.api.remotes import SwitcherBreezeRemote
+from aioswitcher.device import DeviceCategory
+
+from homeassistant.components.button import ButtonEntity, ButtonEntityDescription
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers import device_registry
+from homeassistant.helpers.dispatcher import async_dispatcher_connect
+from homeassistant.helpers.entity import DeviceInfo, EntityCategory
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
+
+from . import SwitcherDataUpdateCoordinator
+from .const import SIGNAL_DEVICE_ADD
+from .utils import get_breeze_remote_manager
+
+
+@dataclass
+class SwitcherThermostatButtonDescriptionMixin:
+    """Mixin to describe a Switcher Thermostat Button entity."""
+
+    press_fn: Callable[[SwitcherType2Api, SwitcherBreezeRemote], SwitcherBaseResponse]
+    supported: Callable[[SwitcherBreezeRemote], bool]
+
+
+@dataclass
+class SwitcherThermostatButtonEntityDescription(
+    ButtonEntityDescription, SwitcherThermostatButtonDescriptionMixin
+):
+    """Class to describe a Switcher Thermostat Button entity."""
+
+
+THERMOSTAT_BUTTONS = [
+    SwitcherThermostatButtonEntityDescription(
+        key="assume_on",
+        name="Assume on",
+        icon="mdi:fan",
+        entity_category=EntityCategory.CONFIG,
+        press_fn=lambda api, remote: api.control_breeze_device(
+            remote, state=DeviceState.ON, update_state=True
+        ),
+        supported=lambda remote: bool(remote.on_off_type),
+    ),
+    SwitcherThermostatButtonEntityDescription(
+        key="assume_off",
+        name="Assume off",
+        icon="mdi:fan-off",
+        entity_category=EntityCategory.CONFIG,
+        press_fn=lambda api, remote: api.control_breeze_device(
+            remote, state=DeviceState.OFF, update_state=True
+        ),
+        supported=lambda remote: bool(remote.on_off_type),
+    ),
+    SwitcherThermostatButtonEntityDescription(
+        key="vertical_swing_on",
+        name="Vertical swing on",
+        icon="mdi:autorenew",
+        press_fn=lambda api, remote: api.control_breeze_device(
+            remote, swing=ThermostatSwing.ON
+        ),
+        supported=lambda remote: bool(remote.separated_swing_command),
+    ),
+    SwitcherThermostatButtonEntityDescription(
+        key="vertical_swing_off",
+        name="Vertical swing off",
+        icon="mdi:autorenew-off",
+        press_fn=lambda api, remote: api.control_breeze_device(
+            remote, swing=ThermostatSwing.OFF
+        ),
+        supported=lambda remote: bool(remote.separated_swing_command),
+    ),
+]
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up Switcher button from config entry."""
+
+    @callback
+    async def async_add_buttons(coordinator: SwitcherDataUpdateCoordinator) -> None:
+        """Get remote and add button from Switcher device."""
+        if coordinator.data.device_type.category == DeviceCategory.THERMOSTAT:
+            remote: SwitcherBreezeRemote = await hass.async_add_executor_job(
+                get_breeze_remote_manager(hass).get_remote, coordinator.data.remote_id
+            )
+            async_add_entities(
+                SwitcherThermostatButtonEntity(coordinator, description, remote)
+                for description in THERMOSTAT_BUTTONS
+                if description.supported(remote)
+            )
+
+    config_entry.async_on_unload(
+        async_dispatcher_connect(hass, SIGNAL_DEVICE_ADD, async_add_buttons)
+    )
+
+
+class SwitcherThermostatButtonEntity(
+    CoordinatorEntity[SwitcherDataUpdateCoordinator], ButtonEntity
+):
+    """Representation of a Switcher climate entity."""
+
+    entity_description: SwitcherThermostatButtonEntityDescription
+
+    def __init__(
+        self,
+        coordinator: SwitcherDataUpdateCoordinator,
+        description: SwitcherThermostatButtonEntityDescription,
+        remote: SwitcherBreezeRemote,
+    ) -> None:
+        """Initialize the entity."""
+        super().__init__(coordinator)
+        self.entity_description = description
+        self._remote = remote
+
+        self._attr_name = f"{coordinator.name} {description.name}"
+        self._attr_unique_id = f"{coordinator.mac_address}-{description.key}"
+        self._attr_device_info = DeviceInfo(
+            connections={
+                (device_registry.CONNECTION_NETWORK_MAC, coordinator.mac_address)
+            }
+        )
+
+    async def async_press(self) -> None:
+        """Press the button."""
+        response: SwitcherBaseResponse = None
+        error = None
+
+        try:
+            async with SwitcherType2Api(
+                self.coordinator.data.ip_address, self.coordinator.data.device_id
+            ) as swapi:
+                response = await self.entity_description.press_fn(swapi, self._remote)
+        except (asyncio.TimeoutError, OSError, RuntimeError) as err:
+            error = repr(err)
+
+        if error or not response or not response.successful:
+            self.coordinator.last_update_success = False
+            self.async_write_ha_state()
+            raise HomeAssistantError(
+                f"Call api for {self.name} failed, "
+                f"response/error: {response or error}"
+            )