Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets / Distance IR Bricklet

openHAB - Distance IR Bricklet

Bemerkung

Die openHAB-Dokumentation ist nur auf Englisch verfügbar.

Warnung

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

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

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

Thing

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

Channels

Distance

The measured distance

Type:
  • Number:Length
UID:
  • tinkerforge:brickletdistanceir:[UID]:BrickletDistanceIRDistance
Read only:
  • Yes
Unit:
  • Meter
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.

Bemerkung

The value returned by Get Distance() is averaged over several samples to yield less noise, while Get Analog Value() gives back raw unfiltered analog values. The only reason to use Get Analog Value() is, if you need the full resolution of the analog-to-digital converter.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletdistanceir:[UID]:BrickletDistanceIRAnalogValue
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:brickletdistanceir:[UID]")
val hwVersion = actions.brickletDistanceIRGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletDistanceIRGetDistance()
Return Map:
  • distance – Type: int, Unit: 1 mm, Range: [0 to 216 - 1]

Returns the distance measured by the sensor. Possible distance ranges are 40 to 300, 100 to 800 and 200 to 1500, depending on the selected IR sensor.

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

Advanced Actions

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

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

Bemerkung

The value returned by Distance is averaged over several samples to yield less noise, while Analog Value gives back raw unfiltered analog values. The only reason to use Analog Value is, if you need the full resolution of the analog-to-digital converter.

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.

brickletDistanceIRGetSamplingPoint(short position)
Parameters:
  • position – Type: short, Range: [0 to 127]
Return Map:
  • distance – Type: int, Unit: 1/10 mm, Range: [0 to 216 - 1]

Returns the distance to a sampling point position as set by This function is not available in openHAB. Please use Brick Viewer to change persistant device settings.

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