diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index 4d2d50006cf..fba83d79c72 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -131,6 +131,7 @@ _EXPERIMENTAL_CONDITION_PLATFORMS = { "gate", "humidifier", "humidity", + "illuminance", "lawn_mower", "light", "lock", diff --git a/homeassistant/components/illuminance/__init__.py b/homeassistant/components/illuminance/__init__.py index 748e92b1290..e97ecc3d260 100644 --- a/homeassistant/components/illuminance/__init__.py +++ b/homeassistant/components/illuminance/__init__.py @@ -1,4 +1,4 @@ -"""Integration for illuminance triggers.""" +"""Integration for illuminance triggers and conditions.""" from __future__ import annotations diff --git a/homeassistant/components/illuminance/condition.py b/homeassistant/components/illuminance/condition.py new file mode 100644 index 00000000000..97bdbd330e9 --- /dev/null +++ b/homeassistant/components/illuminance/condition.py @@ -0,0 +1,43 @@ +"""Provides conditions for illuminance.""" + +from __future__ import annotations + +from homeassistant.components.binary_sensor import ( + DOMAIN as BINARY_SENSOR_DOMAIN, + BinarySensorDeviceClass, +) +from homeassistant.components.number import DOMAIN as NUMBER_DOMAIN, NumberDeviceClass +from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN, SensorDeviceClass +from homeassistant.const import LIGHT_LUX, STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant +from homeassistant.helpers.automation import DomainSpec +from homeassistant.helpers.condition import ( + Condition, + make_entity_numerical_condition, + make_entity_state_condition, +) + +ILLUMINANCE_DETECTED_DOMAIN_SPECS = { + BINARY_SENSOR_DOMAIN: DomainSpec(device_class=BinarySensorDeviceClass.LIGHT) +} +ILLUMINANCE_VALUE_DOMAIN_SPECS = { + SENSOR_DOMAIN: DomainSpec(device_class=SensorDeviceClass.ILLUMINANCE), + NUMBER_DOMAIN: DomainSpec(device_class=NumberDeviceClass.ILLUMINANCE), +} + +CONDITIONS: dict[str, type[Condition]] = { + "is_detected": make_entity_state_condition( + ILLUMINANCE_DETECTED_DOMAIN_SPECS, STATE_ON + ), + "is_not_detected": make_entity_state_condition( + ILLUMINANCE_DETECTED_DOMAIN_SPECS, STATE_OFF + ), + "is_value": make_entity_numerical_condition( + ILLUMINANCE_VALUE_DOMAIN_SPECS, LIGHT_LUX + ), +} + + +async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]: + """Return the conditions for illuminance.""" + return CONDITIONS diff --git a/homeassistant/components/illuminance/conditions.yaml b/homeassistant/components/illuminance/conditions.yaml new file mode 100644 index 00000000000..d2e07200c4b --- /dev/null +++ b/homeassistant/components/illuminance/conditions.yaml @@ -0,0 +1,52 @@ +.detected_condition_common: &detected_condition_common + target: + entity: + - domain: binary_sensor + device_class: light + fields: + behavior: &condition_behavior + required: true + default: any + selector: + select: + translation_key: condition_behavior + options: + - all + - any + +.number_or_entity: &number_or_entity + required: false + selector: + choose: + choices: + number: + selector: + number: + unit_of_measurement: "lx" + entity: + selector: + entity: + filter: + - domain: input_number + unit_of_measurement: "lx" + - domain: number + device_class: illuminance + - domain: sensor + device_class: illuminance + translation_key: number_or_entity + +is_detected: *detected_condition_common + +is_not_detected: *detected_condition_common + +is_value: + target: + entity: + - domain: sensor + device_class: illuminance + - domain: number + device_class: illuminance + fields: + behavior: *condition_behavior + above: *number_or_entity + below: *number_or_entity diff --git a/homeassistant/components/illuminance/icons.json b/homeassistant/components/illuminance/icons.json index 0833f0b7602..db0ed9dcf5c 100644 --- a/homeassistant/components/illuminance/icons.json +++ b/homeassistant/components/illuminance/icons.json @@ -1,4 +1,15 @@ { + "conditions": { + "is_detected": { + "condition": "mdi:brightness-7" + }, + "is_not_detected": { + "condition": "mdi:brightness-4" + }, + "is_value": { + "condition": "mdi:brightness-percent" + } + }, "triggers": { "changed": { "trigger": "mdi:brightness-6" diff --git a/homeassistant/components/illuminance/strings.json b/homeassistant/components/illuminance/strings.json index 476d7df7458..524b3bdfbdb 100644 --- a/homeassistant/components/illuminance/strings.json +++ b/homeassistant/components/illuminance/strings.json @@ -1,9 +1,57 @@ { "common": { + "condition_behavior_description": "How the state should match on the targeted entities.", + "condition_behavior_name": "Behavior", "trigger_behavior_description": "The behavior of the targeted entities to trigger on.", "trigger_behavior_name": "Behavior" }, + "conditions": { + "is_detected": { + "description": "Tests if light is currently detected.", + "fields": { + "behavior": { + "description": "[%key:component::illuminance::common::condition_behavior_description%]", + "name": "[%key:component::illuminance::common::condition_behavior_name%]" + } + }, + "name": "Light is detected" + }, + "is_not_detected": { + "description": "Tests if light is currently not detected.", + "fields": { + "behavior": { + "description": "[%key:component::illuminance::common::condition_behavior_description%]", + "name": "[%key:component::illuminance::common::condition_behavior_name%]" + } + }, + "name": "Light is not detected" + }, + "is_value": { + "description": "Tests the illuminance value.", + "fields": { + "above": { + "description": "Require the illuminance to be above this value.", + "name": "Above" + }, + "behavior": { + "description": "[%key:component::illuminance::common::condition_behavior_description%]", + "name": "[%key:component::illuminance::common::condition_behavior_name%]" + }, + "below": { + "description": "Require the illuminance to be below this value.", + "name": "Below" + } + }, + "name": "Illuminance" + } + }, "selector": { + "condition_behavior": { + "options": { + "all": "All", + "any": "Any" + } + }, "number_or_entity": { "choices": { "entity": "Entity", diff --git a/tests/components/illuminance/test_condition.py b/tests/components/illuminance/test_condition.py new file mode 100644 index 00000000000..9a3b0c16c9c --- /dev/null +++ b/tests/components/illuminance/test_condition.py @@ -0,0 +1,295 @@ +"""Test illuminance conditions.""" + +from typing import Any + +import pytest + +from homeassistant.const import ( + ATTR_DEVICE_CLASS, + ATTR_UNIT_OF_MEASUREMENT, + 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, + parametrize_condition_states_all, + parametrize_condition_states_any, + parametrize_numerical_condition_above_below_all, + parametrize_numerical_condition_above_below_any, + parametrize_target_entities, + target_entities, +) + +_ILLUMINANCE_UNIT_ATTRS = {ATTR_UNIT_OF_MEASUREMENT: "lx"} + + +@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.fixture +async def target_sensors(hass: HomeAssistant) -> dict[str, list[str]]: + """Create multiple sensor entities associated with different targets.""" + return await target_entities(hass, "sensor") + + +@pytest.fixture +async def target_numbers(hass: HomeAssistant) -> dict[str, list[str]]: + """Create multiple number entities associated with different targets.""" + return await target_entities(hass, "number") + + +@pytest.mark.parametrize( + "condition", + [ + "illuminance.is_detected", + "illuminance.is_not_detected", + "illuminance.is_value", + ], +) +async def test_illuminance_conditions_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str +) -> None: + """Test the illuminance 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="illuminance.is_detected", + target_states=[STATE_ON], + other_states=[STATE_OFF], + required_filter_attributes={ATTR_DEVICE_CLASS: "light"}, + ), + *parametrize_condition_states_any( + condition="illuminance.is_not_detected", + target_states=[STATE_OFF], + other_states=[STATE_ON], + required_filter_attributes={ATTR_DEVICE_CLASS: "light"}, + ), + ], +) +async def test_illuminance_binary_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 the illuminance binary conditions 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="illuminance.is_detected", + target_states=[STATE_ON], + other_states=[STATE_OFF], + required_filter_attributes={ATTR_DEVICE_CLASS: "light"}, + ), + *parametrize_condition_states_all( + condition="illuminance.is_not_detected", + target_states=[STATE_OFF], + other_states=[STATE_ON], + required_filter_attributes={ATTR_DEVICE_CLASS: "light"}, + ), + ], +) +async def test_illuminance_binary_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 the illuminance binary conditions 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, + ) + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("condition_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities("sensor"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + parametrize_numerical_condition_above_below_any( + "illuminance.is_value", + device_class="illuminance", + unit_attributes=_ILLUMINANCE_UNIT_ATTRS, + ), +) +async def test_illuminance_value_condition_behavior_any( + hass: HomeAssistant, + target_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 the illuminance value condition with 'any' behavior.""" + await assert_condition_behavior_any( + hass, + target_entities=target_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("sensor"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + parametrize_numerical_condition_above_below_all( + "illuminance.is_value", + device_class="illuminance", + unit_attributes=_ILLUMINANCE_UNIT_ATTRS, + ), +) +async def test_illuminance_value_condition_behavior_all( + hass: HomeAssistant, + target_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 the illuminance value condition with 'all' behavior.""" + await assert_condition_behavior_all( + hass, + target_entities=target_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("number"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + parametrize_numerical_condition_above_below_any( + "illuminance.is_value", + device_class="illuminance", + unit_attributes=_ILLUMINANCE_UNIT_ATTRS, + ), +) +async def test_illuminance_value_number_condition_behavior_any( + hass: HomeAssistant, + target_numbers: 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 the illuminance value condition with number entities and 'any' behavior.""" + await assert_condition_behavior_any( + hass, + target_entities=target_numbers, + 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("number"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + parametrize_numerical_condition_above_below_all( + "illuminance.is_value", + device_class="illuminance", + unit_attributes=_ILLUMINANCE_UNIT_ATTRS, + ), +) +async def test_illuminance_value_number_condition_behavior_all( + hass: HomeAssistant, + target_numbers: 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 the illuminance value condition with number entities and 'all' behavior.""" + await assert_condition_behavior_all( + hass, + target_entities=target_numbers, + condition_target_config=condition_target_config, + entity_id=entity_id, + entities_in_target=entities_in_target, + condition=condition, + condition_options=condition_options, + states=states, + )