Delphi/Lazarus - LED Strip Bricklet 2.0¶

Simple¶

Download (ExampleSimple.pas)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

program ExampleSimple;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletLEDStripV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ls: TBrickletLEDStripV2;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your LED Strip Bricklet 2.0 }

var
  e: TExample;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  ls := TBrickletLEDStripV2.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Set first 3 LEDs to red, green and blue }
  ls.SetLEDValues(0, [255, 0, 0, 0, 255, 0, 0, 0, 255]);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Callback¶

Download (ExampleCallback.pas)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

program ExampleCallback;

{ FIXME: This example is incomplete }

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletLEDStripV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ls: TBrickletLEDStripV2;
  public
    procedure FrameStartedCB(sender: TBrickletLEDStripV2; const length_: word);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your LED Strip Bricklet 2.0 }

var
  e: TExample;

{ Use frame started callback to move the active LED every frame }
procedure TExample.FrameStartedCB(sender: TBrickletLEDStripV2; const length_: word);
begin
  WriteLn(Format('Length: %d', [length_]));
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  ls := TBrickletLEDStripV2.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Set frame duration to 50ms (20 frames per second) }
  ls.SetFrameDuration(50);

  { Register frame started callback to procedure FrameStartedCB }
  ls.OnFrameStarted := {$ifdef FPC}@{$endif}FrameStartedCB;

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Basic Functions¶

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

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	ledStripV2 – Type: TBrickletLEDStripV2

Creates an object with the unique device ID uid:

ledStripV2 := TBrickletLEDStripV2.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletLEDStripV2.SetLEDValues(const index: word; const value: array of byte)¶

Parameters:	index – Type: word, Range: [0 to 6144] value – Type: array of byte, Range: [0 to 255]

Sets the RGB(W) values for the LEDs starting from index. You can set at most 2048 RGB values or 1536 RGBW values (6144 byte each).

To make the colors show correctly you need to configure the chip type (see SetChipType) and a channel mapping (see SetChannelMapping) according to the connected LEDs.

If the channel mapping has 3 colors, you need to give the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you need to give data in the sequence RGBWRGBWRGBW...

The data is double buffered and the colors will be transfered to the LEDs when the next frame duration ends (see SetFrameDuration).

Generic approach:

• Set the frame duration to a value that represents the number of frames per second you want to achieve.
• Set all of the LED colors for one frame.
• Wait for the OnFrameStarted callback.
• Set all of the LED colors for next frame.
• Wait for the OnFrameStarted callback.
• And so on.

This approach ensures that you can change the LED colors with a fixed frame rate.

function TBrickletLEDStripV2.GetLEDValues(const index: word; const length: word): array of byte¶

Parameters:	index – Type: word, Range: [0 to 6144] length – Type: word, Range: [0 to 6144]
Returns:	value – Type: array of byte, Range: [0 to 255]

Returns length RGB(W) values starting from the given index.

If the channel mapping has 3 colors, you will get the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you will get the data in the sequence RGBWRGBWRGBW... (assuming you start at an index divisible by 3 (RGB) or 4 (RGBW)).

procedure TBrickletLEDStripV2.SetFrameDuration(const duration: word)¶

Parameters:	duration – Type: word, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100

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

For an explanation of the general approach see SetLEDValues.

Default value: 100ms (10 frames per second).

function TBrickletLEDStripV2.GetFrameDuration: word¶

Returns:	duration – Type: word, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100

Returns the frame duration as set by SetFrameDuration.

function TBrickletLEDStripV2.GetSupplyVoltage: word¶

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

Returns the current supply voltage of the LEDs.

procedure TBrickletLEDStripV2.SetClockFrequency(const frequency: longword)¶

Parameters:	frequency – Type: longword, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666

Sets the frequency of the clock.

The Bricklet will choose the nearest achievable frequency, which may be off by a few Hz. You can get the exact frequency that is used by calling GetClockFrequency.

If you have problems with flickering LEDs, they may be bits flipping. You can fix this by either making the connection between the LEDs and the Bricklet shorter or by reducing the frequency.

With a decreasing frequency your maximum frames per second will decrease too.

function TBrickletLEDStripV2.GetClockFrequency: longword¶

Returns:	frequency – Type: longword, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666

Returns the currently used clock frequency as set by SetClockFrequency.

procedure TBrickletLEDStripV2.SetChipType(const chip: word)¶

Parameters:	chip – Type: word, Range: See constants, Default: 2801

Sets the type of the LED driver chip. We currently support the chips

• WS2801,
• WS2811,
• WS2812 / SK6812 / NeoPixel RGB,
• SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812),
• WS2813 / WS2815 (Chip Type = WS2812)
• LPD8806 and
• APA102 / DotStar.

The following constants are available for this function:

For chip:

• BRICKLET_LED_STRIP_V2_CHIP_TYPE_WS2801 = 2801
• BRICKLET_LED_STRIP_V2_CHIP_TYPE_WS2811 = 2811
• BRICKLET_LED_STRIP_V2_CHIP_TYPE_WS2812 = 2812
• BRICKLET_LED_STRIP_V2_CHIP_TYPE_LPD8806 = 8806
• BRICKLET_LED_STRIP_V2_CHIP_TYPE_APA102 = 102

function TBrickletLEDStripV2.GetChipType: word¶

Returns:	chip – Type: word, Range: See constants, Default: 2801

Returns the currently used chip type as set by SetChipType.

The following constants are available for this function:

For chip:

• BRICKLET_LED_STRIP_V2_CHIP_TYPE_WS2801 = 2801
• BRICKLET_LED_STRIP_V2_CHIP_TYPE_WS2811 = 2811
• BRICKLET_LED_STRIP_V2_CHIP_TYPE_WS2812 = 2812
• BRICKLET_LED_STRIP_V2_CHIP_TYPE_LPD8806 = 8806
• BRICKLET_LED_STRIP_V2_CHIP_TYPE_APA102 = 102

procedure TBrickletLEDStripV2.SetChannelMapping(const mapping: byte)¶

Parameters:	mapping – Type: byte, Range: See constants, Default: 36

Sets the channel mapping for the connected LEDs.

If the mapping has 4 colors, the function SetLEDValues expects 4 values per pixel and if the mapping has 3 colors it expects 3 values per pixel.

The function always expects the order RGB(W). The connected LED driver chips might have their 3 or 4 channels in a different order. For example, the WS2801 chips typically use BGR order, then WS2812 chips typically use GRB order and the APA102 chips typically use WBGR order.

The APA102 chips are special. They have three 8-bit channels for RGB and an additional 5-bit channel for the overall brightness of the RGB LED making them 4-channel chips. Internally the brightness channel is the first channel, therefore one of the Wxyz channel mappings should be used. Then the W channel controls the brightness.

The following constants are available for this function:

For mapping:

• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RGB = 6
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RBG = 9
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BRG = 33
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BGR = 36
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GRB = 18
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GBR = 24
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RGBW = 27
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RGWB = 30
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RBGW = 39
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RBWG = 45
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RWGB = 54
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RWBG = 57
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GRWB = 78
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GRBW = 75
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GBWR = 108
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GBRW = 99
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GWBR = 120
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GWRB = 114
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BRGW = 135
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BRWG = 141
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BGRW = 147
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BGWR = 156
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BWRG = 177
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BWGR = 180
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WRBG = 201
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WRGB = 198
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WGBR = 216
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WGRB = 210
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WBGR = 228
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WBRG = 225

function TBrickletLEDStripV2.GetChannelMapping: byte¶

Returns:	mapping – Type: byte, Range: See constants, Default: 36

Returns the currently used channel mapping as set by SetChannelMapping.

The following constants are available for this function:

For mapping:

• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RGB = 6
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RBG = 9
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BRG = 33
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BGR = 36
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GRB = 18
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GBR = 24
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RGBW = 27
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RGWB = 30
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RBGW = 39
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RBWG = 45
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RWGB = 54
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_RWBG = 57
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GRWB = 78
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GRBW = 75
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GBWR = 108
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GBRW = 99
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GWBR = 120
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_GWRB = 114
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BRGW = 135
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BRWG = 141
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BGRW = 147
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BGWR = 156
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BWRG = 177
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_BWGR = 180
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WRBG = 201
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WRGB = 198
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WGBR = 216
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WGRB = 210
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WBGR = 228
• BRICKLET_LED_STRIP_V2_CHANNEL_MAPPING_WBRG = 225

Advanced Functions¶

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

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

procedure TBrickletLEDStripV2.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_LED_STRIP_V2_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_LED_STRIP_V2_STATUS_LED_CONFIG_ON = 1
• BRICKLET_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletLEDStripV2.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_LED_STRIP_V2_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_LED_STRIP_V2_STATUS_LED_CONFIG_ON = 1
• BRICKLET_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletLEDStripV2.GetChipTemperature: smallint¶

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

procedure TBrickletLEDStripV2.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 TBrickletLEDStripV2.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:

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 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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

procedure TBrickletLEDStripV2.SetFrameStartedCallbackConfiguration(const enable: boolean)¶

Parameters:	enable – Type: boolean, Default: true

Enables/disables the OnFrameStarted callback.

function TBrickletLEDStripV2.GetFrameStartedCallbackConfiguration: boolean¶

Returns:	enable – Type: boolean, Default: true

Returns the configuration as set by SetFrameStartedCallbackConfiguration.

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: TBrickletLEDStripV2; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

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

property TBrickletLEDStripV2.OnFrameStarted¶

procedure(sender: TBrickletLEDStripV2; const length: word) of object;

Callback Parameters:	sender – Type: TBrickletLEDStripV2 length – Type: word, Range: [0 to 6144]

This callback is triggered directly after a new frame render is started. The parameter is the number of LEDs in that frame.

You should send the data for the next frame directly after this callback was triggered.

For an explanation of the general approach see SetLEDValues.

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 TBrickletLEDStripV2.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 TBrickletLEDStripV2.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_LED_STRIP_V2_FUNCTION_SET_LED_VALUES = 1
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_FRAME_DURATION = 3
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_CLOCK_FREQUENCY = 7
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_CHIP_TYPE = 9
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_CHANNEL_MAPPING = 11
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_LED_STRIP_V2_FUNCTION_RESET = 243
• BRICKLET_LED_STRIP_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletLEDStripV2.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.

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_LED_STRIP_V2_FUNCTION_SET_LED_VALUES = 1
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_FRAME_DURATION = 3
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_CLOCK_FREQUENCY = 7
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_CHIP_TYPE = 9
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_CHANNEL_MAPPING = 11
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_LED_STRIP_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_LED_STRIP_V2_FUNCTION_RESET = 243
• BRICKLET_LED_STRIP_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletLEDStripV2.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 TBrickletLEDStripV2.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_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BRICKLET_LED_STRIP_V2_BOOTLOADER_STATUS_OK = 0
• BRICKLET_LED_STRIP_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
• BRICKLET_LED_STRIP_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
• BRICKLET_LED_STRIP_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BRICKLET_LED_STRIP_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BRICKLET_LED_STRIP_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletLEDStripV2.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_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletLEDStripV2.SetWriteFirmwarePointer(const pointer: longword)¶

Parameters:	pointer – Type: longword, Unit: 1 B, Range: [0 to 232 - 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 TBrickletLEDStripV2.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 TBrickletLEDStripV2.WriteUID(const uid: longword)¶

Parameters:	uid – Type: longword, Range: [0 to 232 - 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 TBrickletLEDStripV2.ReadUID: longword¶

Returns:	uid – Type: longword, Range: [0 to 232 - 1]

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

Constants¶

const BRICKLET_LED_STRIP_V2_DEVICE_IDENTIFIER¶

This constant is used to identify a LED Strip Bricklet 2.0.

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_LED_STRIP_V2_DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a LED Strip Bricklet 2.0.