openHAB - Dual Button Bricklet

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

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

Thing

UID:
  • tinkerforge:brickletdualbutton:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Left LED State – Type: Choice, Default: Auto Toggle - Default Off
    • Auto Toggle - Default On: Enables auto toggle. LED initially enabled
    • Auto Toggle - Default Off: Enables auto toggle. LED initially disabled
    • Channel - Default On: Creates a control channel. LED initially enabled.
    • Channel - Default Off: Creates a control channel. LED initially disabled.
  • Options: Auto Toggle - Default On, Auto Toggle - Default Off, Channel - Default On, Channel - Default Off

  • Right LED State – Type: Choice, Default: Auto Toggle - Default Off
    • Auto Toggle - Default On: Enables auto toggle. LED initially enabled
    • Auto Toggle - Default Off: Enables auto toggle. LED initially disabled
    • Channel - Default On: Creates a control channel. LED initially enabled.
    • Channel - Default Off: Creates a control channel. LED initially disabled.
  • Options: Auto Toggle - Default On, Auto Toggle - Default Off, Channel - Default On, Channel - Default Off

Channels

Left Button

This channel triggers if the right button is pressed or released

Type:
  • Trigger (system.rawbutton)
UID:
  • tinkerforge:brickletdualbutton:[UID]:BrickletDualButtonLeftButton
Read only:
  • No
Right Button

This channel triggers if the right button is pressed or released

Type:
  • Trigger (system.rawbutton)
UID:
  • tinkerforge:brickletdualbutton:[UID]:BrickletDualButtonRightButton
Read only:
  • No
Left LED

Controls the left LED.

Type:
  • Switch
UID:
  • tinkerforge:brickletdualbutton:[UID]:BrickletDualButtonLeftLED
Read only:
  • No
Predicate:
  • This channel will only be available if Left LED State is one of Channel - Default On, Channel - Default Off.
Right LED

Controls the right LED.

Type:
  • Switch
UID:
  • tinkerforge:brickletdualbutton:[UID]:BrickletDualButtonRightLED
Read only:
  • No
Predicate:
  • This channel will only be available if Right LED State is one of Channel - Default On, Channel - Default Off.

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

Basic Actions

brickletDualButtonGetLEDState()
Return Map:
  • ledL – Type: short, Range: See constants, Default: 1
  • ledR – Type: short, Range: See constants, Default: 1

Returns the current state of the LEDs, as set by the thing configuration.

The following constants are available for this function:

For ledL:

  • val LED_STATE_AUTO_TOGGLE_ON = 0
  • val LED_STATE_AUTO_TOGGLE_OFF = 1
  • val LED_STATE_ON = 2
  • val LED_STATE_OFF = 3

For ledR:

  • val LED_STATE_AUTO_TOGGLE_ON = 0
  • val LED_STATE_AUTO_TOGGLE_OFF = 1
  • val LED_STATE_ON = 2
  • val LED_STATE_OFF = 3
brickletDualButtonGetButtonState()
Return Map:
  • buttonL – Type: short, Range: See constants
  • buttonR – Type: short, Range: See constants

Returns the current state for both buttons. Possible states are:

  • 0 = pressed
  • 1 = released

The following constants are available for this function:

For buttonL:

  • val BUTTON_STATE_PRESSED = 0
  • val BUTTON_STATE_RELEASED = 1

For buttonR:

  • val BUTTON_STATE_PRESSED = 0
  • val BUTTON_STATE_RELEASED = 1

Advanced Actions

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