From 42bc5c3a5f7bffe018bfc7ac8a2c1306964b2e93 Mon Sep 17 00:00:00 2001 From: Michael <35783820+mib1185@users.noreply.github.com> Date: Thu, 5 Mar 2026 10:52:29 +0100 Subject: [PATCH] Add `remote.turned_on` and `remote.turned_off` triggers (#164535) Co-authored-by: Martin Hjelmare --- .../components/automation/__init__.py | 1 + homeassistant/components/remote/icons.json | 8 + homeassistant/components/remote/strings.json | 37 ++- homeassistant/components/remote/trigger.py | 17 ++ homeassistant/components/remote/triggers.yaml | 18 ++ tests/components/remote/test_trigger.py | 212 ++++++++++++++++++ 6 files changed, 292 insertions(+), 1 deletion(-) create mode 100644 homeassistant/components/remote/trigger.py create mode 100644 homeassistant/components/remote/triggers.yaml create mode 100644 tests/components/remote/test_trigger.py diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index 6345069458b..3edf2ca3fe7 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -149,6 +149,7 @@ _EXPERIMENTAL_TRIGGER_PLATFORMS = { "lock", "media_player", "person", + "remote", "scene", "siren", "switch", diff --git a/homeassistant/components/remote/icons.json b/homeassistant/components/remote/icons.json index 43a7f6ee7b6..1560336d7c1 100644 --- a/homeassistant/components/remote/icons.json +++ b/homeassistant/components/remote/icons.json @@ -26,5 +26,13 @@ "turn_on": { "service": "mdi:remote" } + }, + "triggers": { + "turned_off": { + "trigger": "mdi:remote-off" + }, + "turned_on": { + "trigger": "mdi:remote" + } } } diff --git a/homeassistant/components/remote/strings.json b/homeassistant/components/remote/strings.json index 52aeeca7560..e2f6af02673 100644 --- a/homeassistant/components/remote/strings.json +++ b/homeassistant/components/remote/strings.json @@ -1,4 +1,8 @@ { + "common": { + "trigger_behavior_description": "The behavior of the targeted remotes to trigger on.", + "trigger_behavior_name": "Behavior" + }, "device_automation": { "action_type": { "toggle": "[%key:common::device_automation::action_type::toggle%]", @@ -27,6 +31,15 @@ } } }, + "selector": { + "trigger_behavior": { + "options": { + "any": "Any", + "first": "First", + "last": "Last" + } + } + }, "services": { "delete_command": { "description": "Deletes a command or a list of commands from the database.", @@ -113,5 +126,27 @@ "name": "[%key:common::action::turn_on%]" } }, - "title": "Remote" + "title": "Remote", + "triggers": { + "turned_off": { + "description": "Triggers when one or more remotes turn off.", + "fields": { + "behavior": { + "description": "[%key:component::remote::common::trigger_behavior_description%]", + "name": "[%key:component::remote::common::trigger_behavior_name%]" + } + }, + "name": "Remote turned off" + }, + "turned_on": { + "description": "Triggers when one or more remotes turn on.", + "fields": { + "behavior": { + "description": "[%key:component::remote::common::trigger_behavior_description%]", + "name": "[%key:component::remote::common::trigger_behavior_name%]" + } + }, + "name": "Remote turned on" + } + } } diff --git a/homeassistant/components/remote/trigger.py b/homeassistant/components/remote/trigger.py new file mode 100644 index 00000000000..92a946c5ab7 --- /dev/null +++ b/homeassistant/components/remote/trigger.py @@ -0,0 +1,17 @@ +"""Provides triggers for remotes.""" + +from homeassistant.const import STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant +from homeassistant.helpers.trigger import Trigger, make_entity_target_state_trigger + +from . import DOMAIN + +TRIGGERS: dict[str, type[Trigger]] = { + "turned_on": make_entity_target_state_trigger(DOMAIN, STATE_ON), + "turned_off": make_entity_target_state_trigger(DOMAIN, STATE_OFF), +} + + +async def async_get_triggers(hass: HomeAssistant) -> dict[str, type[Trigger]]: + """Return the triggers for remotes.""" + return TRIGGERS diff --git a/homeassistant/components/remote/triggers.yaml b/homeassistant/components/remote/triggers.yaml new file mode 100644 index 00000000000..6dadeba1fd2 --- /dev/null +++ b/homeassistant/components/remote/triggers.yaml @@ -0,0 +1,18 @@ +.trigger_common: &trigger_common + target: + entity: + domain: remote + fields: + behavior: + required: true + default: any + selector: + select: + options: + - first + - last + - any + translation_key: trigger_behavior + +turned_off: *trigger_common +turned_on: *trigger_common diff --git a/tests/components/remote/test_trigger.py b/tests/components/remote/test_trigger.py new file mode 100644 index 00000000000..96f57906e6b --- /dev/null +++ b/tests/components/remote/test_trigger.py @@ -0,0 +1,212 @@ +"""Test remote trigger.""" + +from typing import Any + +import pytest + +from homeassistant.components.remote import DOMAIN +from homeassistant.const import ATTR_LABEL_ID, CONF_ENTITY_ID, STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant, ServiceCall + +from tests.components import ( + TriggerStateDescription, + arm_trigger, + parametrize_target_entities, + parametrize_trigger_states, + set_or_remove_state, + target_entities, +) + + +@pytest.fixture +async def target_remotes(hass: HomeAssistant) -> list[str]: + """Create multiple remotes entities associated with different targets.""" + return (await target_entities(hass, DOMAIN))["included"] + + +@pytest.mark.parametrize( + "trigger_key", + ["remote.turned_on", "remote.turned_off"], +) +async def test_remote_triggers_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str +) -> None: + """Test the remote triggers are gated by the labs flag.""" + await arm_trigger(hass, trigger_key, None, {ATTR_LABEL_ID: "test_label"}) + assert ( + "Unnamed automation failed to setup triggers and has been disabled: Trigger " + f"'{trigger_key}' requires the experimental 'New triggers and conditions' " + "feature to be enabled in Home Assistant Labs settings (feature flag: " + "'new_triggers_conditions')" + ) in caplog.text + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("trigger_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities(DOMAIN), +) +@pytest.mark.parametrize( + ("trigger", "trigger_options", "states"), + [ + *parametrize_trigger_states( + trigger="remote.turned_on", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + *parametrize_trigger_states( + trigger="remote.turned_off", + target_states=[STATE_OFF], + other_states=[STATE_ON], + ), + ], +) +async def test_remote_state_trigger_behavior_any( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_remotes: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + trigger_options: dict[str, Any], + states: list[TriggerStateDescription], +) -> None: + """Test that the remote triggers when any remote changes to a specific state.""" + other_entity_ids = set(target_remotes) - {entity_id} + + # Set all remotes, including the tested remote, to the initial state + for eid in target_remotes: + set_or_remove_state(hass, eid, states[0]["included"]) + await hass.async_block_till_done() + + await arm_trigger(hass, trigger, {}, trigger_target_config) + + for state in states[1:]: + included_state = state["included"] + set_or_remove_state(hass, entity_id, included_state) + await hass.async_block_till_done() + assert len(service_calls) == state["count"] + for service_call in service_calls: + assert service_call.data[CONF_ENTITY_ID] == entity_id + service_calls.clear() + + # Check that changing other remotes also triggers + 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 len(service_calls) == (entities_in_target - 1) * state["count"] + service_calls.clear() + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("trigger_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities(DOMAIN), +) +@pytest.mark.parametrize( + ("trigger", "trigger_options", "states"), + [ + *parametrize_trigger_states( + trigger="remote.turned_on", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + *parametrize_trigger_states( + trigger="remote.turned_off", + target_states=[STATE_OFF], + other_states=[STATE_ON], + ), + ], +) +async def test_remote_state_trigger_behavior_first( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_remotes: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + trigger_options: dict[str, Any], + states: list[TriggerStateDescription], +) -> None: + """Test that the remote triggers when the first remote changes to a specific state.""" + other_entity_ids = set(target_remotes) - {entity_id} + + # Set all remotes, including the tested remote, to the initial state + for eid in target_remotes: + set_or_remove_state(hass, eid, states[0]["included"]) + await hass.async_block_till_done() + + await arm_trigger(hass, trigger, {"behavior": "first"}, trigger_target_config) + + for state in states[1:]: + included_state = state["included"] + set_or_remove_state(hass, entity_id, included_state) + await hass.async_block_till_done() + assert len(service_calls) == state["count"] + for service_call in service_calls: + assert service_call.data[CONF_ENTITY_ID] == entity_id + service_calls.clear() + + # Triggering other remotes should not cause the trigger to fire again + 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 len(service_calls) == 0 + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("trigger_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities(DOMAIN), +) +@pytest.mark.parametrize( + ("trigger", "trigger_options", "states"), + [ + *parametrize_trigger_states( + trigger="remote.turned_on", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + *parametrize_trigger_states( + trigger="remote.turned_off", + target_states=[STATE_OFF], + other_states=[STATE_ON], + ), + ], +) +async def test_remote_state_trigger_behavior_last( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_remotes: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + trigger_options: dict[str, Any], + states: list[TriggerStateDescription], +) -> None: + """Test that the remote triggers when the last remote changes to a specific state.""" + other_entity_ids = set(target_remotes) - {entity_id} + + # Set all remotes, including the tested remote, to the initial state + for eid in target_remotes: + set_or_remove_state(hass, eid, states[0]["included"]) + await hass.async_block_till_done() + + await arm_trigger(hass, trigger, {"behavior": "last"}, trigger_target_config) + + for state in states[1:]: + included_state = state["included"] + 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 len(service_calls) == 0 + + set_or_remove_state(hass, entity_id, included_state) + await hass.async_block_till_done() + assert len(service_calls) == state["count"] + for service_call in service_calls: + assert service_call.data[CONF_ENTITY_ID] == entity_id + service_calls.clear()