Delphi/Lazarus - LED Strip Bricklet 2.0

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das LED Strip Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LED Strip Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.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.

API

Da Delphi nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

constructor TBrickletLEDStripV2.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • ledStripV2 – Typ: TBrickletLEDStripV2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

procedure TBrickletLEDStripV2.SetLEDValues(const index: word; const value: array of byte)
Parameter:
  • index – Typ: word, Wertebereich: [0 bis 6144]
  • value – Typ: array of byte, Wertebereich: [0 bis 255]

Setzt die RGB(W) Werte der LEDs beginnend beim index. Es können bis zu 2048 RGB Werte oder 1536 RGBW Werte (jeweils 6144 Byte) gesetzt werden.

Damit die Farben richtig angezeigt werden muss den LEDs entsprechend der richtig Chip Type (siehe SetChipType) und das richtige Channel Mapping (siehe SetChannelMapping) eingestellt werden.

Wenn das Channel Mapping 3 Farben hat, müssen die Werte in der Sequenz RGBRGBRGB... übergeben werden. Hat das Mapping 4 Farben, müssen die Werte in der Sequenz RGBWRGBWRGBW... übergeben werden.

Die Daten werden Zwischengespeichert und die Farben werden auf die LEDs transferiert wenn die nächste frame duration abgelaufen ist (siehe SetFrameDuration).

Genereller Ansatz:

  • Setze frame duration auf einen Wert welcher der Anzahl der Bilder pro Sekunde entspricht die erreicht werden sollen.
  • Setze alle LEDs für einen Frame.
  • Warte auf den OnFrameStarted Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf den OnFrameStarted Callback.
  • Und so weiter.

Dieser Ansatz garantiert, dass die LED Farben mit einer festen Framerate angezeigt werden.

function TBrickletLEDStripV2.GetLEDValues(const index: word; const length: word): array of byte
Parameter:
  • index – Typ: word, Wertebereich: [0 bis 6144]
  • length – Typ: word, Wertebereich: [0 bis 6144]
Rückgabe:
  • value – Typ: array of byte, Wertebereich: [0 bis 255]

Gibt length RGB(W) Werte zurück, beginnend vom übergebenen index.

Wenn das Channel Mapping 3 Farben hat, werden die Werte in der Sequenz RGBRGBRGB... zurückgegeben, hat das Mapping 4 Farben, werden die Werte in der Sequenz RGBWRGBWRGBW... zurückgegeben (unter der Annahme, dass ein durch 3 (RGB) oder 4 (RGBW) teilbarer Index übergeben wird).

procedure TBrickletLEDStripV2.SetFrameDuration(const duration: word)
Parameter:
  • duration – Typ: word, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

Setzt die frame duration (Länge des Frames).

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die Länge des Frames auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Für eine Erklärung des generellen Ansatzes siehe SetLEDValues.

Standardwert: 100ms (10 Frames pro Sekunde).

function TBrickletLEDStripV2.GetFrameDuration: word
Rückgabe:
  • duration – Typ: word, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

Gibt die frame duration (Länge des Frames) zurück, wie von SetFrameDuration gesetzt.

function TBrickletLEDStripV2.GetSupplyVoltage: word
Rückgabe:
  • voltage – Typ: word, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

procedure TBrickletLEDStripV2.SetClockFrequency(const frequency: longword)
Parameter:
  • frequency – Typ: longword, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

Setzt die Frequenz der Clock-Leitung.

Das Bricklet wählt die nächst mögliche erreichbare Frequenz. Diese kann ein paar Hz neben des gesetzten Wertes liegen. Die exakte Frequenz wie sie genutzt wird kann mit GetClockFrequency erfragt werden.

Wenn Probleme mit flackernden LEDs auftreten kann es daran liegen das Bits auf der Leitung flippen. Dies kann behoben werden in dem man die Verbindung zwischen Bricklet und LEDs verringert oder in dem man die Frequenz reduziert.

Mit abnehmender Frequenz nimmt allerdings auch die maximale Framerate ab.

function TBrickletLEDStripV2.GetClockFrequency: longword
Rückgabe:
  • frequency – Typ: longword, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

Gibt die aktuell genutzte Clock-Frequenz zurück, wie von SetClockFrequency gesetzt.

procedure TBrickletLEDStripV2.SetChipType(const chip: word)
Parameter:
  • chip – Typ: word, Wertebereich: Siehe Konstanten, Standardwert: 2801

Setzt den Typ des LED-Treiber-Chips. Aktuell unterstützen wir die folgenden Chips

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

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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
Rückgabe:
  • chip – Typ: word, Wertebereich: Siehe Konstanten, Standardwert: 2801

Gibt den aktuell genutzten Typ des Chips zurück, wie von SetChipType gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)
Parameter:
  • mapping – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 36

Setzt das Channel Mapping für die angeschlossenen LEDs.

Falls das Mapping 4 Farben hat, erwartet die Funktion SetLEDValues 4 Werte pro Pixel. Bei einem Mapping mit 3 Farben werden 3 Werte pro Pixel erwartet.

Die Funktion erwartet immer die Reihenfolge RGB(W). Die angeschlossenen LED-Treiber-Chips können die Daten für ihre 3 oder 4 Kanäle in einer anderen Reihenfolge erwarten. Zum Beispiel verwenden WS2801 Chips typischerweise BGR Reihenfolge, WS2812 Chips verwenden typischerweise GRB Reihenfolge und APA102 verwenden typischerweise WBGR Reihenfolge.

Die APA102 haben eine Besonderheit. Sie haben drei 8-Bit Kanäle für RGB und einen zusätzlichen 5-Bit Kanal für die Helligkeit der RGB LED. Dadurch ist der APA102 insgesamt ein 4-Kanal Chip. Intern ist der Helligkeitskanal der erste Kanal. Daher sollte eines der Wxyz Channel Mappings verwendet werden. Dann kann über den W Kanal die Helligkeit eingestellt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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
Rückgabe:
  • mapping – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 36

Gibt die aktuell genutzten Channel Mapping zurück, wie von SetChannelMapping gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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

Fortgeschrittene Funktionen

procedure TBrickletLEDStripV2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: longword, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

procedure TBrickletLEDStripV2.SetStatusLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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
Rückgabe:
  • temperature – Typ: smallint, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

procedure TBrickletLEDStripV2.Reset

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

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)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: word, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

procedure TBrickletLEDStripV2.SetFrameStartedCallbackConfiguration(const enable: boolean)
Parameter:
  • enable – Typ: boolean, Standardwert: true

Aktiviert/deaktiviert den OnFrameStarted Callback.

function TBrickletLEDStripV2.GetFrameStartedCallbackConfiguration: boolean
Rückgabe:
  • enable – Typ: boolean, Standardwert: true

Gibt die Konfiguration zurück, wie von SetFrameStartedCallbackConfiguration gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

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

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

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

property TBrickletLEDStripV2.OnFrameStarted
procedure(sender: TBrickletLEDStripV2; const length: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletLEDStripV2
  • length – Typ: word, Wertebereich: [0 bis 6144]

Dieser Callback wird direkt nachdem dem start eines Frames ausgelöst. Der Parameter ist die Anzahl der LEDs in diesem Frame.

Die Daten für das nächste Frame sollten direkt nach dem auslösen dieses Callbacks übertragen werden.

Für eine Erklärung des generellen Ansatzes siehe SetLEDValues.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

function TBrickletLEDStripV2.GetAPIVersion: array [0..2] of byte
Ausgabeparameter:
  • apiVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

function TBrickletLEDStripV2.GetResponseExpected(const functionId: byte): boolean
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)
Parameter:
  • responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

function TBrickletLEDStripV2.SetBootloaderMode(const mode: byte): byte
Parameter:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: byte, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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

Für 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
Rückgabe:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)
Parameter:
  • pointer – Typ: longword, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für WriteFirmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

function TBrickletLEDStripV2.WriteFirmware(const data: array [0..63] of byte): byte
Parameter:
  • data – Typ: array [0..63] of byte, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: byte, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

procedure TBrickletLEDStripV2.WriteUID(const uid: longword)
Parameter:
  • uid – Typ: longword, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

function TBrickletLEDStripV2.ReadUID: longword
Rückgabe:
  • uid – Typ: longword, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten

const BRICKLET_LED_STRIP_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein LED Strip Bricklet 2.0 zu identifizieren.

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_LED_STRIP_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet 2.0 dar.