JavaScript - LED Strip Bricklet¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (Node.js)¶

Download (ExampleSimple.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ls = new Tinkerforge.BrickletLEDStrip(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // 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]);
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Callback (Node.js)¶

Download (ExampleCallback.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your LED Strip Bricklet
var NUM_LEDS = 16;

var r = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
var g = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
var b = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
var rIndex = 0;

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ls = new Tinkerforge.BrickletLEDStrip(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Set frame duration to 50ms (20 frames per second)
        ls.setFrameDuration(50);
        // Set initial rgb values to get started
        ls.setRGBValues(0, NUM_LEDS, r, g, b);
    }
);

// Register frame rendered callback
ls.on(Tinkerforge.BrickletLEDStrip.CALLBACK_FRAME_RENDERED,
    // Use frame rendered callback to move the active LED every frame
    function (length) {
        b[rIndex] = 0;
        if(rIndex === NUM_LEDS-1) {
            rIndex = 0;
        }
        else {
            rIndex += 1;
        }
        b[rIndex] = 255;

        // Set new data for next render cycle
        ls.setRGBValues(0, NUM_LEDS, r, g, b)
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Simple (HTML)¶

Download (ExampleSimple.html), Test (ExampleSimple.html)

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>LED Strip Bricklet Simple Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var ls = new Tinkerforge.BrickletLEDStrip(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // 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]);
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)¶

Download (ExampleCallback.html), Test (ExampleCallback.html)

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>LED Strip Bricklet Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                var NUM_LEDS = 16;
                var r = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
                var g = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
                var b = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
                var rIndex = 0;
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var ls = new Tinkerforge.BrickletLEDStrip(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Set frame duration to 50ms (20 frames per second)
                        ls.setFrameDuration(50);
                        // Set initial rgb values to get started
                        ls.setRGBValues(0, NUM_LEDS, r, g, b);
                    }
                );

                // Register frame rendered callback
                ls.on(Tinkerforge.BrickletLEDStrip.CALLBACK_FRAME_RENDERED,
                    // Use frame rendered callback to move the active LED every frame
                    function (length) {
                        b[rIndex] = 0;
                        if(rIndex === NUM_LEDS-1) {
                            rIndex = 0;
                        }
                        else {
                            rIndex += 1;
                        }
                        b[rIndex] = 255;

                        // Set new data for next render cycle
                        ls.setRGBValues(0, NUM_LEDS, r, g, b)
                    }
                );
            }
        </script>
    </body>
</html>

API¶

Allgemein kann jede Funktion der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Funktion als Argumente aufgerufen, falls die Funktion ihre Ergebnisse asynchron zurückgibt. Die errorCallback-Funktion wird im Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der folgenden Werte sein:

IPConnection.ERROR_ALREADY_CONNECTED = 11
IPConnection.ERROR_NOT_CONNECTED = 12
IPConnection.ERROR_CONNECT_FAILED = 13
IPConnection.ERROR_INVALID_FUNCTION_ID = 21
IPConnection.ERROR_TIMEOUT = 31
IPConnection.ERROR_INVALID_PARAMETER = 41
IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
IPConnection.ERROR_UNKNOWN_ERROR = 43
IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen¶

new BrickletLEDStrip(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	ledStrip – Typ: BrickletLEDStrip

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

var ledStrip = new BrickletLEDStrip("YOUR_DEVICE_UID", ipcon)

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

BrickletLEDStrip.setRGBValues(index, length, r, g, b[, returnCallback][, errorCallback])¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 319] length – Typ: int, Wertebereich: [0 bis 16] r – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255] g – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255] b – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]
Callback-Parameter:	undefined
Rückgabe:	undefined

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 CALLBACK_FRAME_RENDERED Callback.
Setze alle LEDs für den nächsten Frame.
Warte auf CALLBACK_FRAME_RENDERED 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.getRGBValues(index, length[, returnCallback][, errorCallback])¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 319] length – Typ: int, Wertebereich: [0 bis 16]
Callback-Parameter:	r – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255] g – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255] b – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]
Rückgabe:	undefined

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

Die Werte sind die letzten von setRGBValues() gesetzten Werte.

BrickletLEDStrip.setFrameDuration(duration[, returnCallback][, errorCallback])¶

Parameter:	duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 100
Callback-Parameter:	undefined
Rückgabe:	undefined

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

BrickletLEDStrip.getFrameDuration([returnCallback][, errorCallback])¶

Callback-Parameter:	duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 100
Rückgabe:	undefined

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

BrickletLEDStrip.getSupplyVoltage([returnCallback][, errorCallback])¶

Callback-Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	undefined

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

BrickletLEDStrip.setClockFrequency(frequency[, returnCallback][, errorCallback])¶

Parameter:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666
Callback-Parameter:	undefined
Rückgabe:	undefined

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.

Added in version 2.0.1$nbsp;(Plugin).

BrickletLEDStrip.getClockFrequency([returnCallback][, errorCallback])¶

Callback-Parameter:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666
Rückgabe:	undefined

Gibt die aktuell genutzte Clock-Frequenz zurück, wie von setClockFrequency() gesetzt.

Added in version 2.0.1$nbsp;(Plugin).

BrickletLEDStrip.setChipType(chip[, returnCallback][, errorCallback])¶

Parameter:	chip – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2801
Callback-Parameter:	undefined
Rückgabe:	undefined

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

Added in version 2.0.2$nbsp;(Plugin).

BrickletLEDStrip.getChipType([returnCallback][, errorCallback])¶

Callback-Parameter:	chip – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2801
Rückgabe:	undefined

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

Added in version 2.0.2$nbsp;(Plugin).

BrickletLEDStrip.setRGBWValues(index, length, r, g, b, w[, returnCallback][, errorCallback])¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 239] length – Typ: int, Wertebereich: [0 bis 12] r – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] g – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] b – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] w – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]
Callback-Parameter:	undefined
Rückgabe:	undefined

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 CALLBACK_FRAME_RENDERED Callback.
Setze alle LEDs für den nächsten Frame.
Warte auf CALLBACK_FRAME_RENDERED 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.

Added in version 2.0.6$nbsp;(Plugin).

BrickletLEDStrip.getRGBWValues(index, length[, returnCallback][, errorCallback])¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 239] length – Typ: int, Wertebereich: [0 bis 12]
Callback-Parameter:	r – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] g – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] b – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] w – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]
Rückgabe:	undefined

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

Die Werte sind die letzten von setRGBWValues() gesetzten Werte.

Added in version 2.0.6$nbsp;(Plugin).

BrickletLEDStrip.setChannelMapping(mapping[, returnCallback][, errorCallback])¶

Parameter:	mapping – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 36
Callback-Parameter:	undefined
Rückgabe:	undefined

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

Added in version 2.0.6$nbsp;(Plugin).

BrickletLEDStrip.getChannelMapping([returnCallback][, errorCallback])¶

Callback-Parameter:	mapping – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 36
Rückgabe:	undefined

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

Added in version 2.0.6$nbsp;(Plugin).

Fortgeschrittene Funktionen¶

BrickletLEDStrip.getIdentity([returnCallback][, errorCallback])¶

Callback-Parameter:

Callback-Parameter:	uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] firmwareVersion – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	undefined

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
hardwareVersion – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

firmwareVersion – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Rückgabe:

undefined

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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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¶

BrickletLEDStrip.on(callback_id, function[, errorCallback])¶

Parameter:	callback_id – Typ: int function – Typ: function
Rückgabe:	undefined

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletLEDStrip.enableFrameRenderedCallback([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert den CALLBACK_FRAME_RENDERED Callback.

Standardmäßig ist der Callback aktiviert.

Added in version 2.0.6$nbsp;(Plugin).

BrickletLEDStrip.disableFrameRenderedCallback([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Deaktiviert den CALLBACK_FRAME_RENDERED Callback.

Standardmäßig ist der Callback aktiviert.

Added in version 2.0.6$nbsp;(Plugin).

BrickletLEDStrip.isFrameRenderedCallbackEnabled([returnCallback][, errorCallback])¶

Callback-Parameter:	enabled – Typ: boolean, Standardwert: true
Rückgabe:	undefined

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

Added in version 2.0.6$nbsp;(Plugin).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion on() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

ledStrip.on(BrickletLEDStrip.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletLEDStrip.CALLBACK_FRAME_RENDERED¶

Callback-Parameter:	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().

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.

BrickletLEDStrip.getAPIVersion()¶

Rückgabe:	apiVersion – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, 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.

BrickletLEDStrip.getResponseExpected(functionId[, errorCallback])¶

Parameter:	functionId – Typ: int, 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 function_id:

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

BrickletLEDStrip.setResponseExpected(functionId, responseExpected[, errorCallback])¶

Parameter:	functionId – Typ: int, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean
Rückgabe:	undefined

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

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

Für function_id:

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

BrickletLEDStrip.setResponseExpectedAll(responseExpected)¶

Parameter:	responseExpected – Typ: boolean
Rückgabe:	undefined

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

Konstanten¶

BrickletLEDStrip.DEVICE_IDENTIFIER¶

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

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

BrickletLEDStrip.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet dar.