openHAB - Temperature Bricklet

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

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

Thing

UID:
  • tinkerforge:bricklettemperature:[UID]
Required firmware version:
  • 2.0.1
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • I2C Mode – Type: Choice, Default: Fast (400kHz)
  • Sets the I2C mode. If you have problems with obvious outliers in the Temperature Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed. It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.
  • Options: Fast (400kHz), Slow (100kHz)

Channels

Temperature

The measured temperature

Type:
  • Number:Temperature
UID:
  • tinkerforge:bricklettemperature:[UID]:BrickletTemperatureTemperature
Read only:
  • Yes
Unit:
  • Celsius
Range:
  • -25 Celsius to 85 Celsius (Step 0.01 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:bricklettemperature:[UID]")
val hwVersion = actions.brickletTemperatureGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletTemperatureGetTemperature()
Return Map:
  • temperature – Type: short, Unit: 1/100 °C, Range: [-2500 to 8500]

Returns the temperature of the sensor.

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

Advanced Actions

brickletTemperatureGetI2CMode()
Return Map:
  • mode – Type: short, Range: See constants, Default: 0

Returns the I2C mode as set by the thing configuration.

The following constants are available for this function:

For mode:

  • val I2C_MODE_FAST = 0
  • val I2C_MODE_SLOW = 1

New in version 2.0.1 (Plugin).

brickletTemperatureGetIdentity()
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 as position 'z'.

The device identifier numbers can be found here