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

openHAB - Industrial Analog Out 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 Analog Out Bricklet 2.0. General information and technical specifications for the Industrial Analog Out 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:brickletindustrialanalogoutv2:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Output Configuration – Type: Choice, Default: Voltage
  • Sets the output configuration. As the output voltage and current level depend on each other, only one can be controlled at the same time.
  • Options: Current, Voltage

  • Voltage Range – Type: Choice, Default: 0 To 10V
  • Configures the voltage range. The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.
  • Options: 0 To 5V, 0 To 10V

  • Current Range – Type: Choice, Default: 4 To 20mA
  • Configures the current range. The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.
  • Options: 4 To 20mA, 0 To 20mA, 0 To 24mA

  • Output LED – Type: Choice, Default: Show Out Status
  • You can turn the Out LED off, on or show a heartbeat. You can also set the LED to Out 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 output value (voltage or current).
  • Options: Off, On, Show Heartbeat, Show Out Status

  • Output 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 or µA above which the LED should turn on and set the \"max\" parameter to 0. Example: If you set a positive threshold of 5V, the LED will turn on as soon as the output value exceeds 5V and turn off again if it goes below 5V. For a negative threshold set the \"max\" parameter to the threshold value in mV or µA below which the LED should turn on and set the \"min\" parameter to 0. Example: If you set a negative threshold of 5V, the LED will turn on as soon as the output value goes below 5V and the LED will turn off when the output value exceeds 5V. In intensity mode you can define a range mV or µA that is used to scale the brightness of the LED. Example with min=2V, max=8V: The LED is off at 2V and below, on at 8V and above and the brightness is linearly scaled between the values 2V and 8V. If the min value is greater than the max value, the LED brightness is scaled the other way around.
  • Options: Threshold, Intensity

  • Output LED Status Minumum – Type: decimal, Default: 0, Min: 0, Max: 10
  • See Output LED Status Mode for further explaination.

  • Output LED Status Maximum – Type: decimal, Default: 10, Min: 0, Max: 10
  • See Output LED Status Mode for further explaination.

  • 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

Output

Enables/disables the output of voltage and current.

Type:
  • Switch
UID:
  • tinkerforge:brickletindustrialanalogoutv2:[UID]:BrickletIndustrialAnalogOutV2Enabled
Read only:
  • No
Output Current

The output current. The output current and output voltage are linked. Changing the output current also changes the output voltage.

Type:
  • Number:ElectricCurrent
UID:
  • tinkerforge:brickletindustrialanalogoutv2:[UID]:BrickletIndustrialAnalogOutV2Current
Read only:
  • No
Predicate:
  • This channel will only be available if Output Configuration is Current.
Unit:
  • Ampere
Range:
  • 0 Ampere to 0.024 Ampere (Step 1e-06 Ampere)
Output Voltage

The output voltage. The output voltage and output current are linked. Changing the output voltage also changes the output current.

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletindustrialanalogoutv2:[UID]:BrickletIndustrialAnalogOutV2Voltage
Read only:
  • No
Predicate:
  • This channel will only be available if Output Configuration is Voltage.
Unit:
  • Volt
Range:
  • 0 Volt to 10 Volt (Step 0.001 Volt)

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

Basic Actions

brickletIndustrialAnalogOutV2SetEnabled(boolean enabled)
Parameters:
  • enabled – Type: boolean, Default: false

Enables/disables the output of voltage and current.

brickletIndustrialAnalogOutV2GetEnabled()
Return Map:
  • enabled – Type: boolean, Default: false

Returns true if output of voltage and current is enabled, false otherwise.

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

Returns the voltage as set by Output Voltage.

brickletIndustrialAnalogOutV2GetCurrent()
Return Map:
  • current – Type: int, Unit: 1 µA, Range: [0 to 24000]

Returns the current as set by Output Current.

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

Returns the Out LED configuration as set by the thing configuration

The following constants are available for this function:

For config:

  • val OUT_LED_CONFIG_OFF = 0
  • val OUT_LED_CONFIG_ON = 1
  • val OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
brickletIndustrialAnalogOutV2GetOutLEDStatusConfig()
Return Map:
  • min – Type: int, Range: [0 to 24000], Default: 0
  • max – Type: int, Range: [0 to 24000], Default: 10000
  • config – Type: int, Range: See constants, Default: 1

Returns the Out LED status configuration as set by the thing configuration.

The following constants are available for this function:

For config:

  • val OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • val OUT_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Actions

brickletIndustrialAnalogOutV2GetConfiguration()
Return Map:
  • voltageRange – Type: int, Range: See constants, Default: 1
  • currentRange – Type: int, Range: See constants, Default: 0

Returns the configuration as set by the thing configuration.

The following constants are available for this function:

For voltageRange:

  • val VOLTAGE_RANGE_0_TO_5V = 0
  • val VOLTAGE_RANGE_0_TO_10V = 1

For currentRange:

  • val CURRENT_RANGE_4_TO_20MA = 0
  • val CURRENT_RANGE_0_TO_20MA = 1
  • val CURRENT_RANGE_0_TO_24MA = 2
brickletIndustrialAnalogOutV2GetChipTemperature()
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.

brickletIndustrialAnalogOutV2GetStatusLEDConfig()
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
brickletIndustrialAnalogOutV2GetSPITFPErrorCount()
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.

brickletIndustrialAnalogOutV2Reset()

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!

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

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