Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets / LED Strip Bricklet 2.0

JavaScript - LED Strip Bricklet 2.0¶

Dies ist die Beschreibung der JavaScript 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 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 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ls = new Tinkerforge.BrickletLEDStripV2(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 3 LEDs to red, green and blue
        ls.setLEDValues(0, [255, 0, 0, 0, 255, 0, 0, 0, 255]);
    }
);

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');

// FIXME: This example is incomplete

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ls = new Tinkerforge.BrickletLEDStripV2(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);
    }
);

// Register frame started callback
ls.on(Tinkerforge.BrickletLEDStripV2.CALLBACK_FRAME_STARTED,
    // Use frame started callback to move the active LED every frame
    function (length) {
        console.log('Length: ' + length);
    }
);

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 2.0 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.BrickletLEDStripV2(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 3 LEDs to red, green and blue
                        ls.setLEDValues(0, [255, 0, 0, 0, 255, 0, 0, 0, 255]);
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)¶

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

<!DOCTYPE html>

<!-- FIXME: This example is incomplete -->

<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 2.0 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();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var ls = new Tinkerforge.BrickletLEDStripV2(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);
                    }
                );

                // Register frame started callback
                ls.on(Tinkerforge.BrickletLEDStripV2.CALLBACK_FRAME_STARTED,
                    // Use frame started callback to move the active LED every frame
                    function (length) {
                        textArea.value += 'Length: ' + length + '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </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 BrickletLEDStripV2(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	ledStripV2 – Typ: BrickletLEDStripV2

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

var ledStripV2 = new BrickletLEDStripV2("YOUR_DEVICE_UID", ipcon)

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

BrickletLEDStripV2.setLEDValues(index, value[, returnCallback][, errorCallback])¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 6144] value – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]
Callback-Parameter:	undefined
Rückgabe:	undefined

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

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

BrickletLEDStripV2.getLEDValues(index, length[, returnCallback][, errorCallback])¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 6144] length – Typ: int, Wertebereich: [0 bis 6144]
Callback-Parameter:	value – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]
Rückgabe:	undefined

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

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

Standardwert: 100ms (10 Frames pro Sekunde).

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

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

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

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.

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

BrickletLEDStripV2.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),
WS2813 / WS2815 (Chip Type = WS2812)
LPD8806 and
APA102 / DotStar.

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

Für chip:

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

BrickletLEDStripV2.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:

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

BrickletLEDStripV2.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 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:

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

BrickletLEDStripV2.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:

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

Fortgeschrittene Funktionen¶

BrickletLEDStripV2.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback-Parameter:	errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

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.

BrickletLEDStripV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

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

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:

BrickletLEDStripV2.STATUS_LED_CONFIG_OFF = 0
BrickletLEDStripV2.STATUS_LED_CONFIG_ON = 1
BrickletLEDStripV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLEDStripV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletLEDStripV2.getStatusLEDConfig([returnCallback][, errorCallback])¶

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

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

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

Für config:

BrickletLEDStripV2.STATUS_LED_CONFIG_OFF = 0
BrickletLEDStripV2.STATUS_LED_CONFIG_ON = 1
BrickletLEDStripV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLEDStripV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletLEDStripV2.getChipTemperature([returnCallback][, errorCallback])¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	undefined

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.

BrickletLEDStripV2.reset([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

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.

BrickletLEDStripV2.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¶

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

BrickletLEDStripV2.setFrameStartedCallbackConfiguration(enable[, returnCallback][, errorCallback])¶

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

Aktiviert/deaktiviert den CALLBACK_FRAME_STARTED Callback.

BrickletLEDStripV2.getFrameStartedCallbackConfiguration([returnCallback][, errorCallback])¶

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

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 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:

ledStripV2.on(BrickletLEDStripV2.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.

BrickletLEDStripV2.CALLBACK_FRAME_STARTED¶

Callback-Parameter:	length – Typ: int, 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.

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

BrickletLEDStripV2.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:

BrickletLEDStripV2.FUNCTION_SET_LED_VALUES = 1
BrickletLEDStripV2.FUNCTION_SET_FRAME_DURATION = 3
BrickletLEDStripV2.FUNCTION_SET_CLOCK_FREQUENCY = 7
BrickletLEDStripV2.FUNCTION_SET_CHIP_TYPE = 9
BrickletLEDStripV2.FUNCTION_SET_CHANNEL_MAPPING = 11
BrickletLEDStripV2.FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
BrickletLEDStripV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletLEDStripV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletLEDStripV2.FUNCTION_RESET = 243
BrickletLEDStripV2.FUNCTION_WRITE_UID = 248

BrickletLEDStripV2.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:

BrickletLEDStripV2.FUNCTION_SET_LED_VALUES = 1
BrickletLEDStripV2.FUNCTION_SET_FRAME_DURATION = 3
BrickletLEDStripV2.FUNCTION_SET_CLOCK_FREQUENCY = 7
BrickletLEDStripV2.FUNCTION_SET_CHIP_TYPE = 9
BrickletLEDStripV2.FUNCTION_SET_CHANNEL_MAPPING = 11
BrickletLEDStripV2.FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
BrickletLEDStripV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletLEDStripV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletLEDStripV2.FUNCTION_RESET = 243
BrickletLEDStripV2.FUNCTION_WRITE_UID = 248

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

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.

BrickletLEDStripV2.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

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:

BrickletLEDStripV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletLEDStripV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

BrickletLEDStripV2.BOOTLOADER_STATUS_OK = 0
BrickletLEDStripV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletLEDStripV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletLEDStripV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletLEDStripV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletLEDStripV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletLEDStripV2.getBootloaderMode([returnCallback][, errorCallback])¶

Callback-Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für mode:

BrickletLEDStripV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletLEDStripV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletLEDStripV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

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.

BrickletLEDStripV2.writeFirmware(data[, returnCallback][, errorCallback])¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Callback-Parameter:	status – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

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.

BrickletLEDStripV2.writeUID(uid[, returnCallback][, errorCallback])¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

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.

BrickletLEDStripV2.readUID([returnCallback][, errorCallback])¶

Callback-Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

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

Konstanten¶

BrickletLEDStripV2.DEVICE_IDENTIFIER¶

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

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