diff --git a/homeassistant/components/fan/device_trigger.py b/homeassistant/components/fan/device_trigger.py index c72be6f9d7c1f0..15f8f4be45e5b2 100644 --- a/homeassistant/components/fan/device_trigger.py +++ b/homeassistant/components/fan/device_trigger.py @@ -4,64 +4,26 @@ import voluptuous as vol from homeassistant.components.automation import AutomationActionType -from homeassistant.components.device_automation import TRIGGER_BASE_SCHEMA -from homeassistant.components.homeassistant.triggers import state as state_trigger -from homeassistant.const import ( - CONF_DEVICE_ID, - CONF_DOMAIN, - CONF_ENTITY_ID, - CONF_PLATFORM, - CONF_TYPE, - STATE_OFF, - STATE_ON, -) +from homeassistant.components.device_automation import toggle_entity +from homeassistant.const import CONF_DOMAIN from homeassistant.core import CALLBACK_TYPE, HomeAssistant -from homeassistant.helpers import config_validation as cv, entity_registry from homeassistant.helpers.typing import ConfigType from . import DOMAIN -TRIGGER_TYPES = {"turned_on", "turned_off"} - -TRIGGER_SCHEMA = TRIGGER_BASE_SCHEMA.extend( - { - vol.Required(CONF_ENTITY_ID): cv.entity_id, - vol.Required(CONF_TYPE): vol.In(TRIGGER_TYPES), - } +TRIGGER_SCHEMA = toggle_entity.TRIGGER_SCHEMA.extend( + {vol.Required(CONF_DOMAIN): DOMAIN} ) async def async_get_triggers(hass: HomeAssistant, device_id: str) -> list[dict]: """List device triggers for Fan devices.""" - registry = await entity_registry.async_get_registry(hass) - triggers = [] + return await toggle_entity.async_get_triggers(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 - # Add triggers for each entity that belongs to this integration - triggers.append( - { - CONF_PLATFORM: "device", - CONF_DEVICE_ID: device_id, - CONF_DOMAIN: DOMAIN, - CONF_ENTITY_ID: entry.entity_id, - CONF_TYPE: "turned_on", - } - ) - triggers.append( - { - CONF_PLATFORM: "device", - CONF_DEVICE_ID: device_id, - CONF_DOMAIN: DOMAIN, - CONF_ENTITY_ID: entry.entity_id, - CONF_TYPE: "turned_off", - } - ) - - return triggers +async def async_get_trigger_capabilities(hass: HomeAssistant, config: dict) -> dict: + """List trigger capabilities.""" + return await toggle_entity.async_get_trigger_capabilities(hass, config) async def async_attach_trigger( @@ -70,18 +32,7 @@ async def async_attach_trigger( action: AutomationActionType, automation_info: dict, ) -> CALLBACK_TYPE: - """Attach a trigger.""" - if config[CONF_TYPE] == "turned_on": - to_state = STATE_ON - else: - to_state = STATE_OFF - - state_config = { - state_trigger.CONF_PLATFORM: "state", - CONF_ENTITY_ID: config[CONF_ENTITY_ID], - state_trigger.CONF_TO: to_state, - } - state_config = state_trigger.TRIGGER_SCHEMA(state_config) - return await state_trigger.async_attach_trigger( - hass, state_config, action, automation_info, platform_type="device" + """Listen for state changes based on configuration.""" + return await toggle_entity.async_attach_trigger( + hass, config, action, automation_info ) diff --git a/tests/components/fan/test_device_trigger.py b/tests/components/fan/test_device_trigger.py index 59af7666a03c96..cecb4151c3f05b 100644 --- a/tests/components/fan/test_device_trigger.py +++ b/tests/components/fan/test_device_trigger.py @@ -1,4 +1,6 @@ """The tests for Fan device triggers.""" +from datetime import timedelta + import pytest import homeassistant.components.automation as automation @@ -6,10 +8,13 @@ from homeassistant.const import STATE_OFF, STATE_ON from homeassistant.helpers import device_registry from homeassistant.setup import async_setup_component +import homeassistant.util.dt as dt_util from tests.common import ( MockConfigEntry, assert_lists_same, + async_fire_time_changed, + async_get_device_automation_capabilities, async_get_device_automations, async_mock_service, mock_device_registry, @@ -65,6 +70,28 @@ async def test_get_triggers(hass, device_reg, entity_reg): assert_lists_same(triggers, expected_triggers) +async def test_get_trigger_capabilities(hass, device_reg, entity_reg): + """Test we get the expected capabilities from a switch trigger.""" + 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"} + ] + } + triggers = await async_get_device_automations(hass, "trigger", device_entry.id) + for trigger in triggers: + capabilities = await async_get_device_automation_capabilities( + hass, "trigger", trigger + ) + assert capabilities == expected_capabilities + + async def test_if_fires_on_state_change(hass, calls): """Test for turn_on and turn_off triggers firing.""" hass.states.async_set("fan.entity", STATE_OFF) @@ -127,3 +154,57 @@ async def test_if_fires_on_state_change(hass, calls): await hass.async_block_till_done() assert len(calls) == 2 assert calls[1].data["some"] == "turn_off - device - fan.entity - on - off - None" + + +async def test_if_fires_on_state_change_with_for(hass, calls): + """Test for triggers firing with delay.""" + entity_id = "fan.entity" + hass.states.async_set(entity_id, STATE_ON) + + assert await async_setup_component( + hass, + automation.DOMAIN, + { + automation.DOMAIN: [ + { + "trigger": { + "platform": "device", + "domain": DOMAIN, + "device_id": "", + "entity_id": entity_id, + "type": "turned_off", + "for": {"seconds": 5}, + }, + "action": { + "service": "test.automation", + "data_template": { + "some": "turn_off {{ trigger.%s }}" + % "}} - {{ trigger.".join( + ( + "platform", + "entity_id", + "from_state.state", + "to_state.state", + "for", + ) + ) + }, + }, + } + ] + }, + ) + await hass.async_block_till_done() + assert hass.states.get(entity_id).state == STATE_ON + assert len(calls) == 0 + + hass.states.async_set(entity_id, STATE_OFF) + await hass.async_block_till_done() + assert len(calls) == 0 + async_fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=10)) + await hass.async_block_till_done() + assert len(calls) == 1 + await hass.async_block_till_done() + assert ( + calls[0].data["some"] == f"turn_off device - {entity_id} - on - off - 0:00:05" + )