/openhab2-javascript

JSR223 JavaScript Code openHAB 2.x automation

Primary LanguageJavaScript

########################## IMPORTANT since 20190526 ##########################

This repository has moved. It is now maintained together with other openHAB helper libraries on openhab-scripters/openhab-helper-libraries.

The development of the different scripting languages for openHAB like

groovy
javascript
Jython (Python)
and many more...

will be combined and will later be an important part of the Next-Generation Rule Engine for openHAB.

########################## IMPORTANT since 20190526 ##########################

openHAB 2.x: JSR223 JavaScript Code since 2.4

This is a repository of very experimental JavaScript code that can be used with openHAB 2.x.

Applications

The JSR223 scripting extensions can be used for general scripting purposes, including defining rules with JavaScript Code for openHAB 2 JSR223 Scripting.

Installation

A) Copy Files into /etc/openhab2/automation/jsr223

B) Go to Paper UI -> Misc and install Binding "Rule Engine"

Defining Rules

Migrating DSL Rules to JSR223/Javascript with a case example

OpenHAB 2 JSR223 Scripting Documentation: JSR223 Scripting and Rule Support.

Further links and information: openHAB 1 Scripted Rule Support.

Rules: Raw ESH API

Simplified with some extra JavaScript Code, found in jslib/JSRule.js:

'use strict';

var OPENHAB_CONF = Java.type("java.lang.System").getenv("OPENHAB_CONF");
load(OPENHAB_CONF+'/automation/jsr223/jslib/JSRule.js');

JSRule({
    name: "My JS Rule",
    description: "Line:"+__LINE__,
    triggers: [
        TimerTrigger("0/15 * * * * ?")//Enable/Disable Rule
    ],
    execute: function( module, input){
        print("################ module:", module);
        postUpdate(getItem("testItemSwitch"), ON);
        sendCommand(getItem("testItemSwitch"), OFF);
    }
});

jslib/helper.js contains more simplifying and helping functions.

jslib/PersistenceExtensions.js contains more simplifying PersistenceExtensions functions.

jslib/triggersAndConditions.js contains trigger functions.

ActionExamples.js contains examples for default actions like PersistenceExtensions, HTTP, Ping, Audio, Voice, ThingAction.

itemTest.js contains examples for testing Items and Groups.