Add humidifier device conditions (#36962)

homeassistant/components/humidifier/device_condition.py

@@ -0,0 +1,103 @@
+"""Provide the device automations for Humidifier."""
+from typing import Dict, List
+
+import voluptuous as vol
+
+from homeassistant.components.device_automation import toggle_entity
+from homeassistant.const import (
+    ATTR_ENTITY_ID,
+    CONF_CONDITION,
+    CONF_DEVICE_ID,
+    CONF_DOMAIN,
+    CONF_ENTITY_ID,
+    CONF_TYPE,
+)
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.helpers import condition, config_validation as cv, entity_registry
+from homeassistant.helpers.config_validation import DEVICE_CONDITION_BASE_SCHEMA
+from homeassistant.helpers.typing import ConfigType, TemplateVarsType
+
+from . import DOMAIN, const
+
+TOGGLE_CONDITION = toggle_entity.CONDITION_SCHEMA.extend(
+    {vol.Required(CONF_DOMAIN): DOMAIN}
+)
+
+MODE_CONDITION = DEVICE_CONDITION_BASE_SCHEMA.extend(
+    {
+        vol.Required(CONF_ENTITY_ID): cv.entity_id,
+        vol.Required(CONF_TYPE): "is_mode",
+        vol.Required(const.ATTR_MODE): str,
+    }
+)
+
+CONDITION_SCHEMA = vol.Any(TOGGLE_CONDITION, MODE_CONDITION)
+
+
+async def async_get_conditions(
+    hass: HomeAssistant, device_id: str
+) -> List[Dict[str, str]]:
+    """List device conditions for Humidifier devices."""
+    registry = await entity_registry.async_get_registry(hass)
+    conditions = await toggle_entity.async_get_conditions(hass, device_id, DOMAIN)
+
+    # Get all the integrations entities for this device
+    for entry in entity_registry.async_entries_for_device(registry, device_id):
+        if entry.domain != DOMAIN:
+            continue
+
+        state = hass.states.get(entry.entity_id)
+
+        if state and state.attributes["supported_features"] & const.SUPPORT_MODES:
+            conditions.append(
+                {
+                    CONF_CONDITION: "device",
+                    CONF_DEVICE_ID: device_id,
+                    CONF_DOMAIN: DOMAIN,
+                    CONF_ENTITY_ID: entry.entity_id,
+                    CONF_TYPE: "is_mode",
+                }
+            )
+
+    return conditions
+
+
+@callback
+def async_condition_from_config(
+    config: ConfigType, config_validation: bool
+) -> condition.ConditionCheckerType:
+    """Create a function to test a device condition."""
+    if config_validation:
+        config = CONDITION_SCHEMA(config)
+
+    if config[CONF_TYPE] == "is_mode":
+        attribute = const.ATTR_MODE
+    else:
+        return toggle_entity.async_condition_from_config(config)
+
+    def test_is_state(hass: HomeAssistant, variables: TemplateVarsType) -> bool:
+        """Test if an entity is a certain state."""
+        state = hass.states.get(config[ATTR_ENTITY_ID])
+        return state and state.attributes.get(attribute) == config[attribute]
+
+    return test_is_state
+
+
+async def async_get_condition_capabilities(hass, config):
+    """List condition capabilities."""
+    state = hass.states.get(config[CONF_ENTITY_ID])
+    condition_type = config[CONF_TYPE]
+
+    fields = {}
+
+    if condition_type == "is_mode":
+        if state:
+            modes = state.attributes.get(const.ATTR_AVAILABLE_MODES, [])
+        else:
+            modes = []
+
+        fields[vol.Required(const.ATTR_AVAILABLE_MODES)] = vol.In(modes)
+
+        return {"extra_fields": vol.Schema(fields)}
+
+    return await toggle_entity.async_get_condition_capabilities(hass, config)

homeassistant/components/humidifier/strings.json

@@ -1,6 +1,11 @@
 {
   "title": "Humidifier",
   "device_automation": {
+    "condition_type": {
+      "is_mode": "{entity_name} is set to a specific mode",
+      "is_on": "{entity_name} is on",
+      "is_off": "{entity_name} is off"
+    },
     "action_type": {
       "set_humidity": "Set humidity for {entity_name}",
       "set_mode": "Change mode on {entity_name}",

tests/components/humidifier/test_device_condition.py

@@ -0,0 +1,314 @@
+"""The tests for Humidifier device conditions."""
+import pytest
+import voluptuous_serialize
+
+import homeassistant.components.automation as automation
+from homeassistant.components.humidifier import DOMAIN, const, device_condition
+from homeassistant.const import STATE_OFF, STATE_ON
+from homeassistant.helpers import config_validation as cv, device_registry
+from homeassistant.setup import async_setup_component
+
+from tests.common import (
+    MockConfigEntry,
+    assert_lists_same,
+    async_get_device_automation_capabilities,
+    async_get_device_automations,
+    async_mock_service,
+    mock_device_registry,
+    mock_registry,
+)
+
+
+@pytest.fixture
+def device_reg(hass):
+    """Return an empty, loaded, registry."""
+    return mock_device_registry(hass)
+
+
+@pytest.fixture
+def entity_reg(hass):
+    """Return an empty, loaded, registry."""
+    return mock_registry(hass)
+
+
+@pytest.fixture
+def calls(hass):
+    """Track calls to a mock service."""
+    return async_mock_service(hass, "test", "automation")
+
+
+async def test_get_conditions(hass, device_reg, entity_reg):
+    """Test we get the expected conditions from a humidifier."""
+    config_entry = MockConfigEntry(domain="test", data={})
+    config_entry.add_to_hass(hass)
+    device_entry = device_reg.async_get_or_create(
+        config_entry_id=config_entry.entry_id,
+        connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
+    )
+    entity_reg.async_get_or_create(DOMAIN, "test", "5678", device_id=device_entry.id)
+    hass.states.async_set(
+        f"{DOMAIN}.test_5678",
+        STATE_ON,
+        {
+            const.ATTR_MODE: const.MODE_AWAY,
+            const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY],
+        },
+    )
+    hass.states.async_set(
+        "humidifier.test_5678", "attributes", {"supported_features": 1}
+    )
+    expected_conditions = [
+        {
+            "condition": "device",
+            "domain": DOMAIN,
+            "type": "is_off",
+            "device_id": device_entry.id,
+            "entity_id": f"{DOMAIN}.test_5678",
+        },
+        {
+            "condition": "device",
+            "domain": DOMAIN,
+            "type": "is_on",
+            "device_id": device_entry.id,
+            "entity_id": f"{DOMAIN}.test_5678",
+        },
+        {
+            "condition": "device",
+            "domain": DOMAIN,
+            "type": "is_mode",
+            "device_id": device_entry.id,
+            "entity_id": f"{DOMAIN}.test_5678",
+        },
+    ]
+    conditions = await async_get_device_automations(hass, "condition", device_entry.id)
+    assert_lists_same(conditions, expected_conditions)
+
+
+async def test_get_conditions_toggle_only(hass, device_reg, entity_reg):
+    """Test we get the expected conditions from a humidifier."""
+    config_entry = MockConfigEntry(domain="test", data={})
+    config_entry.add_to_hass(hass)
+    device_entry = device_reg.async_get_or_create(
+        config_entry_id=config_entry.entry_id,
+        connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
+    )
+    entity_reg.async_get_or_create(DOMAIN, "test", "5678", device_id=device_entry.id)
+    hass.states.async_set(
+        f"{DOMAIN}.test_5678",
+        STATE_ON,
+        {
+            const.ATTR_MODE: const.MODE_AWAY,
+            const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY],
+        },
+    )
+    hass.states.async_set(
+        "humidifier.test_5678", "attributes", {"supported_features": 0}
+    )
+    expected_conditions = [
+        {
+            "condition": "device",
+            "domain": DOMAIN,
+            "type": "is_off",
+            "device_id": device_entry.id,
+            "entity_id": f"{DOMAIN}.test_5678",
+        },
+        {
+            "condition": "device",
+            "domain": DOMAIN,
+            "type": "is_on",
+            "device_id": device_entry.id,
+            "entity_id": f"{DOMAIN}.test_5678",
+        },
+    ]
+    conditions = await async_get_device_automations(hass, "condition", device_entry.id)
+    assert_lists_same(conditions, expected_conditions)
+
+
+async def test_if_state(hass, calls):
+    """Test for turn_on and turn_off conditions."""
+    hass.states.async_set(
+        "humidifier.entity", STATE_ON, {const.ATTR_MODE: const.MODE_AWAY}
+    )
+
+    assert await async_setup_component(
+        hass,
+        automation.DOMAIN,
+        {
+            automation.DOMAIN: [
+                {
+                    "trigger": {"platform": "event", "event_type": "test_event1"},
+                    "condition": [
+                        {
+                            "condition": "device",
+                            "domain": DOMAIN,
+                            "device_id": "",
+                            "entity_id": "humidifier.entity",
+                            "type": "is_on",
+                        }
+                    ],
+                    "action": {
+                        "service": "test.automation",
+                        "data_template": {
+                            "some": "is_on {{ trigger.%s }}"
+                            % "}} - {{ trigger.".join(("platform", "event.event_type"))
+                        },
+                    },
+                },
+                {
+                    "trigger": {"platform": "event", "event_type": "test_event2"},
+                    "condition": [
+                        {
+                            "condition": "device",
+                            "domain": DOMAIN,
+                            "device_id": "",
+                            "entity_id": "humidifier.entity",
+                            "type": "is_off",
+                        }
+                    ],
+                    "action": {
+                        "service": "test.automation",
+                        "data_template": {
+                            "some": "is_off {{ trigger.%s }}"
+                            % "}} - {{ trigger.".join(("platform", "event.event_type"))
+                        },
+                    },
+                },
+                {
+                    "trigger": {"platform": "event", "event_type": "test_event3"},
+                    "condition": [
+                        {
+                            "condition": "device",
+                            "domain": DOMAIN,
+                            "device_id": "",
+                            "entity_id": "humidifier.entity",
+                            "type": "is_mode",
+                            "mode": "away",
+                        }
+                    ],
+                    "action": {
+                        "service": "test.automation",
+                        "data_template": {
+                            "some": "is_mode - {{ trigger.platform }} - {{ trigger.event.event_type }}"
+                        },
+                    },
+                },
+            ]
+        },
+    )
+    await hass.async_block_till_done()
+    assert hass.states.get("humidifier.entity").state == STATE_ON
+    assert len(calls) == 0
+
+    hass.bus.async_fire("test_event1")
+    hass.bus.async_fire("test_event2")
+    await hass.async_block_till_done()
+    assert len(calls) == 1
+    assert calls[0].data["some"] == "is_on event - test_event1"
+
+    hass.states.async_set("humidifier.entity", STATE_OFF)
+    hass.bus.async_fire("test_event1")
+    hass.bus.async_fire("test_event2")
+    await hass.async_block_till_done()
+    assert len(calls) == 2
+    assert calls[1].data["some"] == "is_off event - test_event2"
+
+    hass.states.async_set(
+        "humidifier.entity", STATE_ON, {const.ATTR_MODE: const.MODE_AWAY}
+    )
+
+    hass.bus.async_fire("test_event3")
+    await hass.async_block_till_done()
+
+    assert len(calls) == 3
+    assert calls[2].data["some"] == "is_mode - event - test_event3"
+
+    hass.states.async_set(
+        "humidifier.entity", STATE_ON, {const.ATTR_MODE: const.MODE_HOME}
+    )
+
+    # Should not fire
+    hass.bus.async_fire("test_event3")
+    await hass.async_block_till_done()
+    assert len(calls) == 3
+
+
+async def test_capabilities(hass):
+    """Test capabilities."""
+    hass.states.async_set(
+        "humidifier.entity",
+        STATE_ON,
+        {
+            const.ATTR_MODE: const.MODE_AWAY,
+            const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY],
+        },
+    )
+
+    # Test mode
+    capabilities = await device_condition.async_get_condition_capabilities(
+        hass,
+        {
+            "condition": "device",
+            "domain": DOMAIN,
+            "device_id": "",
+            "entity_id": "humidifier.entity",
+            "type": "is_mode",
+        },
+    )
+
+    assert capabilities and "extra_fields" in capabilities
+
+    assert voluptuous_serialize.convert(
+        capabilities["extra_fields"], custom_serializer=cv.custom_serializer
+    ) == [
+        {
+            "name": "available_modes",
+            "options": [("home", "home"), ("away", "away")],
+            "required": True,
+            "type": "select",
+        }
+    ]
+
+
+async def test_capabilities_no_state(hass):
+    """Test capabilities while state not available."""
+    # Test mode
+    capabilities = await device_condition.async_get_condition_capabilities(
+        hass,
+        {
+            "condition": "device",
+            "domain": DOMAIN,
+            "device_id": "",
+            "entity_id": "humidifier.entity",
+            "type": "is_mode",
+        },
+    )
+
+    assert capabilities and "extra_fields" in capabilities
+
+    assert voluptuous_serialize.convert(
+        capabilities["extra_fields"], custom_serializer=cv.custom_serializer
+    ) == [
+        {"name": "available_modes", "options": [], "required": True, "type": "select"}
+    ]
+
+
+async def test_get_condition_capabilities(hass, device_reg, entity_reg):
+    """Test we get the expected toggle capabilities."""
+    config_entry = MockConfigEntry(domain="test", data={})
+    config_entry.add_to_hass(hass)
+    device_entry = device_reg.async_get_or_create(
+        config_entry_id=config_entry.entry_id,
+        connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
+    )
+    entity_reg.async_get_or_create(DOMAIN, "test", "5678", device_id=device_entry.id)
+    expected_capabilities = {
+        "extra_fields": [
+            {"name": "for", "optional": True, "type": "positive_time_period_dict"}
+        ]
+    }
+    conditions = await async_get_device_automations(hass, "condition", device_entry.id)
+    for condition in conditions:
+        capabilities = await async_get_device_automation_capabilities(
+            hass, "condition", condition
+        )
+        assert capabilities == expected_capabilities