Add counter purpose-specific condition (#166879)

homeassistant/components/automation/__init__.py

@@ -124,6 +124,7 @@ _EXPERIMENTAL_CONDITION_PLATFORMS = {
     "battery",
     "calendar",
     "climate",
+    "counter",
     "cover",
     "device_tracker",
     "door",

homeassistant/components/counter/condition.py

@@ -0,0 +1,15 @@
+"""Provides conditions for counters."""
+
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.condition import Condition, make_entity_numerical_condition
+
+DOMAIN = "counter"
+
+CONDITIONS: dict[str, type[Condition]] = {
+    "is_value": make_entity_numerical_condition(DOMAIN),
+}
+
+
+async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]:
+    """Return the conditions for counters."""
+    return CONDITIONS

homeassistant/components/counter/conditions.yaml

@@ -0,0 +1,25 @@
+is_value:
+  target:
+    entity:
+      - domain: counter
+  fields:
+    behavior:
+      required: true
+      default: any
+      selector:
+        select:
+          translation_key: condition_behavior
+          options:
+            - all
+            - any
+    threshold:
+      required: true
+      selector:
+        numeric_threshold:
+          entity:
+            - domain: counter
+            - domain: input_number
+            - domain: number
+          mode: is
+          number:
+            mode: box

homeassistant/components/counter/icons.json

@@ -1,4 +1,9 @@
 {
+  "conditions": {
+    "is_value": {
+      "condition": "mdi:counter"
+    }
+  },
   "services": {
     "decrement": {
       "service": "mdi:numeric-negative-1"

homeassistant/components/counter/strings.json

@@ -3,6 +3,22 @@
     "trigger_behavior_description": "The behavior of the targeted counters to trigger on.",
     "trigger_behavior_name": "Behavior"
   },
+  "conditions": {
+    "is_value": {
+      "description": "Tests the value of one or more counters.",
+      "fields": {
+        "behavior": {
+          "description": "How the state should match on the targeted counters.",
+          "name": "Behavior"
+        },
+        "threshold": {
+          "description": "What to test for and threshold values.",
+          "name": "Threshold"
+        }
+      },
+      "name": "Counter value"
+    }
+  },
   "entity_component": {
     "_": {
       "name": "[%key:component::counter::title%]",
@@ -30,6 +46,12 @@
     }
   },
   "selector": {
+    "condition_behavior": {
+      "options": {
+        "all": "All",
+        "any": "Any"
+      }
+    },
     "trigger_behavior": {
       "options": {
         "any": "Any",

tests/components/counter/test_condition.py

@@ -0,0 +1,177 @@
+"""Test counter conditions."""
+
+from typing import Any
+
+import pytest
+
+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_target_entities,
+    target_entities,
+)
+
+
+@pytest.fixture
+async def target_counters(hass: HomeAssistant) -> dict[str, list[str]]:
+    """Create multiple counter entities associated with different targets."""
+    return await target_entities(hass, "counter")
+
+
+async def test_counter_condition_gated_by_labs_flag(
+    hass: HomeAssistant, caplog: pytest.LogCaptureFixture
+) -> None:
+    """Test the counter condition is gated by the labs flag."""
+    await assert_condition_gated_by_labs_flag(hass, caplog, "counter.is_value")
+
+
+@pytest.mark.usefixtures("enable_labs_preview_features")
+@pytest.mark.parametrize(
+    ("condition_target_config", "entity_id", "entities_in_target"),
+    parametrize_target_entities("counter"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states_any(
+            condition="counter.is_value",
+            condition_options={
+                "threshold": {"type": "above", "value": {"number": 20}},
+            },
+            target_states=["21", "50", "100"],
+            other_states=["0", "10", "20"],
+        ),
+        *parametrize_condition_states_any(
+            condition="counter.is_value",
+            condition_options={
+                "threshold": {"type": "below", "value": {"number": 20}},
+            },
+            target_states=["0", "10", "19"],
+            other_states=["20", "50", "100"],
+        ),
+        *parametrize_condition_states_any(
+            condition="counter.is_value",
+            condition_options={
+                "threshold": {
+                    "type": "between",
+                    "value_min": {"number": 10},
+                    "value_max": {"number": 30},
+                },
+            },
+            target_states=["11", "20", "29"],
+            other_states=["0", "10", "30", "100"],
+        ),
+        *parametrize_condition_states_any(
+            condition="counter.is_value",
+            condition_options={
+                "threshold": {
+                    "type": "outside",
+                    "value_min": {"number": 10},
+                    "value_max": {"number": 30},
+                },
+            },
+            target_states=["0", "10", "30", "100"],
+            other_states=["11", "20", "29"],
+        ),
+    ],
+)
+async def test_counter_is_value_condition_behavior_any(
+    hass: HomeAssistant,
+    target_counters: dict[str, list[str]],
+    condition_target_config: dict[str, Any],
+    entity_id: str,
+    entities_in_target: int,
+    condition: str,
+    condition_options: dict[str, Any],
+    states: list[ConditionStateDescription],
+) -> None:
+    """Test the counter is_value condition with 'any' behavior."""
+    await assert_condition_behavior_any(
+        hass,
+        target_entities=target_counters,
+        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("counter"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states_all(
+            condition="counter.is_value",
+            condition_options={
+                "threshold": {"type": "above", "value": {"number": 20}},
+            },
+            target_states=["21", "50", "100"],
+            other_states=["0", "10", "20"],
+        ),
+        *parametrize_condition_states_all(
+            condition="counter.is_value",
+            condition_options={
+                "threshold": {"type": "below", "value": {"number": 20}},
+            },
+            target_states=["0", "10", "19"],
+            other_states=["20", "50", "100"],
+        ),
+        *parametrize_condition_states_all(
+            condition="counter.is_value",
+            condition_options={
+                "threshold": {
+                    "type": "between",
+                    "value_min": {"number": 10},
+                    "value_max": {"number": 30},
+                },
+            },
+            target_states=["11", "20", "29"],
+            other_states=["0", "10", "30", "100"],
+        ),
+        *parametrize_condition_states_all(
+            condition="counter.is_value",
+            condition_options={
+                "threshold": {
+                    "type": "outside",
+                    "value_min": {"number": 10},
+                    "value_max": {"number": 30},
+                },
+            },
+            target_states=["0", "10", "30", "100"],
+            other_states=["11", "20", "29"],
+        ),
+    ],
+)
+async def test_counter_is_value_condition_behavior_all(
+    hass: HomeAssistant,
+    target_counters: dict[str, list[str]],
+    condition_target_config: dict[str, Any],
+    entity_id: str,
+    entities_in_target: int,
+    condition: str,
+    condition_options: dict[str, Any],
+    states: list[ConditionStateDescription],
+) -> None:
+    """Test the counter is_value condition with 'all' behavior."""
+    await assert_condition_behavior_all(
+        hass,
+        target_entities=target_counters,
+        condition_target_config=condition_target_config,
+        entity_id=entity_id,
+        entities_in_target=entities_in_target,
+        condition=condition,
+        condition_options=condition_options,
+        states=states,
+    )