OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

EventWebSocket: Document regex topic filter (#2641) 

Refs https://github.com/openhab/openhab-core/pull/5116.

Signed-off-by: Florian Hotze <dev@florianhotze.com>
pull/2605/head^2
Florian Hotze 2026-01-13 18:16:26 +01:00 committed by GitHub
parent 4647f1a0fe
commit fe4e5029af
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
configuration/websocket.md
View File

@ -125,11 +125,15 @@ Topic filters can be used to include and/or exclude events of a specific topic f
They can be applied both inclusive and exclusive, and provide API compatibility with the existing topic filter functionality of the SSE event stream.
Topics usually start with `openhab` and are split into several segments separated by an `/`, e.g. `openhab/items/MyItem/command` to listen to commands to `MyItem`.
You may use `*` as a wildcard for a topic segment.
You may use `*` as a wildcard for a single or multiple topic segment(s).
To exclude a topic, start it with a `!`.
When sending only exclude topics, all events except those excluded are sent.
In other cases, only events of the selected topics are sent, whereas exclude topics can be used to filter out a subset of the selected events.
In addition to the `*` wildcard syntax, regular expressions can be used.
To use a regular expression for filtering, provide the regular expression as the topic:
E.g., `openhab/items/Kitchen_[^/]*/state` will match topics such as `openhab/items/Kitchen_Light/state`, but not `openhab/items/Kitchen_HVAC/Kitchen_Temperature/state`.
When sending only excluded topics, all events except those excluded are sent.
In other cases, only events of the selected topics are sent, whereas excluded topics can be used to filter out a subset of the selected events.
The payload of the event contains a list of string with the topics: