"""Support for Template alarm control panels.""" from __future__ import annotations from enum import Enum import logging import voluptuous as vol from homeassistant.components.alarm_control_panel import ( ENTITY_ID_FORMAT, PLATFORM_SCHEMA as PARENT_PLATFORM_SCHEMA, AlarmControlPanelEntity, AlarmControlPanelEntityFeature, CodeFormat, ) from homeassistant.const import ( ATTR_CODE, CONF_NAME, CONF_UNIQUE_ID, CONF_VALUE_TEMPLATE, STATE_ALARM_ARMED_AWAY, STATE_ALARM_ARMED_CUSTOM_BYPASS, STATE_ALARM_ARMED_HOME, STATE_ALARM_ARMED_NIGHT, STATE_ALARM_ARMED_VACATION, STATE_ALARM_ARMING, STATE_ALARM_DISARMED, STATE_ALARM_PENDING, STATE_ALARM_TRIGGERED, STATE_UNAVAILABLE, ) from homeassistant.core import HomeAssistant, callback from homeassistant.exceptions import TemplateError import homeassistant.helpers.config_validation as cv from homeassistant.helpers.entity import async_generate_entity_id from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.script import Script from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from .const import DOMAIN from .template_entity import TemplateEntity, rewrite_common_legacy_to_modern_conf _LOGGER = logging.getLogger(__name__) _VALID_STATES = [ STATE_ALARM_ARMED_AWAY, STATE_ALARM_ARMED_CUSTOM_BYPASS, STATE_ALARM_ARMED_HOME, STATE_ALARM_ARMED_NIGHT, STATE_ALARM_ARMED_VACATION, STATE_ALARM_ARMING, STATE_ALARM_DISARMED, STATE_ALARM_PENDING, STATE_ALARM_TRIGGERED, STATE_UNAVAILABLE, ] CONF_ARM_AWAY_ACTION = "arm_away" CONF_ARM_CUSTOM_BYPASS_ACTION = "arm_custom_bypass" CONF_ARM_HOME_ACTION = "arm_home" CONF_ARM_NIGHT_ACTION = "arm_night" CONF_ARM_VACATION_ACTION = "arm_vacation" CONF_DISARM_ACTION = "disarm" CONF_TRIGGER_ACTION = "trigger" CONF_ALARM_CONTROL_PANELS = "panels" CONF_CODE_ARM_REQUIRED = "code_arm_required" CONF_CODE_FORMAT = "code_format" class TemplateCodeFormat(Enum): """Class to represent different code formats.""" no_code = None number = CodeFormat.NUMBER text = CodeFormat.TEXT ALARM_CONTROL_PANEL_SCHEMA = vol.Schema( { vol.Optional(CONF_VALUE_TEMPLATE): cv.template, vol.Optional(CONF_DISARM_ACTION): cv.SCRIPT_SCHEMA, vol.Optional(CONF_ARM_AWAY_ACTION): cv.SCRIPT_SCHEMA, vol.Optional(CONF_ARM_CUSTOM_BYPASS_ACTION): cv.SCRIPT_SCHEMA, vol.Optional(CONF_ARM_HOME_ACTION): cv.SCRIPT_SCHEMA, vol.Optional(CONF_ARM_NIGHT_ACTION): cv.SCRIPT_SCHEMA, vol.Optional(CONF_ARM_VACATION_ACTION): cv.SCRIPT_SCHEMA, vol.Optional(CONF_TRIGGER_ACTION): cv.SCRIPT_SCHEMA, vol.Optional(CONF_CODE_ARM_REQUIRED, default=True): cv.boolean, vol.Optional(CONF_CODE_FORMAT, default=TemplateCodeFormat.number.name): cv.enum( TemplateCodeFormat ), vol.Optional(CONF_NAME): cv.string, vol.Optional(CONF_UNIQUE_ID): cv.string, } ) PLATFORM_SCHEMA = PARENT_PLATFORM_SCHEMA.extend( { vol.Required(CONF_ALARM_CONTROL_PANELS): cv.schema_with_slug_keys( ALARM_CONTROL_PANEL_SCHEMA ), } ) async def _async_create_entities(hass, config): """Create Template Alarm Control Panels.""" alarm_control_panels = [] for object_id, entity_config in config[CONF_ALARM_CONTROL_PANELS].items(): entity_config = rewrite_common_legacy_to_modern_conf(entity_config) unique_id = entity_config.get(CONF_UNIQUE_ID) alarm_control_panels.append( AlarmControlPanelTemplate( hass, object_id, entity_config, unique_id, ) ) return alarm_control_panels async def async_setup_platform( hass: HomeAssistant, config: ConfigType, async_add_entities: AddEntitiesCallback, discovery_info: DiscoveryInfoType | None = None, ) -> None: """Set up the Template Alarm Control Panels.""" async_add_entities(await _async_create_entities(hass, config)) class AlarmControlPanelTemplate(TemplateEntity, AlarmControlPanelEntity): """Representation of a templated Alarm Control Panel.""" _attr_should_poll = False def __init__( self, hass, object_id, config, unique_id, ): """Initialize the panel.""" super().__init__( hass, config=config, fallback_name=object_id, unique_id=unique_id ) self.entity_id = async_generate_entity_id( ENTITY_ID_FORMAT, object_id, hass=hass ) name = self._attr_name self._template = config.get(CONF_VALUE_TEMPLATE) self._disarm_script = None self._code_arm_required: bool = config[CONF_CODE_ARM_REQUIRED] self._code_format: TemplateCodeFormat = config[CONF_CODE_FORMAT] if (disarm_action := config.get(CONF_DISARM_ACTION)) is not None: self._disarm_script = Script(hass, disarm_action, name, DOMAIN) self._arm_away_script = None if (arm_away_action := config.get(CONF_ARM_AWAY_ACTION)) is not None: self._arm_away_script = Script(hass, arm_away_action, name, DOMAIN) self._arm_home_script = None if (arm_home_action := config.get(CONF_ARM_HOME_ACTION)) is not None: self._arm_home_script = Script(hass, arm_home_action, name, DOMAIN) self._arm_night_script = None if (arm_night_action := config.get(CONF_ARM_NIGHT_ACTION)) is not None: self._arm_night_script = Script(hass, arm_night_action, name, DOMAIN) self._arm_vacation_script = None if (arm_vacation_action := config.get(CONF_ARM_VACATION_ACTION)) is not None: self._arm_vacation_script = Script(hass, arm_vacation_action, name, DOMAIN) self._arm_custom_bypass_script = None if ( arm_custom_bypass_action := config.get(CONF_ARM_CUSTOM_BYPASS_ACTION) ) is not None: self._arm_custom_bypass_script = Script( hass, arm_custom_bypass_action, name, DOMAIN ) self._trigger_script = None if (trigger_action := config.get(CONF_TRIGGER_ACTION)) is not None: self._trigger_script = Script(hass, trigger_action, name, DOMAIN) self._state: str | None = None @property def state(self) -> str | None: """Return the state of the device.""" return self._state @property def supported_features(self) -> int: """Return the list of supported features.""" supported_features = 0 if self._arm_night_script is not None: supported_features = ( supported_features | AlarmControlPanelEntityFeature.ARM_NIGHT ) if self._arm_home_script is not None: supported_features = ( supported_features | AlarmControlPanelEntityFeature.ARM_HOME ) if self._arm_away_script is not None: supported_features = ( supported_features | AlarmControlPanelEntityFeature.ARM_AWAY ) if self._arm_vacation_script is not None: supported_features = ( supported_features | AlarmControlPanelEntityFeature.ARM_VACATION ) if self._arm_custom_bypass_script is not None: supported_features = ( supported_features | AlarmControlPanelEntityFeature.ARM_CUSTOM_BYPASS ) if self._trigger_script is not None: supported_features = ( supported_features | AlarmControlPanelEntityFeature.TRIGGER ) return supported_features @property def code_format(self) -> CodeFormat | None: """Regex for code format or None if no code is required.""" return self._code_format.value @property def code_arm_required(self) -> bool: """Whether the code is required for arm actions.""" return self._code_arm_required @callback def _update_state(self, result): if isinstance(result, TemplateError): self._state = None return # Validate state if result in _VALID_STATES: self._state = result _LOGGER.debug("Valid state - %s", result) return _LOGGER.error( "Received invalid alarm panel state: %s for entity %s. Expected: %s", result, self.entity_id, ", ".join(_VALID_STATES), ) self._state = None async def async_added_to_hass(self) -> None: """Register callbacks.""" if self._template: self.add_template_attribute( "_state", self._template, None, self._update_state ) await super().async_added_to_hass() async def _async_alarm_arm(self, state, script, code): """Arm the panel to specified state with supplied script.""" optimistic_set = False if self._template is None: self._state = state optimistic_set = True await self.async_run_script( script, run_variables={ATTR_CODE: code}, context=self._context ) if optimistic_set: self.async_write_ha_state() async def async_alarm_arm_away(self, code: str | None = None) -> None: """Arm the panel to Away.""" await self._async_alarm_arm( STATE_ALARM_ARMED_AWAY, script=self._arm_away_script, code=code ) async def async_alarm_arm_home(self, code: str | None = None) -> None: """Arm the panel to Home.""" await self._async_alarm_arm( STATE_ALARM_ARMED_HOME, script=self._arm_home_script, code=code ) async def async_alarm_arm_night(self, code: str | None = None) -> None: """Arm the panel to Night.""" await self._async_alarm_arm( STATE_ALARM_ARMED_NIGHT, script=self._arm_night_script, code=code ) async def async_alarm_arm_vacation(self, code: str | None = None) -> None: """Arm the panel to Vacation.""" await self._async_alarm_arm( STATE_ALARM_ARMED_VACATION, script=self._arm_vacation_script, code=code ) async def async_alarm_arm_custom_bypass(self, code: str | None = None) -> None: """Arm the panel to Custom Bypass.""" await self._async_alarm_arm( STATE_ALARM_ARMED_CUSTOM_BYPASS, script=self._arm_custom_bypass_script, code=code, ) async def async_alarm_disarm(self, code: str | None = None) -> None: """Disarm the panel.""" await self._async_alarm_arm( STATE_ALARM_DISARMED, script=self._disarm_script, code=code ) async def async_alarm_trigger(self, code: str | None = None) -> None: """Trigger the panel.""" await self._async_alarm_arm( STATE_ALARM_TRIGGERED, script=self._trigger_script, code=code )