Software / API Bindings / openHAB / API Reference and Examples / Bricklets (Discontinued) / RGB LED Matrix Bricklet

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

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

Thing¶

UID:
tinkerforge:brickletrgbledmatrix:[UID]

Required firmware version:
2.0.0

Firmware update supported:
yes

Channels:
Frame Started

LED Values

Actions:
GetRed

GetGreen

GetBlue

SetRed

SetGreen

SetBlue

GetFrameDuration

DrawFrame

GetSupplyVoltage

ReadUID

GetChipTemperature

GetStatusLEDConfig

GetSPITFPErrorCount

Reset

GetIdentity

Parameters:
Frame Duration – Type: integer, Default: 0, Min: 0, Max: 65535

The frame duration in milliseconds. This configures how fast the Frame Started Channel will trigger. 0 disables the callback.

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

UID:	tinkerforge:brickletrgbledmatrix:[UID]
Required firmware version:	2.0.0
Firmware update supported:	yes
Channels:	Frame Started LED Values
Actions:	GetRed GetGreen GetBlue SetRed SetGreen SetBlue GetFrameDuration DrawFrame GetSupplyVoltage ReadUID GetChipTemperature GetStatusLEDConfig GetSPITFPErrorCount Reset GetIdentity
Parameters:	Frame Duration – Type: integer, Default: 0, Min: 0, Max: 65535 The frame duration in milliseconds. This configures how fast the Frame Started Channel will trigger. 0 disables the callback. 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¶

Frame Started¶

This channel is triggered directly after a new frame render is started. You should send the data for the next frame directly after this listener was triggered.

Type:
Trigger (system.trigger)

UID:
tinkerforge:brickletrgbledmatrix:[UID]:BrickletRGBLEDMatrixFrameStarted

Read only:
No

Type:	Trigger (system.trigger)
UID:	tinkerforge:brickletrgbledmatrix:[UID]:BrickletRGBLEDMatrixFrameStarted
Read only:	No

LED Values¶

The RGB(W) values for the LEDs.

Command format is a ','-separated list of integers. The first integer is the index of the first LED to set, additional integers are the values to set. Values are between 0 (off) and 255 (on). If the channel mapping has 3 colors, you need to give the data in the sequence R,G,B,R,G,B,R,G,B,... if the channel mapping has 4 colors you need to give data in the sequence R,G,B,W,R,G,B,W,R,G,B,W...

The data is double buffered and the colors will be transfered to the LEDs when the next frame duration ends. You can set at most 2048 RGB values or 1536 RGBW values.

For example sending 2,255,0,0,0,255,0,0,0,255 will set the LED 2 to red, LED 3 to green and LED 4 to blue.

Type:
String

UID:
tinkerforge:brickletrgbledmatrix:[UID]:BrickletRGBLEDMatrixLEDValues

Read only:
No

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

Basic Actions¶

brickletRGBLEDMatrixGetRed()¶

Return Map:	red – Type: int[], Length: 64, Range: [0 to 255], Default: {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

Returns the red LED values as set by LED Values.

brickletRGBLEDMatrixGetGreen()¶

Return Map:	green – Type: int[], Length: 64, Range: [0 to 255], Default: {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

Returns the green LED values as set by LED Values.

brickletRGBLEDMatrixGetBlue()¶

Return Map:	blue – Type: int[], Length: 64, Range: [0 to 255], Default: {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

Returns the blue LED values as set by LED Values.

brickletRGBLEDMatrixSetRed(int[] red)¶

Parameters:	red – Type: int[], Length: 64, Range: [0 to 255]

Sets the 64 red LED values of the matrix.

brickletRGBLEDMatrixSetGreen(int[] green)¶

Parameters:	green – Type: int[], Length: 64, Range: [0 to 255], Default: {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

Sets the 64 green LED values of the matrix.

brickletRGBLEDMatrixSetBlue(int[] blue)¶

Parameters:	blue – Type: int[], Length: 64, Range: [0 to 255], Default: {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

Sets the 64 blue LED values of the matrix.

brickletRGBLEDMatrixGetFrameDuration()¶

Return Map:	frameDuration – Type: int, Unit: 1 ms, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the frame duration as set by the thing configuration.

brickletRGBLEDMatrixDrawFrame()¶

If you set the frame duration to 0 (see the thing configuration), you can use this function to transfer the frame to the matrix.

Approach:

Call the thing configuration with 0.
Set LED values for first frame with LED Values, LED Values, LED Values.
Call DrawFrame().
Wait for Frame Started channel.
Set LED values for second frame with LED Values, LED Values, LED Values.
Call DrawFrame().
Wait for Frame Started channel.
and so on.

Advanced Actions¶

brickletRGBLEDMatrixGetSupplyVoltage()¶

Return Map:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

Returns the current supply voltage of the Bricklet.

brickletRGBLEDMatrixGetChipTemperature()¶

Return Map:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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.

brickletRGBLEDMatrixGetStatusLEDConfig()¶

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

brickletRGBLEDMatrixGetSPITFPErrorCount()¶

Return Map:	errorCountAckChecksum – Type: long, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: long, Range: [0 to 2³² - 1] errorCountFrame – Type: long, Range: [0 to 2³² - 1] errorCountOverflow – Type: long, Range: [0 to 2³² - 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.

brickletRGBLEDMatrixReset()¶

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!

brickletRGBLEDMatrixGetIdentity()¶

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.

Internal Actions¶

brickletRGBLEDMatrixReadUID()¶

Return Map:	uid – Type: long, Range: [0 to 2³² - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.