openHAB - Analog Out Bricklet 2.0

Bemerkung

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

This is the description of the openHAB API bindings for the Analog Out Bricklet 2.0. General information and technical specifications for the 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:brickletanalogoutv2:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:

Channels

Input Voltage

The input voltage

This channel will only update after the configured update interval, not on changed values.

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletanalogoutv2:[UID]:BrickletAnalogOutV2InputVoltage
Read only:
  • Yes
Unit:
  • Volt
Range:
  • 0 Volt to 15 Volt (Step 0.001 Volt)
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms
  • Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
Output Voltage

The output voltage. The possible range is 0V to 12V

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletanalogoutv2:[UID]:BrickletAnalogOutV2OutputVoltage
Read only:
  • No
Unit:
  • Volt
Range:
  • 0 Volt to 12 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:brickletanalogoutv2:[UID]")
val hwVersion = actions.brickletAnalogOutV2GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletAnalogOutV2SetOutputVoltage(int voltage)
Parameters:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 12000], Default: 0

Sets the voltage.

brickletAnalogOutV2GetOutputVoltage()
Return Map:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 12000], Default: 0

Returns the voltage as set by Output Voltage.

Advanced Actions

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

Returns the input voltage.

brickletAnalogOutV2GetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', '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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here