Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets / Industrial Dual Analog In Bricklet 2.0

openHAB - Industrial Dual Analog In Bricklet 2.0

Warning

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

This is the description of the openHAB API bindings for the Industrial Dual Analog In Bricklet 2.0. General information and technical specifications for the Industrial Dual 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:brickletindustrialdualanaloginv2:[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

  • Status LED Configuration – Type: Choice, Default: Show Status
  • The status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
  • Options: Off, On, Show Heartbeat, Show Status

Channels

Voltage Channel 0

The measured voltage

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletindustrialdualanaloginv2:[UID]:BrickletIndustrialDualAnalogInV2VoltageChannel0
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.

  • LED Configuration – Type: Choice, Default: Show Channel Status
  • Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to Show Channel Status. In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.
  • Options: Off, On, Show Heartbeat, Show Channel Status

  • LED Status Mode – Type: Choice, Default: Intensity
  • For each channel you can choose between threshold and intensity mode. In threshold mode you can define a positive or a negative threshold. For a positive threshold set the \"min\" parameter to the threshold value in mV above which the LED should turn on and set the \"max\" parameter to 0. Example: If you set a positive threshold of 10V, the LED will turn on as soon as the voltage exceeds 10V and turn off again if it goes below 10V. For a negative threshold set the \"max\" parameter to the threshold value in mV below which the LED should turn on and set the \"min\" parameter to 0. Example: If you set a negative threshold of 10V, the LED will turn on as soon as the voltage goes below 10V and the LED will turn off when the voltage exceeds 10V. In intensity mode you can define a range in mV that is used to scale the brightness of the LED. Example with min=4V, max=20V: The LED is off at 4V, on at 20V and the brightness is linearly scaled between the values 4V and 20V. If the min value is greater than the max value, the LED brightness is scaled the other way around.
  • Options: Threshold, Intensity

  • LED Status Minimum – Type: integer, Default: 0, Unit: V, Min: -35, Max: 35
  • See LED Status Mode for further explaination.

  • LED Status Maximum – Type: integer, Default: 10, Unit: V, Min: -35, Max: 35
  • See LED Status Mode for further explaination.
Voltage Channel 1

The measured voltage

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletindustrialdualanaloginv2:[UID]:BrickletIndustrialDualAnalogInV2VoltageChannel1
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.

  • LED Configuration – Type: Choice, Default: Show Channel Status
  • Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to Show Channel Status. In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.
  • Options: Off, On, Show Heartbeat, Show Channel Status

  • LED Status Mode – Type: Choice, Default: Intensity
  • For each channel you can choose between threshold and intensity mode. In threshold mode you can define a positive or a negative threshold. For a positive threshold set the \"min\" parameter to the threshold value in mV above which the LED should turn on and set the \"max\" parameter to 0. Example: If you set a positive threshold of 10V, the LED will turn on as soon as the voltage exceeds 10V and turn off again if it goes below 10V. For a negative threshold set the \"max\" parameter to the threshold value in mV below which the LED should turn on and set the \"min\" parameter to 0. Example: If you set a negative threshold of 10V, the LED will turn on as soon as the voltage goes below 10V and the LED will turn off when the voltage exceeds 10V. In intensity mode you can define a range in mV that is used to scale the brightness of the LED. Example with min=4V, max=20V: The LED is off at 4V, on at 20V and the brightness is linearly scaled between the values 4V and 20V. If the min value is greater than the max value, the LED brightness is scaled the other way around.
  • Options: Threshold, Intensity

  • LED Status Minimum – Type: integer, Default: 0, Unit: V, Min: -35, Max: 35
  • See LED Status Mode for further explaination.

  • LED Status Maximum – Type: integer, Default: 10, Unit: V, Min: -35, Max: 35
  • See LED Status Mode for further explaination.

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

Basic Actions

brickletIndustrialDualAnalogInV2GetVoltage(int channel)
Parameters:
  • channel – Type: int, 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 value periodically, it is recommended to use the Voltage Channel 0 channel. You can set the channel configuration with the configuration of Voltage Channel 0.

brickletIndustrialDualAnalogInV2GetChannelLEDConfig(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 1]
Return Map:
  • config – Type: int, Range: See constants, Default: 3

Returns the channel LED configuration as set by the configuration of Voltage Channel 0

The following constants are available for this function:

For config:

  • val CHANNEL_LED_CONFIG_OFF = 0
  • val CHANNEL_LED_CONFIG_ON = 1
  • val CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
brickletIndustrialDualAnalogInV2GetChannelLEDStatusConfig(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 1]
Return Map:
  • min – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 10000
  • config – Type: int, Range: See constants, Default: 1

Returns the channel LED status configuration as set by the configuration of Voltage Channel 0.

The following constants are available for this function:

For config:

  • val CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • val CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Actions

brickletIndustrialDualAnalogInV2GetSampleRate()
Return Map:
  • rate – Type: int, 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
brickletIndustrialDualAnalogInV2GetCalibration()
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.

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

brickletIndustrialDualAnalogInV2GetChipTemperature()
Return Map:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

brickletIndustrialDualAnalogInV2GetStatusLEDConfig()
Return Map:
  • config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration

The following constants are available for this function:

For config:

  • val STATUS_LED_CONFIG_OFF = 0
  • val STATUS_LED_CONFIG_ON = 1
  • val STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val STATUS_LED_CONFIG_SHOW_STATUS = 3
brickletIndustrialDualAnalogInV2GetSPITFPErrorCount()
Return Map:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

brickletIndustrialDualAnalogInV2Reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

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

Internal Actions

brickletIndustrialDualAnalogInV2ReadUID()
Return Map:
  • uid – Type: long, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.