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

Delphi/Lazarus - RGB LED Matrix Bricklet¶

This is the description of the Delphi/Lazarus 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 Delphi/Lazarus API bindings is part of their general description.

API¶

Since Delphi does not support multiple return values directly, we use the out keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions¶

constructor TBrickletRGBLEDMatrix.Create(const uid: string; ipcon: TIPConnection)¶

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	rgbLEDMatrix – Type: TBrickletRGBLEDMatrix

Creates an object with the unique device ID uid:

rgbLEDMatrix := TBrickletRGBLEDMatrix.Create('YOUR_DEVICE_UID', ipcon);

This object can then be used after the IP Connection is connected.

procedure TBrickletRGBLEDMatrix.SetRed(const red: array [0..63] of byte)¶

Parameters:	red – Type: array [0..63] of byte, Range: [0 to 255]

Sets the 64 red LED values of the matrix.

function TBrickletRGBLEDMatrix.GetRed: array [0..63] of byte¶

Returns:	red – Type: array [0..63] of byte, 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 SetRed.

procedure TBrickletRGBLEDMatrix.SetGreen(const green: array [0..63] of byte)¶

Parameters:	green – Type: array [0..63] of byte, 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.

function TBrickletRGBLEDMatrix.GetGreen: array [0..63] of byte¶

Returns:	green – Type: array [0..63] of byte, 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 SetGreen.

procedure TBrickletRGBLEDMatrix.SetBlue(const blue: array [0..63] of byte)¶

Parameters:	blue – Type: array [0..63] of byte, 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.

function TBrickletRGBLEDMatrix.GetBlue: array [0..63] of byte¶

Returns:	blue – Type: array [0..63] of byte, 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 SetBlue.

procedure TBrickletRGBLEDMatrix.SetFrameDuration(const frameDuration: word)¶

Parameters:	frameDuration – Type: word, Unit: 1 ms, Range: [0 to 2¹⁶ - 1], Default: 0

Sets the frame duration.

Example: If you want to achieve 20 frames per second, you should set the frame duration to 50ms (50ms * 20 = 1 second).

Set this value to 0 to turn the automatic frame write mechanism off.

Approach:

Call SetFrameDuration with value > 0.
Set LED values for first frame with SetRed, SetGreen, SetBlue.
Wait for OnFrameStarted callback.
Set LED values for second frame with SetRed, SetGreen, SetBlue.
Wait for OnFrameStarted callback.
and so on.

For frame duration of 0 see DrawFrame.

function TBrickletRGBLEDMatrix.GetFrameDuration: word¶

Returns:	frameDuration – Type: word, Unit: 1 ms, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the frame duration as set by SetFrameDuration.

procedure TBrickletRGBLEDMatrix.DrawFrame¶

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

Approach:

Call SetFrameDuration with 0.
Set LED values for first frame with SetRed, SetGreen, SetBlue.
Call DrawFrame.
Wait for OnFrameStarted callback.
Set LED values for second frame with SetRed, SetGreen, SetBlue.
Call DrawFrame.
Wait for OnFrameStarted callback.
and so on.

Advanced Functions¶

function TBrickletRGBLEDMatrix.GetSupplyVoltage: word¶

Returns:	voltage – Type: word, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

Returns the current supply voltage of the Bricklet.

procedure TBrickletRGBLEDMatrix.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶

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

procedure TBrickletRGBLEDMatrix.SetStatusLEDConfig(const config: byte)¶

Parameters:	config – Type: byte, Range: See constants, Default: 3

Sets 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.

The following constants are available for this function:

For config:

BRICKLET_RGB_LED_MATRIX_STATUS_LED_CONFIG_OFF = 0
BRICKLET_RGB_LED_MATRIX_STATUS_LED_CONFIG_ON = 1
BRICKLET_RGB_LED_MATRIX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_RGB_LED_MATRIX_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletRGBLEDMatrix.GetStatusLEDConfig: byte¶

Returns:	config – Type: byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig

The following constants are available for this function:

For config:

BRICKLET_RGB_LED_MATRIX_STATUS_LED_CONFIG_OFF = 0
BRICKLET_RGB_LED_MATRIX_STATUS_LED_CONFIG_ON = 1
BRICKLET_RGB_LED_MATRIX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_RGB_LED_MATRIX_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletRGBLEDMatrix.GetChipTemperature: smallint¶

Returns:	temperature – Type: smallint, 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.

procedure TBrickletRGBLEDMatrix.Reset¶

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!

procedure TBrickletRGBLEDMatrix.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)¶

Output Parameters:

Output Parameters:	uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] firmwareVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] deviceIdentifier – Type: word, 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: array [0..2] of byte

0: major – Type: byte, Range: [0 to 255]
1: minor – Type: byte, Range: [0 to 255]
2: revision – Type: byte, Range: [0 to 255]

firmwareVersion – Type: array [0..2] of byte

0: major – Type: byte, Range: [0 to 255]
1: minor – Type: byte, Range: [0 to 255]
2: revision – Type: byte, Range: [0 to 255]

deviceIdentifier – Type: word, 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. There is also a constant for the device identifier of this Bricklet.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

procedure TExample.MyCallback(sender: TBrickletRGBLEDMatrix; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

rgbLEDMatrix.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

The available callback properties and their parameter types are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

property TBrickletRGBLEDMatrix.OnFrameStarted¶

procedure(sender: TBrickletRGBLEDMatrix; const frameNumber: longword) of object;

Callback Parameters:	sender – Type: TBrickletRGBLEDMatrix frameNumber – Type: longword, Range: [0 to 2³² - 1]

This callback is triggered as soon as a new frame write is started. The LED values are double buffered, so you can send the LED values for the next frame directly after this callback is triggered.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

function TBrickletRGBLEDMatrix.GetAPIVersion: array [0..2] of byte¶

Output Parameters:	apiVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

function TBrickletRGBLEDMatrix.GetResponseExpected(const functionId: byte): boolean¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_RED = 1
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_GREEN = 3
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_BLUE = 5
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_FRAME_DURATION = 7
BRICKLET_RGB_LED_MATRIX_FUNCTION_DRAW_FRAME = 9
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_RGB_LED_MATRIX_FUNCTION_RESET = 243
BRICKLET_RGB_LED_MATRIX_FUNCTION_WRITE_UID = 248

procedure TBrickletRGBLEDMatrix.SetResponseExpected(const functionId: byte; const responseExpected: boolean)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For functionId:

BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_RED = 1
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_GREEN = 3
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_BLUE = 5
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_FRAME_DURATION = 7
BRICKLET_RGB_LED_MATRIX_FUNCTION_DRAW_FRAME = 9
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_RGB_LED_MATRIX_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_RGB_LED_MATRIX_FUNCTION_RESET = 243
BRICKLET_RGB_LED_MATRIX_FUNCTION_WRITE_UID = 248

procedure TBrickletRGBLEDMatrix.SetResponseExpectedAll(const responseExpected: boolean)¶

Parameters:	responseExpected – Type: boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

function TBrickletRGBLEDMatrix.SetBootloaderMode(const mode: byte): byte¶

Parameters:	mode – Type: byte, Range: See constants
Returns:	status – Type: byte, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BRICKLET_RGB_LED_MATRIX_BOOTLOADER_STATUS_OK = 0
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_STATUS_INVALID_MODE = 1
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_STATUS_NO_CHANGE = 2
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletRGBLEDMatrix.GetBootloaderMode: byte¶

Returns:	mode – Type: byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode.

The following constants are available for this function:

For mode:

BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletRGBLEDMatrix.SetWriteFirmwarePointer(const pointer: longword)¶

Parameters:	pointer – Type: longword, Unit: 1 B, Range: [0 to 2³² - 1]

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

function TBrickletRGBLEDMatrix.WriteFirmware(const data: array [0..63] of byte): byte¶

Parameters:	data – Type: array [0..63] of byte, Range: [0 to 255]
Returns:	status – Type: byte, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

procedure TBrickletRGBLEDMatrix.WriteUID(const uid: longword)¶

Parameters:	uid – Type: longword, Range: [0 to 2³² - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

function TBrickletRGBLEDMatrix.ReadUID: longword¶

Returns:	uid – Type: longword, Range: [0 to 2³² - 1]

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

Constants¶

const BRICKLET_RGB_LED_MATRIX_DEVICE_IDENTIFIER¶

This constant is used to identify a RGB LED Matrix Bricklet.

The GetIdentity function and the TIPConnection.OnEnumerate callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

const BRICKLET_RGB_LED_MATRIX_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a RGB LED Matrix Bricklet.