openHAB - Industrial Analog Out Bricklet

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

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

Thing

UID:
  • tinkerforge:brickletindustrialanalogout:[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

Channels

Output Enabled

Enables/disables the output of voltage and current.

Type:
  • Switch
UID:
  • tinkerforge:brickletindustrialanalogout:[UID]:BrickletIndustrialAnalogOutEnabled
Read only:
  • No
Output Current

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

Type:
  • Number:ElectricCurrent
UID:
  • tinkerforge:brickletindustrialanalogout:[UID]:BrickletIndustrialAnalogOutCurrent
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 in V. The output voltage and output current are linked. Changing the output voltage also changes the output current.

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

Basic Actions

brickletIndustrialAnalogOutEnable()

Enables the output of voltage and current.

The default is disabled.

brickletIndustrialAnalogOutDisable()

Disables the output of voltage and current.

The default is disabled.

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

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

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

Returns the voltage as set by Output Voltage.

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

Returns the current as set by Output Current.

Advanced Actions

brickletIndustrialAnalogOutGetConfiguration()
Return Map:
  • voltageRange – Type: short, Range: See constants, Default: 1
  • currentRange – Type: short, 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
brickletIndustrialAnalogOutGetIdentity()
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