Add documentation on triggers yaml #2884
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joostlek
commented
Dec 2, 2025
Comment on lines
33
to
37
| _OPTIONS_SCHEMA = vol.Schema({ | ||
| vol.Required("event_type"): cv.string, | ||
| vol.Required("behavior", default="any"): vol.In( | ||
| ["first", "last", "any"] | ||
| ), | ||
| }) |
Member
Author
There was a problem hiding this comment.
I feel like we should adapt this trigger to be more realistic, I'd love for the example YAML to adhere to the example trigger, but from the example it wasn't clear what event_type: str was used for
Member
There was a problem hiding this comment.
Yeah, I think we should have a single consistent example on this page. Lets update the class to represent a nicer trigger.
abmantis
requested changes
Dec 3, 2025
|
|
||
| ### Trigger schema | ||
|
|
||
| The frontend uses the `triggers.yaml` file to know the structure of the triggers. |
Member
There was a problem hiding this comment.
Suggested change
| The frontend uses the `triggers.yaml` file to know the structure of the triggers. | |
| Triggers should have their description in a `triggers.yaml` file. The description specifies the structure of the triggers and is used by the frontend, for example. |
it is also used on core, in the get_triggers_for_target websocket api, not only for frontend.
| The frontend uses the `triggers.yaml` file to know the structure of the triggers. | ||
| This file is similar to `services.yaml`. | ||
|
|
||
| For example, the following snippet shows a trigger that takes a target binary sensor with a specific device class and a select selector with a predefined set of options. |
Member
There was a problem hiding this comment.
Suggested change
| For example, the following snippet shows a trigger that takes a target binary sensor with a specific device class and a select selector with a predefined set of options. | |
| The following snippet shows a trigger that takes a target binary sensor with a specific device class and a select selector with a predefined set of options. |
if we update the example class above, I think we can simplify this sentence since it is part of the full example in the current top section.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Add documentation on triggers yaml
Type of change
Checklist
Additional information