openHAB - Industrial Dual 0-20mA Bricklet

This is the description of the openHAB API bindings for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA Bricklet are summarized in its hardware description.

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

Thing

UID:
  • tinkerforge:brickletindustrialdual020ma:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Sample Rate – Type: Choice, Default: 4 SPS
  • The sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.
  • Options: 240 SPS, 60 SPS, 15 SPS, 4 SPS

Channels

Current Sensor 0

The measured current between 0 and 0.022505322A (22.5mA)

Type:
  • Number:ElectricCurrent
UID:
  • tinkerforge:brickletindustrialdual020ma:[UID]:BrickletIndustrialDual020mACurrentSensor0
Read only:
  • Yes
Unit:
  • Ampere
Range:
  • 0 Ampere to 0.022505322 Ampere (Step 1e-09 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.
Current Sensor 1

The measured current between 0 and 0.022505322A (22.5mA)

Type:
  • Number:ElectricCurrent
UID:
  • tinkerforge:brickletindustrialdual020ma:[UID]:BrickletIndustrialDual020mACurrentSensor1
Read only:
  • Yes
Unit:
  • Ampere
Range:
  • 0 Ampere to 0.022505322 Ampere (Step 1e-09 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.

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

Basic Actions

brickletIndustrialDual020mAGetCurrent(short sensor)
Parameters:
  • sensor – Type: short, Range: [0 to 1]
Return Map:
  • current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

Returns the current of the specified sensor.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works properly.

If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.

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

Advanced Actions

brickletIndustrialDual020mAGetSampleRate()
Return Map:
  • rate – Type: short, Range: See constants, Default: 3

Returns the sample rate as set by the thing configuration.

The following constants are available for this function:

For rate:

  • val SAMPLE_RATE_240_SPS = 0
  • val SAMPLE_RATE_60_SPS = 1
  • val SAMPLE_RATE_15_SPS = 2
  • val SAMPLE_RATE_4_SPS = 3
brickletIndustrialDual020mAGetIdentity()
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