alarm_control_panel.py

Go to the documentation of this file.

"""Each ElkM1 area will be created as a separate alarm_control_panel."""
 
from __future__ import annotations
 
from typing import Any
 
from elkm1_lib.areas import Area
from elkm1_lib.const import AlarmState, ArmedStatus, ArmLevel, ArmUpState
from elkm1_lib.elements import Element
from elkm1_lib.elk import Elk
from elkm1_lib.keypads import Keypad
import voluptuous as vol
 
from homeassistant.components.alarm_control_panel import (
    ATTR_CHANGED_BY,
    AlarmControlPanelEntity,
    AlarmControlPanelEntityFeature,
    AlarmControlPanelState,
    CodeFormat,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_platform
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.restore_state import RestoreEntity
from homeassistant.helpers.typing import VolDictType
 
from . import ElkM1ConfigEntry
from .const import (
    ATTR_CHANGED_BY_ID,
    ATTR_CHANGED_BY_KEYPAD,
    ATTR_CHANGED_BY_TIME,
    ELK_USER_CODE_SERVICE_SCHEMA,
)
from .entity import ElkAttachedEntity, ElkEntity, create_elk_entities
from .models import ELKM1Data
 
DISPLAY_MESSAGE_SERVICE_SCHEMA: VolDictType = {
    vol.Optional("clear", default=2): vol.All(vol.Coerce(int), vol.In([0, 1, 2])),
    vol.Optional("beep", default=False): cv.boolean,
    vol.Optional("timeout", default=0): vol.All(
        vol.Coerce(int), vol.Range(min=0, max=65535)
    ),
    vol.Optional("line1", default=""): cv.string,
    vol.Optional("line2", default=""): cv.string,
}
 
SERVICE_ALARM_DISPLAY_MESSAGE = "alarm_display_message"
SERVICE_ALARM_ARM_VACATION = "alarm_arm_vacation"
SERVICE_ALARM_ARM_HOME_INSTANT = "alarm_arm_home_instant"
SERVICE_ALARM_ARM_NIGHT_INSTANT = "alarm_arm_night_instant"
SERVICE_ALARM_BYPASS = "alarm_bypass"
SERVICE_ALARM_CLEAR_BYPASS = "alarm_clear_bypass"
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ElkM1ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the ElkM1 alarm platform."""
    elk_data = config_entry.runtime_data
    elk = elk_data.elk
    entities: list[ElkEntity] = []
    create_elk_entities(elk_data, elk.areas, "area", ElkArea, entities)
    async_add_entities(entities)
 
    platform = entity_platform.async_get_current_platform()
 
    platform.async_register_entity_service(
        SERVICE_ALARM_ARM_VACATION,
        ELK_USER_CODE_SERVICE_SCHEMA,
        "async_alarm_arm_vacation",
    )
    platform.async_register_entity_service(
        SERVICE_ALARM_ARM_HOME_INSTANT,
        ELK_USER_CODE_SERVICE_SCHEMA,
        "async_alarm_arm_home_instant",
    )
    platform.async_register_entity_service(
        SERVICE_ALARM_ARM_NIGHT_INSTANT,
        ELK_USER_CODE_SERVICE_SCHEMA,
        "async_alarm_arm_night_instant",
    )
    platform.async_register_entity_service(
        SERVICE_ALARM_DISPLAY_MESSAGE,
        DISPLAY_MESSAGE_SERVICE_SCHEMA,
        "async_display_message",
    )
    platform.async_register_entity_service(
        SERVICE_ALARM_BYPASS,
        ELK_USER_CODE_SERVICE_SCHEMA,
        "async_bypass",
    )
    platform.async_register_entity_service(
        SERVICE_ALARM_CLEAR_BYPASS,
        ELK_USER_CODE_SERVICE_SCHEMA,
        "async_clear_bypass",
    )
 
 
class ElkArea(ElkAttachedEntity, AlarmControlPanelEntity, RestoreEntity):
    """Representation of an Area / Partition within the ElkM1 alarm panel."""
 
    _attr_supported_features = (
        AlarmControlPanelEntityFeature.ARM_HOME
        | AlarmControlPanelEntityFeature.ARM_AWAY
        | AlarmControlPanelEntityFeature.ARM_NIGHT
    )
    _element: Area
 
    def __init__(self, element: Element, elk: Elk, elk_data: ELKM1Data) -> None:
        """Initialize Area as Alarm Control Panel."""
        super().__init__(element, elk, elk_data)
        self._elk_elk_elk = elk
        self._changed_by_keypad_changed_by_keypad: str | None = None
        self._changed_by_time_changed_by_time: str | None = None
        self._changed_by_id_changed_by_id: int | None = None
        self._changed_by_changed_by: str | None = None
        self._state_state: AlarmControlPanelState | None = None
 
    async def async_added_to_hass(self) -> None:
        """Register callback for ElkM1 changes."""
        await super().async_added_to_hass()
        if len(self._elk_elk_elk.areas.elements) == 1:
            for keypad in self._elk_elk_elk.keypads:
                keypad.add_callback(self._watch_keypad_watch_keypad)
        self._element_element.add_callback(self._watch_area_watch_area)
 
        # We do not get changed_by back from resync.
        if not (last_state := await self.async_get_last_stateasync_get_last_state()):
            return
 
        if ATTR_CHANGED_BY_KEYPAD in last_state.attributes:
            self._changed_by_keypad_changed_by_keypad = last_state.attributes[ATTR_CHANGED_BY_KEYPAD]
        if ATTR_CHANGED_BY_TIME in last_state.attributes:
            self._changed_by_time_changed_by_time = last_state.attributes[ATTR_CHANGED_BY_TIME]
        if ATTR_CHANGED_BY_ID in last_state.attributes:
            self._changed_by_id_changed_by_id = last_state.attributes[ATTR_CHANGED_BY_ID]
        if ATTR_CHANGED_BY in last_state.attributes:
            self._changed_by_changed_by = last_state.attributes[ATTR_CHANGED_BY]
 
    def _watch_keypad(self, keypad: Element, changeset: dict[str, Any]) -> None:
        assert isinstance(keypad, Keypad)
        if keypad.area != self._element_element.index:
            return
        if changeset.get("last_user") is not None:
            self._changed_by_keypad_changed_by_keypad = keypad.name
            self._changed_by_time_changed_by_time = keypad.last_user_time.isoformat()
            self._changed_by_id_changed_by_id = keypad.last_user + 1
            self._changed_by_changed_by = self._elk_elk_elk.users.username(keypad.last_user)
            self.async_write_ha_stateasync_write_ha_state()
 
    def _watch_area(self, area: Element, changeset: dict[str, Any]) -> None:
        if not (last_log := changeset.get("last_log")):
            return
        # user_number only set for arm/disarm logs
        if (user_number := last_log.get("user_number")) is None:
            return
        self._changed_by_keypad_changed_by_keypad = None
        self._changed_by_id_changed_by_id = user_number
        self._changed_by_changed_by = self._elk_elk_elk.users.username(user_number - 1)
        self._changed_by_time_changed_by_time = last_log["timestamp"]
        self.async_write_ha_stateasync_write_ha_state()
 
    @property
    def code_format(self) -> CodeFormat | None:
        """Return the alarm code format."""
        return CodeFormat.NUMBER
 
    @property
    def alarm_state(self) -> AlarmControlPanelState | None:
        """Return the state of the element."""
        return self._state_state
 
    @property
    def extra_state_attributes(self) -> dict[str, Any]:
        """Attributes of the area."""
        attrs = self.initial_attrsinitial_attrs()
        elmt = self._element_element
        attrs["is_exit"] = elmt.is_exit
        attrs["timer1"] = elmt.timer1
        attrs["timer2"] = elmt.timer2
        if elmt.armed_status is not None:
            attrs["armed_status"] = ArmedStatus(elmt.armed_status).name.lower()
        if elmt.arm_up_state is not None:
            attrs["arm_up_state"] = ArmUpState(elmt.arm_up_state).name.lower()
        if elmt.alarm_state is not None:
            attrs["alarm_state"] = AlarmState(elmt.alarm_state).name.lower()
        attrs[ATTR_CHANGED_BY_KEYPAD] = self._changed_by_keypad_changed_by_keypad
        attrs[ATTR_CHANGED_BY_TIME] = self._changed_by_time_changed_by_time
        attrs[ATTR_CHANGED_BY_ID] = self._changed_by_id_changed_by_id
        return attrs
 
    @property
    def changed_by(self) -> str | None:
        """Last change triggered by."""
        return self._changed_by_changed_by
 
    def _element_changed(self, element: Element, changeset: dict[str, Any]) -> None:
        elk_state_to_hass_state = {
            ArmedStatus.DISARMED: AlarmControlPanelState.DISARMED,
            ArmedStatus.ARMED_AWAY: AlarmControlPanelState.ARMED_AWAY,
            ArmedStatus.ARMED_STAY: AlarmControlPanelState.ARMED_HOME,
            ArmedStatus.ARMED_STAY_INSTANT: AlarmControlPanelState.ARMED_HOME,
            ArmedStatus.ARMED_TO_NIGHT: AlarmControlPanelState.ARMED_NIGHT,
            ArmedStatus.ARMED_TO_NIGHT_INSTANT: AlarmControlPanelState.ARMED_NIGHT,
            ArmedStatus.ARMED_TO_VACATION: AlarmControlPanelState.ARMED_AWAY,
        }
 
        if self._element_element.alarm_state is None:
            self._state_state = None
        elif self._element_element.in_alarm_state():
            # Area is in alarm state
            self._state_state = AlarmControlPanelState.TRIGGERED
        elif self._entry_exit_timer_is_running_entry_exit_timer_is_running():
            self._state_state = (
                AlarmControlPanelState.ARMING
                if self._element_element.is_exit
                else AlarmControlPanelState.PENDING
            )
        elif self._element_element.armed_status is not None:
            self._state_state = elk_state_to_hass_state[self._element_element.armed_status]
        else:
            self._state_state = None
 
    def _entry_exit_timer_is_running(self) -> bool:
        return self._element_element.timer1 > 0 or self._element_element.timer2 > 0
 
    async def async_alarm_disarm(self, code: str | None = None) -> None:
        """Send disarm command."""
        if code is not None:
            self._element_element.disarm(int(code))
 
    async def async_alarm_arm_home(self, code: str | None = None) -> None:
        """Send arm home command."""
        if code is not None:
            self._element_element.arm(ArmLevel.ARMED_STAY, int(code))
 
    async def async_alarm_arm_away(self, code: str | None = None) -> None:
        """Send arm away command."""
        if code is not None:
            self._element_element.arm(ArmLevel.ARMED_AWAY, int(code))
 
    async def async_alarm_arm_night(self, code: str | None = None) -> None:
        """Send arm night command."""
        if code is not None:
            self._element_element.arm(ArmLevel.ARMED_NIGHT, int(code))
 
    async def async_alarm_arm_home_instant(self, code: str | None = None) -> None:
        """Send arm stay instant command."""
        if code is not None:
            self._element_element.arm(ArmLevel.ARMED_STAY_INSTANT, int(code))
 
    async def async_alarm_arm_night_instant(self, code: str | None = None) -> None:
        """Send arm night instant command."""
        if code is not None:
            self._element_element.arm(ArmLevel.ARMED_NIGHT_INSTANT, int(code))
 
    async def async_alarm_arm_vacation(self, code: str | None = None) -> None:
        """Send arm vacation command."""
        if code is not None:
            self._element_element.arm(ArmLevel.ARMED_VACATION, int(code))
 
    async def async_display_message(
        self, clear: int, beep: bool, timeout: int, line1: str, line2: str
    ) -> None:
        """Display a message on all keypads for the area."""
        self._element_element.display_message(clear, beep, timeout, line1, line2)
 
    async def async_bypass(self, code: str | None = None) -> None:
        """Bypass all zones in area."""
        if code is not None:
            self._element_element.bypass(int(code))
 
    async def async_clear_bypass(self, code: str | None = None) -> None:
        """Clear bypass for all zones in area."""
        if code is not None:
            self._element_element.clear_bypass(int(code))