openHAB - Humidity Bricklet

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

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

Thing

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

Channels

Humidity

The measured relative humidity

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:bricklethumidity:[UID]:BrickletHumidityHumidity
Read only:
  • Yes
Unit:
  • Percent
Range:
  • 0 Percent to 100 Percent (Step 0.1 Percent)
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.
Analog Value

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by Get Humidity() is averaged over several samples to yield less noise, while Get Analog Value() gives back raw unfiltered analog values. The returned humidity value is calibrated for room temperatures, if you use the sensor in extreme cold or extreme warm environments, you might want to calculate the humidity from the analog value yourself. See the HIH 5030 datasheet.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:bricklethumidity:[UID]:BrickletHumidityAnalogValue
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)
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:bricklethumidity:[UID]")
val hwVersion = actions.brickletHumidityGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletHumidityGetHumidity()
Return Map:
  • humidity – Type: int, Unit: 1/10 %, Range: [0 to 1000]

Returns the humidity of the sensor.

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

Advanced Actions

brickletHumidityGetAnalogValue()
Return Map:
  • value – Type: int, Range: [0 to 212 - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by Humidity is averaged over several samples to yield less noise, while Analog Value gives back raw unfiltered analog values. The returned humidity value is calibrated for room temperatures, if you use the sensor in extreme cold or extreme warm environments, you might want to calculate the humidity from the analog value yourself. See the HIH 5030 datasheet.

If you want the analog value periodically, it is recommended to use the Analog Value channel and set the period with the configuration of Analog Value.

brickletHumidityGetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', '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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here