From 44b73ab7bdc9e7041ce48a96ea0aa80815f5f2e1 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Wed, 18 Mar 2026 09:43:17 +0100 Subject: [PATCH] Add occupancy conditions (#165678) --- .../components/automation/__init__.py | 1 + .../components/occupancy/condition.py | 25 +++ .../components/occupancy/conditions.yaml | 24 +++ homeassistant/components/occupancy/icons.json | 8 + .../components/occupancy/strings.json | 30 +++ tests/components/occupancy/test_condition.py | 196 ++++++++++++++++++ 6 files changed, 284 insertions(+) create mode 100644 homeassistant/components/occupancy/condition.py create mode 100644 homeassistant/components/occupancy/conditions.yaml create mode 100644 tests/components/occupancy/test_condition.py diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index a41e9fda1e1..c6a78434ed6 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -130,6 +130,7 @@ _EXPERIMENTAL_CONDITION_PLATFORMS = { "lock", "media_player", "motion", + "occupancy", "person", "siren", "switch", diff --git a/homeassistant/components/occupancy/condition.py b/homeassistant/components/occupancy/condition.py new file mode 100644 index 00000000000..b4260798d06 --- /dev/null +++ b/homeassistant/components/occupancy/condition.py @@ -0,0 +1,25 @@ +"""Provides conditions for occupancy.""" + +from homeassistant.components.binary_sensor import ( + DOMAIN as BINARY_SENSOR_DOMAIN, + BinarySensorDeviceClass, +) +from homeassistant.const import STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant +from homeassistant.helpers.automation import DomainSpec +from homeassistant.helpers.condition import Condition, make_entity_state_condition + +_OCCUPANCY_DOMAIN_SPECS = { + BINARY_SENSOR_DOMAIN: DomainSpec(device_class=BinarySensorDeviceClass.OCCUPANCY) +} + + +CONDITIONS: dict[str, type[Condition]] = { + "is_detected": make_entity_state_condition(_OCCUPANCY_DOMAIN_SPECS, STATE_ON), + "is_not_detected": make_entity_state_condition(_OCCUPANCY_DOMAIN_SPECS, STATE_OFF), +} + + +async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]: + """Return the conditions for occupancy.""" + return CONDITIONS diff --git a/homeassistant/components/occupancy/conditions.yaml b/homeassistant/components/occupancy/conditions.yaml new file mode 100644 index 00000000000..1f3cb7346b0 --- /dev/null +++ b/homeassistant/components/occupancy/conditions.yaml @@ -0,0 +1,24 @@ +.condition_common_fields: &condition_common_fields + behavior: + required: true + default: any + selector: + select: + translation_key: condition_behavior + options: + - all + - any + +is_detected: + fields: *condition_common_fields + target: + entity: + - domain: binary_sensor + device_class: occupancy + +is_not_detected: + fields: *condition_common_fields + target: + entity: + - domain: binary_sensor + device_class: occupancy diff --git a/homeassistant/components/occupancy/icons.json b/homeassistant/components/occupancy/icons.json index f437e3e67a1..d12ae545603 100644 --- a/homeassistant/components/occupancy/icons.json +++ b/homeassistant/components/occupancy/icons.json @@ -1,4 +1,12 @@ { + "conditions": { + "is_detected": { + "condition": "mdi:home-account" + }, + "is_not_detected": { + "condition": "mdi:home-outline" + } + }, "triggers": { "cleared": { "trigger": "mdi:home-outline" diff --git a/homeassistant/components/occupancy/strings.json b/homeassistant/components/occupancy/strings.json index 078d4393eab..b93743b2bb8 100644 --- a/homeassistant/components/occupancy/strings.json +++ b/homeassistant/components/occupancy/strings.json @@ -1,9 +1,39 @@ { "common": { + "condition_behavior_description": "How the state should match on the targeted occupancy sensors.", + "condition_behavior_name": "Behavior", "trigger_behavior_description": "The behavior of the targeted occupancy sensors to trigger on.", "trigger_behavior_name": "Behavior" }, + "conditions": { + "is_detected": { + "description": "Tests if one or more occupancy sensors are detecting occupancy.", + "fields": { + "behavior": { + "description": "[%key:component::occupancy::common::condition_behavior_description%]", + "name": "[%key:component::occupancy::common::condition_behavior_name%]" + } + }, + "name": "Occupancy is detected" + }, + "is_not_detected": { + "description": "Tests if one or more occupancy sensors are not detecting occupancy.", + "fields": { + "behavior": { + "description": "[%key:component::occupancy::common::condition_behavior_description%]", + "name": "[%key:component::occupancy::common::condition_behavior_name%]" + } + }, + "name": "Occupancy is not detected" + } + }, "selector": { + "condition_behavior": { + "options": { + "all": "All", + "any": "Any" + } + }, "trigger_behavior": { "options": { "any": "Any", diff --git a/tests/components/occupancy/test_condition.py b/tests/components/occupancy/test_condition.py new file mode 100644 index 00000000000..f4753d06acd --- /dev/null +++ b/tests/components/occupancy/test_condition.py @@ -0,0 +1,196 @@ +"""Test occupancy conditions.""" + +from typing import Any + +import pytest + +from homeassistant.const import ATTR_DEVICE_CLASS, CONF_ENTITY_ID, STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant + +from tests.components.common import ( + ConditionStateDescription, + assert_condition_behavior_all, + assert_condition_behavior_any, + assert_condition_gated_by_labs_flag, + create_target_condition, + parametrize_condition_states_all, + parametrize_condition_states_any, + parametrize_target_entities, + target_entities, +) + + +@pytest.fixture +async def target_binary_sensors(hass: HomeAssistant) -> dict[str, list[str]]: + """Create multiple binary sensor entities associated with different targets.""" + return await target_entities(hass, "binary_sensor") + + +@pytest.mark.parametrize( + "condition", + [ + "occupancy.is_detected", + "occupancy.is_not_detected", + ], +) +async def test_occupancy_conditions_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str +) -> None: + """Test the occupancy 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("binary_sensor"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states_any( + condition="occupancy.is_detected", + target_states=[STATE_ON], + other_states=[STATE_OFF], + required_filter_attributes={ATTR_DEVICE_CLASS: "occupancy"}, + ), + *parametrize_condition_states_any( + condition="occupancy.is_not_detected", + target_states=[STATE_OFF], + other_states=[STATE_ON], + required_filter_attributes={ATTR_DEVICE_CLASS: "occupancy"}, + ), + ], +) +async def test_occupancy_binary_sensor_condition_behavior_any( + hass: HomeAssistant, + target_binary_sensors: dict[str, 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 occupancy condition for binary_sensor with 'any' behavior.""" + await assert_condition_behavior_any( + hass, + target_entities=target_binary_sensors, + condition_target_config=condition_target_config, + entity_id=entity_id, + entities_in_target=entities_in_target, + condition=condition, + condition_options=condition_options, + states=states, + ) + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("condition_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities("binary_sensor"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states_all( + condition="occupancy.is_detected", + target_states=[STATE_ON], + other_states=[STATE_OFF], + required_filter_attributes={ATTR_DEVICE_CLASS: "occupancy"}, + ), + *parametrize_condition_states_all( + condition="occupancy.is_not_detected", + target_states=[STATE_OFF], + other_states=[STATE_ON], + required_filter_attributes={ATTR_DEVICE_CLASS: "occupancy"}, + ), + ], +) +async def test_occupancy_binary_sensor_condition_behavior_all( + hass: HomeAssistant, + target_binary_sensors: dict[str, 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 occupancy condition for binary_sensor with 'all' behavior.""" + await assert_condition_behavior_all( + hass, + target_entities=target_binary_sensors, + condition_target_config=condition_target_config, + entity_id=entity_id, + entities_in_target=entities_in_target, + condition=condition, + condition_options=condition_options, + states=states, + ) + + +# --- Device class exclusion test --- + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ( + "condition_key", + "state_matching", + "state_non_matching", + ), + [ + ( + "occupancy.is_detected", + STATE_ON, + STATE_OFF, + ), + ( + "occupancy.is_not_detected", + STATE_OFF, + STATE_ON, + ), + ], +) +async def test_occupancy_condition_excludes_non_occupancy_device_class( + hass: HomeAssistant, + condition_key: str, + state_matching: str, + state_non_matching: str, +) -> None: + """Test occupancy condition excludes entities without device_class occupancy.""" + entity_id_occupancy = "binary_sensor.test_occupancy" + entity_id_motion = "binary_sensor.test_motion" + + # Set matching states on all entities + hass.states.async_set( + entity_id_occupancy, + state_matching, + {ATTR_DEVICE_CLASS: "occupancy"}, + ) + hass.states.async_set( + entity_id_motion, state_matching, {ATTR_DEVICE_CLASS: "motion"} + ) + await hass.async_block_till_done() + + condition_any = await create_target_condition( + hass, + condition=condition_key, + target={CONF_ENTITY_ID: [entity_id_occupancy, entity_id_motion]}, + behavior="any", + ) + + # Matching entity in matching state - condition should be True + assert condition_any(hass) is True + + # Set matching entity to non-matching state + hass.states.async_set( + entity_id_occupancy, + state_non_matching, + {ATTR_DEVICE_CLASS: "occupancy"}, + ) + await hass.async_block_till_done() + + # Wrong device class entity still in matching state, but should be excluded + assert condition_any(hass) is False