openHAB - Current12 Bricklet

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

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

Thing

UID:
  • tinkerforge:brickletcurrent12:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:

Channels

Current

The measured current.

Type:
  • Number:ElectricCurrent
UID:
  • tinkerforge:brickletcurrent12:[UID]:BrickletCurrent12Current
Read only:
  • Yes
Unit:
  • Ampere
Range:
  • -12.5 Ampere to 12.5 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.
Over Current

Enabled if more than 12.5A were measured. To reset this value you have to power cycle the Bricklet.

Type:
  • Switch
UID:
  • tinkerforge:brickletcurrent12:[UID]:BrickletCurrent12OverCurrent
Read only:
  • No
Analog Value

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by Get Current() is averaged over several samples to yield less noise, while Get Analog Value() gives back raw unfiltered analog values. The only reason to use Get Analog Value() is, if you need the full resolution of the analog-to-digital converter.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletcurrent12:[UID]:BrickletCurrent12AnalogValue
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)
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:brickletcurrent12:[UID]")
val hwVersion = actions.brickletCurrent12GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletCurrent12GetCurrent()
Return Map:
  • current – Type: short, Unit: 1 mA, Range: [-12500 to 12500]

Returns the current of the sensor.

If you want to get the current periodically, it is recommended to use the Current channel and set the period with the configuration of Current.

Advanced Actions

brickletCurrent12IsOverCurrent()
Return Map:
  • over – Type: boolean

Returns true if more than 12.5A were measured.

Note

To reset this value you have to power cycle the Bricklet.

brickletCurrent12GetAnalogValue()
Return Map:
  • value – Type: int, Range: [0 to 212 - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by Current is averaged over several samples to yield less noise, while Analog Value gives back raw unfiltered analog values. The only reason to use Analog Value is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the Analog Value channel and set the period with the configuration of Analog Value.

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