openHAB - Humidity Bricklet 2.0

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

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

Thing

UID:
  • tinkerforge:bricklethumidityv2:[UID]
Required firmware version:
  • 2.0.3
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Humidity Moving Average Length – Type: integer, Default: 5, Min: 1, Max: 1000
  • The length of a moving averaging for the humidity.

  • Temperature Moving Average Length – Type: integer, Default: 5, Min: 1, Max: 1000
  • The length of a moving averaging for the temperature.

  • Sample Rate – Type: Choice, Default: 1 SPS
  • The samples per second that are gathered by the humidity/temperature sensor HDC1080. We added this function since we found out that a high measurement frequency can lead to self-heating of the sensor. Which can distort the temperature measurement. If you don't need a lot of measurements, you can use the lowest available measurement frequency of 0.1 samples per second for the least amount of self-heating.
  • Options: 20 SPS, 10 SPS, 5 SPS, 1 SPS, 0.2 SPS, 0.1 SPS

  • Status LED Config – Type: Choice, Default: Show Status
  • The status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
  • Options: Off, On, Show Heartbeat, Show Status

Channels

Humidity

The measured relative humidity

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:bricklethumidityv2:[UID]:BrickletHumidityV2Humidity
Read only:
  • Yes
Unit:
  • Percent
Range:
  • 0 Percent to 100 Percent (Step 0.01 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.
Temperature

The measured temperature

Type:
  • Number:Temperature
UID:
  • tinkerforge:bricklethumidityv2:[UID]:BrickletHumidityV2Temperature
Read only:
  • Yes
Unit:
  • Celsius
Range:
  • -40 Celsius to 165 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.
Heater

Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.

Type:
  • Switch
UID:
  • tinkerforge:bricklethumidityv2:[UID]:BrickletHumidityV2Heater
Read only:
  • No

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:bricklethumidityv2:[UID]")
val hwVersion = actions.brickletHumidityV2GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletHumidityV2GetHumidity()
Return Map:
  • humidity – Type: int, Unit: 1/100 %, Range: [0 to 10000]

Returns the humidity measured by the sensor.

If you want to get the value periodically, it is recommended to use the Humidity channel. You can set the channel configuration with the configuration of Humidity.

brickletHumidityV2GetTemperature()
Return Map:
  • temperature – Type: int, Unit: 1/100 °C, Range: [-4000 to 16500]

Returns the temperature measured by the sensor.

If you want to get the value periodically, it is recommended to use the Temperature channel. You can set the channel configuration with the configuration of Temperature.

brickletHumidityV2SetHeaterConfiguration(int heaterConfig)
Parameters:
  • heaterConfig – Type: int, Range: See constants, Default: False

Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.

The following constants are available for this function:

For heaterConfig:

  • val HEATER_CONFIG_DISABLED = 0
  • val HEATER_CONFIG_ENABLED = 1
brickletHumidityV2GetHeaterConfiguration()
Return Map:
  • heaterConfig – Type: int, Range: See constants, Default: False

Returns the heater configuration as set by Heater.

The following constants are available for this function:

For heaterConfig:

  • val HEATER_CONFIG_DISABLED = 0
  • val HEATER_CONFIG_ENABLED = 1
brickletHumidityV2GetMovingAverageConfiguration()
Return Map:
  • movingAverageLengthHumidity – Type: int, Range: [1 to 1000], Default: 5
  • movingAverageLengthTemperature – Type: int, Range: [1 to 1000], Default: 5

Returns the moving average configuration as set by the thing configuration.

brickletHumidityV2GetSamplesPerSecond()
Return Map:
  • sps – Type: int, Range: See constants, Default: 3

Returnes the samples per second, as set by the thing configuration.

The following constants are available for this function:

For sps:

  • val SPS_20 = 0
  • val SPS_10 = 1
  • val SPS_5 = 2
  • val SPS_1 = 3
  • val SPS_02 = 4
  • val SPS_01 = 5

New in version 2.0.3 (Plugin).

Advanced Actions

brickletHumidityV2GetChipTemperature()
Return Map:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

brickletHumidityV2GetStatusLEDConfig()
Return Map:
  • config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration

The following constants are available for this function:

For config:

  • val STATUS_LED_CONFIG_OFF = 0
  • val STATUS_LED_CONFIG_ON = 1
  • val STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val STATUS_LED_CONFIG_SHOW_STATUS = 3
brickletHumidityV2GetSPITFPErrorCount()
Return Map:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

brickletHumidityV2GetIdentity()
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

Internal Actions

brickletHumidityV2ReadUID()
Return Map:
  • uid – Type: long, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.