Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets / Industrial Dual 0-20mA Bricklet 2.0

openHAB - Industrial Dual 0-20mA Bricklet 2.0

Bemerkung

Die openHAB-Dokumentation ist nur auf Englisch verfügbar.

Warnung

The openHAB bindings are still in beta, but the development was stopped.

This is the description of the openHAB API bindings for the Industrial Dual 0-20mA Bricklet 2.0. General information and technical specifications for the Industrial Dual 0-20mA 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:brickletindustrialdual020mav2:[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

  • Gain – Type: Choice, Default: 1x
  • The gain between 1x and 8x. If you want to measure a very small current, you can increase the gain to get some more resolution. Example: If you measure 0.5mA with a gain of 8x the return value will be 4mA.
  • Options: 1x, 2x, 4x, 8x

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

Current Sensor 0

The measured current of the 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.

Type:
  • Number:ElectricCurrent
UID:
  • tinkerforge:brickletindustrialdual020mav2:[UID]:BrickletIndustrialDual020mAV2CurrentSensor0
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.

  • LED Configuration – Type: Choice, Default: Show Channel Status
  • Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to Show Channel Status. In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.
  • Options: Off, On, Show Heartbeat, Show Channel Status

  • LED Status Mode – Type: Choice, Default: Intensity
  • For each channel you can choose between threshold and intensity mode. In threshold mode you can define a positive or a negative threshold. For a positive threshold set the \"min\" parameter to the threshold value in nA above which the LED should turn on and set the \"max\" parameter to 0. Example: If you set a positive threshold of 10mA, the LED will turn on as soon as the current exceeds 10mA and turn off again if it goes below 10mA. For a negative threshold set the \"max\" parameter to the threshold value in nA below which the LED should turn on and set the \"min\" parameter to 0. Example: If you set a negative threshold of 10mA, the LED will turn on as soon as the current goes below 10mA and the LED will turn off when the current exceeds 10mA. In intensity mode you can define a range in nA that is used to scale the brightness of the LED. Example with min=4mA and max=20mA: The LED is off at 4mA and below, on at 20mA and above and the brightness is linearly scaled between the values 4mA and 20mA. If the min value is greater than the max value, the LED brightness is scaled the other way around.
  • Options: Threshold, Intensity

  • LED Status Minimum – Type: integer, Default: 0, Unit: V, Min: -35, Max: 35
  • See LED Status Mode for further explaination.

  • LED Status Maximum – Type: integer, Default: 10, Unit: V, Min: -35, Max: 35
  • See LED Status Mode for further explaination.
Current Sensor 1

The measured current of the 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.

Type:
  • Number:ElectricCurrent
UID:
  • tinkerforge:brickletindustrialdual020mav2:[UID]:BrickletIndustrialDual020mAV2CurrentSensor1
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.

  • LED Configuration – Type: Choice, Default: Show Channel Status
  • Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to Show Channel Status. In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.
  • Options: Off, On, Show Heartbeat, Show Channel Status

  • LED Status Mode – Type: Choice, Default: Intensity
  • For each channel you can choose between threshold and intensity mode. In threshold mode you can define a positive or a negative threshold. For a positive threshold set the \"min\" parameter to the threshold value in nA above which the LED should turn on and set the \"max\" parameter to 0. Example: If you set a positive threshold of 10mA, the LED will turn on as soon as the current exceeds 10mA and turn off again if it goes below 10mA. For a negative threshold set the \"max\" parameter to the threshold value in nA below which the LED should turn on and set the \"min\" parameter to 0. Example: If you set a negative threshold of 10mA, the LED will turn on as soon as the current goes below 10mA and the LED will turn off when the current exceeds 10mA. In intensity mode you can define a range in nA that is used to scale the brightness of the LED. Example with min=4mA and max=20mA: The LED is off at 4mA and below, on at 20mA and above and the brightness is linearly scaled between the values 4mA and 20mA. If the min value is greater than the max value, the LED brightness is scaled the other way around.
  • Options: Threshold, Intensity

  • LED Status Minimum – Type: integer, Default: 0, Unit: V, Min: -35, Max: 35
  • See LED Status Mode for further explaination.

  • LED Status Maximum – Type: integer, Default: 10, Unit: V, Min: -35, Max: 35
  • See LED Status Mode for further explaination.

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

Basic Actions

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

Returns the current of the specified channel.

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

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

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

brickletIndustrialDual020mAV2GetChannelLEDConfig(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 1]
Return Map:
  • config – Type: int, Range: See constants, Default: 3

Returns the channel LED configuration as set by the configuration of Current Sensor 0

The following constants are available for this function:

For config:

  • val CHANNEL_LED_CONFIG_OFF = 0
  • val CHANNEL_LED_CONFIG_ON = 1
  • val CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
brickletIndustrialDual020mAV2GetChannelLEDStatusConfig(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 1]
Return Map:
  • min – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 4000000
  • max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 20000000
  • config – Type: int, Range: See constants, Default: 1

Returns the channel LED status configuration as set by the configuration of Current Sensor 0.

The following constants are available for this function:

For config:

  • val CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • val CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Actions

brickletIndustrialDual020mAV2GetSampleRate()
Return Map:
  • rate – Type: int, 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
brickletIndustrialDual020mAV2GetGain()
Return Map:
  • gain – Type: int, Range: See constants, Default: 0

Returns the gain as set by the thing configuration.

The following constants are available for this function:

For gain:

  • val GAIN_1X = 0
  • val GAIN_2X = 1
  • val GAIN_4X = 2
  • val GAIN_8X = 3
brickletIndustrialDual020mAV2GetChipTemperature()
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.

brickletIndustrialDual020mAV2GetStatusLEDConfig()
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
brickletIndustrialDual020mAV2GetSPITFPErrorCount()
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.

brickletIndustrialDual020mAV2Reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

brickletIndustrialDual020mAV2GetIdentity()
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 at position 'z'.

The device identifier numbers can be found here. 

Internal Actions

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