Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets (Discontinued) / Temperature IR Bricklet

openHAB - Temperature IR Bricklet

Bemerkung

Die openHAB-Dokumentation ist nur auf Englisch verfügbar.

Warnung

The openHAB bindings are still in beta, but the development was stopped.

This is the description of the openHAB API bindings for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR Bricklet are summarized in its hardware description.

An installation guide for the openHAB API bindings is part of their general description.

Thing

UID:
  • tinkerforge:bricklettemperatureir:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:

Channels

Ambient Temperature

The measured ambient temperature

Type:
  • Number:Temperature
UID:
  • tinkerforge:bricklettemperatureir:[UID]:BrickletTemperatureIRAmbientTemperature
Read only:
  • Yes
Unit:
  • Celsius
Range:
  • -40 Celsius to 125 Celsius (Step 0.1 Celsius)
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
Object Temperature

The measured object temperature, i.e. the temperature of the surface of the object the sensor is aimed at. The temperature of different materials is dependent on their emissivity.

Type:
  • Number:Temperature
UID:
  • tinkerforge:bricklettemperatureir:[UID]:BrickletTemperatureIRObjectTemperature
Read only:
  • Yes
Unit:
  • Celsius
Range:
  • -70 Celsius to 380 Celsius (Step 0.1 Celsius)
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval in milliseconds. A value of 0 disables automatic updates.

Actions

Actions can be used in rules by creating an action object. All actions return a Map<String, Object>. Returned values can be accessed by name, sometimes the type deduction needs some hints, as shown below:

val actions = getActions("tinkerforge", "tinkerforge:bricklettemperatureir:[UID]")
val hwVersion = actions.brickletTemperatureIRGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletTemperatureIRGetAmbientTemperature()
Return Map:
  • temperature – Type: short, Unit: 1/10 °C, Range: [-400 to 1250]

Returns the ambient temperature of the sensor.

If you want to get the ambient temperature periodically, it is recommended to use the Ambient Temperature channel and set the period with the configuration of Ambient Temperature.

brickletTemperatureIRGetObjectTemperature()
Return Map:
  • temperature – Type: short, Unit: 1/10 °C, Range: [-700 to 3800]

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with This function is not available in openHAB. Please use Brick Viewer to change persistant device settings.

If you want to get the object temperature periodically, it is recommended to use the Object Temperature channel and set the period with the configuration of Object Temperature.

Advanced Actions

brickletTemperatureIRGetEmissivity()
Return Map:
  • emissivity – Type: int, Unit: 1/65535, Range: [6553 to 216 - 1], Default: 216 - 1

Returns the emissivity as set by This function is not available in openHAB. Please use Brick Viewer to change persistant device settings.

brickletTemperatureIRGetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here.