Add switch conditions

homeassistant/components/automation/__init__.py

@@ -125,6 +125,7 @@ NEW_TRIGGERS_CONDITIONS_FEATURE_FLAG = "new_triggers_conditions"
 _EXPERIMENTAL_CONDITION_PLATFORMS = {
     "fan",
     "light",
+    "switch",
 }
 
 _EXPERIMENTAL_TRIGGER_PLATFORMS = {

homeassistant/components/switch/condition.py

@@ -0,0 +1,17 @@
+"""Provides conditions for switches."""
+
+from homeassistant.const import STATE_OFF, STATE_ON
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.condition import Condition, make_entity_state_condition
+
+from .const import DOMAIN
+
+CONDITIONS: dict[str, type[Condition]] = {
+    "is_off": make_entity_state_condition(DOMAIN, STATE_OFF),
+    "is_on": make_entity_state_condition(DOMAIN, STATE_ON),
+}
+
+
+async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]:
+    """Return the switch conditions."""
+    return CONDITIONS

homeassistant/components/switch/conditions.yaml

@@ -0,0 +1,17 @@
+.condition_common: &condition_common
+  target:
+    entity:
+      domain: switch
+  fields:
+    behavior:
+      required: true
+      default: any
+      selector:
+        select:
+          translation_key: condition_behavior
+          options:
+            - all
+            - any
+
+is_off: *condition_common
+is_on: *condition_common

homeassistant/components/switch/icons.json

@@ -1,4 +1,12 @@
 {
+  "conditions": {
+    "is_off": {
+      "condition": "mdi:toggle-switch-variant-off"
+    },
+    "is_on": {
+      "condition": "mdi:toggle-switch-variant"
+    }
+  },
   "entity_component": {
     "_": {
       "default": "mdi:toggle-switch-variant",

homeassistant/components/switch/strings.json

@@ -1,8 +1,32 @@
 {
   "common": {
+    "condition_behavior_description": "How the state should match on the targeted switches.",
+    "condition_behavior_name": "Behavior",
     "trigger_behavior_description": "The behavior of the targeted switches to trigger on.",
     "trigger_behavior_name": "Behavior"
   },
+  "conditions": {
+    "is_off": {
+      "description": "Test if a switch is off.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::switch::common::condition_behavior_description%]",
+          "name": "[%key:component::switch::common::condition_behavior_name%]"
+        }
+      },
+      "name": "If a switch is off"
+    },
+    "is_on": {
+      "description": "Test if a switch is on.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::switch::common::condition_behavior_description%]",
+          "name": "[%key:component::switch::common::condition_behavior_name%]"
+        }
+      },
+      "name": "If a switch is on"
+    }
+  },
   "device_automation": {
     "action_type": {
       "toggle": "[%key:common::device_automation::action_type::toggle%]",
@@ -46,6 +70,12 @@
     }
   },
   "selector": {
+    "condition_behavior": {
+      "options": {
+        "all": "All",
+        "any": "Any"
+      }
+    },
     "trigger_behavior": {
       "options": {
         "any": "Any",

tests/components/switch/test_condition.py

@@ -0,0 +1,185 @@
+"""Test switch conditions."""
+
+from typing import Any
+
+import pytest
+
+from homeassistant.const import STATE_OFF, STATE_ON
+from homeassistant.core import HomeAssistant
+
+from tests.components import (
+    ConditionStateDescription,
+    assert_condition_gated_by_labs_flag,
+    create_target_condition,
+    parametrize_condition_states,
+    parametrize_target_entities,
+    set_or_remove_state,
+    target_entities,
+)
+
+
+@pytest.fixture(autouse=True, name="stub_blueprint_populate")
+def stub_blueprint_populate_autouse(stub_blueprint_populate: None) -> None:
+    """Stub copying the blueprints to the config folder."""
+
+
+@pytest.fixture
+async def target_lights(hass: HomeAssistant) -> list[str]:
+    """Create multiple light entities associated with different targets."""
+    return (await target_entities(hass, "light"))["included"]
+
+
+@pytest.fixture
+async def target_switches(hass: HomeAssistant) -> list[str]:
+    """Create multiple switch entities associated with different targets."""
+    return (await target_entities(hass, "switch"))["included"]
+
+
+@pytest.mark.parametrize(
+    "condition",
+    [
+        "switch.is_off",
+        "switch.is_on",
+    ],
+)
+async def test_switch_conditions_gated_by_labs_flag(
+    hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str
+) -> None:
+    """Test the switch 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("switch"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states(
+            condition="switch.is_on",
+            target_states=[STATE_ON],
+            other_states=[STATE_OFF],
+        ),
+        *parametrize_condition_states(
+            condition="switch.is_off",
+            target_states=[STATE_OFF],
+            other_states=[STATE_ON],
+        ),
+    ],
+)
+async def test_switch_state_condition_behavior_any(
+    hass: HomeAssistant,
+    target_lights: list[str],
+    target_switches: 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 switch state condition with the 'any' behavior."""
+    other_entity_ids = set(target_switches) - {entity_id}
+
+    # Set all switches, including the tested switch, to the initial state
+    for eid in target_switches:
+        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",
+    )
+
+    # Set state for lights to ensure that they don't impact the condition
+    for state in states:
+        for eid in target_lights:
+            set_or_remove_state(hass, eid, state["included"])
+            await hass.async_block_till_done()
+            assert condition(hass) is False
+
+    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 lights 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("switch"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states(
+            condition="switch.is_on",
+            target_states=[STATE_ON],
+            other_states=[STATE_OFF],
+        ),
+        *parametrize_condition_states(
+            condition="switch.is_off",
+            target_states=[STATE_OFF],
+            other_states=[STATE_ON],
+        ),
+    ],
+)
+async def test_switch_state_condition_behavior_all(
+    hass: HomeAssistant,
+    target_switches: 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 switch state condition with the 'all' behavior."""
+    # Set state for two switches to ensure that they don't impact the condition
+    hass.states.async_set("switch.label_switch_1", STATE_OFF)
+    hass.states.async_set("switch.label_switch_2", STATE_ON)
+
+    other_entity_ids = set(target_switches) - {entity_id}
+
+    # Set all switches, including the tested switch, to the initial state
+    for eid in target_switches:
+        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()
+        # The condition passes if all entities are either in a target state or invalid
+        assert condition(hass) == (
+            (not state["state_valid"])
+            or (state["condition_true"] and entities_in_target == 1)
+        )
+
+        for other_entity_id in other_entity_ids:
+            set_or_remove_state(hass, other_entity_id, included_state)
+            await hass.async_block_till_done()
+
+        # The condition passes if all entities are either in a target state or invalid
+        assert condition(hass) == (
+            (not state["state_valid"]) or state["condition_true"]
+        )