Add lawn_mower conditions (#161382)

homeassistant/components/automation/__init__.py

@@ -127,6 +127,7 @@ _EXPERIMENTAL_CONDITION_PLATFORMS = {
     "assist_satellite",
     "device_tracker",
     "fan",
+    "lawn_mower",
     "light",
     "lock",
     "siren",

homeassistant/components/lawn_mower/condition.py

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

homeassistant/components/lawn_mower/conditions.yaml

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

homeassistant/components/lawn_mower/icons.json

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

homeassistant/components/lawn_mower/strings.json

@@ -1,8 +1,62 @@
 {
   "common": {
+    "condition_behavior_description": "How the state should match on the targeted lawn mowers.",
+    "condition_behavior_name": "Behavior",
     "trigger_behavior_description": "The behavior of the targeted lawn mowers to trigger on.",
     "trigger_behavior_name": "Behavior"
   },
+  "conditions": {
+    "is_docked": {
+      "description": "Tests if one or more lawn mowers are docked.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::lawn_mower::common::condition_behavior_description%]",
+          "name": "[%key:component::lawn_mower::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Lawn mower is docked"
+    },
+    "is_encountering_an_error": {
+      "description": "Tests if one or more lawn mowers are encountering an error.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::lawn_mower::common::condition_behavior_description%]",
+          "name": "[%key:component::lawn_mower::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Lawn mower is encountering an error"
+    },
+    "is_mowing": {
+      "description": "Tests if one or more lawn mowers are mowing.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::lawn_mower::common::condition_behavior_description%]",
+          "name": "[%key:component::lawn_mower::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Lawn mower is mowing"
+    },
+    "is_paused": {
+      "description": "Tests if one or more lawn mowers are paused.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::lawn_mower::common::condition_behavior_description%]",
+          "name": "[%key:component::lawn_mower::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Lawn mower is paused"
+    },
+    "is_returning": {
+      "description": "Tests if one or more lawn mowers are returning to the dock.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::lawn_mower::common::condition_behavior_description%]",
+          "name": "[%key:component::lawn_mower::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Lawn mower is returning"
+    }
+  },
   "entity_component": {
     "_": {
       "name": "[%key:component::lawn_mower::title%]",
@@ -16,6 +70,12 @@
     }
   },
   "selector": {
+    "condition_behavior": {
+      "options": {
+        "all": "All",
+        "any": "Any"
+      }
+    },
     "trigger_behavior": {
       "options": {
         "any": "Any",

tests/components/lawn_mower/test_condition.py

@@ -0,0 +1,190 @@
+"""Test lawn mower conditions."""
+
+from typing import Any
+
+import pytest
+
+from homeassistant.components.lawn_mower.const import LawnMowerActivity
+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_lawn_mowers(hass: HomeAssistant) -> list[str]:
+    """Create multiple lawn mower entities associated with different targets."""
+    return (await target_entities(hass, "lawn_mower"))["included"]
+
+
+@pytest.mark.parametrize(
+    "condition",
+    [
+        "lawn_mower.is_docked",
+        "lawn_mower.is_encountering_an_error",
+        "lawn_mower.is_mowing",
+        "lawn_mower.is_paused",
+        "lawn_mower.is_returning",
+    ],
+)
+async def test_lawn_mower_conditions_gated_by_labs_flag(
+    hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str
+) -> None:
+    """Test the lawn mower 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("lawn_mower"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states_any(
+            condition="lawn_mower.is_docked",
+            target_states=[LawnMowerActivity.DOCKED],
+            other_states=other_states(LawnMowerActivity.DOCKED),
+        ),
+        *parametrize_condition_states_any(
+            condition="lawn_mower.is_encountering_an_error",
+            target_states=[LawnMowerActivity.ERROR],
+            other_states=other_states(LawnMowerActivity.ERROR),
+        ),
+        *parametrize_condition_states_any(
+            condition="lawn_mower.is_mowing",
+            target_states=[LawnMowerActivity.MOWING],
+            other_states=other_states(LawnMowerActivity.MOWING),
+        ),
+        *parametrize_condition_states_any(
+            condition="lawn_mower.is_paused",
+            target_states=[LawnMowerActivity.PAUSED],
+            other_states=other_states(LawnMowerActivity.PAUSED),
+        ),
+        *parametrize_condition_states_any(
+            condition="lawn_mower.is_returning",
+            target_states=[LawnMowerActivity.RETURNING],
+            other_states=other_states(LawnMowerActivity.RETURNING),
+        ),
+    ],
+)
+async def test_lawn_mower_state_condition_behavior_any(
+    hass: HomeAssistant,
+    target_lawn_mowers: 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 lawn mower state condition with the 'any' behavior."""
+    other_entity_ids = set(target_lawn_mowers) - {entity_id}
+
+    # Set all lawn mowers, including the tested lawn mower, to the initial state
+    for eid in target_lawn_mowers:
+        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 lawn mowers 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("lawn_mower"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states_all(
+            condition="lawn_mower.is_docked",
+            target_states=[LawnMowerActivity.DOCKED],
+            other_states=other_states(LawnMowerActivity.DOCKED),
+        ),
+        *parametrize_condition_states_all(
+            condition="lawn_mower.is_encountering_an_error",
+            target_states=[LawnMowerActivity.ERROR],
+            other_states=other_states(LawnMowerActivity.ERROR),
+        ),
+        *parametrize_condition_states_all(
+            condition="lawn_mower.is_mowing",
+            target_states=[LawnMowerActivity.MOWING],
+            other_states=other_states(LawnMowerActivity.MOWING),
+        ),
+        *parametrize_condition_states_all(
+            condition="lawn_mower.is_paused",
+            target_states=[LawnMowerActivity.PAUSED],
+            other_states=other_states(LawnMowerActivity.PAUSED),
+        ),
+        *parametrize_condition_states_all(
+            condition="lawn_mower.is_returning",
+            target_states=[LawnMowerActivity.RETURNING],
+            other_states=other_states(LawnMowerActivity.RETURNING),
+        ),
+    ],
+)
+async def test_lawn_mower_state_condition_behavior_all(
+    hass: HomeAssistant,
+    target_lawn_mowers: 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 lawn mower state condition with the 'all' behavior."""
+    other_entity_ids = set(target_lawn_mowers) - {entity_id}
+
+    # Set all lawn mowers, including the tested lawn mower, to the initial state
+    for eid in target_lawn_mowers:
+        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"]