openHAB - API Bindings¶

Requirements¶

• openHAB 2.5.0 or newer, openHAB 3 is currently not supported.

Installation¶

To install the bindings, just copy the JAR into the addons directory of your installation. openHAB will then load the bindings.

Usage¶

To control Tinkerforge hardware with the openHAB bindings, Brick Daemon has to be installed first. Brick Daemon acts as a proxy between the USB interface of the Bricks and the bindings. You can then connect the bindings by adding a Brick Daemon thing in openHAB's Paper UI.

Attached devices are automatically put into the inbox after adding the Brick Daemon thing.

Devices and channels can be configured: Channels typically allow changing the update rate. The configuration of some things can show or hide channels, for example the IO-4/16 pin configuration will dynamically create input or output channels. Sometimes PaperUI needs to be refreshed by pressing F5 to show new channels.

Changing device configuration is only supported, if it is stored in the RAM of the device. Persistent configuration has to be set externally (e.g. by using Brick Viewer), because openHAB will often reconfigure devices, for example on startup or when reconnected to a Brick Daemon. Writing persistent configuration every time would use up too many write-cycles.

rule "GUI example"
when
    System started
then
    var lcdActions = getActions("tinkerforge", "tinkerforge:brickletlcd128x64:HQ6")
    lcdActions.brickletLCD128x64ClearDisplay()
    lcdActions.brickletLCD128x64RemoveAllGUI();
    lcdActions.brickletLCD128x64SetGUIButton(0, 0, 0, 60, 20, "button");
    lcdActions.brickletLCD128x64SetGUISlider(0, 0, 30, 60, 0, 50);
    lcdActions.brickletLCD128x64SetGUIGraphConfiguration(0, 1, 62, 0, 60, 52, "X", "Y");
    lcdActions.brickletLCD128x64SetGUIGraphData(0, newArrayList(0, 10, 20, 40, 20, 15));
    lcdActions.brickletLCD128x64SetGUITabConfiguration(3, false);
    lcdActions.brickletLCD128x64SetGUITabText(0, "Tab A");
    lcdActions.brickletLCD128x64SetGUITabText(1, "Tab B");
end

rule "invert image"
when
    Item Enx_Button changed to OFF
then
    val lcdActions = getActions("tinkerforge", "tinkerforge:brickletlcd128x64:HQ6")
    pixels = lcdActions.brickletLCD128x64ReadPixels(0, 0, 127, 63).get("pixels")
    val inverted = pixels.map[p | !p]
    lcdActions.brickletLCD128x64WritePixels(0, 0, 127, 63, inverted)
end

API Reference and Examples¶

Links to the API reference for the IP Connection, Bricks and Bricklets as well as the examples from the ZIP file of the bindings are listed in the following table. Further project descriptions can be found in the Kits section.