jsr233: Describe parameter of SimpleRule.execute(Map inputs) based on trigger

Author: dilyanpalauzov

configuration/jsr223.md

@@ -538,13 +538,77 @@ The following trigger types are defined by openHAB (custom triggers can also be
 All parameters are Strings.
 Read the JSR223 language specific documentation for examples of using these `TriggerType` objects.
 
+When a trigger is fired, it produces data, which is passed to the ActionHandler.
+Below the `inputs` parameter contains the data from the fired trigger:
+
+:::: tabs
+
+::: tab Groovy
+
+```groovy
+import org.openhab.core.config.core.Configuration
+import org.openhab.core.automation.module.script.rulesupport.shared.simple.SimpleRule
+import org.openhab.core.automation.*
+scriptExtension.importPreset("RuleSupport")
+
+automationManager.addRule(new SimpleRule() {
+    @Override
+    Object execute(Action module, Map<String, ?> inputs) {
+        // inputs is ... described below
+    }
+
+    List<Trigger> triggers = [
+        TriggerBuilder.create().withId("trig1").withTypeUID("core.ItemStateChangeTrigger")
+        .withConfiguration(new Configuration([itemName: "r"])).build(),
+        TriggerBuilder.create().withId("cr2").withTypeUID("timer.GenericCronTrigger")
+        .withConfiguration(new Configuration([cronExpression: "* * * 25 * *"])).build()
+    ]
+})
+```
+
+:::
+
+::: tab JavaScript/ECMAScript&nbsp;-&nbsp;262&nbsp;Edition&nbsp;5.1
+
+```js
+se.importPreset("RuleSupport")
+se.importPreset("RuleSimple")
+
+automationManager.addRule(new SimpleRule() {
+    execute: function(module, inputs) {
+      // inputs is ... described below
+    },
+    getTriggers: function() { return [
+        TriggerBuilder.create().withId("trig1").withTypeUID("core.ItemStateChangeTrigger")
+        .withConfiguration(new Configuration({itemName: "r"})).build(),
+        TriggerBuilder.create().withId("cr2").withTypeUID("timer.GenericCronTrigger")
+        .withConfiguration(new Configuration({cronExpression: "* * * 25 * *"})).build()
+    ] }
+})
+```
+
+:::
+
+::::
+
+When `trig1` fires, inputs.get("module") is `"trig1"`.
+The table below `core.ItemStateChangeTrigger` shows that five keys and values will be inserted into `inputs`.
+The values are inserted twice: once with the trigger id prefix followed by dot in the key, once without.
+That is, `inputs` will have eleven keys and six values: `inputs.get("module")`, `inputs.get("oldState") == inputs.get("trig1.oldState")`, `inputs.get("newState") == inputs.get("trig1.newState")`, `inputs.get("lastStateUpdate") == inputs.get("trig1.lastStateUpdate")`, `inputs.get("lastStateChange") == inputs.get("trig1.lastStateChange")` and `inputs.get("event") == inputs.get("trig1.event")`.
+
 ::: details timer.DateTimeTrigger
 
-| Parameter  | Description                                                               |
-|------------|---------------------------------------------------------------------------|
-| `itemName` | The name of the `Item`                                                    |
-| `timeOnly` | Whether only the time of the item should be compared or the date and time |
-| `offset`   | The offset in seconds to add to the time of the item                      |
+| Parameter  | Description                                                                                     |
+|------------|-------------------------------------------------------------------------------------------------|
+| `itemName` | The name of the `Item`                                                                          |
+| `timeOnly` | Whether only the time of the item should be compared or the date and time.  Default is `false`. |
+| `offset`   | The offset in seconds to add to the time of the item                                            |
+
+Data provided by the trigger:
+
+| Key     | Description                                                                                                                             |
+| ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| `event` | [`org.openhab.core.automation.events.TimerEvent`](https://www.openhab.org/javadoc/latest/org/openhab/core/automation/events/timerevent) |
 
 :::
 
@@ -580,6 +644,14 @@ Read the JSR223 language specific documentation for examples of using these `Tri
 | `itemName` | The name of the `Item` |
 | `state`    | The `State` (optional) |
 
+Data provided by the trigger:
+
+| Key               | Description                                                                                                                                                                      |
+| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `state`           | The item [`org.openhab.core.types.State`](https://www.openhab.org/javadoc/latest/org/openhab/core/types/state)                                                                   |
+| `event`           | [`org.openhab.core.items.events.ItemStateUpdatedEvent`](https://www.openhab.org/javadoc/latest/org/openhab/core/items/events/itemstateupdatedevent)                              |
+| `lastStateUpdate` | The time of the previous state update [`java.time.ZonedDateTime`](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/ZonedDateTime.html) - since openHAB 5.0 |
+
 :::
 
 ::: details core.ItemStateChangeTrigger
@@ -590,6 +662,16 @@ Read the JSR223 language specific documentation for examples of using these `Tri
 | `previousState` | The previous `State` (optional) |
 | `state`         | The `State` (optional)          |
 
+Data provided by the trigger:
+
+| Key               | Description                                                                                                                                                                      |
+| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `oldState`        | Old [`org.openhab.core.types.State`](https://www.openhab.org/javadoc/latest/org/openhab/core/types/state)                                                                        |
+| `newState`        | The new item [`org.openhab.core.types.State`](https://www.openhab.org/javadoc/latest/org/openhab/core/types/state)                                                               |
+| `lastStateUpdate` | The time of the previous state update [`java.time.ZonedDateTime`](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/ZonedDateTime.html) - since openHAB 5.0 |
+| `lastStateChange` | The time of the previous state change [`java.time.ZonedDateTime`](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/ZonedDateTime.html) - since openHAB 5.0 |
+| `event`           | [`org.openhab.core.items.events.ItemStateChangedEvent`](https://www.openhab.org/javadoc/latest/org/openhab/core/items/events/itemstatechangedevent)                              |
+
 :::
 
 ::: details core.GroupCommandTrigger