core/homeassistant/components/zha/alarm_control_panel.py

119 lines
4.3 KiB
Python

"""Alarm control panels on Zigbee Home Automation networks."""
from __future__ import annotations
import functools
from zha.application.platforms.alarm_control_panel.const import (
AlarmState as ZHAAlarmState,
)
from homeassistant.components.alarm_control_panel import (
AlarmControlPanelEntity,
AlarmControlPanelEntityFeature,
AlarmControlPanelState,
CodeFormat,
)
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,
async_add_entities as zha_async_add_entities,
convert_zha_error_to_ha_error,
get_zha_data,
)
ZHA_STATE_TO_ALARM_STATE_MAP = {
ZHAAlarmState.DISARMED.value: AlarmControlPanelState.DISARMED,
ZHAAlarmState.ARMED_HOME.value: AlarmControlPanelState.ARMED_HOME,
ZHAAlarmState.ARMED_AWAY.value: AlarmControlPanelState.ARMED_AWAY,
ZHAAlarmState.ARMED_NIGHT.value: AlarmControlPanelState.ARMED_NIGHT,
ZHAAlarmState.ARMED_VACATION.value: AlarmControlPanelState.ARMED_VACATION,
ZHAAlarmState.ARMED_CUSTOM_BYPASS.value: AlarmControlPanelState.ARMED_CUSTOM_BYPASS,
ZHAAlarmState.PENDING.value: AlarmControlPanelState.PENDING,
ZHAAlarmState.ARMING.value: AlarmControlPanelState.ARMING,
ZHAAlarmState.DISARMING.value: AlarmControlPanelState.DISARMING,
ZHAAlarmState.TRIGGERED.value: AlarmControlPanelState.TRIGGERED,
ZHAAlarmState.UNKNOWN.value: None,
}
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the Zigbee Home Automation alarm control panel from config entry."""
zha_data = get_zha_data(hass)
entities_to_create = zha_data.platforms[Platform.ALARM_CONTROL_PANEL]
unsub = async_dispatcher_connect(
hass,
SIGNAL_ADD_ENTITIES,
functools.partial(
zha_async_add_entities,
async_add_entities,
ZHAAlarmControlPanel,
entities_to_create,
),
)
config_entry.async_on_unload(unsub)
class ZHAAlarmControlPanel(ZHAEntity, AlarmControlPanelEntity):
"""Entity for ZHA alarm control devices."""
_attr_translation_key: str = "alarm_control_panel"
_attr_code_format = CodeFormat.TEXT
_attr_supported_features = (
AlarmControlPanelEntityFeature.ARM_HOME
| AlarmControlPanelEntityFeature.ARM_AWAY
| AlarmControlPanelEntityFeature.ARM_NIGHT
| AlarmControlPanelEntityFeature.TRIGGER
)
@property
def code_arm_required(self) -> bool:
"""Whether the code is required for arm actions."""
return self.entity_data.entity.code_arm_required
@convert_zha_error_to_ha_error
async def async_alarm_disarm(self, code: str | None = None) -> None:
"""Send disarm command."""
await self.entity_data.entity.async_alarm_disarm(code)
self.async_write_ha_state()
@convert_zha_error_to_ha_error
async def async_alarm_arm_home(self, code: str | None = None) -> None:
"""Send arm home command."""
await self.entity_data.entity.async_alarm_arm_home(code)
self.async_write_ha_state()
@convert_zha_error_to_ha_error
async def async_alarm_arm_away(self, code: str | None = None) -> None:
"""Send arm away command."""
await self.entity_data.entity.async_alarm_arm_away(code)
self.async_write_ha_state()
@convert_zha_error_to_ha_error
async def async_alarm_arm_night(self, code: str | None = None) -> None:
"""Send arm night command."""
await self.entity_data.entity.async_alarm_arm_night(code)
self.async_write_ha_state()
@convert_zha_error_to_ha_error
async def async_alarm_trigger(self, code: str | None = None) -> None:
"""Send alarm trigger command."""
await self.entity_data.entity.async_alarm_trigger(code)
self.async_write_ha_state()
@property
def alarm_state(self) -> AlarmControlPanelState | None:
"""Return the state of the entity."""
return ZHA_STATE_TO_ALARM_STATE_MAP.get(self.entity_data.entity.state["state"])