openHAB - CO2 Bricklet

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

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

Thing

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

Channels

CO2 Concentration

The measured CO2 concentration.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletco2:[UID]:BrickletCO2CO2Concentration
Read only:
  • Yes
Unit:
  • Parts Per Million
Range:
  • 0 Parts Per Million to 10000 Parts Per Million (Step 1 Parts Per Million)
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:brickletco2:[UID]")
val hwVersion = actions.brickletCO2GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletCO2GetCO2Concentration()
Return Map:
  • co2Concentration – Type: int, Unit: 1 ppm, Range: [0 to 10000]

Returns the measured CO2 concentration.

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

Advanced Actions

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