Delphi/Lazarus - LED Strip Bricklet

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das LED Strip Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LED Strip Bricklet 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
51
52
program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletLEDStrip;

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

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

var
  e: TExample;

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

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

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

  { Set first 10 LEDs to green }
  ls.SetRGBValues(0, 10, [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
                  [255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0],
                  [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);

  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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletLEDStrip;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ls: TBrickletLEDStrip;
    r: {$ifdef FPC}array [0..15] of byte{$else}TArray0To15OfUInt8{$endif};
    g: {$ifdef FPC}array [0..15] of byte{$else}TArray0To15OfUInt8{$endif};
    b: {$ifdef FPC}array [0..15] of byte{$else}TArray0To15OfUInt8{$endif};
    rIndex: integer;
  public
    procedure FrameRenderedCB(sender: TBrickletLEDStrip; const length: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Use frame rendered callback to move the active LED every frame }
procedure TExample.FrameRenderedCB(sender: TBrickletLEDStrip; const length: word);
begin
  b[rIndex] := 0;
  if rIndex = NUM_LEDS-1 then begin
    rIndex := 0
  end
  else begin
    rIndex := rIndex + 1
  end;
  b[rIndex] := 255;

  { Set new data for next render cycle }
  sender.SetRGBValues(0, NUM_LEDS, r, g, b);
end;

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

  { Create device object }
  ls := TBrickletLEDStrip.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 rendered callback to procedure FrameRenderedCB }
  ls.OnFrameRendered := {$ifdef FPC}@{$endif}FrameRenderedCB;

  { Set initial rgb values to get started }
  ls.SetRGBValues(0, NUM_LEDS, r, g, b);

  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 TBrickletLEDStrip.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • ledStrip – Typ: TBrickletLEDStrip

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

ledStrip := TBrickletLEDStrip.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

procedure TBrickletLEDStrip.SetRGBValues(const index: word; const length: byte; const r: array [0..15] of byte; const g: array [0..15] of byte; const b: array [0..15] of byte)
Parameter:
  • index – Typ: word, Wertebereich: [0 bis 319]
  • length – Typ: byte, Wertebereich: [0 bis 16]
  • r – Typ: array [0..15] of byte, Wertebereich: [0 bis 255]
  • g – Typ: array [0..15] of byte, Wertebereich: [0 bis 255]
  • b – Typ: array [0..15] of byte, Wertebereich: [0 bis 255]

Setzt length RGB Werte für die LEDs, beginnend vom angegebenen index.

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

Beispiel: Wenn

  • index auf 5,
  • length auf 3,
  • r auf [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  • g auf [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] und
  • b auf [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

gesetzt wird, wird die LED an Index 5 die Farbe Rot annehmen, 6 wird Grün und 7 wird Blau.

Bemerkung

Abhängig von der internen LED Schaltung können die Farben vertauscht sein.

Die Farben werden auf die tatsächlichen 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 OnFrameRendered Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf OnFrameRendered Callback.
  • Und so weiter.

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

Die effektive Anzahl steuerbarer LEDs ist abhängig von der Anzahl der freien Bricklet Ports (siehe hier). Ein Aufruf von SetRGBValues mit index + length größer als die Begrenzung werden komplett ingnoriert.

procedure TBrickletLEDStrip.GetRGBValues(const index: word; const length: byte; out r: array [0..15] of byte; out g: array [0..15] of byte; out b: array [0..15] of byte)
Parameter:
  • index – Typ: word, Wertebereich: [0 bis 319]
  • length – Typ: byte, Wertebereich: [0 bis 16]
Ausgabeparameter:
  • r – Typ: array [0..15] of byte, Wertebereich: [0 bis 255]
  • g – Typ: array [0..15] of byte, Wertebereich: [0 bis 255]
  • b – Typ: array [0..15] of byte, Wertebereich: [0 bis 255]

Gibt length R, G und B Werte zurück, beginnend von der übergebenen LED index.

Die Werte sind die letzten von SetRGBValues gesetzten Werte.

procedure TBrickletLEDStrip.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 SetRGBValues.

function TBrickletLEDStrip.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 TBrickletLEDStrip.GetSupplyVoltage: word
Rückgabe:
  • voltage – Typ: word, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

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

Setzt die Frequenz der Clock-Leitung. Der erlaubte Wertebereich beläuft von sich 10000Hz (10kHz) bis 2000000Hz (2MHz).

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.

Bemerkung

Die Frequenz in Firmware Version 2.0.0 ist fest auf 2MHz gesetzt.

Neu in Version 2.0.1 (Plugin).

function TBrickletLEDStrip.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.

Neu in Version 2.0.1 (Plugin).

procedure TBrickletLEDStrip.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),
  • LPD8806 and
  • APA102 / DotStar.

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

Für chip:

  • BRICKLET_LED_STRIP_CHIP_TYPE_WS2801 = 2801
  • BRICKLET_LED_STRIP_CHIP_TYPE_WS2811 = 2811
  • BRICKLET_LED_STRIP_CHIP_TYPE_WS2812 = 2812
  • BRICKLET_LED_STRIP_CHIP_TYPE_LPD8806 = 8806
  • BRICKLET_LED_STRIP_CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

function TBrickletLEDStrip.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_CHIP_TYPE_WS2801 = 2801
  • BRICKLET_LED_STRIP_CHIP_TYPE_WS2811 = 2811
  • BRICKLET_LED_STRIP_CHIP_TYPE_WS2812 = 2812
  • BRICKLET_LED_STRIP_CHIP_TYPE_LPD8806 = 8806
  • BRICKLET_LED_STRIP_CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

procedure TBrickletLEDStrip.SetRGBWValues(const index: word; const length: byte; const r: array [0..11] of byte; const g: array [0..11] of byte; const b: array [0..11] of byte; const w: array [0..11] of byte)
Parameter:
  • index – Typ: word, Wertebereich: [0 bis 239]
  • length – Typ: byte, Wertebereich: [0 bis 12]
  • r – Typ: array [0..11] of byte, Wertebereich: [0 bis 255]
  • g – Typ: array [0..11] of byte, Wertebereich: [0 bis 255]
  • b – Typ: array [0..11] of byte, Wertebereich: [0 bis 255]
  • w – Typ: array [0..11] of byte, Wertebereich: [0 bis 255]

Setzt length RGBW Werte für die LEDs beginnend vom angegebenen index.

Damit die Farben richtig angezeigt werden muss den LEDs der entsprechende Chip Type (SetChipType) und das richtige 4-Kanal Channel Mapping (SetChannelMapping) eingestellt werden.

Beispiel: Wenn

  • index auf 5,
  • length auf 4,
  • r auf [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  • g auf [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  • b auf [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] und
  • w auf [0, 0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0]

gesetzt wird, wird die LED an Index 5 die Farbe Rot annehmen, 6 wird Grün, 7 wird Blau und 8 wird Weiß.

Bemerkung

Abhängig von der internen LED Schaltung können die Farben vertauscht sein.

Die Farben werden auf die tatsächlichen 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 OnFrameRendered Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf OnFrameRendered Callback.
  • Und so weiter.

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

Die effektive Anzahl steuerbarer LEDs ist abhängig von der Anzahl der freien Bricklet Ports (siehe hier). Ein Aufruf von SetRGBWValues mit index + length größer als die Begrenzung werden komplett ignoriert.

Die LPD8806 LED-Treiber-Chips haben 7-Bit Kanäle für RGB. Intern teilt das LED Strip Bricklet die 8-Bit Werte die mit dieser Funktion gesetzt werden durch 2, um daraus 7-Bit Werte zu machen. Daher kann der normale Wertebereich (0-255) auch für LPD8806 LEDs verwendet werden.

Der Helligkeitskanal der APA102 LED-Treiber-Chips hat 5-Bit. Intern teilt das LED Strip Bricklet die 8-Bit Werte die mit dieser Funktion gesetzt werden durch 8, um daraus 5-Bit Werte zu machen. Daher kann der normale Wertebereich (0-255) auch für den Helligkeitskanal von APA102 LEDs verwendet werden.

Neu in Version 2.0.6 (Plugin).

procedure TBrickletLEDStrip.GetRGBWValues(const index: word; const length: byte; out r: array [0..11] of byte; out g: array [0..11] of byte; out b: array [0..11] of byte; out w: array [0..11] of byte)
Parameter:
  • index – Typ: word, Wertebereich: [0 bis 239]
  • length – Typ: byte, Wertebereich: [0 bis 12]
Ausgabeparameter:
  • r – Typ: array [0..11] of byte, Wertebereich: [0 bis 255]
  • g – Typ: array [0..11] of byte, Wertebereich: [0 bis 255]
  • b – Typ: array [0..11] of byte, Wertebereich: [0 bis 255]
  • w – Typ: array [0..11] of byte, Wertebereich: [0 bis 255]

Gibt length RGBW Werte zurück, beginnend vom übergebenen index.

Die Werte sind die letzten von SetRGBWValues gesetzten Werte.

Neu in Version 2.0.6 (Plugin).

procedure TBrickletLEDStrip.SetChannelMapping(const mapping: byte)
Parameter:
  • mapping – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 36

Setzt das Channel Mapping für die angeschlossenene LEDs.

SetRGBValues und SetRGBWValues nehmen die Daten in RGB(W) Reihenfolge entgegen. Aber die angeschlossenen LED-Treiber-Chips erwarten die Daten für ihre 3 oder 4 Kanäle in einer anderen Reihenfolge. 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.

Wenn ein 3-Kanal Mapping ausgewählt wurde, dann muss auch SetRGBValues für das setzen der Farben verwendet werden. SetRGBWValues zusammen mit einem 3-Kanal Mapping führt zu falscher Darstellung der Farben. Im Gegenzug muss bei einem 4-Kanal Mapping SetRGBWValues für das setzen der Farben verwendet werden. SetRGBValues zusammen mit einem 4-Kanal Mapping führt zu falscher Darstellung der Farben.

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

Für mapping:

  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RGB = 6
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RBG = 9
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BRG = 33
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BGR = 36
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GRB = 18
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GBR = 24
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RGBW = 27
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RGWB = 30
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RBGW = 39
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RBWG = 45
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RWGB = 54
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RWBG = 57
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GRWB = 78
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GRBW = 75
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GBWR = 108
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GBRW = 99
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GWBR = 120
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GWRB = 114
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BRGW = 135
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BRWG = 141
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BGRW = 147
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BGWR = 156
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BWRG = 177
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BWGR = 180
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WRBG = 201
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WRGB = 198
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WGBR = 216
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WGRB = 210
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WBGR = 228
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WBRG = 225

Neu in Version 2.0.6 (Plugin).

function TBrickletLEDStrip.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_CHANNEL_MAPPING_RGB = 6
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RBG = 9
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BRG = 33
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BGR = 36
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GRB = 18
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GBR = 24
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RGBW = 27
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RGWB = 30
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RBGW = 39
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RBWG = 45
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RWGB = 54
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_RWBG = 57
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GRWB = 78
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GRBW = 75
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GBWR = 108
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GBRW = 99
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GWBR = 120
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_GWRB = 114
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BRGW = 135
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BRWG = 141
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BGRW = 147
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BGWR = 156
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BWRG = 177
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_BWGR = 180
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WRBG = 201
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WRGB = 198
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WGBR = 216
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WGRB = 210
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WBGR = 228
  • BRICKLET_LED_STRIP_CHANNEL_MAPPING_WBRG = 225

Neu in Version 2.0.6 (Plugin).

Fortgeschrittene Funktionen

procedure TBrickletLEDStrip.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 TBrickletLEDStrip.EnableFrameRenderedCallback

Aktiviert den OnFrameRendered Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

procedure TBrickletLEDStrip.DisableFrameRenderedCallback

Deaktiviert den OnFrameRendered Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

function TBrickletLEDStrip.IsFrameRenderedCallbackEnabled: boolean
Rückgabe:
  • enabled – Typ: boolean, Standardwert: true

Gibt true zurück falls der OnFrameRendered Callback aktiviert ist, false sonst.

Neu in Version 2.0.6 (Plugin).

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

ledStrip.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 TBrickletLEDStrip.OnFrameRendered
procedure(sender: TBrickletLEDStrip; const length: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletLEDStrip
  • length – Typ: word, Wertebereich: [0 bis 320]

Dieser Callback wird direkt direkt nachdem ein Frame gerendert wurde ausgelöst. Der Parameter ist die Anzahl der RGB oder RGBW 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 SetRGBValues.

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 TBrickletLEDStrip.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 TBrickletLEDStrip.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_FUNCTION_SET_RGB_VALUES = 1
  • BRICKLET_LED_STRIP_FUNCTION_SET_FRAME_DURATION = 3
  • BRICKLET_LED_STRIP_FUNCTION_SET_CLOCK_FREQUENCY = 7
  • BRICKLET_LED_STRIP_FUNCTION_SET_CHIP_TYPE = 9
  • BRICKLET_LED_STRIP_FUNCTION_SET_RGBW_VALUES = 11
  • BRICKLET_LED_STRIP_FUNCTION_SET_CHANNEL_MAPPING = 13
  • BRICKLET_LED_STRIP_FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
  • BRICKLET_LED_STRIP_FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16
procedure TBrickletLEDStrip.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_FUNCTION_SET_RGB_VALUES = 1
  • BRICKLET_LED_STRIP_FUNCTION_SET_FRAME_DURATION = 3
  • BRICKLET_LED_STRIP_FUNCTION_SET_CLOCK_FREQUENCY = 7
  • BRICKLET_LED_STRIP_FUNCTION_SET_CHIP_TYPE = 9
  • BRICKLET_LED_STRIP_FUNCTION_SET_RGBW_VALUES = 11
  • BRICKLET_LED_STRIP_FUNCTION_SET_CHANNEL_MAPPING = 13
  • BRICKLET_LED_STRIP_FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
  • BRICKLET_LED_STRIP_FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16
procedure TBrickletLEDStrip.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.

Konstanten

const BRICKLET_LED_STRIP_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein LED Strip Bricklet 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_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet dar.