openHAB JS Automation Tools
This library provides some utilites for the openHAB JS Scripting Add-On. The JavaScript Add-On is using the NodeJS version found in openhab/openhab-addons/bundles/org.openhab.automation.jsscripting/pom.xml (currently v12.16.1).
Please note that it depents on the openHAB JavaScript Library, which is included in the JS Scripting Add-On by default. Therefore it is not listed in the dependencies of this package.
Table of Contents
Installation
- Install the openHAB JavaScript binding, a version of the openHAB library will be automatically installed and available to all javascript rules by default.
- Go to the javascript user scripts directory:
cd $OPENHAB_CONF/automation/js - Run
npm i florianh-openhab-tools(you may need to install npm)
Scene Engine
Call scene by sending a command to the sceneItem.
When a member of the scene changes it's state, the rule will check whether a defined scene is matching the current states and which scene.
It creates a full rule with triggers and actions out of your scene definition.
The sceneItem
Must be a Number item. You can assign a scene to every positive integer value, except to 0.
0 is the value the Item gets when no match with a scene is found on members change.
Scene definition
Scene defintion works with an array of objects.
const scenes = [ // For each sceneItem one object.
{ // Object of the first sceneItem.
selectorItem: 'scene call item name',
selectorStates: [ // For each numeric state of the sceneItem one object.
{ // Object for the value 1 of the sceneItem.
selectorValue: 1,
sceneTargets: [ // Target states of items in the scene. Parameters explained later.
{ item: 'Florian_Licht', value: 'ON', required: true },
{ item: 'Florian_LED_Stripes', value: 'OFF', required: false }
]
},
{ // Object for the value 15 of the sceneItem.
selectorValue: 15,
sceneTargets: [ // Target states of items in the scene. Parameters explained later.
{ item: 'Florian_LED_Stripes', value: 'ON', required: true }
]
}
]
}
];
sceneTargets' parameters
| Identifier | Purpose | Type | Required |
|---|---|---|---|
item |
Name of a scene member. | String | yes |
value |
Target state of that member. | String | yes |
required |
Whether that member must match the target state when the scene is checked. | Boolean | no, defaults to true |
Scene rule
NOTE: The sceneEngine was developed for file-based JavaScript rules, therefore create a script in the directory $OPENHAB_CONF/automation/js and not in the UI.
require('florianh-openhab-tools').rules.getSceneEngine(scenes, engineId);
| Parameter | Purpose | required |
|---|---|---|
| scenes | The scene definition array of objects. | yes |
| engineId | The id of the scene engine, used in description. | yes |
Group Utilities
The Group Utilities provide a number of functions on groups, e.g. arithmetic operations like min/max and count operations.
For supported methods look at the GroupUtils JSDoc.
These are a GraalJS compatible fork of the my original groupUtils from rkoshak/openhab-rules-tools.
Examples
const { itemutils } = require('florianh-openhab-tools');
// The name of the member with the maximum state.
itemutils.getGroup(group).membersMax.name;
// The sum of states.
itemutils.getGroup(group).membersSum;
// Count how many members are on.
itemutils.getGroup(group).membersCount(item => item.state === 'ON');
4 May 3, 2022
14 Jan 3, 2023
109 Dec 19, 2022
4 Nov 4, 2022
4 Jun 9, 2022
30 May 21, 2022
2.6k Dec 23, 2022
261 Dec 30, 2022
2 Dec 23, 2021
7 Oct 20, 2022
68 Dec 25, 2022
272 Dec 23, 2022
3 Dec 15, 2022
42 Dec 1, 2022
7 Aug 24, 2022
186 Dec 21, 2022
173 Dec 18, 2022
364 Dec 31, 2022
21 Dec 5, 2022