openHAB - Bindings

Bemerkung

Zur Zeit ist nur die englische openHAB-Dokumentation verfügbar.

Bemerkung

The openHAB bindings are currently still in beta.

The openHAB bindings allow you to control Bricks and Bricklets from your openHAB installation. The ZIP file for the bindings contains:

  • org.openhab.binding.tinkerforge-[version].jar, a precompiled version of the bindings
  • in org.openhab.binding.tinkerforge/ the source code of the bindings
  • in examples/ example DSL rules for some Bricks and Bricklets
  • tinkerforge-2.1.26.jar, the currently required version of the Java bindings

Requirements

  • openHAB 2.5.0 or newer

Installation

Bemerkung

Currently the bindings also require installation of the Java bindings version 2.1.26 or higher. They are available in in the zip file or alternatively in the Central Maven Repository. Put the jar into the addons directory, next to the openHAB bindings jar.

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. Persistant 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 persistant configuration every time would use up too many write-cycles.

Actions

There are actions available for each thing. To use actions of a thing in a rule, first the actions have to be loaded with: var devActions = getActions("tinkerforge", "tinkerforge:[devicetype]:[Device UID]") Then they can be used with devActions.[actionname]([parameters]). The following example shows how to show a GUI on an LCD 128x64 Bricklet with the UID "HQ6":

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

The parameters and return values typically correspond to those of the respective function in the Java Bindings. Functions that expect arrays as parameters can also be called with lists, as shown in the call of setGUIGraphData in the example. Results are returned as a Map<String, Object>, that can be used as follows:

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

This rule is triggered if the Item Enx_Button changes to OFF (i.e. if the corresponding RGB LED Button is released). It will then read the pixels currently shown on the LCD Bricklet, invert them and draw the inverted pixels back on the LCD.

Nearly the complete API of devices can be used as actions. Functions that change the state of a channel will refresh it automatically. Alternatively you can use items associated to the channels with .sendCommand to change those. Not supported are operations, that would write EEPROM or Flash Storage, to avoid unneccesary write-cycles.

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.

  API Beispiele
Bricks    
DC API Beispiele
HAT API Beispiele
HAT Zero API Beispiele
IMU 2.0 API Beispiele
Master API Beispiele
RED API Beispiele
Servo API Beispiele
Silent Stepper API Beispiele
Stepper API Beispiele
     
Bricks (Abgekündigt)    
IMU API Beispiele
     
Bricklets    
Accelerometer 2.0 API Beispiele
Air Quality API Beispiele
Ambient Light 3.0 API Beispiele
Analog In 3.0 API Beispiele
Analog Out 2.0 API Beispiele
Analog Out 3.0 API Beispiele
Barometer API Beispiele
Barometer 2.0 API Beispiele
CAN API Beispiele
CAN 2.0 API Beispiele
CO2 2.0 API Beispiele
Color API Beispiele
Color 2.0 API Beispiele
Compass API Beispiele
Distance IR API Beispiele
Distance IR 2.0 API Beispiele
Distance US 2.0 API Beispiele
DMX API Beispiele
Dual Button API Beispiele
Dual Button 2.0 API Beispiele
Dual Relay API Beispiele
Dust Detector API Beispiele
E-Paper 296x128 API Beispiele
Energy Monitor API Beispiele
GPS 2.0 API Beispiele
Hall Effect API Beispiele
Hall Effect 2.0 API Beispiele
Humidity 2.0 API Beispiele
IMU 3.0 API  
Industrial Analog Out 2.0 API Beispiele
Industrial Counter API Beispiele
Industrial Digital In 4 2.0 API Beispiele
Industrial Digital Out 4 API Beispiele
Industrial Digital Out 4 2.0 API Beispiele
Industrial Dual 0-20mA API Beispiele
Industrial Dual 0-20mA 2.0 API Beispiele
Industrial Dual Analog In 2.0 API Beispiele
Industrial Dual Relay API Beispiele
Industrial Quad Relay 2.0 API Beispiele
IO-16 API Beispiele
IO-16 2.0 API Beispiele
IO-4 2.0 API Beispiele
Isolator API Beispiele
Joystick API Beispiele
Joystick 2.0 API Beispiele
Laser Range Finder 2.0 API Beispiele
LCD 128x64 API Beispiele
LCD 20x4 API Beispiele
LED Strip 2.0 API Beispiele
Line API Beispiele
Linear Poti API Beispiele
Linear Poti 2.0 API Beispiele
Load Cell 2.0 API Beispiele
Motion Detector 2.0 API Beispiele
Motorized Linear Poti API Beispiele
Multi Touch API Beispiele
Multi Touch 2.0 API Beispiele
NFC API Beispiele
OLED 128x64 2.0 API Beispiele
OLED 64x48 API Beispiele
One Wire API Beispiele
Outdoor Weather API Beispiele
Particulate Matter API Beispiele
Piezo Speaker API Beispiele
Piezo Speaker 2.0 API Beispiele
PTC 2.0 API Beispiele
Real-Time Clock API Beispiele
Real-Time Clock 2.0 API Beispiele
Remote Switch 2.0 API Beispiele
RGB LED API Beispiele
RGB LED 2.0 API Beispiele
RGB LED Button API Beispiele
Rotary Encoder 2.0 API Beispiele
Rotary Poti API Beispiele
Rotary Poti 2.0 API Beispiele
RS232 API Beispiele
RS232 2.0 API Beispiele
RS485 API Beispiele
Segment Display 4x7 API Beispiele
Segment Display 4x7 2.0 API Beispiele
Solid State Relay 2.0 API Beispiele
Sound Intensity API Beispiele
Sound Pressure Level API Beispiele
Temperature API Beispiele
Temperature 2.0 API Beispiele
Temperature IR 2.0 API Beispiele
Thermal Imaging API Beispiele
Thermocouple 2.0 API Beispiele
Tilt API Beispiele
UV Light API Beispiele
UV Light 2.0 API Beispiele
Voltage/Current 2.0 API Beispiele
XMC1400 Breakout API Beispiele
     
Bricklets (Abgekündigt)    
Accelerometer API Beispiele
Ambient Light API Beispiele
Ambient Light 2.0 API Beispiele
Analog In API Beispiele
Analog In 2.0 API Beispiele
Analog Out API Beispiele
CO2 API Beispiele
Current12 API Beispiele
Current25 API Beispiele
Distance US API Beispiele
GPS API Beispiele
Humidity API Beispiele
Industrial Analog Out API Beispiele
Industrial Digital In 4 API Beispiele
Industrial Dual Analog In API Beispiele
Industrial Quad Relay API Beispiele
IO-4 API Beispiele
Laser Range Finder API Beispiele
LCD 16x2 API Beispiele
LED Strip API Beispiele
Load Cell API Beispiele
Moisture API Beispiele
Motion Detector API Beispiele
NFC/RFID API Beispiele
OLED 128x64 API Beispiele
Piezo Buzzer API Beispiele
PTC API Beispiele
Remote Switch API Beispiele
RGB LED Matrix API Beispiele
Rotary Encoder API Beispiele
Solid State Relay API Beispiele
Temperature IR API Beispiele
Thermocouple API Beispiele
Voltage API Beispiele
Voltage/Current API Beispiele