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 a syntax for merging lists of triggers #117698

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

karwosts
Copy link
Contributor

@karwosts karwosts commented May 18, 2024

Proposed change

The user of Trigger Selectors in blueprints currently has a significant limitation in that the selector returns a list of triggers, but there is no yaml syntax to merge a list of triggers from the selector with a list of triggers hardcoded in the blueprint.

So if a blueprint wants to trigger on some predefined behavior, it cannot allow user to configure additional triggers with a selector because the lists cannot be merged.

To mitigate this, I propose a syntax (under platform: trigger) for triggers which will allow for combining a list of triggers from an input with a hardcoded list of triggers. When the backend encounters this list, it will just be flattened into a single list of triggers.

E.g.:

blueprint:
  name: Nested Trigger Blueprint
  domain: automation
  input:
    usertrigger:
      selector:
        trigger:

trigger:
  - platform: time_pattern
    seconds: /10
  - platform: trigger
    trigger: !input usertrigger
condition: []
action: []

This can trigger the blueprint on the predefined time pattern, in addition to any triggers specified by the user.

I'm sure there's still more work to be done here with testing, but wanted to see if this idea has merit. It worked for me as a basic proof of concept.

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@karwosts karwosts requested a review from a team as a code owner May 18, 2024 16:08
@home-assistant home-assistant bot added cla-signed core new-feature small-pr PRs with less than 30 lines. labels May 18, 2024
@karwosts karwosts closed this May 20, 2024
@karwosts karwosts reopened this May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
1 participant