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

Rules tweaks (#2336) 

* Update JRuby notification action

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>

* split helper library code into separate blocks for clarity

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>

---------

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
pull/2337/head
jimtng 2024-07-17 04:56:46 +10:00 committed by GitHub
parent 550ea8608c
commit 9f48d8153a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
concepts/rules.md
View File

@ -625,7 +625,7 @@ rule "Window open reminder" do
changed gWindows.members, to: OPEN, for: 1.hour changed gWindows.members, to: OPEN, for: 1.hour
run do |event| run do |event|
# Item guaranteed to be OPEN here, no need to check # Item guaranteed to be OPEN here, no need to check
notify("#{event.item.label} is open for an hour!") Notification.send("#{event.item.label} is open for an hour!")
end end
end end
``` ```

22
configuration/jsr223.md
View File

@ -89,7 +89,9 @@ sRule.setTriggers([
]); ]);
automationManager.addRule(sRule); automationManager.addRule(sRule);
```
```js
// And the same rule using the helper library: // And the same rule using the helper library:
const { rules, triggers } = require('openhab'); const { rules, triggers } = require('openhab');
@ -185,7 +187,9 @@ s_rule.set_triggers([
]) ])
$automationManager.add_rule(s_rule) $automationManager.add_rule(s_rule)
```
```ruby
# And the same rule using the bundled helper library: # And the same rule using the bundled helper library:
rule "A Cron Rule in Ruby" do rule "A Cron Rule in Ruby" do
@ -234,12 +238,18 @@ To facilitate JSR223 scripting, several openHAB-related variables are automatica
They can be loaded into the script context using `scriptExtension.importPreset(String preset)`, e.g. `scriptExtension.importPreset("RuleSimple")`. They can be loaded into the script context using `scriptExtension.importPreset(String preset)`, e.g. `scriptExtension.importPreset("RuleSimple")`.
The `default` preset is preloaded, so it does not require importing. The `default` preset is preloaded, so it does not require importing.
- [`Default`](#default-preset-importpreset-not-required) - [Overview](#overview)
- [`RuleSimple`](#rulesimple-preset) - [Example rules for a first impression](#example-rules-for-a-first-impression)
- [`RuleSupport`](#rulesupport-preset) - [Script Locations](#script-locations)
- [`RuleFactories`](#rulefactories-preset) - [`ScriptExtension` Objects (all JSR223 languages)](#scriptextension-objects-all-jsr223-languages)
- [`ScriptAction`](#scriptaction-preset) - [Default Preset (`importPreset` not required)](#default-preset-importpreset-not-required)
- [`cache`](#cache-preset) - [`events` operations](#events-operations)
- [RuleSimple Preset](#rulesimple-preset)
- [`RuleSupport` Preset](#rulesupport-preset)
- [`RuleFactories` Preset](#rulefactories-preset)
- [`ScriptAction` Preset](#scriptaction-preset)
- [`cache` Preset](#cache-preset)
- [`TriggerType` Objects (all JSR223 languages)](#triggertype-objects-all-jsr223-languages)
#### Default Preset (`importPreset` not required) #### Default Preset (`importPreset` not required)