Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets (Discontinued) / Analog In Bricklet 2.0

openHAB - Analog In Bricklet 2.0

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 Analog In Bricklet 2.0. General information and technical specifications for the Analog In 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:brickletanaloginv2:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Moving Average Length – Type: integer, Default: 50, Min: 1, Max: 50
  • The length of a moving averaging for the voltage. Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

Channels

Voltage

The measured voltage

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletanaloginv2:[UID]:BrickletAnalogInV2Voltage
Read only:
  • Yes
Unit:
  • Volt
Range:
  • 0 Volt to 42 Volt (Step 0.001 Volt)
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.

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

Basic Actions

brickletAnalogInV2GetVoltage()
Return Map:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 42000]

Returns the measured voltage. The resolution is approximately 10mV.

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

Advanced Actions

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

Returns the value as read by a 12-bit 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.

brickletAnalogInV2GetMovingAverage()
Return Map:
  • average – Type: short, Range: [1 to 50], Default: 50

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

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