siren.py

Go to the documentation of this file.

"""YoLink Siren."""
 
from __future__ import annotations
 
from collections.abc import Callable
from dataclasses import dataclass
from typing import Any
 
from yolink.client_request import ClientRequest
from yolink.const import ATTR_DEVICE_SIREN
from yolink.device import YoLinkDevice
 
from homeassistant.components.siren import (
    SirenEntity,
    SirenEntityDescription,
    SirenEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import DOMAIN
from .coordinator import YoLinkCoordinator
from .entity import YoLinkEntity
 
 
@dataclass(frozen=True)
class YoLinkSirenEntityDescription(SirenEntityDescription):
    """YoLink SirenEntityDescription."""
 
    exists_fn: Callable[[YoLinkDevice], bool] = lambda _: True
    value: Callable[[Any], bool | None] = lambda _: None
 
 
DEVICE_TYPES: tuple[YoLinkSirenEntityDescription, ...] = (
    YoLinkSirenEntityDescription(
        key="state",
        value=lambda value: value == "alert" if value is not None else None,
        exists_fn=lambda device: device.device_type in [ATTR_DEVICE_SIREN],
    ),
)
 
DEVICE_TYPE = [ATTR_DEVICE_SIREN]
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up YoLink siren from a config entry."""
    device_coordinators = hass.data[DOMAIN][config_entry.entry_id].device_coordinators
    siren_device_coordinators = [
        device_coordinator
        for device_coordinator in device_coordinators.values()
        if device_coordinator.device.device_type in DEVICE_TYPE
    ]
    async_add_entities(
        YoLinkSirenEntity(config_entry, siren_device_coordinator, description)
        for siren_device_coordinator in siren_device_coordinators
        for description in DEVICE_TYPES
        if description.exists_fn(siren_device_coordinator.device)
    )
 
 
class YoLinkSirenEntity(YoLinkEntity, SirenEntity):
    """YoLink Siren Entity."""
 
    _attr_name = None
 
    entity_description: YoLinkSirenEntityDescription
 
    def __init__(
        self,
        config_entry: ConfigEntry,
        coordinator: YoLinkCoordinator,
        description: YoLinkSirenEntityDescription,
    ) -> None:
        """Init YoLink Siren."""
        super().__init__(config_entry, coordinator)
        self.entity_descriptionentity_description = description
        self._attr_unique_id_attr_unique_id = (
            f"{coordinator.device.device_id} {self.entity_description.key}"
        )
        self._attr_supported_features_attr_supported_features = (
            SirenEntityFeature.TURN_ON | SirenEntityFeature.TURN_OFF
        )
 
    @callback
    def update_entity_state(self, state: dict[str, Any]) -> None:
        """Update HA Entity State."""
        self._attr_is_on_attr_is_on = self.entity_descriptionentity_description.value(
            state.get(self.entity_descriptionentity_description.key)
        )
        self.async_write_ha_stateasync_write_ha_state()
 
    async def call_state_change(self, state: bool) -> None:
        """Call setState api to change siren state."""
        await self.call_devicecall_device(ClientRequest("setState", {"state": {"alarm": state}}))
        self._attr_is_on_attr_is_on = self.entity_descriptionentity_description.value("alert" if state else "normal")
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the entity on."""
        await self.call_state_changecall_state_change(True)
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the entity off."""
        await self.call_state_changecall_state_change(False)