openHAB - Industrial Quad Relay Bricklet 2.0

Warning

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

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

Relay 0

Switches Relay 0. A running monoflop timer for this relay will be aborted if the relay is toggled by this channel.

Type:
  • Switch
UID:
  • tinkerforge:brickletindustrialquadrelayv2:[UID]:BrickletIndustrialQuadRelayV2Relay0
Read only:
  • No
Parameters:
  • 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 Channel Status. In this mode the LED is on if the channel is high and off otherwise.
  • Options: Off, On, Show Heartbeat, Show Channel Status
Relay 1

Switches Relay 1. A running monoflop timer for this relay will be aborted if the relay is toggled by this channel.

Type:
  • Switch
UID:
  • tinkerforge:brickletindustrialquadrelayv2:[UID]:BrickletIndustrialQuadRelayV2Relay1
Read only:
  • No
Parameters:
  • 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 Channel Status. In this mode the LED is on if the channel is high and off otherwise.
  • Options: Off, On, Show Heartbeat, Show Channel Status
Relay 2

Switches Relay 2. A running monoflop timer for this relay will be aborted if the relay is toggled by this channel.

Type:
  • Switch
UID:
  • tinkerforge:brickletindustrialquadrelayv2:[UID]:BrickletIndustrialQuadRelayV2Relay2
Read only:
  • No
Parameters:
  • 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 Channel Status. In this mode the LED is on if the channel is high and off otherwise.
  • Options: Off, On, Show Heartbeat, Show Channel Status
Relay 3

Switches Relay 3. A running monoflop timer for this relay will be aborted if the relay is toggled by this channel.

Type:
  • Switch
UID:
  • tinkerforge:brickletindustrialquadrelayv2:[UID]:BrickletIndustrialQuadRelayV2Relay3
Read only:
  • No
Parameters:
  • 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 Channel Status. In this mode the LED is on if the channel is high and off otherwise.
  • Options: Off, On, Show Heartbeat, Show Channel Status
Monoflop Relay 0

Triggers a monoflop as configured.

Type:
  • Commands (String)
UID:
  • tinkerforge:brickletindustrialquadrelayv2:[UID]:BrickletIndustrialQuadRelayV2MonoflopRelay0
Read only:
  • No
Commands:
  • Accepts any string
Parameters:
  • Monoflop Duration – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • The time that the relay should hold the configured value.

  • Monoflop Value – Type: boolean, Default: true
  • The desired value of the relay. Activated means relay closed and deactivated means relay open.
Monoflop Relay 1

Triggers a monoflop as configured.

Type:
  • Commands (String)
UID:
  • tinkerforge:brickletindustrialquadrelayv2:[UID]:BrickletIndustrialQuadRelayV2MonoflopRelay1
Read only:
  • No
Commands:
  • Accepts any string
Parameters:
  • Monoflop Duration – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • The time that the relay should hold the configured value.

  • Monoflop Value – Type: boolean, Default: true
  • The desired value of the relay. Activated means relay closed and deactivated means relay open.
Monoflop Relay 2

Triggers a monoflop as configured.

Type:
  • Commands (String)
UID:
  • tinkerforge:brickletindustrialquadrelayv2:[UID]:BrickletIndustrialQuadRelayV2MonoflopRelay2
Read only:
  • No
Commands:
  • Accepts any string
Parameters:
  • Monoflop Duration – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • The time that the relay should hold the configured value.

  • Monoflop Value – Type: boolean, Default: true
  • The desired value of the relay. Activated means relay closed and deactivated means relay open.
Monoflop Relay 3

Triggers a monoflop as configured.

Type:
  • Commands (String)
UID:
  • tinkerforge:brickletindustrialquadrelayv2:[UID]:BrickletIndustrialQuadRelayV2MonoflopRelay3
Read only:
  • No
Commands:
  • Accepts any string
Parameters:
  • Monoflop Duration – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • The time that the relay should hold the configured value.

  • Monoflop Value – Type: boolean, Default: true
  • The desired value of the relay. Activated means relay closed and deactivated means relay open.

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

Basic Actions

brickletIndustrialQuadRelayV2SetValue(boolean[] value)
Parameters:
  • value – Type: boolean[], Length: 4

Sets the value of all four relays. A value of true closes the relay and a value of false opens the relay.

Use Relay 0 to only change one relay.

All running monoflop timers will be aborted if this function is called.

brickletIndustrialQuadRelayV2GetValue()
Return Map:
  • value – Type: boolean[], Length: 4

Returns the values as set by SetValue().

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

Returns the channel LED configuration as set by the configuration of Relay 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

Advanced Actions

brickletIndustrialQuadRelayV2SetSelectedValue(int channel, boolean value)
Parameters:
  • channel – Type: int, Range: [0 to 3]
  • value – Type: boolean

Sets the output value of the specified channel without affecting the other channels.

A running monoflop timer for the specified channel will be aborted if this function is called.

brickletIndustrialQuadRelayV2SetMonoflop(int channel, boolean value, long time)
Parameters:
  • channel – Type: int, Range: [0 to 3]
  • value – Type: boolean
  • time – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]

Configures a monoflop of the specified channel.

The second parameter is the desired value of the specified channel. A true means relay closed and a false means relay open.

The third parameter indicates the time that the channels should hold the value.

If this function is called with the parameters (0, 1, 1500) channel 0 will close and in 1.5s channel 0 will open again

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Industrial Quad Relay Bricklet 2.0 connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and channel 0 closed. Channel 0 will be closed all the time. If now the RS485 connection is lost, then channel 0 will be opened in at most two seconds.

brickletIndustrialQuadRelayV2GetMonoflop(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 3]
Return Map:
  • value – Type: boolean
  • time – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]
  • timeRemaining – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]

Returns (for the given channel) the current value and the time as set by Monoflop Relay 0 as well as the remaining time until the value flips.

If the timer is not running currently, the remaining time will be returned as 0.

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

brickletIndustrialQuadRelayV2GetStatusLEDConfig()
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
brickletIndustrialQuadRelayV2GetSPITFPErrorCount()
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.

brickletIndustrialQuadRelayV2Reset()

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!

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

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