Skip to content

Document wildcard support for channel event triggers #2717

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

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

Document wildcard support for channel event triggers #2717

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion configuration/rules-dsl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,11 @@ You can find all the possible values for status from [Thing Status](/docs/concep
The `thingUID` is the identifier assigned to the Thing, manually in your configuration or automatically during auto discovery.
You can find it from UI or from Karaf remote console.
For example, one z-wave device can be "zwave:device:c5155aa4:node14".
The `*` wildcard is allowed in the `thingUID`.
The following wildcards may be used in `thingUID` to match multiple Things:

- `*` matches zero or more characters.
- `?` matches zero or one character.

For example, `chromecast:*` will trigger on all `chromecast` Things and `*` will trigger on all things.

If the Rule needs to know what the triggering thing was, or access a string value of the previous or new status, use the [implicit variables]({{base}}/configuration/rules-dsl.html#implicit-variables-inside-the-execution-block) `triggeringThing`, `previousThingStatus` or `newThingStatus` to access the information.
Expand Down Expand Up @@ -306,6 +310,7 @@ Channel "<triggerChannel>" triggered [<triggerEvent>]
```

`triggerChannel` is the identifier for a specific channel.
The `*` and `?` wildcards are allowed in the `triggerChannel` and behave the same as for `thingUID`.

When a binding provides such channels, you can find the needed information in the corresponding binding documentation.
There is no generic list of possible values for `triggerEvent`,
Expand Down