Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets / Dust Detector Bricklet

openHAB - Dust Detector Bricklet

Warning

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

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

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

Thing

UID:
  • tinkerforge:brickletdustdetector:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Moving Average Length – Type: integer, Default: 100, Min: 0, Max: 100
  • The length of a moving averaging for the dust density. Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.

Channels

Dust Density

The measured dust density

Type:
  • Number:Density
UID:
  • tinkerforge:brickletdustdetector:[UID]:BrickletDustDetectorDustDensity
Read only:
  • Yes
Unit:
  • Microgram Per Cubicmetre
Range:
  • 0 Microgram Per Cubicmetre to 500 Microgram Per Cubicmetre (Step 1 Microgram Per Cubicmetre)
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:brickletdustdetector:[UID]")
val hwVersion = actions.brickletDustDetectorGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletDustDetectorGetDustDensity()
Return Map:
  • dustDensity – Type: int, Unit: 1 µg/m³, Range: [0 to 500]

Returns the dust density.

If you want to get the dust density periodically, it is recommended to use the Dust Density channel and set the period with the configuration of Dust Density.

Advanced Actions

brickletDustDetectorGetMovingAverage()
Return Map:
  • average – Type: short, Range: [0 to 100], Default: 100

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

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