Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets / RGB LED Button Bricklet

openHAB - RGB LED Button Bricklet

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 RGB LED Button Bricklet. General information and technical specifications for the RGB LED 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:brickletrgbledbutton:[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

LED Color

The color of the LED.

Type:
  • Color - Only HSBType commands are accepted. Updating the brightness without changing the hue (e.g. by sending a PercentType) may fail.
UID:
  • tinkerforge:brickletrgbledbutton:[UID]:BrickletRGBLEDButtonColor
Read only:
  • No
Button

This channel triggers if the button is pressed or released

Type:
  • Trigger (system.rawbutton)
UID:
  • tinkerforge:brickletrgbledbutton:[UID]:BrickletRGBLEDButtonButton
Read only:
  • No

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

Basic Actions

brickletRGBLEDButtonGetColor()
Return Map:
  • red – Type: int, Range: [0 to 255], Default: 0
  • green – Type: int, Range: [0 to 255], Default: 0
  • blue – Type: int, Range: [0 to 255], Default: 0

Returns the LED color as set by LED Color.

brickletRGBLEDButtonGetButtonState()
Return Map:
  • state – Type: int, Range: See constants

Returns the current state of the button (either pressed or released).

The following constants are available for this function:

For state:

  • val BUTTON_STATE_PRESSED = 0
  • val BUTTON_STATE_RELEASED = 1
brickletRGBLEDButtonGetColorCalibration()
Return Map:
  • red – Type: int, Unit: 1 %, Range: [0 to 100], Default: 100
  • green – Type: int, Unit: 1 %, Range: [0 to 100], Default: 100
  • blue – Type: int, Unit: 1 %, Range: [0 to 100], Default: 55

Returns the color calibration as set by This function is not available in openHAB. Please use Brick Viewer to change persistant device settings.

brickletRGBLEDButtonSetColor(int red, int green, int blue)
Parameters:
  • red – Type: int, Range: [0 to 255], Default: 0
  • green – Type: int, Range: [0 to 255], Default: 0
  • blue – Type: int, Range: [0 to 255], Default: 0

Sets the color of the LED.

Advanced Actions

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

brickletRGBLEDButtonGetStatusLEDConfig()
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
brickletRGBLEDButtonGetSPITFPErrorCount()
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.

brickletRGBLEDButtonReset()

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!

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

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