openHAB - Analog In Bricklet

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

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

Thing

UID:
  • tinkerforge:brickletanalogin:[UID]
Required firmware version:
  • 2.0.3
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Average Length – Type: integer, Default: 50, Min: 0, Max: 255
  • The length of a averaging for the voltage value. Setting the length to 0 will turn the averaging completely off. If the averaging is off, there is more noise on the data, but the data is without delay.

  • Measurement Range – Type: Choice, Default: Automatic
  • The measurement range. Possible ranges are:
    • Automatically switched
    • 0V - 6.05V, ~1.48mV resolution
    • 0V - 10.32V, ~2.52mV resolution
    • 0V - 36.30V, ~8.86mV resolution
    • - 45.00V, ~11.25mV resolution
    • 0V - 3.3V, ~0.81mV resolution
    • Options: Automatic, Up To 6V, Up To 10V, Up To 36V, Up To 45V, Up To 3V

Channels

Voltage

The measured voltage

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletanalogin:[UID]:BrickletAnalogInVoltage
Read only:
  • Yes
Unit:
  • Volt
Range:
  • 0 Volt to 45 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.

Note

The value returned by Get Voltage() 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:brickletanalogin:[UID]:BrickletAnalogInAnalogValue
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:brickletanalogin:[UID]")
val hwVersion = actions.brickletAnalogInGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

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

Returns the voltage of the sensor. The resolution between 0 and 6V is about 2mV. Between 6 and 45V the resolution is about 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.

brickletAnalogInGetRange()
Return Map:
  • range – Type: short, Range: See constants, Default: 0

Returns the measurement range as set by the thing configuration.

The following constants are available for this function:

For range:

  • val RANGE_AUTOMATIC = 0
  • val RANGE_UP_TO_6V = 1
  • val RANGE_UP_TO_10V = 2
  • val RANGE_UP_TO_36V = 3
  • val RANGE_UP_TO_45V = 4
  • val RANGE_UP_TO_3V = 5

New in version 2.0.1 (Plugin).

Advanced Actions

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

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

Note

The value returned by Voltage 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.

brickletAnalogInGetAveraging()
Return Map:
  • average – Type: short, Range: [0 to 255], Default: 50

Returns the averaging configuration as set by the thing configuration.

New in version 2.0.3 (Plugin).

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