openHAB - Voltage/Current Bricklet 2.0

This is the description of the openHAB API bindings for the Voltage/Current Bricklet 2.0. General information and technical specifications for the Voltage/Current 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:brickletvoltagecurrentv2:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Averaging – Type: Choice, Default: 64
  • Configures the number of samples to average over.
  • Options: 1, 4, 16, 64, 128, 256, 512, 1024

  • Voltage Conversion Time – Type: Choice, Default: 1.1ms
  • Configures the voltage conversion time.
  • Options: 140µs, 204µs, 332µs, 588µs, 1.1ms, 2.116ms, 4.156ms, 8.244ms

  • Current Conversion Time – Type: Choice, Default: 1.1ms
  • Configures the current conversion time.
  • Options: 140µs, 204µs, 332µs, 588µs, 1.1ms, 2.116ms, 4.156ms, 8.244ms

  • Status LED Config – 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

Measured Current

The measured current between -20 and 20A.

Type:
  • Number:ElectricCurrent
UID:
  • tinkerforge:brickletvoltagecurrentv2:[UID]:BrickletVoltageCurrentV2Current
Read only:
  • Yes
Unit:
  • Ampere
Range:
  • -20 Ampere to 20 Ampere (Step 0.001 Ampere)
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.
Measured Voltage

The measured voltage between 0 and 36V.

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletvoltagecurrentv2:[UID]:BrickletVoltageCurrentV2Voltage
Read only:
  • Yes
Unit:
  • Volt
Range:
  • 0 Volt to 36 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.
Measured Power

The measured power between 0 and 720W.

Type:
  • Number:Power
UID:
  • tinkerforge:brickletvoltagecurrentv2:[UID]:BrickletVoltageCurrentV2Power
Read only:
  • Yes
Unit:
  • Watt
Range:
  • 0 Watt to 720 Watt (Step 0.001 Watt)
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:brickletvoltagecurrentv2:[UID]")
val hwVersion = actions.brickletVoltageCurrentV2GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

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

Returns the voltage.

If you want to get the value periodically, it is recommended to use the Measured Voltage channel. You can set the channel configuration with the configuration of Measured Voltage.

brickletVoltageCurrentV2GetCurrent()
Return Map:
  • current – Type: int, Unit: 1 mA, Range: [-20000 to 20000]

Returns the current.

If you want to get the value periodically, it is recommended to use the Measured Current channel. You can set the channel configuration with the configuration of Measured Current.

brickletVoltageCurrentV2GetPower()
Return Map:
  • power – Type: int, Unit: 1 mW, Range: [0 to 720000]

Returns the power.

If you want to get the value periodically, it is recommended to use the Measured Power channel. You can set the channel configuration with the configuration of Measured Power.

brickletVoltageCurrentV2GetConfiguration()
Return Map:
  • averaging – Type: int, Range: See constants, Default: 3
  • voltageConversionTime – Type: int, Range: See constants, Default: 4
  • currentConversionTime – Type: int, Range: See constants, Default: 4

Returns the configuration as set by the thing configuration.

The following constants are available for this function:

For averaging:

  • val AVERAGING_1 = 0
  • val AVERAGING_4 = 1
  • val AVERAGING_16 = 2
  • val AVERAGING_64 = 3
  • val AVERAGING_128 = 4
  • val AVERAGING_256 = 5
  • val AVERAGING_512 = 6
  • val AVERAGING_1024 = 7

For voltageConversionTime:

  • val CONVERSION_TIME_140US = 0
  • val CONVERSION_TIME_204US = 1
  • val CONVERSION_TIME_332US = 2
  • val CONVERSION_TIME_588US = 3
  • val CONVERSION_TIME_1_1MS = 4
  • val CONVERSION_TIME_2_116MS = 5
  • val CONVERSION_TIME_4_156MS = 6
  • val CONVERSION_TIME_8_244MS = 7

For currentConversionTime:

  • val CONVERSION_TIME_140US = 0
  • val CONVERSION_TIME_204US = 1
  • val CONVERSION_TIME_332US = 2
  • val CONVERSION_TIME_588US = 3
  • val CONVERSION_TIME_1_1MS = 4
  • val CONVERSION_TIME_2_116MS = 5
  • val CONVERSION_TIME_4_156MS = 6
  • val CONVERSION_TIME_8_244MS = 7

Advanced Actions

brickletVoltageCurrentV2GetCalibration()
Return Map:
  • voltageMultiplier – Type: int, Range: [0 to 216 - 1]
  • voltageDivisor – Type: int, Range: [0 to 216 - 1]
  • currentMultiplier – Type: int, Range: [0 to 216 - 1]
  • currentDivisor – Type: int, Range: [0 to 216 - 1]

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

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

brickletVoltageCurrentV2GetStatusLEDConfig()
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
brickletVoltageCurrentV2GetSPITFPErrorCount()
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.

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

Internal Actions

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