From 899306c8ec9e17af1405d4639532929423ba1989 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Thu, 7 Nov 2019 07:29:39 -0800 Subject: [PATCH] Add vacuum device conditions (#28551) --- .../components/vacuum/device_condition.py | 79 ++++++++++ homeassistant/components/vacuum/strings.json | 4 + .../vacuum/test_device_condition.py | 138 ++++++++++++++++++ 3 files changed, 221 insertions(+) create mode 100644 homeassistant/components/vacuum/device_condition.py create mode 100644 tests/components/vacuum/test_device_condition.py diff --git a/homeassistant/components/vacuum/device_condition.py b/homeassistant/components/vacuum/device_condition.py new file mode 100644 index 00000000000..6a41fe0490e --- /dev/null +++ b/homeassistant/components/vacuum/device_condition.py @@ -0,0 +1,79 @@ +"""Provide the device automations for Vacuum.""" +from typing import Dict, List +import voluptuous as vol + +from homeassistant.const import ( + ATTR_ENTITY_ID, + CONF_CONDITION, + CONF_DOMAIN, + CONF_TYPE, + CONF_DEVICE_ID, + CONF_ENTITY_ID, +) +from homeassistant.core import HomeAssistant +from homeassistant.helpers import condition, config_validation as cv, entity_registry +from homeassistant.helpers.typing import ConfigType, TemplateVarsType +from homeassistant.helpers.config_validation import DEVICE_CONDITION_BASE_SCHEMA +from . import DOMAIN, STATE_DOCKED, STATE_CLEANING, STATE_RETURNING + +CONDITION_TYPES = {"is_cleaning", "is_docked"} + +CONDITION_SCHEMA = DEVICE_CONDITION_BASE_SCHEMA.extend( + { + vol.Required(CONF_ENTITY_ID): cv.entity_id, + vol.Required(CONF_TYPE): vol.In(CONDITION_TYPES), + } +) + + +async def async_get_conditions( + hass: HomeAssistant, device_id: str +) -> List[Dict[str, str]]: + """List device conditions for Vacuum devices.""" + registry = await entity_registry.async_get_registry(hass) + conditions = [] + + # 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 + + conditions.append( + { + CONF_CONDITION: "device", + CONF_DEVICE_ID: device_id, + CONF_DOMAIN: DOMAIN, + CONF_ENTITY_ID: entry.entity_id, + CONF_TYPE: "is_cleaning", + } + ) + conditions.append( + { + CONF_CONDITION: "device", + CONF_DEVICE_ID: device_id, + CONF_DOMAIN: DOMAIN, + CONF_ENTITY_ID: entry.entity_id, + CONF_TYPE: "is_docked", + } + ) + + return conditions + + +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_docked": + test_states = [STATE_DOCKED] + else: + test_states = [STATE_CLEANING, STATE_RETURNING] + + 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 is not None and state.state in test_states + + return test_is_state diff --git a/homeassistant/components/vacuum/strings.json b/homeassistant/components/vacuum/strings.json index 2a6fcbbd357..0300242a506 100644 --- a/homeassistant/components/vacuum/strings.json +++ b/homeassistant/components/vacuum/strings.json @@ -1,5 +1,9 @@ { "device_automation": { + "condtion_type": { + "is_docked": "{entity_name} is docked", + "is_cleaning": "{entity_name} is cleaning" + }, "trigger_type": { "cleaning": "{entity_name} started cleaning", "docked": "{entity_name} docked" diff --git a/tests/components/vacuum/test_device_condition.py b/tests/components/vacuum/test_device_condition.py new file mode 100644 index 00000000000..80e7b72c36f --- /dev/null +++ b/tests/components/vacuum/test_device_condition.py @@ -0,0 +1,138 @@ +"""The tests for Vacuum device conditions.""" +import pytest + +from homeassistant.components.vacuum import ( + DOMAIN, + STATE_CLEANING, + STATE_DOCKED, + STATE_RETURNING, +) +from homeassistant.setup import async_setup_component +import homeassistant.components.automation as automation +from homeassistant.helpers import device_registry + +from tests.common import ( + MockConfigEntry, + assert_lists_same, + async_mock_service, + mock_device_registry, + mock_registry, + async_get_device_automations, +) + + +@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 serivce.""" + 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 vacuum.""" + 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_conditions = [ + { + "condition": "device", + "domain": DOMAIN, + "type": "is_cleaning", + "device_id": device_entry.id, + "entity_id": f"{DOMAIN}.test_5678", + }, + { + "condition": "device", + "domain": DOMAIN, + "type": "is_docked", + "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("vacuum.entity", STATE_DOCKED) + + 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": "vacuum.entity", + "type": "is_cleaning", + } + ], + "action": { + "service": "test.automation", + "data_template": { + "some": "is_cleaning - {{ trigger.platform }} - {{ trigger.event.event_type }}" + }, + }, + }, + { + "trigger": {"platform": "event", "event_type": "test_event2"}, + "condition": [ + { + "condition": "device", + "domain": DOMAIN, + "device_id": "", + "entity_id": "vacuum.entity", + "type": "is_docked", + } + ], + "action": { + "service": "test.automation", + "data_template": { + "some": "is_docked - {{ trigger.platform }} - {{ trigger.event.event_type }}" + }, + }, + }, + ] + }, + ) + 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_docked - event - test_event2" + + hass.states.async_set("vacuum.entity", STATE_CLEANING) + 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_cleaning - event - test_event1" + + # Returning means it's still cleaning + hass.states.async_set("vacuum.entity", STATE_RETURNING) + hass.bus.async_fire("test_event1") + hass.bus.async_fire("test_event2") + await hass.async_block_till_done() + assert len(calls) == 3 + assert calls[2].data["some"] == "is_cleaning - event - test_event1"