Skip to content

Improve trigger descriptions #157643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 8 commits into from
Dec 2, 2025
Merged

Improve trigger descriptions #157643

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b42bfc8
Improve trigger descriptions
emontnemery Dec 1, 2025
bbcd2b1
Adjust
emontnemery Dec 1, 2025
deb8692
Adjust language
emontnemery Dec 1, 2025
bc2fb7a
Adjust more
emontnemery Dec 1, 2025
d69ff82
Adjust more
emontnemery Dec 1, 2025
895cb66
Adjust language
emontnemery Dec 1, 2025
5014466
Make language more cumbersome
emontnemery Dec 2, 2025
eb8a527
Update homeassistant/components/assist_satellite/strings.json
emontnemery Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions homeassistant/components/alarm_control_panel/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,74 +159,74 @@
"title": "Alarm control panel",
"triggers": {
"armed": {
"description": "Triggers when an alarm is armed.",
"description": "Triggers when one or several alarms get armed, regardless of the mode.",
"fields": {
"behavior": {
"description": "[%key:component::alarm_control_panel::common::trigger_behavior_description%]",
"name": "[%key:component::alarm_control_panel::common::trigger_behavior_name%]"
}
},
"name": "When an alarm is armed"
"name": "Alarm armed"
},
"armed_away": {
"description": "Triggers when an alarm is armed away.",
"description": "Triggers when one or several alarms get armed in away mode.",
"fields": {
"behavior": {
"description": "[%key:component::alarm_control_panel::common::trigger_behavior_description%]",
"name": "[%key:component::alarm_control_panel::common::trigger_behavior_name%]"
}
},
"name": "When an alarm is armed away"
"name": "Alarm armed away"
},
"armed_home": {
"description": "Triggers when an alarm is armed home.",
"description": "Triggers when one or several alarms get armed in home mode.",
"fields": {
"behavior": {
"description": "[%key:component::alarm_control_panel::common::trigger_behavior_description%]",
"name": "[%key:component::alarm_control_panel::common::trigger_behavior_name%]"
}
},
"name": "When an alarm is armed home"
"name": "Alarm armed home"
},
"armed_night": {
"description": "Triggers when an alarm is armed night.",
"description": "Triggers when one or several alarms get armed in night mode.",
"fields": {
"behavior": {
"description": "[%key:component::alarm_control_panel::common::trigger_behavior_description%]",
"name": "[%key:component::alarm_control_panel::common::trigger_behavior_name%]"
}
},
"name": "When an alarm is armed night"
"name": "Alarm armed night"
},
"armed_vacation": {
"description": "Triggers when an alarm is armed vacation.",
"description": "Triggers when one or several alarms get armed in vacation mode.",
"fields": {
"behavior": {
"description": "[%key:component::alarm_control_panel::common::trigger_behavior_description%]",
"name": "[%key:component::alarm_control_panel::common::trigger_behavior_name%]"
}
},
"name": "When an alarm is armed vacation"
"name": "Alarm armed vacation"
},
"disarmed": {
"description": "Triggers when an alarm is disarmed.",
"description": "Triggers when one or several alarms get disarmed.",
"fields": {
"behavior": {
"description": "[%key:component::alarm_control_panel::common::trigger_behavior_description%]",
"name": "[%key:component::alarm_control_panel::common::trigger_behavior_name%]"
}
},
"name": "When an alarm is disarmed"
"name": "Alarm disarmed"
},
"triggered": {
"description": "Triggers when an alarm is triggered.",
"description": "Triggers when one or several alarms get triggered.",
"fields": {
"behavior": {
"description": "[%key:component::alarm_control_panel::common::trigger_behavior_description%]",
"name": "[%key:component::alarm_control_panel::common::trigger_behavior_name%]"
}
},
"name": "When an alarm is triggered"
"name": "Alarm triggered"
}
}
}
16 changes: 8 additions & 8 deletions homeassistant/components/assist_satellite/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,44 +112,44 @@
"title": "Assist satellite",
"triggers": {
"idle": {

@emontnemery emontnemery Dec 1, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The keys for assist_satellite are not consistent with other domains

"description": "Triggers when an Assist satellite becomes idle.",
"description": "Triggers when one or several voice assistant satellites became idle after having processed a command.",
Comment thread
MartinHjelmare marked this conversation as resolved.
Outdated
"fields": {
"behavior": {
"description": "[%key:component::assist_satellite::common::trigger_behavior_description%]",
"name": "[%key:component::assist_satellite::common::trigger_behavior_name%]"
}
},
"name": "When an Assist satellite becomes idle"
"name": "Satellite became idle"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "become idle" instead of "became idle".

Copilot uses AI. Check for mistakes.
},
"listening": {
"description": "Triggers when an Assist satellite starts listening.",
"description": "Triggers when one or several voice assistant satellites started listening for a command from someone.",
Comment thread
MartinHjelmare marked this conversation as resolved.
Outdated
"fields": {
"behavior": {
"description": "[%key:component::assist_satellite::common::trigger_behavior_description%]",
"name": "[%key:component::assist_satellite::common::trigger_behavior_name%]"
}
},
"name": "When an Assist satellite starts listening"
"name": "Satellite started listening"
Comment thread
MartinHjelmare marked this conversation as resolved.
},
"processing": {
"description": "Triggers when an Assist satellite is processing.",
"description": "Triggers when one or several voice assistant satellites started processing a command after having heard it.",
"fields": {
"behavior": {
"description": "[%key:component::assist_satellite::common::trigger_behavior_description%]",
"name": "[%key:component::assist_satellite::common::trigger_behavior_name%]"
}
},
"name": "When an Assist satellite is processing"
"name": "Satellite started processing"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "start processing" instead of "started processing".

Copilot uses AI. Check for mistakes.
},
"responding": {
"description": "Triggers when an Assist satellite is responding.",
"description": "Triggers when one or several voice assistant satellites started responding to a command after having processed it, or starts to announce something.",
"fields": {
"behavior": {
"description": "[%key:component::assist_satellite::common::trigger_behavior_description%]",
"name": "[%key:component::assist_satellite::common::trigger_behavior_name%]"
}
},
"name": "When an Assist satellite is responding"
"name": "Satellite started responding"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "start responding" instead of "started responding".

Copilot uses AI. Check for mistakes.
}
}
}
20 changes: 10 additions & 10 deletions homeassistant/components/climate/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,54 +299,54 @@
"title": "Climate",
"triggers": {
"started_cooling": {
"description": "Triggers when a climate started cooling.",
"description": "Triggers when one or several climate control devices started cooling.",
"fields": {
"behavior": {
"description": "[%key:component::climate::common::trigger_behavior_description%]",
"name": "[%key:component::climate::common::trigger_behavior_name%]"
}
},
"name": "When a climate started cooling"
"name": "Climate control device started cooling"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "start cooling" instead of "started cooling".

Copilot uses AI. Check for mistakes.
},
"started_drying": {
"description": "Triggers when a climate started drying.",
"description": "Triggers when one or several climate control devices started drying.",
"fields": {
"behavior": {
"description": "[%key:component::climate::common::trigger_behavior_description%]",
"name": "[%key:component::climate::common::trigger_behavior_name%]"
}
},
"name": "When a climate started drying"
"name": "Climate control device started drying"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "start drying" instead of "started drying".

Copilot uses AI. Check for mistakes.
},
"started_heating": {
"description": "Triggers when a climate starts to heat.",
"description": "Triggers when one or several climate control devices started heating.",
"fields": {
"behavior": {
"description": "[%key:component::climate::common::trigger_behavior_description%]",
"name": "[%key:component::climate::common::trigger_behavior_name%]"
}
},
"name": "When a climate starts to heat"
"name": "Climate control device started heating"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "start heating" instead of "started heating".

Copilot uses AI. Check for mistakes.
},
"turned_off": {
"description": "Triggers when a climate is turned off.",
"description": "Triggers when one or several climate control devices turned off.",
"fields": {
"behavior": {
"description": "[%key:component::climate::common::trigger_behavior_description%]",
"name": "[%key:component::climate::common::trigger_behavior_name%]"
}
},
"name": "When a climate is turned off"
"name": "Climate control device turned off"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "turn off" instead of "turned off".

Copilot uses AI. Check for mistakes.
},
"turned_on": {
"description": "Triggers when a climate is turned on.",
"description": "Triggers when one or several climate control devices turned on, regardless of the mode.",
"fields": {
"behavior": {
"description": "[%key:component::climate::common::trigger_behavior_description%]",
"name": "[%key:component::climate::common::trigger_behavior_name%]"
}
},
"name": "When a climate is turned on"
"name": "Climate control device turned on"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "turn on" instead of "turned on".

Suggested change
"name": "Climate control device turned on"
"name": "Climate control device turn on"

Copilot uses AI. Check for mistakes.
}
}
}
8 changes: 4 additions & 4 deletions homeassistant/components/fan/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,24 +166,24 @@
"title": "Fan",
"triggers": {
"turned_off": {
"description": "Triggers when a fan is turned off.",
"description": "Triggers when one or several fans turned off.",
"fields": {
"behavior": {
"description": "[%key:component::fan::common::trigger_behavior_description%]",
"name": "[%key:component::fan::common::trigger_behavior_name%]"
}
},
"name": "When a fan is turned off"
"name": "Fan turned off"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. The name uses past tense "turned off" while the description uses present tense "Triggers when...turned off". Consider using present tense in descriptions for consistency: "turn off" instead of "turned off".

Copilot uses AI. Check for mistakes.
},
"turned_on": {
"description": "Triggers when a fan is turned on.",
"description": "Triggers when one or several fans turned on.",
Comment thread
MartinHjelmare marked this conversation as resolved.
Outdated
"fields": {
"behavior": {
"description": "[%key:component::fan::common::trigger_behavior_description%]",
"name": "[%key:component::fan::common::trigger_behavior_name%]"
}
},
"name": "When a fan is turned on"
"name": "Fan turned on"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. The name uses past tense "turned on" while the description uses present tense "Triggers when...turned on". Consider using present tense in descriptions for consistency: "turn on" instead of "turned on".

Copilot uses AI. Check for mistakes.
}
}
}
16 changes: 8 additions & 8 deletions homeassistant/components/lawn_mower/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,44 +41,44 @@
"title": "Lawn mower",
"triggers": {
"docked": {

@emontnemery emontnemery Dec 1, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we change this to "returned_to_dock", or is "docked" good enough?

@jlpouffier jlpouffier Dec 1, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docked is good.
You explained it too me, we do not enforce the temporary state "Returning to dock". So it's for both. IT's good 👍🏻

"description": "Triggers when a lawn mower has docked.",
"description": "Triggers when one or several lawn mowers returned to dock.",
"fields": {
"behavior": {
"description": "[%key:component::lawn_mower::common::trigger_behavior_description%]",
"name": "[%key:component::lawn_mower::common::trigger_behavior_name%]"
}
},
"name": "When a lawn mower has docked"
"name": "Lawn mower returned to dock"
Comment thread
MartinHjelmare marked this conversation as resolved.
},
"errored": {

@emontnemery emontnemery Dec 1, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we change this to "encounted_error", or is "errored" good enough?

"description": "Triggers when a lawn mower has errored.",
"description": "Triggers when one or several lawn mowers encountered an error.",
"fields": {
"behavior": {
"description": "[%key:component::lawn_mower::common::trigger_behavior_description%]",
"name": "[%key:component::lawn_mower::common::trigger_behavior_name%]"
}
},
"name": "When a lawn mower has errored"
"name": "Lawn mower encountered an error"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "encounter an error" instead of "encountered an error".

Copilot uses AI. Check for mistakes.
},
"paused_mowing": {
"description": "Triggers when a lawn mower has paused mowing.",
"description": "Triggers when one or several lawn mowers paused mowing.",
"fields": {
"behavior": {
"description": "[%key:component::lawn_mower::common::trigger_behavior_description%]",
"name": "[%key:component::lawn_mower::common::trigger_behavior_name%]"
}
},
"name": "When a lawn mower has paused mowing"
"name": "Lawn mower paused mowing"
Comment thread
MartinHjelmare marked this conversation as resolved.
},
"started_mowing": {
"description": "Triggers when a lawn mower has started mowing.",
"description": "Triggers when one or several lawn mowers started mowing.",
"fields": {
"behavior": {
"description": "[%key:component::lawn_mower::common::trigger_behavior_description%]",
"name": "[%key:component::lawn_mower::common::trigger_behavior_name%]"
}
},
"name": "When a lawn mower has started mowing"
"name": "Lawn mower started mowing"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "start mowing" instead of "started mowing".

Copilot uses AI. Check for mistakes.
}
}
}
8 changes: 4 additions & 4 deletions homeassistant/components/light/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,24 +510,24 @@
"title": "Light",
"triggers": {
"turned_off": {
"description": "Triggers when a light is turned off.",
"description": "Triggers when one or several lights turned off.",
"fields": {
"behavior": {
"description": "[%key:component::light::common::trigger_behavior_description%]",
"name": "[%key:component::light::common::trigger_behavior_name%]"
}
},
"name": "When a light is turned off"
"name": "Light turned off"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent between the name and description. The name uses past tense "turned off" while the description uses present tense "Triggers when...turned off". Consider using consistent tense throughout. The descriptions should either use present tense ("turn off") or maintain past tense ("turned off") for consistency.

Copilot uses AI. Check for mistakes.
},
"turned_on": {
"description": "Triggers when a light is turned on.",
"description": "Triggers when one or several lights turned on.",
"fields": {
"behavior": {
"description": "[%key:component::light::common::trigger_behavior_description%]",
"name": "[%key:component::light::common::trigger_behavior_name%]"
}
},
"name": "When a light is turned on"
"name": "Light turned on"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent between the name and description. The name uses past tense "turned on" while the description uses present tense "Triggers when...turned on". Consider using consistent tense throughout. The descriptions should either use present tense ("turn on") or maintain past tense ("turned on") for consistency.

Copilot uses AI. Check for mistakes.
}
}
}
4 changes: 2 additions & 2 deletions homeassistant/components/media_player/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,14 +381,14 @@
"title": "Media player",
"triggers": {
"stopped_playing": {
"description": "Triggers when a media player stops playing.",
"description": "Triggers when one or several media players stopped playing media.",
"fields": {
"behavior": {
"description": "[%key:component::media_player::common::trigger_behavior_description%]",
"name": "[%key:component::media_player::common::trigger_behavior_name%]"
}
},
"name": "When a media player stops playing"
"name": "Media player stopped playing"

Copilot AI Dec 1, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The verb tense is inconsistent. Consider using present tense in descriptions for consistency: "stop playing media" instead of "stopped playing media".

Copilot uses AI. Check for mistakes.
}
}
}
4 changes: 2 additions & 2 deletions homeassistant/components/mqtt/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1562,7 +1562,7 @@
},
"triggers": {
"_": {
"description": "When a specific message is received on a given MQTT topic.",
"description": "Triggers when a specific message is received on a given MQTT topic.",
"fields": {
"payload": {
"description": "The payload to trigger on.",
Expand All @@ -1573,7 +1573,7 @@
"name": "Topic"
}
},
"name": "MQTT"
"name": "MQTT message received"
}
}
}
4 changes: 2 additions & 2 deletions homeassistant/components/text/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@
"title": "Text",
"triggers": {
"changed": {
"description": "Triggers when the text changes.",
"name": "When the text changes"
"description": "Triggers when one or several texts changed.",
"name": "Text changed"
Comment thread
MartinHjelmare marked this conversation as resolved.
}
}
}
Loading
Loading