Skip to content
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.

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

Add option to trigger template triggers when the template updates #121451

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

Petro31
Copy link
Contributor

@Petro31 Petro31 commented Jul 7, 2024

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

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Jul 7, 2024

Hey there @PhracturedBlue, @tetienne, @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (template) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of template can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign template Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@MartinHjelmare MartinHjelmare changed the title Add option to trigger template triggers when the template updates. Add option to trigger template triggers when the template updates Jul 7, 2024
@Mariusthvdb
Copy link
Contributor

Mariusthvdb commented Jul 8, 2024

sounds very useful indeed.
Would the trigger.value keep the datetime type if datetime would be used in the trigger.
(and not return a string, as happens when using trigger variables)

template:
- trigger:
  - platform: template
    value_template: "{{'2024-07-08'|as_datetime|as_local}}"
    render: True
  sensor:
  - name: Value is datetime
    state: "{{ trigger.value is datetime}}"

if yes, consider my +1 to be +10

@Petro31
Copy link
Contributor Author

Petro31 commented Jul 8, 2024

sounds very useful indeed. Would the trigger.value keep the datetime type if datetime would be used in the trigger. (and not return a string, as happens when using trigger variables)

template:
- trigger:
  - platform: template
    value_template: "{{'2024-07-08'|as_datetime|as_local}}"
    render: True
  sensor:
  - name: Value is datetime
    state: "{{ trigger.value is datetime}}"

if yes, consider my +1 to be +10

It should, lucky for you too... template triggers by default resolve once a minute if the template never updates.

Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants