core/homeassistant/components/zha/siren.py

112 lines
3.6 KiB
Python

"""Support for ZHA sirens."""
from __future__ import annotations
import functools
from typing import Any
from zha.application.const import (
WARNING_DEVICE_MODE_BURGLAR,
WARNING_DEVICE_MODE_EMERGENCY,
WARNING_DEVICE_MODE_EMERGENCY_PANIC,
WARNING_DEVICE_MODE_FIRE,
WARNING_DEVICE_MODE_FIRE_PANIC,
WARNING_DEVICE_MODE_POLICE_PANIC,
)
from zha.application.platforms.siren import SirenEntityFeature as ZHASirenEntityFeature
from homeassistant.components.siren import (
ATTR_DURATION,
ATTR_TONE,
ATTR_VOLUME_LEVEL,
SirenEntity,
SirenEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .entity import ZHAEntity
from .helpers import (
SIGNAL_ADD_ENTITIES,
EntityData,
async_add_entities as zha_async_add_entities,
convert_zha_error_to_ha_error,
get_zha_data,
)
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the Zigbee Home Automation siren from config entry."""
zha_data = get_zha_data(hass)
entities_to_create = zha_data.platforms[Platform.SIREN]
unsub = async_dispatcher_connect(
hass,
SIGNAL_ADD_ENTITIES,
functools.partial(
zha_async_add_entities, async_add_entities, ZHASiren, entities_to_create
),
)
config_entry.async_on_unload(unsub)
class ZHASiren(ZHAEntity, SirenEntity):
"""Representation of a ZHA siren."""
_attr_available_tones: list[int | str] | dict[int, str] | None = {
WARNING_DEVICE_MODE_BURGLAR: "Burglar",
WARNING_DEVICE_MODE_FIRE: "Fire",
WARNING_DEVICE_MODE_EMERGENCY: "Emergency",
WARNING_DEVICE_MODE_POLICE_PANIC: "Police Panic",
WARNING_DEVICE_MODE_FIRE_PANIC: "Fire Panic",
WARNING_DEVICE_MODE_EMERGENCY_PANIC: "Emergency Panic",
}
def __init__(self, entity_data: EntityData, **kwargs: Any) -> None:
"""Initialize the ZHA siren."""
super().__init__(entity_data, **kwargs)
features: SirenEntityFeature = SirenEntityFeature(0)
zha_features: ZHASirenEntityFeature = self.entity_data.entity.supported_features
if ZHASirenEntityFeature.TURN_ON in zha_features:
features |= SirenEntityFeature.TURN_ON
if ZHASirenEntityFeature.TURN_OFF in zha_features:
features |= SirenEntityFeature.TURN_OFF
if ZHASirenEntityFeature.TONES in zha_features:
features |= SirenEntityFeature.TONES
if ZHASirenEntityFeature.VOLUME_SET in zha_features:
features |= SirenEntityFeature.VOLUME_SET
if ZHASirenEntityFeature.DURATION in zha_features:
features |= SirenEntityFeature.DURATION
self._attr_supported_features = features
@property
def is_on(self) -> bool:
"""Return True if entity is on."""
return self.entity_data.entity.is_on
@convert_zha_error_to_ha_error
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on siren."""
await self.entity_data.entity.async_turn_on(
duration=kwargs.get(ATTR_DURATION),
tone=kwargs.get(ATTR_TONE),
volume_level=kwargs.get(ATTR_VOLUME_LEVEL),
)
self.async_write_ha_state()
@convert_zha_error_to_ha_error
async def async_turn_off(self, **kwargs: Any) -> None:
"""Turn off siren."""
await self.entity_data.entity.async_turn_off()
self.async_write_ha_state()