Adjust language + sort

homeassistant/components/automation/__init__.py

@@ -128,6 +128,7 @@ _EXPERIMENTAL_CONDITION_PLATFORMS = {
     "fan",
     "light",
     "siren",
+    "vacuum",
 }
 
 _EXPERIMENTAL_TRIGGER_PLATFORMS = {

homeassistant/components/vacuum/condition.py

@@ -0,0 +1,21 @@
+"""Provides conditions for vacuum cleaners."""
+
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.condition import Condition, make_entity_state_condition
+
+from .const import DOMAIN, VacuumActivity
+
+CONDITIONS: dict[str, type[Condition]] = {
+    "is_cleaning": make_entity_state_condition(DOMAIN, VacuumActivity.CLEANING),
+    "is_docked": make_entity_state_condition(DOMAIN, VacuumActivity.DOCKED),
+    "is_encountering_an_error": make_entity_state_condition(
+        DOMAIN, VacuumActivity.ERROR
+    ),
+    "is_paused": make_entity_state_condition(DOMAIN, VacuumActivity.PAUSED),
+    "is_returning": make_entity_state_condition(DOMAIN, VacuumActivity.RETURNING),
+}
+
+
+async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]:
+    """Return the conditions for vacuum cleaners."""
+    return CONDITIONS

homeassistant/components/vacuum/conditions.yaml

@@ -0,0 +1,20 @@
+.condition_common: &condition_common
+  target:
+    entity:
+      domain: vacuum
+  fields:
+    behavior:
+      required: true
+      default: any
+      selector:
+        select:
+          translation_key: condition_behavior
+          options:
+            - all
+            - any
+
+is_cleaning: *condition_common
+is_docked: *condition_common
+is_encountering_an_error: *condition_common
+is_paused: *condition_common
+is_returning: *condition_common

homeassistant/components/vacuum/icons.json

@@ -1,4 +1,21 @@
 {
+  "conditions": {
+    "is_cleaning": {
+      "condition": "mdi:play"
+    },
+    "is_docked": {
+      "condition": "mdi:home-import-outline"
+    },
+    "is_encountering_an_error": {
+      "condition": "mdi:alert-circle-outline"
+    },
+    "is_paused": {
+      "condition": "mdi:pause"
+    },
+    "is_returning": {
+      "condition": "mdi:home-import-outline"
+    }
+  },
   "entity_component": {
     "_": {
       "default": "mdi:robot-vacuum"

homeassistant/components/vacuum/strings.json

@@ -1,8 +1,62 @@
 {
   "common": {
+    "condition_behavior_description": "How the state should match on the targeted vacuum cleaners.",
+    "condition_behavior_name": "Behavior",
     "trigger_behavior_description": "The behavior of the targeted vacuum cleaners to trigger on.",
     "trigger_behavior_name": "Behavior"
   },
+  "conditions": {
+    "is_cleaning": {
+      "description": "Tests if one or more vacuum cleaners are cleaning.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::vacuum::common::condition_behavior_description%]",
+          "name": "[%key:component::vacuum::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Vacuum cleaner is cleaning"
+    },
+    "is_docked": {
+      "description": "Tests if one or more vacuum cleaners are docked.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::vacuum::common::condition_behavior_description%]",
+          "name": "[%key:component::vacuum::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Vacuum cleaner is docked"
+    },
+    "is_encountering_an_error": {
+      "description": "Tests if one or more vacuum cleaners are encountering an error.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::vacuum::common::condition_behavior_description%]",
+          "name": "[%key:component::vacuum::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Vacuum cleaner is encountering an error"
+    },
+    "is_paused": {
+      "description": "Tests if one or more vacuum cleaners are paused.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::vacuum::common::condition_behavior_description%]",
+          "name": "[%key:component::vacuum::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Vacuum cleaner is paused"
+    },
+    "is_returning": {
+      "description": "Tests if one or more vacuum cleaners are returning to the dock.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::vacuum::common::condition_behavior_description%]",
+          "name": "[%key:component::vacuum::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Vacuum cleaner is returning"
+    }
+  },
   "device_automation": {
     "action_type": {
       "clean": "Let {entity_name} clean",
@@ -36,6 +90,12 @@
     }
   },
   "selector": {
+    "condition_behavior": {
+      "options": {
+        "all": "All",
+        "any": "Any"
+      }
+    },
     "trigger_behavior": {
       "options": {
         "any": "Any",

tests/components/vacuum/test_condition.py

@@ -0,0 +1,190 @@
+"""Test vacuum conditions."""
+
+from typing import Any
+
+import pytest
+
+from homeassistant.components.vacuum import VacuumActivity
+from homeassistant.core import HomeAssistant
+
+from tests.components import (
+    ConditionStateDescription,
+    assert_condition_gated_by_labs_flag,
+    create_target_condition,
+    other_states,
+    parametrize_condition_states_all,
+    parametrize_condition_states_any,
+    parametrize_target_entities,
+    set_or_remove_state,
+    target_entities,
+)
+
+
+@pytest.fixture
+async def target_vacuums(hass: HomeAssistant) -> list[str]:
+    """Create multiple vacuum entities associated with different targets."""
+    return (await target_entities(hass, "vacuum"))["included"]
+
+
+@pytest.mark.parametrize(
+    "condition",
+    [
+        "vacuum.is_cleaning",
+        "vacuum.is_docked",
+        "vacuum.is_encountering_an_error",
+        "vacuum.is_paused",
+        "vacuum.is_returning",
+    ],
+)
+async def test_vacuum_conditions_gated_by_labs_flag(
+    hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str
+) -> None:
+    """Test the vacuum 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("vacuum"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states_any(
+            condition="vacuum.is_cleaning",
+            target_states=[VacuumActivity.CLEANING],
+            other_states=other_states(VacuumActivity.CLEANING),
+        ),
+        *parametrize_condition_states_any(
+            condition="vacuum.is_docked",
+            target_states=[VacuumActivity.DOCKED],
+            other_states=other_states(VacuumActivity.DOCKED),
+        ),
+        *parametrize_condition_states_any(
+            condition="vacuum.is_encountering_an_error",
+            target_states=[VacuumActivity.ERROR],
+            other_states=other_states(VacuumActivity.ERROR),
+        ),
+        *parametrize_condition_states_any(
+            condition="vacuum.is_paused",
+            target_states=[VacuumActivity.PAUSED],
+            other_states=other_states(VacuumActivity.PAUSED),
+        ),
+        *parametrize_condition_states_any(
+            condition="vacuum.is_returning",
+            target_states=[VacuumActivity.RETURNING],
+            other_states=other_states(VacuumActivity.RETURNING),
+        ),
+    ],
+)
+async def test_vacuum_state_condition_behavior_any(
+    hass: HomeAssistant,
+    target_vacuums: 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 vacuum state condition with the 'any' behavior."""
+    other_entity_ids = set(target_vacuums) - {entity_id}
+
+    # Set all vacuums, including the tested vacuum, to the initial state
+    for eid in target_vacuums:
+        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 vacuums 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("vacuum"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states_all(
+            condition="vacuum.is_cleaning",
+            target_states=[VacuumActivity.CLEANING],
+            other_states=other_states(VacuumActivity.CLEANING),
+        ),
+        *parametrize_condition_states_all(
+            condition="vacuum.is_docked",
+            target_states=[VacuumActivity.DOCKED],
+            other_states=other_states(VacuumActivity.DOCKED),
+        ),
+        *parametrize_condition_states_all(
+            condition="vacuum.is_encountering_an_error",
+            target_states=[VacuumActivity.ERROR],
+            other_states=other_states(VacuumActivity.ERROR),
+        ),
+        *parametrize_condition_states_all(
+            condition="vacuum.is_paused",
+            target_states=[VacuumActivity.PAUSED],
+            other_states=other_states(VacuumActivity.PAUSED),
+        ),
+        *parametrize_condition_states_all(
+            condition="vacuum.is_returning",
+            target_states=[VacuumActivity.RETURNING],
+            other_states=other_states(VacuumActivity.RETURNING),
+        ),
+    ],
+)
+async def test_vacuum_state_condition_behavior_all(
+    hass: HomeAssistant,
+    target_vacuums: 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 vacuum state condition with the 'all' behavior."""
+    other_entity_ids = set(target_vacuums) - {entity_id}
+
+    # Set all vacuums, including the tested vacuum, to the initial state
+    for eid in target_vacuums:
+        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()
+        assert condition(hass) == state["condition_true_first_entity"]
+
+        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"]