MATLAB/Octave - LED Strip Bricklet

Dies ist die Beschreibung der MATLAB/Octave 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 MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (MATLAB)

Download (matlab_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLEDStrip;

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

    ipcon = IPConnection(); % Create IP connection
    ls = handle(BrickletLEDStrip(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % 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]);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLEDStrip;

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

    global NUM_LEDS;
    global r;
    global g;
    global b;
    global r_index;

    NUM_LEDS = 16;
    r = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
    g = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
    b = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
    r_index = 1;

    ipcon = IPConnection(); % Create IP connection
    ls = handle(BrickletLEDStrip(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % 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 function cb_frame_rendered
    set(ls, 'FrameRenderedCallback', @(h, e) cb_frame_rendered(e));

    % Set initial rgb values to get started
    ls.setRGBValues(1, NUM_LEDS, r, g, b);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Use frame rendered callback to move the active LED every frame
function cb_frame_rendered(e)
    global NUM_LEDS;
    global r_index;
    global r;
    global g;
    global b;

    ls = e.getSource();
    b(r_index) = 1;

    if r_index == NUM_LEDS
        r_index = 1;
    else
        r_index = r_index + 1;
    end

    b(r_index) = 255;

    % Set new data for next render cycle
    ls.setRGBValues(1, NUM_LEDS, r, g, b);
end

Simple (Octave)

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your LED Strip Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ls = javaObject("com.tinkerforge.BrickletLEDStrip", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % 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]);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)

Download (octave_example_callback.m)

 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
function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your LED Strip Bricklet
    
    global NUM_LEDS;
    global r;
    global g;
    global b;
    global r_index;

    NUM_LEDS = 16;
    r = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
    g = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
    b = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
    r_index = 1;

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ls = javaObject("com.tinkerforge.BrickletLEDStrip", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % 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 function cb_frame_rendered
    ls.addFrameRenderedCallback(@cb_frame_rendered);

    % Set initial rgb values to get started
    ls.setRGBValues(1, NUM_LEDS, r, g, b);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Use frame rendered callback to move the active LED every frame
function cb_frame_rendered(e)
    global NUM_LEDS;
    global r_index;
    global r;
    global g;
    global b;

    ls = e.getSource();
    b(r_index) = 1;

    if r_index == NUM_LEDS
        r_index = 1;
    else
        r_index = r_index + 1;
    end

    b(r_index) = 255;

    % Set new data for next render cycle
    ls.setRGBValues(1, NUM_LEDS, r, g, b);
end

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletLEDStrip(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • ledStrip – Typ: BrickletLEDStrip

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

In MATLAB:

import com.tinkerforge.BrickletLEDStrip;

ledStrip = BrickletLEDStrip("YOUR_DEVICE_UID", ipcon);

In Octave:

ledStrip = java_new("com.tinkerforge.BrickletLEDStrip", "YOUR_DEVICE_UID", ipcon);

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

void BrickletLEDStrip.setRGBValues(int index, short length, short[] r, short[] g, short[] b)
Parameter:
  • index – Typ: int, Wertebereich: [0 bis 319]
  • length – Typ: short, Wertebereich: [0 bis 16]
  • r – Typ: short[], Länge: 16, Wertebereich: [0 bis 255]
  • g – Typ: short[], Länge: 16, Wertebereich: [0 bis 255]
  • b – Typ: short[], Länge: 16, 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 FrameRenderedCallback Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf FrameRenderedCallback 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.

BrickletLEDStrip.RGBValues BrickletLEDStrip.getRGBValues(int index, short length)
Parameter:
  • index – Typ: int, Wertebereich: [0 bis 319]
  • length – Typ: short, Wertebereich: [0 bis 16]
Rückgabeobjekt:
  • r – Typ: short[], Länge: 16, Wertebereich: [0 bis 255]
  • g – Typ: short[], Länge: 16, Wertebereich: [0 bis 255]
  • b – Typ: short[], Länge: 16, 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.

void BrickletLEDStrip.setFrameDuration(int duration)
Parameter:
  • duration – Typ: int, 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().

int BrickletLEDStrip.getFrameDuration()
Rückgabe:
  • duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

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

int BrickletLEDStrip.getSupplyVoltage()
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

void BrickletLEDStrip.setClockFrequency(long frequency)
Parameter:
  • frequency – Typ: long, 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).

long BrickletLEDStrip.getClockFrequency()
Rückgabe:
  • frequency – Typ: long, 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).

void BrickletLEDStrip.setChipType(int chip)
Parameter:
  • chip – Typ: int, 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:

  • BrickletLEDStrip.CHIP_TYPE_WS2801 = 2801
  • BrickletLEDStrip.CHIP_TYPE_WS2811 = 2811
  • BrickletLEDStrip.CHIP_TYPE_WS2812 = 2812
  • BrickletLEDStrip.CHIP_TYPE_LPD8806 = 8806
  • BrickletLEDStrip.CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

int BrickletLEDStrip.getChipType()
Rückgabe:
  • chip – Typ: int, 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:

  • BrickletLEDStrip.CHIP_TYPE_WS2801 = 2801
  • BrickletLEDStrip.CHIP_TYPE_WS2811 = 2811
  • BrickletLEDStrip.CHIP_TYPE_WS2812 = 2812
  • BrickletLEDStrip.CHIP_TYPE_LPD8806 = 8806
  • BrickletLEDStrip.CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

void BrickletLEDStrip.setRGBWValues(int index, short length, short[] r, short[] g, short[] b, short[] w)
Parameter:
  • index – Typ: int, Wertebereich: [0 bis 239]
  • length – Typ: short, Wertebereich: [0 bis 12]
  • r – Typ: short[], Länge: 12, Wertebereich: [0 bis 255]
  • g – Typ: short[], Länge: 12, Wertebereich: [0 bis 255]
  • b – Typ: short[], Länge: 12, Wertebereich: [0 bis 255]
  • w – Typ: short[], Länge: 12, 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 FrameRenderedCallback Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf FrameRenderedCallback 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).

BrickletLEDStrip.RGBWValues BrickletLEDStrip.getRGBWValues(int index, short length)
Parameter:
  • index – Typ: int, Wertebereich: [0 bis 239]
  • length – Typ: short, Wertebereich: [0 bis 12]
Rückgabeobjekt:
  • r – Typ: short[], Länge: 12, Wertebereich: [0 bis 255]
  • g – Typ: short[], Länge: 12, Wertebereich: [0 bis 255]
  • b – Typ: short[], Länge: 12, Wertebereich: [0 bis 255]
  • w – Typ: short[], Länge: 12, 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).

void BrickletLEDStrip.setChannelMapping(short mapping)
Parameter:
  • mapping – Typ: short, 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:

  • BrickletLEDStrip.CHANNEL_MAPPING_RGB = 6
  • BrickletLEDStrip.CHANNEL_MAPPING_RBG = 9
  • BrickletLEDStrip.CHANNEL_MAPPING_BRG = 33
  • BrickletLEDStrip.CHANNEL_MAPPING_BGR = 36
  • BrickletLEDStrip.CHANNEL_MAPPING_GRB = 18
  • BrickletLEDStrip.CHANNEL_MAPPING_GBR = 24
  • BrickletLEDStrip.CHANNEL_MAPPING_RGBW = 27
  • BrickletLEDStrip.CHANNEL_MAPPING_RGWB = 30
  • BrickletLEDStrip.CHANNEL_MAPPING_RBGW = 39
  • BrickletLEDStrip.CHANNEL_MAPPING_RBWG = 45
  • BrickletLEDStrip.CHANNEL_MAPPING_RWGB = 54
  • BrickletLEDStrip.CHANNEL_MAPPING_RWBG = 57
  • BrickletLEDStrip.CHANNEL_MAPPING_GRWB = 78
  • BrickletLEDStrip.CHANNEL_MAPPING_GRBW = 75
  • BrickletLEDStrip.CHANNEL_MAPPING_GBWR = 108
  • BrickletLEDStrip.CHANNEL_MAPPING_GBRW = 99
  • BrickletLEDStrip.CHANNEL_MAPPING_GWBR = 120
  • BrickletLEDStrip.CHANNEL_MAPPING_GWRB = 114
  • BrickletLEDStrip.CHANNEL_MAPPING_BRGW = 135
  • BrickletLEDStrip.CHANNEL_MAPPING_BRWG = 141
  • BrickletLEDStrip.CHANNEL_MAPPING_BGRW = 147
  • BrickletLEDStrip.CHANNEL_MAPPING_BGWR = 156
  • BrickletLEDStrip.CHANNEL_MAPPING_BWRG = 177
  • BrickletLEDStrip.CHANNEL_MAPPING_BWGR = 180
  • BrickletLEDStrip.CHANNEL_MAPPING_WRBG = 201
  • BrickletLEDStrip.CHANNEL_MAPPING_WRGB = 198
  • BrickletLEDStrip.CHANNEL_MAPPING_WGBR = 216
  • BrickletLEDStrip.CHANNEL_MAPPING_WGRB = 210
  • BrickletLEDStrip.CHANNEL_MAPPING_WBGR = 228
  • BrickletLEDStrip.CHANNEL_MAPPING_WBRG = 225

Neu in Version 2.0.6 (Plugin).

short BrickletLEDStrip.getChannelMapping()
Rückgabe:
  • mapping – Typ: short, 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:

  • BrickletLEDStrip.CHANNEL_MAPPING_RGB = 6
  • BrickletLEDStrip.CHANNEL_MAPPING_RBG = 9
  • BrickletLEDStrip.CHANNEL_MAPPING_BRG = 33
  • BrickletLEDStrip.CHANNEL_MAPPING_BGR = 36
  • BrickletLEDStrip.CHANNEL_MAPPING_GRB = 18
  • BrickletLEDStrip.CHANNEL_MAPPING_GBR = 24
  • BrickletLEDStrip.CHANNEL_MAPPING_RGBW = 27
  • BrickletLEDStrip.CHANNEL_MAPPING_RGWB = 30
  • BrickletLEDStrip.CHANNEL_MAPPING_RBGW = 39
  • BrickletLEDStrip.CHANNEL_MAPPING_RBWG = 45
  • BrickletLEDStrip.CHANNEL_MAPPING_RWGB = 54
  • BrickletLEDStrip.CHANNEL_MAPPING_RWBG = 57
  • BrickletLEDStrip.CHANNEL_MAPPING_GRWB = 78
  • BrickletLEDStrip.CHANNEL_MAPPING_GRBW = 75
  • BrickletLEDStrip.CHANNEL_MAPPING_GBWR = 108
  • BrickletLEDStrip.CHANNEL_MAPPING_GBRW = 99
  • BrickletLEDStrip.CHANNEL_MAPPING_GWBR = 120
  • BrickletLEDStrip.CHANNEL_MAPPING_GWRB = 114
  • BrickletLEDStrip.CHANNEL_MAPPING_BRGW = 135
  • BrickletLEDStrip.CHANNEL_MAPPING_BRWG = 141
  • BrickletLEDStrip.CHANNEL_MAPPING_BGRW = 147
  • BrickletLEDStrip.CHANNEL_MAPPING_BGWR = 156
  • BrickletLEDStrip.CHANNEL_MAPPING_BWRG = 177
  • BrickletLEDStrip.CHANNEL_MAPPING_BWGR = 180
  • BrickletLEDStrip.CHANNEL_MAPPING_WRBG = 201
  • BrickletLEDStrip.CHANNEL_MAPPING_WRGB = 198
  • BrickletLEDStrip.CHANNEL_MAPPING_WGBR = 216
  • BrickletLEDStrip.CHANNEL_MAPPING_WGRB = 210
  • BrickletLEDStrip.CHANNEL_MAPPING_WBGR = 228
  • BrickletLEDStrip.CHANNEL_MAPPING_WBRG = 225

Neu in Version 2.0.6 (Plugin).

Fortgeschrittene Funktionen

BrickletLEDStrip.Identity BrickletLEDStrip.getIdentity()
Rückgabeobjekt:
  • 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: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, 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

void BrickletLEDStrip.enableFrameRenderedCallback()

Aktiviert den FrameRenderedCallback Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

void BrickletLEDStrip.disableFrameRenderedCallback()

Deaktiviert den FrameRenderedCallback Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

boolean BrickletLEDStrip.isFrameRenderedCallbackEnabled()
Rückgabe:
  • enabled – Typ: boolean, Standardwert: true

Gibt true zurück falls der FrameRenderedCallback 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 wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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.

callback BrickletLEDStrip.FrameRenderedCallback
Event-Objekt:
  • length – Typ: int, 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().

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addFrameRenderedCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeFrameRenderedCallback() wieder entfernt werden.

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.

short[] BrickletLEDStrip.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, 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.

boolean BrickletLEDStrip.getResponseExpected(byte functionId)
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:

  • BrickletLEDStrip.FUNCTION_SET_RGB_VALUES = 1
  • BrickletLEDStrip.FUNCTION_SET_FRAME_DURATION = 3
  • BrickletLEDStrip.FUNCTION_SET_CLOCK_FREQUENCY = 7
  • BrickletLEDStrip.FUNCTION_SET_CHIP_TYPE = 9
  • BrickletLEDStrip.FUNCTION_SET_RGBW_VALUES = 11
  • BrickletLEDStrip.FUNCTION_SET_CHANNEL_MAPPING = 13
  • BrickletLEDStrip.FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
  • BrickletLEDStrip.FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16
void BrickletLEDStrip.setResponseExpected(byte functionId, boolean responseExpected)
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:

  • BrickletLEDStrip.FUNCTION_SET_RGB_VALUES = 1
  • BrickletLEDStrip.FUNCTION_SET_FRAME_DURATION = 3
  • BrickletLEDStrip.FUNCTION_SET_CLOCK_FREQUENCY = 7
  • BrickletLEDStrip.FUNCTION_SET_CHIP_TYPE = 9
  • BrickletLEDStrip.FUNCTION_SET_RGBW_VALUES = 11
  • BrickletLEDStrip.FUNCTION_SET_CHANNEL_MAPPING = 13
  • BrickletLEDStrip.FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
  • BrickletLEDStrip.FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16
void BrickletLEDStrip.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

Konstanten

int BrickletLEDStrip.DEVICE_IDENTIFIER

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

Die getIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletLEDStrip.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet dar.