diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index 8d55680c86f7c3..83dec00cc97e5e 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -129,6 +129,7 @@ "garage_door", "gate", "humidifier", + "humidity", "lawn_mower", "light", "lock", diff --git a/homeassistant/components/humidity/__init__.py b/homeassistant/components/humidity/__init__.py index 2c84f69089fc53..59840a5f14f6e6 100644 --- a/homeassistant/components/humidity/__init__.py +++ b/homeassistant/components/humidity/__init__.py @@ -1,4 +1,4 @@ -"""Integration for humidity triggers.""" +"""Integration for humidity triggers and conditions.""" from __future__ import annotations diff --git a/homeassistant/components/humidity/condition.py b/homeassistant/components/humidity/condition.py new file mode 100644 index 00000000000000..34a6c4c1449147 --- /dev/null +++ b/homeassistant/components/humidity/condition.py @@ -0,0 +1,38 @@ +"""Provides conditions for humidity.""" + +from __future__ import annotations + +from homeassistant.components.climate import ( + ATTR_CURRENT_HUMIDITY as CLIMATE_ATTR_CURRENT_HUMIDITY, + DOMAIN as CLIMATE_DOMAIN, +) +from homeassistant.components.humidifier import ( + ATTR_CURRENT_HUMIDITY as HUMIDIFIER_ATTR_CURRENT_HUMIDITY, + DOMAIN as HUMIDIFIER_DOMAIN, +) +from homeassistant.components.number import DOMAIN as NUMBER_DOMAIN, NumberDeviceClass +from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN, SensorDeviceClass +from homeassistant.const import PERCENTAGE +from homeassistant.core import HomeAssistant +from homeassistant.helpers.automation import DomainSpec, NumericalDomainSpec +from homeassistant.helpers.condition import Condition, make_entity_numerical_condition + +HUMIDITY_DOMAIN_SPECS = { + CLIMATE_DOMAIN: NumericalDomainSpec( + value_source=CLIMATE_ATTR_CURRENT_HUMIDITY, + ), + HUMIDIFIER_DOMAIN: NumericalDomainSpec( + value_source=HUMIDIFIER_ATTR_CURRENT_HUMIDITY, + ), + SENSOR_DOMAIN: DomainSpec(device_class=SensorDeviceClass.HUMIDITY), + NUMBER_DOMAIN: DomainSpec(device_class=NumberDeviceClass.HUMIDITY), +} + +CONDITIONS: dict[str, type[Condition]] = { + "value": make_entity_numerical_condition(HUMIDITY_DOMAIN_SPECS, PERCENTAGE), +} + + +async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]: + """Return the conditions for humidity.""" + return CONDITIONS diff --git a/homeassistant/components/humidity/conditions.yaml b/homeassistant/components/humidity/conditions.yaml new file mode 100644 index 00000000000000..d04d32b1775156 --- /dev/null +++ b/homeassistant/components/humidity/conditions.yaml @@ -0,0 +1,43 @@ +.number_or_entity: &number_or_entity + required: false + selector: + choose: + choices: + number: + selector: + number: + mode: box + unit_of_measurement: "%" + entity: + selector: + entity: + filter: + - domain: input_number + unit_of_measurement: "%" + - domain: number + device_class: humidity + - domain: sensor + device_class: humidity + translation_key: number_or_entity + +value: + target: + entity: + - domain: sensor + device_class: humidity + - domain: number + device_class: humidity + - domain: climate + - domain: humidifier + fields: + behavior: + required: true + default: any + selector: + select: + translation_key: condition_behavior + options: + - all + - any + above: *number_or_entity + below: *number_or_entity diff --git a/homeassistant/components/humidity/icons.json b/homeassistant/components/humidity/icons.json index 6b3c862c663647..81e5586fdcf06f 100644 --- a/homeassistant/components/humidity/icons.json +++ b/homeassistant/components/humidity/icons.json @@ -1,4 +1,9 @@ { + "conditions": { + "value": { + "condition": "mdi:water-percent" + } + }, "triggers": { "changed": { "trigger": "mdi:water-percent" diff --git a/homeassistant/components/humidity/strings.json b/homeassistant/components/humidity/strings.json index d80ec91e7d69bd..bdd6842bc4caf1 100644 --- a/homeassistant/components/humidity/strings.json +++ b/homeassistant/components/humidity/strings.json @@ -1,9 +1,37 @@ { "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": { + "value": { + "description": "Tests if a relative humidity value is above a threshold, below a threshold, or in a range of values.", + "fields": { + "above": { + "description": "Require the relative humidity to be above this value.", + "name": "Above" + }, + "behavior": { + "description": "[%key:component::humidity::common::condition_behavior_description%]", + "name": "[%key:component::humidity::common::condition_behavior_name%]" + }, + "below": { + "description": "Require the relative humidity to be below this value.", + "name": "Below" + } + }, + "name": "Relative humidity" + } + }, "selector": { + "condition_behavior": { + "options": { + "all": "All", + "any": "Any" + } + }, "number_or_entity": { "choices": { "entity": "Entity", diff --git a/tests/components/humidity/test_condition.py b/tests/components/humidity/test_condition.py new file mode 100644 index 00000000000000..34233752304286 --- /dev/null +++ b/tests/components/humidity/test_condition.py @@ -0,0 +1,355 @@ +"""Test humidity conditions.""" + +from typing import Any + +import pytest + +from homeassistant.components.climate import ( + ATTR_CURRENT_HUMIDITY as CLIMATE_ATTR_CURRENT_HUMIDITY, + HVACMode, +) +from homeassistant.components.humidifier import ( + ATTR_CURRENT_HUMIDITY as HUMIDIFIER_ATTR_CURRENT_HUMIDITY, +) +from homeassistant.const import ATTR_UNIT_OF_MEASUREMENT, 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_numerical_attribute_condition_above_below_all, + parametrize_numerical_attribute_condition_above_below_any, + parametrize_numerical_condition_above_below_all, + parametrize_numerical_condition_above_below_any, + parametrize_target_entities, + target_entities, +) + +_HUMIDITY_UNIT_ATTRS = {ATTR_UNIT_OF_MEASUREMENT: "%"} + + +@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.fixture +async def target_climates(hass: HomeAssistant) -> dict[str, list[str]]: + """Create multiple climate entities associated with different targets.""" + return await target_entities(hass, "climate") + + +@pytest.fixture +async def target_humidifiers(hass: HomeAssistant) -> dict[str, list[str]]: + """Create multiple humidifier entities associated with different targets.""" + return await target_entities(hass, "humidifier") + + +@pytest.mark.parametrize( + "condition", + [ + "humidity.value", + ], +) +async def test_humidity_conditions_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str +) -> None: + """Test the humidity 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("sensor"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + parametrize_numerical_condition_above_below_any( + "humidity.value", + device_class="humidity", + unit_attributes=_HUMIDITY_UNIT_ATTRS, + ), +) +async def test_humidity_sensor_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 humidity sensor 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( + "humidity.value", + device_class="humidity", + unit_attributes=_HUMIDITY_UNIT_ATTRS, + ), +) +async def test_humidity_sensor_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 humidity sensor 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( + "humidity.value", + device_class="humidity", + unit_attributes=_HUMIDITY_UNIT_ATTRS, + ), +) +async def test_humidity_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 humidity number condition with '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( + "humidity.value", + device_class="humidity", + unit_attributes=_HUMIDITY_UNIT_ATTRS, + ), +) +async def test_humidity_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 humidity number condition with '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, + ) + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("condition_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities("climate"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + parametrize_numerical_attribute_condition_above_below_any( + "humidity.value", + HVACMode.AUTO, + CLIMATE_ATTR_CURRENT_HUMIDITY, + ), +) +async def test_humidity_climate_condition_behavior_any( + hass: HomeAssistant, + target_climates: 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 humidity climate condition with 'any' behavior.""" + await assert_condition_behavior_any( + hass, + target_entities=target_climates, + 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("climate"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + parametrize_numerical_attribute_condition_above_below_all( + "humidity.value", + HVACMode.AUTO, + CLIMATE_ATTR_CURRENT_HUMIDITY, + ), +) +async def test_humidity_climate_condition_behavior_all( + hass: HomeAssistant, + target_climates: 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 humidity climate condition with 'all' behavior.""" + await assert_condition_behavior_all( + hass, + target_entities=target_climates, + 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("humidifier"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + parametrize_numerical_attribute_condition_above_below_any( + "humidity.value", + STATE_ON, + HUMIDIFIER_ATTR_CURRENT_HUMIDITY, + ), +) +async def test_humidity_humidifier_condition_behavior_any( + hass: HomeAssistant, + target_humidifiers: 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 humidity humidifier condition with 'any' behavior.""" + await assert_condition_behavior_any( + hass, + target_entities=target_humidifiers, + 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("humidifier"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + parametrize_numerical_attribute_condition_above_below_all( + "humidity.value", + STATE_ON, + HUMIDIFIER_ATTR_CURRENT_HUMIDITY, + ), +) +async def test_humidity_humidifier_condition_behavior_all( + hass: HomeAssistant, + target_humidifiers: 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 humidity humidifier condition with 'all' behavior.""" + await assert_condition_behavior_all( + hass, + target_entities=target_humidifiers, + condition_target_config=condition_target_config, + entity_id=entity_id, + entities_in_target=entities_in_target, + condition=condition, + condition_options=condition_options, + states=states, + )