Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets / DMX Bricklet

JavaScript - DMX Bricklet¶

Dies ist die Beschreibung der JavaScript API Bindings für das DMX Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DMX 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 DMX Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dmx = new Tinkerforge.BrickletDMX(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) {
        // Configure Bricklet as DMX master
        dmx.setDMXMode(Tinkerforge.BrickletDMX.DMX_MODE_MASTER);

        // Write DMX frame with 3 channels
        dmx.writeFrame([255, 128, 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 ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dmx = new Tinkerforge.BrickletDMX(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) {
        // Configure Bricklet as DMX master
        dmx.setDMXMode(Tinkerforge.BrickletDMX.DMX_MODE_MASTER);
    }
);

// Register frame started callback
dmx.on(Tinkerforge.BrickletDMX.CALLBACK_FRAME_STARTED,
    function () {
        // Write DMX frame with 3 channels again to constantly send these values
        dmx.writeFrame([255, 128, 0]);
    }
);

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>DMX 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 dmx = new Tinkerforge.BrickletDMX(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) {
                        // Configure Bricklet as DMX master
                        dmx.setDMXMode(Tinkerforge.BrickletDMX.DMX_MODE_MASTER);

                        // Write DMX frame with 3 channels
                        dmx.writeFrame([255, 128, 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>DMX 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();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var dmx = new Tinkerforge.BrickletDMX(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) {
                        // Configure Bricklet as DMX master
                        dmx.setDMXMode(Tinkerforge.BrickletDMX.DMX_MODE_MASTER);
                    }
                );

                // Register frame started callback
                dmx.on(Tinkerforge.BrickletDMX.CALLBACK_FRAME_STARTED,
                    function () {
                        // Write DMX frame with 3 channels again to constantly send these values
                        dmx.writeFrame([255, 128, 0]);
                    }
                );
            }
        </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 BrickletDMX(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	dmx – Typ: BrickletDMX

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

var dmx = new BrickletDMX("YOUR_DEVICE_UID", ipcon)

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

BrickletDMX.setDMXMode(dmxMode[, returnCallback][, errorCallback])¶

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

Setzt den DMX Modus entweder auf Master oder Slave.

Ein Aufruf dieser Funktion setzt die Frame-Nummer auf 0.

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

Für dmx_mode:

BrickletDMX.DMX_MODE_MASTER = 0
BrickletDMX.DMX_MODE_SLAVE = 1

BrickletDMX.getDMXMode([returnCallback][, errorCallback])¶

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

Gibt den DMX Modus zurück, wie von setDMXMode() gesetzt.

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

Für dmx_mode:

BrickletDMX.DMX_MODE_MASTER = 0
BrickletDMX.DMX_MODE_SLAVE = 1

BrickletDMX.writeFrame(frame[, returnCallback][, errorCallback])¶

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

Schreibt einen DMX Frame. Die maximale Framegröße ist 512 Byte. Jedes Byte stellt dabei einen Kanal dar.

Das nächste Frame kann geschrieben werden nachdem der CALLBACK_FRAME_STARTED Callback aufgerufen wurde. Das Frame verfügt über einen Doublebuffer, so dass ein neues Frame geschrieben werden kann, sobald das vorherige Frame geschrieben wurde.

Die Daten werden transferiert, wenn die nächste Frame Duration abgelaufen ist, siehe see setFrameDuration().

Genereller Ansatz:

Setze Frame Duration auf einen Wert welcher der Anzahl der Bilder pro Sekunde entspricht die erreicht werden sollen.
Setze alle Kanäle für den ersten Frame.
Warte auf CALLBACK_FRAME_STARTED Callback.
Setze alle Kanäle für den nächsten Frame.
Warte auf CALLBACK_FRAME_STARTED Callback.
Und so weiter.

Dieser Ansatz garantiert, dass DMX Daten mit einer festen Framerate gesetzt werden.

Diese Funktion kann nur im Master Modus aufgerufen werden.

BrickletDMX.readFrame([returnCallback][, errorCallback])¶

Callback-Parameter:	frame – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255] frameNumber – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

Gibt das letzte Frame zurück, dass von dem DMX Master geschrieben wurde. Die Größe des Arrays ist identisch zu der Anzahl der Kanäle im Frame. Jedes Byte repräsentiert ein Kanal.

Das nächste Frame ist verfügbar nachdem der CALLBACK_FRAME_AVAILABLE Callback aufgerufen wurde.

Genereller Ansatz:

Aufruf von readFrame() um das erste Frame zu bekommen.
Warten auf den CALLBACK_FRAME_AVAILABLE Callback.
Aufruf von readFrame() um das zweite Frame zu bekommen.
Warten auf den CALLBACK_FRAME_AVAILABLE Callback.
Und so weiter.

Anstatt das diese Funktion gepollt wird, kann auch der CALLBACK_FRAME Callback genutzt werden. Der Callback kann mit setFrameCallbackConfig() aktiviert werden.

Die frame number startet mit 0 und wird für jedes empfangene Frame erhöht.

Diese Funktion kann nur im Slave Modus aufgerufen werden.

BrickletDMX.setFrameDuration(frameDuration[, returnCallback][, errorCallback])¶

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

Setzt die Dauer eines Frames.

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die frame duration auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Soll jeweils ein Frame so schnell wie möglich gesendet werden, so sollte die frame duration auf 0 gesetzt werden.

Diese Einstellung wird nur im Master Modus genutzt.

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

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

Gibt die Frame duration zurück die mittels setFrameDuration() gesetzt wurde.

Fortgeschrittene Funktionen¶

BrickletDMX.getFrameErrorCount([returnCallback][, errorCallback])¶

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

Gibt die aktuelle Anzahl an Overrun und Framing Fehlern zurück.

BrickletDMX.setCommunicationLEDConfig(config[, returnCallback][, errorCallback])¶

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

Setzt die Konfiguration der Kommunikations-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 Bootloadermodus befindet ist die LED aus.

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

Für config:

BrickletDMX.COMMUNICATION_LED_CONFIG_OFF = 0
BrickletDMX.COMMUNICATION_LED_CONFIG_ON = 1
BrickletDMX.COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletDMX.COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

BrickletDMX.getCommunicationLEDConfig([returnCallback][, errorCallback])¶

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

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

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

Für config:

BrickletDMX.COMMUNICATION_LED_CONFIG_OFF = 0
BrickletDMX.COMMUNICATION_LED_CONFIG_ON = 1
BrickletDMX.COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletDMX.COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

BrickletDMX.setErrorLEDConfig(config[, returnCallback][, errorCallback])¶

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

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe CALLBACK_FRAME_ERROR_COUNT Callback). Wenn diese Funktion danach nochmal mit der Show-Error-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

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

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

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

Für config:

BrickletDMX.ERROR_LED_CONFIG_OFF = 0
BrickletDMX.ERROR_LED_CONFIG_ON = 1
BrickletDMX.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletDMX.ERROR_LED_CONFIG_SHOW_ERROR = 3

BrickletDMX.getErrorLEDConfig([returnCallback][, errorCallback])¶

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

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

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

Für config:

BrickletDMX.ERROR_LED_CONFIG_OFF = 0
BrickletDMX.ERROR_LED_CONFIG_ON = 1
BrickletDMX.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletDMX.ERROR_LED_CONFIG_SHOW_ERROR = 3

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

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

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

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

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

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

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

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

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

BrickletDMX.setFrameCallbackConfig(frameStartedCallbackEnabled, frameAvailableCallbackEnabled, frameCallbackEnabled, frameErrorCountCallbackEnabled[, returnCallback][, errorCallback])¶

Parameter:	frameStartedCallbackEnabled – Typ: boolean, Standardwert: true frameAvailableCallbackEnabled – Typ: boolean, Standardwert: true frameCallbackEnabled – Typ: boolean, Standardwert: false frameErrorCountCallbackEnabled – Typ: boolean, Standardwert: false
Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert/Deaktiviert die verschiedenen Callback. Standardmäßig sind der CALLBACK_FRAME_STARTED Callback und der CALLBACK_FRAME_AVAILABLE Callback aktiviert, während der CALLBACK_FRAME Callback und der CALLBACK_FRAME_ERROR_COUNT Callback deaktiviert sind.

Wenn der CALLBACK_FRAME Callback aktiviert wird dann kann der CALLBACK_FRAME_AVAILABLE Callback deaktiviert werden, da dieser dann redundant ist.

BrickletDMX.getFrameCallbackConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	frameStartedCallbackEnabled – Typ: boolean, Standardwert: true frameAvailableCallbackEnabled – Typ: boolean, Standardwert: true frameCallbackEnabled – Typ: boolean, Standardwert: false frameErrorCountCallbackEnabled – Typ: boolean, Standardwert: false
Rückgabe:	undefined

Gibt die Frame Callback Konfiguration zurück, wie von setFrameCallbackConfig() 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:

dmx.on(BrickletDMX.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.

BrickletDMX.CALLBACK_FRAME_STARTED¶

Callback-Parameter:	undefined

Dieser Callback wird ausgelöst sobald ein neuer Frame gestartet wurde. Nachdem dieser Callback empfangen wurde sollten die Daten für den nächsten Frame geschrieben werden.

Für eine Erklärung siehe die Beschreibung in der Funktion writeFrame().

Der Callback kann mittels setFrameCallbackConfig() aktiviert werden.

Dieser Callback wird nur im Master Modus ausgelöst.

BrickletDMX.CALLBACK_FRAME_AVAILABLE¶

Callback-Parameter:	frameNumber – Typ: int, Wertebereich: [0 bis 2³² - 1]

Dieser Callback wird im Slave Modus ausgelöst, wenn ein neuer Frame vom DMX Master empfangen wurde und nun ausgelesen werden kann. Der Frame muss ausgelesen werden, bevor der Master ein neues Frame schreibt. Siehe readFrame() für weitere Details.

Der Parameter ist die Frame-Nummer, diese wird für jeden empfangenen Frame um eins erhöht.

Der Callback kann mittels setFrameCallbackConfig() aktiviert werden.

Dieser Callback kann nur im Slave Modus ausgelöst werden.

BrickletDMX.CALLBACK_FRAME¶

Callback-Parameter:	frame – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255] frameNumber – Typ: int, Wertebereich: [0 bis 2³² - 1]

Dieser Callback wird aufgerufen sobald ein neuer Frame verfügbar ist (vom DMX Master geschrieben).

Die Größe des Arrays ist gleichbedeutend zu der Anzahl an Kanälen in dem Frame. Jedes Byte stellt einen Kanal dar.

Der Callback kann mittels setFrameCallbackConfig() aktiviert werden.

Dieser Callback kann nur im Slave Modus ausgelöst werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für frame ausgelöst.

BrickletDMX.CALLBACK_FRAME_ERROR_COUNT¶

Callback-Parameter:	overrunErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1] framingErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1]

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Framing Fehler zurück.

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.

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

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

BrickletDMX.FUNCTION_SET_DMX_MODE = 1
BrickletDMX.FUNCTION_WRITE_FRAME = 3
BrickletDMX.FUNCTION_SET_FRAME_DURATION = 5
BrickletDMX.FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
BrickletDMX.FUNCTION_SET_ERROR_LED_CONFIG = 10
BrickletDMX.FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
BrickletDMX.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletDMX.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletDMX.FUNCTION_RESET = 243
BrickletDMX.FUNCTION_WRITE_UID = 248

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

BrickletDMX.FUNCTION_SET_DMX_MODE = 1
BrickletDMX.FUNCTION_WRITE_FRAME = 3
BrickletDMX.FUNCTION_SET_FRAME_DURATION = 5
BrickletDMX.FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
BrickletDMX.FUNCTION_SET_ERROR_LED_CONFIG = 10
BrickletDMX.FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
BrickletDMX.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletDMX.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletDMX.FUNCTION_RESET = 243
BrickletDMX.FUNCTION_WRITE_UID = 248

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

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

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

Für status:

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

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

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

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

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

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

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

BrickletDMX.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein DMX 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.

BrickletDMX.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines DMX Bricklet dar.