openHAB - RGB LED 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 Bricklet. General information and technical specifications for the RGB LED Bricklet are summarized in its hardware description.

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

Thing¶

UID:
tinkerforge:brickletrgbled:[UID]

Required firmware version:
2.0.0

Firmware update supported:
yes

Channels:
LED Color

Actions:
SetRGBValue

GetRGBValue

GetIdentity

UID:	tinkerforge:brickletrgbled:[UID]
Required firmware version:	2.0.0
Firmware update supported:	yes
Channels:	LED Color
Actions:	SetRGBValue GetRGBValue GetIdentity

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:brickletrgbled:[UID]:BrickletRGBLEDColor

Read only:
No

Type:	Color - Only HSBType commands are accepted. Updating the brightness without changing the hue (e.g. by sending a PercentType) may fail.
UID:	tinkerforge:brickletrgbled:[UID]:BrickletRGBLEDColor
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:brickletrgbled:[UID]")
val hwVersion = actions.brickletRGBLEDGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions¶

brickletRGBLEDSetRGBValue(short r, short g, short b)¶

Parameters:	r – Type: short, Range: [0 to 255], Default: 0 g – Type: short, Range: [0 to 255], Default: 0 b – Type: short, Range: [0 to 255], Default: 0

Sets the r, g and b values for the LED.

brickletRGBLEDGetRGBValue()¶

Return Map:	r – Type: short, Range: [0 to 255], Default: 0 g – Type: short, Range: [0 to 255], Default: 0 b – Type: short, Range: [0 to 255], Default: 0

Returns the r, g and b values of the LED as set by LED Color.

Advanced Actions¶

brickletRGBLEDGetIdentity()¶

Return Map:

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 2¹⁶ - 1]

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 2¹⁶ - 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.