openhab-widgets

Some OpenHAB widgets I've found from the net and then improved to fit my needs. To keep track of my changes, I've added them to this repository. Hopefully someone else finds them useful, too.

The repository contains the following widgets. N.B. The widgets are separate from each others, I just happen to use them all and thus have collected them together.

Read the separate README.md files in each widget directory for more information.

• MultiState – provides a handy widget to control a group of switches or rollershutters or display just multiple humidity values.
• SonosControlWithArt – control Sonos playback and shows album art.

OpenHAB widget

A readymade OpenHAB widget can be found in widget directory under each widget. The name of the file is WidgetName.widget.json and it is ready to be uploaded to OpenHAB.

Making changes

If you want to modify the widgets, please do not edit the widget file directly. Instead, edit the files mentioned below, generate the widget as instructed also below, and finally commit the changes including both the edited files and the generated widget.

Further, kindly update the relevant README.MD file to describe your changes.

Widget files

Each widget directory contains the following files:

• [WidgetName].template – Widget JSON template used as a skeleton in the widget building process.
• [WidgetName].widget.html – HTML / Angular code of the widget. This can be copied from the widget code editing pane in HABPanel, if you want to test your changes inside OpenHAB.
• [WidgetName].settings.json – Settings of the widget, used to generate the configuration user interface.

I ended up splitting the widget into several files so that they are easier to change and still there is a possibility to create a widget file for OpenHAB.

Generating OpenHAB widget

OpenHAB stores a widget in a JSON file that contains everything and is thus quite hard to edit. This repository contains a script build-widget.shthat can be used to build a widget from the aforementioned files.

To use the script, execute it in the shell:

./build-widget.sh multistate/MultiState

The command builds MultiState widget in multistate directory and creates the final widget JSON into multistate/widget/MultiState.widget.jsonfile, ready to be uploaded to OpenHAB.