siren.py

Go to the documentation of this file.

"""Support for deCONZ siren."""
 
from __future__ import annotations
 
from typing import Any
 
from pydeconz.models.event import EventType
from pydeconz.models.light.siren import Siren
 
from homeassistant.components.siren import (
    ATTR_DURATION,
    DOMAIN as SIREN_DOMAIN,
    SirenEntity,
    SirenEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .entity import DeconzDevice
from .hub import DeconzHub
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up sirens for deCONZ component."""
    hub = DeconzHub.get_hub(hass, config_entry)
    hub.entities[SIREN_DOMAIN] = set()
 
    @callback
    def async_add_siren(_: EventType, siren_id: str) -> None:
        """Add siren from deCONZ."""
        siren = hub.api.lights.sirens[siren_id]
        async_add_entities([DeconzSiren(siren, hub)])
 
    hub.register_platform_add_device_callback(
        async_add_siren,
        hub.api.lights.sirens,
    )
 
 
class DeconzSiren(DeconzDevice[Siren], SirenEntity):
    """Representation of a deCONZ siren."""
 
    TYPE = SIREN_DOMAIN
    _attr_supported_features = (
        SirenEntityFeature.TURN_ON
        | SirenEntityFeature.TURN_OFF
        | SirenEntityFeature.DURATION
    )
 
    @property
    def is_on(self) -> bool:
        """Return true if siren is on."""
        return self._device.is_on
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn on siren."""
        if (duration := kwargs.get(ATTR_DURATION)) is not None:
            duration *= 10
        await self.hub.api.lights.sirens.set_state(
            id=self._device.resource_id,
            on=True,
            duration=duration,
        )
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn off siren."""
        await self.hub.api.lights.sirens.set_state(
            id=self._device.resource_id,
            on=False,
        )