Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets (Discontinued) / Dual Relay Bricklet

openHAB - Dual Relay Bricklet

Warning

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

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

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

Thing

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

Channels

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:brickletdualrelay:[UID]:BrickletDualRelayRelay1
Read only:
  • No
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:brickletdualrelay:[UID]:BrickletDualRelayRelay2
Read only:
  • No
Monoflop Relay 1

Triggers a monoflop as configured.

Type:
  • Commands (String)
UID:
  • tinkerforge:brickletdualrelay:[UID]:BrickletDualRelayMonoflopRelay1
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:brickletdualrelay:[UID]:BrickletDualRelayMonoflopRelay2
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:brickletdualrelay:[UID]")
val hwVersion = actions.brickletDualRelayGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletDualRelaySetState(boolean relay1, boolean relay2)
Parameters:
  • relay1 – Type: boolean, Default: false
  • relay2 – Type: boolean, Default: false

Sets the state of the relays, true means on and false means off. For example: (true, false) turns relay 1 on and relay 2 off.

If you just want to set one of the relays and don't know the current state of the other relay, you can get the state with Relay 1 or you can use Relay 1.

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

brickletDualRelayGetState()
Return Map:
  • relay1 – Type: boolean, Default: false
  • relay2 – Type: boolean, Default: false

Returns the state of the relays, true means on and false means off.

Advanced Actions

brickletDualRelaySetSelectedState(short relay, boolean state)
Parameters:
  • relay – Type: short, Range: [1 to 2]
  • state – Type: boolean

Sets the state of the selected relay (1 or 2), true means on and false means off.

A running monoflop timer for the selected relay will be aborted if this function is called.

The other relay remains untouched.

brickletDualRelaySetMonoflop(short relay, boolean state, long time)
Parameters:
  • relay – Type: short, Range: [1 to 2]
  • state – Type: boolean
  • time – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]

The first parameter can be 1 or 2 (relay 1 or relay 2). The second parameter is the desired state of the relay (true means on and false means off). The third parameter indicates the time that the relay should hold the state.

If this function is called with the parameters (1, true, 1500): Relay 1 will turn on and in 1.5s it will turn off again.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a Dual Relay Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The relay will be on all the time. If now the RS485 connection is lost, the relay will turn off in at most two seconds.

brickletDualRelayGetMonoflop(short relay)
Parameters:
  • relay – Type: short, Range: [1 to 2]
Return Map:
  • state – 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 relay) the current state and the time as set by Monoflop Relay 1 as well as the remaining time until the state flips.

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

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