openHAB - Industrial Dual Analog In Bricklet

Bemerkung

Zur Zeit ist nur die englische openHAB-Dokumentation verfügbar.

This is the description of the openHAB API bindings for the Industrial Dual Analog In Bricklet. General information and technical specifications for the Industrial Dual 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:brickletindustrialdualanalogin:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Sample Rate – Type: Choice, Default: 2 SPS
  • The voltage measurement sample rate. Decreasing the sample rate will also decrease the noise on the data.
  • Options: 976 SPS, 488 SPS, 244 SPS, 122 SPS, 61 SPS, 4 SPS, 2 SPS, 1 SPS

Channels

Voltage Channel 0

The measured voltage between -35 and 35 V

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletindustrialdualanalogin:[UID]:BrickletIndustrialDualAnalogInVoltageChannel0
Read only:
  • Yes
Unit:
  • Volt
Range:
  • -35 Volt to 35 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.
Voltage Channel 1

The measured voltage between -35 and 35 V

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletindustrialdualanalogin:[UID]:BrickletIndustrialDualAnalogInVoltageChannel1
Read only:
  • Yes
Unit:
  • Volt
Range:
  • -35 Volt to 35 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.

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

Basic Actions

brickletIndustrialDualAnalogInGetVoltage(short channel)
Parameters:
  • channel – Type: short, Range: [0 to 1]
Return Map:
  • voltage – Type: int, Unit: 1 mV, Range: [-35000 to 35000]

Returns the voltage for the given channel.

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

Advanced Actions

brickletIndustrialDualAnalogInGetSampleRate()
Return Map:
  • rate – Type: short, Range: See constants, Default: 6

Returns the sample rate as set by the thing configuration.

The following constants are available for this function:

For rate:

  • val SAMPLE_RATE_976_SPS = 0
  • val SAMPLE_RATE_488_SPS = 1
  • val SAMPLE_RATE_244_SPS = 2
  • val SAMPLE_RATE_122_SPS = 3
  • val SAMPLE_RATE_61_SPS = 4
  • val SAMPLE_RATE_4_SPS = 5
  • val SAMPLE_RATE_2_SPS = 6
  • val SAMPLE_RATE_1_SPS = 7
brickletIndustrialDualAnalogInGetCalibration()
Return Map:
  • offset – Type: int[], Length: 2, Range: [-223 to 223 - 1]
  • gain – Type: int[], Length: 2, Range: [-223 to 223 - 1]

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

brickletIndustrialDualAnalogInGetADCValues()
Return Map:
  • value – Type: int[], Length: 2, Range: [-223 to 223 - 1]

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see This function is not available in openHAB. Please use Brick Viewer to change persistant device settings.

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