openHAB - Dual Button Bricklet 2.0

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

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

Left Button

This channel triggers if the left button is pressed or released

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

This channel triggers if the right button is pressed or released

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

Controls the left LED.

Type:
  • Switch
UID:
  • tinkerforge:brickletdualbuttonv2:[UID]:BrickletDualButtonV2LeftLED
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:brickletdualbuttonv2:[UID]:BrickletDualButtonV2RightLED
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:brickletdualbuttonv2:[UID]")
val hwVersion = actions.brickletDualButtonV2GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletDualButtonV2GetLEDState()
Return Map:
  • ledL – Type: int, Range: See constants, Default: 1
  • ledR – Type: int, 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
brickletDualButtonV2GetButtonState()
Return Map:
  • buttonL – Type: int, Range: See constants
  • buttonR – Type: int, 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

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

brickletDualButtonV2GetStatusLEDConfig()
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
brickletDualButtonV2GetSPITFPErrorCount()
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.

brickletDualButtonV2GetIdentity()
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 as position 'z'.

The device identifier numbers can be found here

Internal Actions

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