Compare commits

...

3 Commits

Author SHA1 Message Date
mib1185
5609b42c26 updating the phrasing to match the standard style 2026-03-01 20:00:55 +00:00
mib1185
0ddf5657d6 fix test case naming 2026-03-01 20:00:16 +00:00
mib1185
d395aac8d6 add remote.turned_on and remote.turned_off triggers 2026-03-01 19:53:25 +00:00
6 changed files with 292 additions and 1 deletions

View File

@@ -149,6 +149,7 @@ _EXPERIMENTAL_TRIGGER_PLATFORMS = {
"lock",
"media_player",
"person",
"remote",
"scene",
"siren",
"switch",

View File

@@ -26,5 +26,13 @@
"turn_on": {
"service": "mdi:remote"
}
},
"triggers": {
"turned_off": {
"trigger": "mdi:remote-off"
},
"turned_on": {
"trigger": "mdi:remote"
}
}
}

View File

@@ -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 turned 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 turned on.",
"fields": {
"behavior": {
"description": "[%key:component::remote::common::trigger_behavior_description%]",
"name": "[%key:component::remote::common::trigger_behavior_name%]"
}
},
"name": "Remote turned on"
}
}
}

View File

@@ -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

View File

@@ -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

View File

@@ -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()