Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets / CO2 Bricklet 2.0

openHAB - CO2 Bricklet 2.0

Warning

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

This is the description of the openHAB API bindings for the CO2 Bricklet 2.0. General information and technical specifications for the CO2 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:brickletco2v2:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Status LED Configuration – 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

CO2 Concentration

The measured CO2 concentration.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletco2v2:[UID]:BrickletCO2V2CO2Concentration
Read only:
  • Yes
Unit:
  • Parts Per Million
Range:
  • 0 Parts Per Million to 40000 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.
Temperature

The measured temperature.

Type:
  • Number:Temperature
UID:
  • tinkerforge:brickletco2v2:[UID]:BrickletCO2V2Temperature
Read only:
  • Yes
Unit:
  • Celsius
Range:
  • -40 Celsius to 120 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.
Humidity

The measured humidity.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletco2v2:[UID]:BrickletCO2V2Humidity
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.
Air Pressure

The CO2 concentration (among other things) depends on the ambient air pressure. To increase the accuracy of the CO2 Bricklet 2.0 you can set the current air pressure. You use the Barometer Bricklet 2.0 or the Air Quality Bricklet to get the current air pressure. The expected unit of the ambient air pressure value is bar. By default air pressure compensation is disabled. Once you set a value it will be used for compensation. You can turn the compensation off again by setting the value to 0. It is sufficient to update the value every few minutes.

Type:
  • Number:Pressure
UID:
  • tinkerforge:brickletco2v2:[UID]:BrickletCO2V2AirPressure
Read only:
  • No
Unit:
  • Bar
Range:
  • 0 Bar to 1.2 Bar (Step 0.001 Bar)

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

Basic Actions

brickletCO2V2GetAllValues()
Return Map:
  • co2Concentration – Type: int, Unit: 1 ppm, Range: [0 to 40000]
  • temperature – Type: int, Unit: 1/100 °C, Range: [-4000 to 12000]
  • humidity – Type: int, Unit: 1/100 %, Range: [0 to 10000]

Returns all values measured by the CO2 Bricklet 2.0.

Note

The sensor is able to messure up to 120 °C. However it is only specified up to 70 °C. Exposing the Bricklet to higher temperatures might result in permanent damage.

brickletCO2V2SetAirPressure(int airPressure)
Parameters:
  • airPressure – Type: int, Unit: 1 hPa, Range: [0, 700 to 1200], Default: 0

The CO2 concentration depends (among other things) on the ambient air pressure.

To increase the accuracy of the CO2 Bricklet 2.0 you can set the current air pressure. You use the Barometer Bricklet 2.0 or the Air Quality Bricklet to get the current air pressure.

By default air pressure compensation is disabled. Once you set a value it will be used for compensation. You can turn the compensation off again by setting the value to 0.

It is sufficient to update the value every few minutes.

brickletCO2V2GetAirPressure()
Return Map:
  • airPressure – Type: int, Unit: 1 hPa, Range: [0, 700 to 1200], Default: 0

Returns the ambient air pressure as set by Air Pressure.

brickletCO2V2GetTemperatureOffset()
Return Map:
  • offset – Type: int, Unit: 1/100 °C, Range: [0 to 216 - 1]

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

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

Returns CO2 concentration.

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

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

Returns temperature.

Note

The sensor is able to messure up to 120 °C. However it is only specified up to 70 °C. Exposing the Bricklet to higher temperatures might result in permanent damage.

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.

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

Returns relative humidity.

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.

Advanced Actions

brickletCO2V2GetChipTemperature()
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.

brickletCO2V2GetStatusLEDConfig()
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
brickletCO2V2GetSPITFPErrorCount()
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.

brickletCO2V2Reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

brickletCO2V2GetIdentity()
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. 

Internal Actions

brickletCO2V2ReadUID()
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.