openhab jsr223 helper for javascript
First at this point special thanks @lewie for his work and share of helper librarays.
Now i have extended this one and want also share this. Perhaps someone will find it usefull.
This extension is only usefull for the older librarys. The new one from @5iver are much more powerfull
You can find all files on GitLab: https://gitlab.com/RNTs_3/openhab-jsr223-javascript-helper/tree/master
The relevant file is RNTs-trigger.js in the folder jslib.
Here is a complete example of all new helper:
'use strict';
var OPENHAB_CONF = Java.type("java.lang.System").getenv("OPENHAB_CONF") // most this is /etc/openhab2
load(OPENHAB_CONF + '/automation/jsr223/jslib/JSRule.js')
load(OPENHAB_CONF + '/automation/jsr223/jslib/RNTs-trigger.js')
var timeOfDay_preset = {
"morning_start": "6:00", // morning_start is nessesary for time of day
"night_start": "22:00", // night_start is nessesary for time of day
"bed_start": "00:00", // bed_start is nessesary for time of day
"astro_calc": "00:01",
}
JSRule({
name: "RNTs - example",
description: "example",
triggers: aggregateTrigger([
TimerTrigger("0 0/15 * 1/1 * ? *"), // single cron trigger
ChangedEventTriggerGroup("gExampleGroup1"), // trigger when single item in group changed
ItemCommandTriggerGroup("gExampleGroup2"), // trigger when single item in group received command
generateCronTriggerSet(timeOfDay_preset), // multiple cron trigger generated from var timeOfDay_preset
ItemStateChangeTrigger("exampleSwitch","","ON") // single item change trigger
]),
execute:
aggregateTrigger(ArrayOfTriggers)
In the JSRule template the key trigger except a single array with various sort of triggers. But it’s not possible to use nested arrays with nested triggers.
Here the parameter is also an array. In difference one can hand over arrays of trigger or single trigger and the function will return a single array of triggers.
ItemCommandTriggerGroup(groupName)
param: group of item
return: single ItemCommandTrigger array of items what are member of group in param
ChangedEventTriggerGroup(groupName)
param: group of item
return: single ChangedEventTrigger array of items what are member of group in param
generateCronTriggerSet(triggerPreset)
param: dataset with trigger times in the follwoing format - hour:minute
return: array of single cron trigger
example of dataset: var example_timeSet = {
“trigger1”: “23:10”,
“nightStart”: “23:04”,
“bedTime”: “23:02”,
}
one can define as much as nessesary trigger times
the key is for human readability but it must be unique
In the example of time of day Migrating DSL Rules to JSR223/Javascript with a case example, @Confectrician thanks for sharing, one can see the benefit of this datastructure. It’s exist one place (var timeOfDay_preset) of relevant times.
var timeOfDay_preset = {
"morning_start": "6:00", // morning_start is nessesary for time of day
"night_start": "22:00", // night_start is nessesary for time of day
"bed_start": "00:00", // bed_start is nessesary for time of day
"astro_calc": "00:01",
}
JSRule({
name: "Time of day",
description: "Calculates the time of day, depending on several triggers",
triggers: aggregateTrigger([
ChannelEventTrigger("astro:sun:home:rise#event", "START", "astroSunriseTrigger"),
ChannelEventTrigger("astro:sun:home:set#event", "START", "astroSunsetTrigger"),
ChannelEventTrigger("astro:sun:minus90:set#event", "START", "astroSunsetDelayTrigger"),
generateCronTriggerSet(timeOfDay_preset),
ItemStateChangeTrigger("Helper_JSR223_SystemIsStarted","","ON") // trigger for system startup witch helper
]),
...
//logInfo("Calculating time of day...")
// Calculate the times for the static times
var tMorning = timeOfDay_preset["morning_start"].split(':')
var tNight = timeOfDay_preset["night_start"].split(':')
var tBed = timeOfDay_preset["bed_start"].split(':')
var morning_start = new Date().setHours(tMorning[0], tMorning[1], 0, 0) // .setHours(Hour, Minute, Second, Millisecond)
var night_start = new Date().setHours(tNight[0], tNight[1], 0, 0)
var bed_start = new Date().setHours(tBed[0], tBed[1], 0, 0)
hint: Abouve you see only the relevant part for generateCronTriggerSet not the complete rule.
checkItemExist(item.name)
param: item name
return: item then exist or null
context.checkItemExist = function(it) {
try {
//print("################## "+ir.getItem(it));
return (typeof it === 'string' || it instanceof String) ? ir.getItem(it) : it;
}catch(err) {
return null;
}
};
This function is append in the file helper.js. It’s almost identical to getItem(item.name). The only difference is, you will not get an error in the log when the item not exist. So i find it a little bit cleaner to check if items exist.
okay. I will look a little bit deeper in your repo.
