Skip to content

JSR223: Update events documentation #2625

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

Merged
stefan-hoehn merged 1 commit into from
Dec 29, 2025
+15 −1
Merged

JSR223: Update events documentation #2625

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
16 changes: 15 additions & 1 deletion configuration/jsr223.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,18 +324,32 @@ With `scriptExtension.get("automationManager")` the `automationManager` can be m

##### `events` operations

Instance of [`org.openhab.core.automation.module.script.defaultscope.ScriptBusEvent`](https://www.openhab.org/javadoc/latest/org/openhab/core/automation/module/script/defaultscope/scriptbusevent).
Instance of [`org.openhab.core.automation.module.script.action.BusEvent`](https://www.openhab.org/javadoc/latest/org/openhab/core/automation/module/script/action/busevent).

For all _post update_, _send command_, and _send time series_ operations, methods with an additional String parameter are available to specify the source of the event.
Refer to [Developer: Event Bus]({{base}}/developer/events.html#event-source) for more information about event source.

##### Post Update

- `events.postUpdate(String, String)`
- `events.postUpdate(Item, Number)`
- `events.postUpdate(Item, String)`
- `events.postUpdate(Item, State)`

##### Send Command

- `events.sendCommand(String, String)`
- `events.sendCommand(Item, Number)`
- `events.sendCommand(Item, String)`
- `events.sendCommand(Item, Command)`

##### Send Time Series

- `events.sendTimeSeries(String, Map<ZonedDateTime, State>, String)`
- `events.sendTimeSeries(Item, TimeSeries)`

##### Store and Restore States

- `events.storeStates(Item...)`
- `events.restoreStates(Map<Item, State>)`

Expand Down