siren.py

Go to the documentation of this file.

"""Support for RFXtrx sirens."""
 
from __future__ import annotations
 
from datetime import datetime
from typing import Any
 
import RFXtrx as rfxtrxmod
 
from homeassistant.components.siren import ATTR_TONE, SirenEntity, SirenEntityFeature
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import CALLBACK_TYPE, HomeAssistant, callback
from homeassistant.helpers.entity import Entity
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.event import async_call_later
 
from . import DEFAULT_OFF_DELAY, DeviceTuple, async_setup_platform_entry
from .const import CONF_OFF_DELAY
from .entity import RfxtrxCommandEntity
 
SECURITY_PANIC_ON = "Panic"
SECURITY_PANIC_OFF = "End Panic"
SECURITY_PANIC_ALL = {SECURITY_PANIC_ON, SECURITY_PANIC_OFF}
 
 
def supported(event: rfxtrxmod.RFXtrxEvent) -> bool:
    """Return whether an event supports sirens."""
    device = event.device
 
    if isinstance(device, rfxtrxmod.ChimeDevice):
        return True
 
    if isinstance(device, rfxtrxmod.SecurityDevice) and isinstance(
        event, rfxtrxmod.SensorEvent
    ):
        if event.values["Sensor Status"] in SECURITY_PANIC_ALL:
            return True
 
    return False
 
 
def get_first_key(data: dict[int, str], entry: str) -> int:
    """Find a key based on the items value."""
    return next((key for key, value in data.items() if value == entry))
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up config entry."""
 
    def _constructor(
        event: rfxtrxmod.RFXtrxEvent,
        auto: rfxtrxmod.RFXtrxEvent | None,
        device_id: DeviceTuple,
        entity_info: dict[str, Any],
    ) -> list[Entity]:
        """Construct a entity from an event."""
        device = event.device
 
        if isinstance(device, rfxtrxmod.ChimeDevice):
            return [
                RfxtrxChime(
                    event.device,
                    device_id,
                    entity_info.get(CONF_OFF_DELAY, DEFAULT_OFF_DELAY),
                    auto,
                )
            ]
 
        if isinstance(device, rfxtrxmod.SecurityDevice) and isinstance(
            event, rfxtrxmod.SensorEvent
        ):
            if event.values["Sensor Status"] in SECURITY_PANIC_ALL:
                return [
                    RfxtrxSecurityPanic(
                        event.device,
                        device_id,
                        entity_info.get(CONF_OFF_DELAY, DEFAULT_OFF_DELAY),
                        auto,
                    )
                ]
        return []
 
    await async_setup_platform_entry(
        hass, config_entry, async_add_entities, supported, _constructor
    )
 
 
class RfxtrxOffDelayMixin(Entity):  # pylint: disable=hass-enforce-class-module
    """Mixin to support timeouts on data.
 
    Many 433 devices only send data when active. They will
    repeatedly (every x seconds) send a command to indicate
    being active and stop sending this command when inactive.
    This mixin allow us to keep track of the timeout once
    they go inactive.
    """
 
    _timeout: CALLBACK_TYPE | None = None
    _off_delay: float | None = None
 
    def _setup_timeout(self) -> None:
        @callback
        def _done(_: datetime) -> None:
            self._timeout_timeout = None
            self.async_write_ha_stateasync_write_ha_state()
 
        if self._off_delay:
            self._timeout_timeout = async_call_later(self.hasshass, self._off_delay, _done)
 
    def _cancel_timeout(self) -> None:
        if self._timeout_timeout:
            self._timeout_timeout()
            self._timeout_timeout = None
 
    async def async_will_remove_from_hass(self) -> None:
        """Run when entity will be removed from hass."""
        self._cancel_timeout_cancel_timeout()
        return await super().async_will_remove_from_hass()
 
 
class RfxtrxChime(RfxtrxCommandEntity, SirenEntity, RfxtrxOffDelayMixin):
    """Representation of a RFXtrx chime."""
 
    _attr_supported_features = SirenEntityFeature.TURN_ON | SirenEntityFeature.TONES
    _device: rfxtrxmod.ChimeDevice
 
    def __init__(
        self,
        device: rfxtrxmod.RFXtrxDevice,
        device_id: DeviceTuple,
        off_delay: float | None = None,
        event: rfxtrxmod.RFXtrxEvent | None = None,
    ) -> None:
        """Initialize the entity."""
        super().__init__(device, device_id, event)
        self._attr_available_tones_attr_available_tones = list(self._device_device.COMMANDS.values())
        self._default_tone_default_tone = next(iter(self._device_device.COMMANDS))
        self._off_delay_off_delay = off_delay
 
    @property
    def is_on(self) -> bool:
        """Return true if device is on."""
        return self._timeout_timeout is not None
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the device on."""
        self._cancel_timeout_cancel_timeout()
 
        if tone := kwargs.get(ATTR_TONE):
            command = get_first_key(self._device_device.COMMANDS, tone)
        else:
            command = self._default_tone_default_tone
 
        await self._async_send(self._device_device.send_command, command)
 
        self._setup_timeout_setup_timeout()
 
        self.async_write_ha_stateasync_write_ha_state()
 
    def _apply_event(self, event: rfxtrxmod.ControlEvent) -> None:
        """Apply a received event."""
        super()._apply_event(event)
 
        sound = event.values.get("Sound")
        if sound is not None:
            self._cancel_timeout_cancel_timeout()
            self._setup_timeout_setup_timeout()
 
    @callback
    def _handle_event(
        self, event: rfxtrxmod.RFXtrxEvent, device_id: DeviceTuple
    ) -> None:
        """Check if event applies to me and update."""
        if self._event_applies_event_applies(event, device_id):
            self._apply_event_apply_event_apply_event(event)
 
            self.async_write_ha_stateasync_write_ha_state()
 
 
class RfxtrxSecurityPanic(RfxtrxCommandEntity, SirenEntity, RfxtrxOffDelayMixin):
    """Representation of a security device."""
 
    _attr_supported_features = SirenEntityFeature.TURN_ON | SirenEntityFeature.TURN_OFF
    _device: rfxtrxmod.SecurityDevice
 
    def __init__(
        self,
        device: rfxtrxmod.RFXtrxDevice,
        device_id: DeviceTuple,
        off_delay: float | None = None,
        event: rfxtrxmod.RFXtrxEvent | None = None,
    ) -> None:
        """Initialize the entity."""
        super().__init__(device, device_id, event)
        self._on_value_on_value = get_first_key(self._device_device.STATUS, SECURITY_PANIC_ON)
        self._off_value_off_value = get_first_key(self._device_device.STATUS, SECURITY_PANIC_OFF)
        self._off_delay_off_delay = off_delay
 
    @property
    def is_on(self) -> bool:
        """Return true if device is on."""
        return self._timeout_timeout is not None
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the device on."""
        self._cancel_timeout_cancel_timeout()
 
        await self._async_send(self._device_device.send_status, self._on_value_on_value)
 
        self._setup_timeout_setup_timeout()
 
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the device off."""
        self._cancel_timeout_cancel_timeout()
 
        await self._async_send(self._device_device.send_status, self._off_value_off_value)
 
        self.async_write_ha_stateasync_write_ha_state()
 
    def _apply_event(self, event: rfxtrxmod.SensorEvent) -> None:
        """Apply a received event."""
        super()._apply_event(event)
 
        status = event.values.get("Sensor Status")
 
        if status == SECURITY_PANIC_ON:
            self._cancel_timeout_cancel_timeout()
            self._setup_timeout_setup_timeout()
        elif status == SECURITY_PANIC_OFF:
            self._cancel_timeout_cancel_timeout()
 
    @callback
    def _handle_event(
        self, event: rfxtrxmod.RFXtrxEvent, device_id: DeviceTuple
    ) -> None:
        """Check if event applies to me and update."""
        if self._event_applies_event_applies(event, device_id):
            self._apply_event_apply_event_apply_event(event)
 
            self.async_write_ha_stateasync_write_ha_state()