From 043a0b5aa693e313efee29dd3258d188d0f235f6 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Thu, 15 Jan 2026 20:17:02 +0100 Subject: [PATCH] Add alarm_control_panel conditions (#160975) --- .../alarm_control_panel/condition.py | 93 ++++++ .../alarm_control_panel/conditions.yaml | 52 ++++ .../components/alarm_control_panel/icons.json | 23 ++ .../alarm_control_panel/strings.json | 80 +++++ .../components/automation/__init__.py | 1 + tests/components/__init__.py | 18 +- .../alarm_control_panel/test_condition.py | 275 ++++++++++++++++++ 7 files changed, 537 insertions(+), 5 deletions(-) create mode 100644 homeassistant/components/alarm_control_panel/condition.py create mode 100644 homeassistant/components/alarm_control_panel/conditions.yaml create mode 100644 tests/components/alarm_control_panel/test_condition.py diff --git a/homeassistant/components/alarm_control_panel/condition.py b/homeassistant/components/alarm_control_panel/condition.py new file mode 100644 index 00000000000..b1d3da3488b --- /dev/null +++ b/homeassistant/components/alarm_control_panel/condition.py @@ -0,0 +1,93 @@ +"""Provides conditions for alarm control panels.""" + +from homeassistant.core import HomeAssistant +from homeassistant.exceptions import HomeAssistantError +from homeassistant.helpers.condition import ( + Condition, + EntityStateConditionBase, + make_entity_state_condition, +) +from homeassistant.helpers.entity import get_supported_features + +from .const import DOMAIN, AlarmControlPanelEntityFeature, AlarmControlPanelState + + +def supports_feature(hass: HomeAssistant, entity_id: str, features: int) -> bool: + """Test if an entity supports the specified features.""" + try: + return bool(get_supported_features(hass, entity_id) & features) + except HomeAssistantError: + return False + + +class EntityStateRequiredFeaturesCondition(EntityStateConditionBase): + """State condition.""" + + _required_features: int + + def entity_filter(self, entities: set[str]) -> set[str]: + """Filter entities of this domain with the required features.""" + entities = super().entity_filter(entities) + return { + entity_id + for entity_id in entities + if supports_feature(self._hass, entity_id, self._required_features) + } + + +def make_entity_state_required_features_condition( + domain: str, to_state: str, required_features: int +) -> type[EntityStateRequiredFeaturesCondition]: + """Create an entity state condition class with required feature filtering.""" + + class CustomCondition(EntityStateRequiredFeaturesCondition): + """Condition for entity state changes.""" + + _domain = domain + _states = {to_state} + _required_features = required_features + + return CustomCondition + + +CONDITIONS: dict[str, type[Condition]] = { + "is_armed": make_entity_state_condition( + DOMAIN, + { + AlarmControlPanelState.ARMED_AWAY, + AlarmControlPanelState.ARMED_CUSTOM_BYPASS, + AlarmControlPanelState.ARMED_HOME, + AlarmControlPanelState.ARMED_NIGHT, + AlarmControlPanelState.ARMED_VACATION, + }, + ), + "is_armed_away": make_entity_state_required_features_condition( + DOMAIN, + AlarmControlPanelState.ARMED_AWAY, + AlarmControlPanelEntityFeature.ARM_AWAY, + ), + "is_armed_home": make_entity_state_required_features_condition( + DOMAIN, + AlarmControlPanelState.ARMED_HOME, + AlarmControlPanelEntityFeature.ARM_HOME, + ), + "is_armed_night": make_entity_state_required_features_condition( + DOMAIN, + AlarmControlPanelState.ARMED_NIGHT, + AlarmControlPanelEntityFeature.ARM_NIGHT, + ), + "is_armed_vacation": make_entity_state_required_features_condition( + DOMAIN, + AlarmControlPanelState.ARMED_VACATION, + AlarmControlPanelEntityFeature.ARM_VACATION, + ), + "is_disarmed": make_entity_state_condition(DOMAIN, AlarmControlPanelState.DISARMED), + "is_triggered": make_entity_state_condition( + DOMAIN, AlarmControlPanelState.TRIGGERED + ), +} + + +async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]: + """Return the alarm control panel conditions.""" + return CONDITIONS diff --git a/homeassistant/components/alarm_control_panel/conditions.yaml b/homeassistant/components/alarm_control_panel/conditions.yaml new file mode 100644 index 00000000000..12c5b700b32 --- /dev/null +++ b/homeassistant/components/alarm_control_panel/conditions.yaml @@ -0,0 +1,52 @@ +.condition_common: &condition_common + target: + entity: + domain: alarm_control_panel + fields: &condition_common_fields + behavior: + required: true + default: any + selector: + select: + translation_key: condition_behavior + options: + - all + - any + +is_armed: *condition_common + +is_armed_away: + fields: *condition_common_fields + target: + entity: + domain: alarm_control_panel + supported_features: + - alarm_control_panel.AlarmControlPanelEntityFeature.ARM_AWAY + +is_armed_home: + fields: *condition_common_fields + target: + entity: + domain: alarm_control_panel + supported_features: + - alarm_control_panel.AlarmControlPanelEntityFeature.ARM_HOME + +is_armed_night: + fields: *condition_common_fields + target: + entity: + domain: alarm_control_panel + supported_features: + - alarm_control_panel.AlarmControlPanelEntityFeature.ARM_NIGHT + +is_armed_vacation: + fields: *condition_common_fields + target: + entity: + domain: alarm_control_panel + supported_features: + - alarm_control_panel.AlarmControlPanelEntityFeature.ARM_VACATION + +is_disarmed: *condition_common + +is_triggered: *condition_common diff --git a/homeassistant/components/alarm_control_panel/icons.json b/homeassistant/components/alarm_control_panel/icons.json index 0fbaeb59cf5..b7db7d4fffd 100644 --- a/homeassistant/components/alarm_control_panel/icons.json +++ b/homeassistant/components/alarm_control_panel/icons.json @@ -1,4 +1,27 @@ { + "conditions": { + "is_armed": { + "condition": "mdi:shield" + }, + "is_armed_away": { + "condition": "mdi:shield-lock" + }, + "is_armed_home": { + "condition": "mdi:shield-home" + }, + "is_armed_night": { + "condition": "mdi:shield-moon" + }, + "is_armed_vacation": { + "condition": "mdi:shield-airplane" + }, + "is_disarmed": { + "condition": "mdi:shield-off" + }, + "is_triggered": { + "condition": "mdi:bell-ring" + } + }, "entity_component": { "_": { "default": "mdi:shield", diff --git a/homeassistant/components/alarm_control_panel/strings.json b/homeassistant/components/alarm_control_panel/strings.json index 94567d69f3e..88d203193c3 100644 --- a/homeassistant/components/alarm_control_panel/strings.json +++ b/homeassistant/components/alarm_control_panel/strings.json @@ -1,8 +1,82 @@ { "common": { + "condition_behavior_description": "How the state should match on the targeted alarms.", + "condition_behavior_name": "Behavior", "trigger_behavior_description": "The behavior of the targeted alarms to trigger on.", "trigger_behavior_name": "Behavior" }, + "conditions": { + "is_armed": { + "description": "Tests if one or more alarms are armed.", + "fields": { + "behavior": { + "description": "[%key:component::alarm_control_panel::common::condition_behavior_description%]", + "name": "[%key:component::alarm_control_panel::common::condition_behavior_name%]" + } + }, + "name": "If an alarm is armed" + }, + "is_armed_away": { + "description": "Tests if one or more alarms are armed in away mode.", + "fields": { + "behavior": { + "description": "[%key:component::alarm_control_panel::common::condition_behavior_description%]", + "name": "[%key:component::alarm_control_panel::common::condition_behavior_name%]" + } + }, + "name": "If an alarm is armed away" + }, + "is_armed_home": { + "description": "Tests if one or more alarms are armed in home mode.", + "fields": { + "behavior": { + "description": "[%key:component::alarm_control_panel::common::condition_behavior_description%]", + "name": "[%key:component::alarm_control_panel::common::condition_behavior_name%]" + } + }, + "name": "If an alarm is armed home" + }, + "is_armed_night": { + "description": "Tests if one or more alarms are armed in night mode.", + "fields": { + "behavior": { + "description": "[%key:component::alarm_control_panel::common::condition_behavior_description%]", + "name": "[%key:component::alarm_control_panel::common::condition_behavior_name%]" + } + }, + "name": "If an alarm is armed night" + }, + "is_armed_vacation": { + "description": "Tests if one or more alarms are armed in vacation mode.", + "fields": { + "behavior": { + "description": "[%key:component::alarm_control_panel::common::condition_behavior_description%]", + "name": "[%key:component::alarm_control_panel::common::condition_behavior_name%]" + } + }, + "name": "If an alarm is armed vacation" + }, + "is_disarmed": { + "description": "Tests if one or more alarms are disarmed.", + "fields": { + "behavior": { + "description": "[%key:component::alarm_control_panel::common::condition_behavior_description%]", + "name": "[%key:component::alarm_control_panel::common::condition_behavior_name%]" + } + }, + "name": "If an alarm is disarmed" + }, + "is_triggered": { + "description": "Tests if one or more alarms are triggered.", + "fields": { + "behavior": { + "description": "[%key:component::alarm_control_panel::common::condition_behavior_description%]", + "name": "[%key:component::alarm_control_panel::common::condition_behavior_name%]" + } + }, + "name": "If an alarm is triggered" + } + }, "device_automation": { "action_type": { "arm_away": "Arm {entity_name} away", @@ -76,6 +150,12 @@ } }, "selector": { + "condition_behavior": { + "options": { + "all": "All", + "any": "Any" + } + }, "trigger_behavior": { "options": { "any": "Any", diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index b173fa5b248..34097bb989b 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -123,6 +123,7 @@ SERVICE_TRIGGER = "trigger" NEW_TRIGGERS_CONDITIONS_FEATURE_FLAG = "new_triggers_conditions" _EXPERIMENTAL_CONDITION_PLATFORMS = { + "alarm_control_panel", "fan", "light", } diff --git a/tests/components/__init__.py b/tests/components/__init__.py index c1181074250..ff77e722764 100644 --- a/tests/components/__init__.py +++ b/tests/components/__init__.py @@ -254,13 +254,21 @@ def parametrize_condition_states( state_with_attributes(other_state, False, True) for other_state in other_states ), - ( - state_with_attributes(target_state, True, True) - for target_state in target_states - ), - ) + ), ), ), + # Test each target state individually to isolate condition_true expectations + *( + ( + condition, + condition_options, + [ + state_with_attributes(other_states[0], False, True), + state_with_attributes(target_state, True, True), + ], + ) + for target_state in target_states + ), ] diff --git a/tests/components/alarm_control_panel/test_condition.py b/tests/components/alarm_control_panel/test_condition.py new file mode 100644 index 00000000000..6592da34e73 --- /dev/null +++ b/tests/components/alarm_control_panel/test_condition.py @@ -0,0 +1,275 @@ +"""Test alarm_control_panel conditions.""" + +from typing import Any + +import pytest + +from homeassistant.components.alarm_control_panel import ( + AlarmControlPanelEntityFeature, + AlarmControlPanelState, +) +from homeassistant.const import ATTR_SUPPORTED_FEATURES +from homeassistant.core import HomeAssistant + +from tests.components import ( + ConditionStateDescription, + assert_condition_gated_by_labs_flag, + create_target_condition, + other_states, + parametrize_condition_states, + parametrize_target_entities, + set_or_remove_state, + target_entities, +) + + +@pytest.fixture(autouse=True, name="stub_blueprint_populate") +def stub_blueprint_populate_autouse(stub_blueprint_populate: None) -> None: + """Stub copying the blueprints to the config folder.""" + + +@pytest.fixture +async def target_alarm_control_panels(hass: HomeAssistant) -> list[str]: + """Create multiple alarm_control_panel entities associated with different targets.""" + return (await target_entities(hass, "alarm_control_panel"))["included"] + + +@pytest.mark.parametrize( + "condition", + [ + "alarm_control_panel.is_armed", + "alarm_control_panel.is_armed_away", + "alarm_control_panel.is_armed_home", + "alarm_control_panel.is_armed_night", + "alarm_control_panel.is_armed_vacation", + "alarm_control_panel.is_disarmed", + "alarm_control_panel.is_triggered", + ], +) +async def test_alarm_control_panel_conditions_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str +) -> None: + """Test the alarm_control_panel conditions are gated by the labs flag.""" + await assert_condition_gated_by_labs_flag(hass, caplog, condition) + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("condition_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities("alarm_control_panel"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states( + condition="alarm_control_panel.is_armed", + target_states=[ + AlarmControlPanelState.ARMED_AWAY, + AlarmControlPanelState.ARMED_CUSTOM_BYPASS, + AlarmControlPanelState.ARMED_HOME, + AlarmControlPanelState.ARMED_NIGHT, + AlarmControlPanelState.ARMED_VACATION, + ], + other_states=[ + AlarmControlPanelState.ARMING, + AlarmControlPanelState.DISARMED, + AlarmControlPanelState.DISARMING, + AlarmControlPanelState.PENDING, + AlarmControlPanelState.TRIGGERED, + ], + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_armed_away", + target_states=[AlarmControlPanelState.ARMED_AWAY], + other_states=other_states(AlarmControlPanelState.ARMED_AWAY), + additional_attributes={ + ATTR_SUPPORTED_FEATURES: AlarmControlPanelEntityFeature.ARM_AWAY + }, + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_armed_home", + target_states=[AlarmControlPanelState.ARMED_HOME], + other_states=other_states(AlarmControlPanelState.ARMED_HOME), + additional_attributes={ + ATTR_SUPPORTED_FEATURES: AlarmControlPanelEntityFeature.ARM_HOME + }, + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_armed_night", + target_states=[AlarmControlPanelState.ARMED_NIGHT], + other_states=other_states(AlarmControlPanelState.ARMED_NIGHT), + additional_attributes={ + ATTR_SUPPORTED_FEATURES: AlarmControlPanelEntityFeature.ARM_NIGHT + }, + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_armed_vacation", + target_states=[AlarmControlPanelState.ARMED_VACATION], + other_states=other_states(AlarmControlPanelState.ARMED_VACATION), + additional_attributes={ + ATTR_SUPPORTED_FEATURES: AlarmControlPanelEntityFeature.ARM_VACATION + }, + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_disarmed", + target_states=[AlarmControlPanelState.DISARMED], + other_states=other_states(AlarmControlPanelState.DISARMED), + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_triggered", + target_states=[AlarmControlPanelState.TRIGGERED], + other_states=other_states(AlarmControlPanelState.TRIGGERED), + ), + ], +) +async def test_alarm_control_panel_state_condition_behavior_any( + hass: HomeAssistant, + target_alarm_control_panels: list[str], + condition_target_config: dict, + entity_id: str, + entities_in_target: int, + condition: str, + condition_options: dict[str, Any], + states: list[ConditionStateDescription], +) -> None: + """Test the alarm_control_panel state condition with the 'any' behavior.""" + other_entity_ids = set(target_alarm_control_panels) - {entity_id} + + # Set all alarm_control_panels, including the tested alarm_control_panel, to the initial state + for eid in target_alarm_control_panels: + set_or_remove_state(hass, eid, states[0]["included"]) + await hass.async_block_till_done() + + condition = await create_target_condition( + hass, + condition=condition, + target=condition_target_config, + behavior="any", + ) + + for state in states: + included_state = state["included"] + set_or_remove_state(hass, entity_id, included_state) + await hass.async_block_till_done() + assert condition(hass) == state["condition_true"] + + # Check if changing other alarm_control_panels also passes the condition + for other_entity_id in other_entity_ids: + set_or_remove_state(hass, other_entity_id, included_state) + await hass.async_block_till_done() + assert condition(hass) == state["condition_true"] + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("condition_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities("alarm_control_panel"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states( + condition="alarm_control_panel.is_armed", + target_states=[ + AlarmControlPanelState.ARMED_AWAY, + AlarmControlPanelState.ARMED_CUSTOM_BYPASS, + AlarmControlPanelState.ARMED_HOME, + AlarmControlPanelState.ARMED_NIGHT, + AlarmControlPanelState.ARMED_VACATION, + ], + other_states=[ + AlarmControlPanelState.ARMING, + AlarmControlPanelState.DISARMED, + AlarmControlPanelState.DISARMING, + AlarmControlPanelState.PENDING, + AlarmControlPanelState.TRIGGERED, + ], + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_armed_away", + target_states=[AlarmControlPanelState.ARMED_AWAY], + other_states=other_states(AlarmControlPanelState.ARMED_AWAY), + additional_attributes={ + ATTR_SUPPORTED_FEATURES: AlarmControlPanelEntityFeature.ARM_AWAY + }, + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_armed_home", + target_states=[AlarmControlPanelState.ARMED_HOME], + other_states=other_states(AlarmControlPanelState.ARMED_HOME), + additional_attributes={ + ATTR_SUPPORTED_FEATURES: AlarmControlPanelEntityFeature.ARM_HOME + }, + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_armed_night", + target_states=[AlarmControlPanelState.ARMED_NIGHT], + other_states=other_states(AlarmControlPanelState.ARMED_NIGHT), + additional_attributes={ + ATTR_SUPPORTED_FEATURES: AlarmControlPanelEntityFeature.ARM_NIGHT + }, + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_armed_vacation", + target_states=[AlarmControlPanelState.ARMED_VACATION], + other_states=other_states(AlarmControlPanelState.ARMED_VACATION), + additional_attributes={ + ATTR_SUPPORTED_FEATURES: AlarmControlPanelEntityFeature.ARM_VACATION + }, + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_disarmed", + target_states=[AlarmControlPanelState.DISARMED], + other_states=other_states(AlarmControlPanelState.DISARMED), + ), + *parametrize_condition_states( + condition="alarm_control_panel.is_triggered", + target_states=[AlarmControlPanelState.TRIGGERED], + other_states=other_states(AlarmControlPanelState.TRIGGERED), + ), + ], +) +async def test_alarm_control_panel_state_condition_behavior_all( + hass: HomeAssistant, + target_alarm_control_panels: list[str], + condition_target_config: dict, + entity_id: str, + entities_in_target: int, + condition: str, + condition_options: dict[str, Any], + states: list[ConditionStateDescription], +) -> None: + """Test the alarm_control_panel state condition with the 'all' behavior.""" + other_entity_ids = set(target_alarm_control_panels) - {entity_id} + + # Set all alarm_control_panels, including the tested alarm_control_panel, to the initial state + for eid in target_alarm_control_panels: + set_or_remove_state(hass, eid, states[0]["included"]) + await hass.async_block_till_done() + + condition = await create_target_condition( + hass, + condition=condition, + target=condition_target_config, + behavior="all", + ) + + for state in states: + included_state = state["included"] + + set_or_remove_state(hass, entity_id, included_state) + await hass.async_block_till_done() + # The condition passes if all entities are either in a target state or invalid + assert condition(hass) == ( + (not state["state_valid"]) + or (state["condition_true"] and entities_in_target == 1) + ) + + for other_entity_id in other_entity_ids: + set_or_remove_state(hass, other_entity_id, included_state) + await hass.async_block_till_done() + + # The condition passes if all entities are either in a target state or invalid + assert condition(hass) == ( + (not state["state_valid"]) or state["condition_true"] + )