Add option to trigger when a template trigger renders any result.

[Petro31]

Proposed change

Currently, template triggers only trigger when the template previously renders false and then renders true. This limits template triggers and forces users to create template entities.

Adding the ability to optionally trigger off any template change opens up functionality for automations and template entities.

e.g. A user would now be able to create a trigger based template sensor where there's shared templates across states and attributes.

template:
- trigger:
  - platform: template
    value_template: "{{ label_entities('living_room') | select('is_state', 'on') | list }}"
    render: True
  sensor:
  - name: Living Room On Entities
    state: "{{ trigger.value | count }}"
    attributes:
      entity_id: "{{ trigger.value }}"

Type of change

• [ ] Spelling, grammar or other readability improvements (current branch).
• [ ] Adjusted missing or incorrect information in the current documentation (current branch).
• [ ] Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • [ ] I've opened up a PR to add logos and icons in Brands repository.
• [x] Added documentation for a new feature I'm adding to Home Assistant (next branch).
• [ ] Removed stale or deprecated documentation.

Additional information

• Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/121451
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

Checklist

• [x] This PR uses the correct branch, based on one of the following:
  • I made a change to the existing documentation and used the current branch.
  • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
• [x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• New Features
  • Added trigger.value property for Template triggers, providing the rendered value from the value_template.
  • Introduced the render option for template triggers, enabling activation on each template change.

[coderabbitai[bot]]

Walkthrough

Walkthrough

The updates introduce two key enhancements to Template triggers in Home Assistant automation: the trigger.value property and the render option. The trigger.value property captures the rendered value from the value_template, while the render option enables the Template trigger to activate whenever the template changes.

Changes

File Path	Change Summary
source/_docs/automation/templating.markdown	Added trigger.value property to enhance Template trigger properties.
source/_docs/automation/trigger.markdown	Introduced render option for Template triggers, allowing activation on template changes.

---

Recent review details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 7cc3a87cf4b522fcbf53482c08807a33f82e7235 and b8a00ea1cc68b0d23b989421a80a48a5584a3454.

Files selected for processing (2)

• source/_docs/automation/templating.markdown (1 hunks)
• source/_docs/automation/trigger.markdown (1 hunks)

Additional context used

LanguageTool

source/_docs/automation/templating.markdown

[misspelling] ~138-~138: Possible spelling mistake found. Context: ...d template to change. | trigger.for | Timedelta object how long state has been to state...

(MORFOLOGIK_RULE_EN_US)

---

[misspelling] ~139-~139: Only proper nouns start with an uppercase character (there are exceptions for headlines). Context: ...n to state, if any. | trigger.value | Rendered value from the value_template templat...

(EN_UPPER_CASE_NGRAM)

source/_docs/automation/trigger.markdown

[misspelling] ~678-~678: Possible spelling mistake found. Context: ...consider using the automation to set an input_datetime to the desired time and then use that ...

(MORFOLOGIK_RULE_EN_US)

---

[misspelling] ~678-~678: Possible spelling mistake found. Context: ...) to the desired time and then use that input_datetime as an automation trigger to perform th...

(MORFOLOGIK_RULE_EN_US)

---

[misspelling] ~679-~679: Possible spelling mistake found. Context: ...the desired actions at the set time. {% endimportant %} ### Render on any template update ...

(MORFOLOGIK_RULE_EN_US)

---

[misspelling] ~695-~695: Possible spelling mistake found. Context: ...) | list }}" render: true ``` {% endraw %} ## Time trigger The time trigger i...

(MORFOLOGIK_RULE_EN_US)

Markdownlint

source/_docs/automation/templating.markdown

136-136: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe Table pipe style

(MD055, table-pipe-style)

---

137-137: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe Table pipe style

(MD055, table-pipe-style)

---

138-138: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe Table pipe style

(MD055, table-pipe-style)

---

139-139: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe Table pipe style

(MD055, table-pipe-style)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify[bot]]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	b8a00ea1cc68b0d23b989421a80a48a5584a3454
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/668ad353602ebb0008980021
😎 Deploy Preview	https://deploy-preview-33614--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.