Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets (Abgekündigt) / Remote Switch Bricklet

JavaScript - Remote Switch Bricklet¶

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

Switch Socket (Node.js)¶

Download (ExampleSwitchSocket.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rs = new Tinkerforge.BrickletRemoteSwitch(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) {
        // Switch on a type A socket with house code 17 and receiver code 1.
        // House code 17 is 10001 in binary (least-significant bit first)
        // and means that the DIP switches 1 and 5 are on and 2-4 are off.
        // Receiver code 1 is 10000 in binary (least-significant bit first)
        // and means that the DIP switch A is on and B-E are off.
        rs.switchSocketA(17, 1, Tinkerforge.BrickletRemoteSwitch.SWITCH_TO_ON);
    }
);

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

Switch Socket (HTML)¶

Download (ExampleSwitchSocket.html), Test (ExampleSwitchSocket.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>Remote Switch Bricklet Switch Socket 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 rs = new Tinkerforge.BrickletRemoteSwitch(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) {
                        // Switch on a type A socket with house code 17 and receiver code 1.
                        // House code 17 is 10001 in binary (least-significant bit first)
                        // and means that the DIP switches 1 and 5 are on and 2-4 are off.
                        // Receiver code 1 is 10000 in binary (least-significant bit first)
                        // and means that the DIP switch A is on and B-E are off.
                        rs.switchSocketA(17, 1, Tinkerforge.BrickletRemoteSwitch.SWITCH_TO_ON);
                    }
                );
            }
        </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 BrickletRemoteSwitch(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	remoteSwitch – Typ: BrickletRemoteSwitch

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

var remoteSwitch = new BrickletRemoteSwitch("YOUR_DEVICE_UID", ipcon)

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

BrickletRemoteSwitch.switchSocket(houseCode, receiverCode, switchTo[, returnCallback][, errorCallback])¶

Parameter:	houseCode – Typ: int, Wertebereich: [0 bis 31] receiverCode – Typ: int, Wertebereich: [0 bis 31] switchTo – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	undefined
Rückgabe:	undefined

Diese Funktion ist veraltet und wurde durch switchSocketA() ersetzt.

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

Für switch_to:

BrickletRemoteSwitch.SWITCH_TO_OFF = 0
BrickletRemoteSwitch.SWITCH_TO_ON = 1

BrickletRemoteSwitch.getSwitchingState([returnCallback][, errorCallback])¶

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

Gibt den aktuellen Zustand des Schaltens zurück. Wenn der aktuell Zustand busy (beschäftigt) ist, sendet das Bricklet gerade einen Code um eine Steckdose zu schalten. Weitere Schaltanforderungen werden ignoriert bis der Zustand auf ready (fertig) wechselt.

Die Länge des Schaltvorgangs ist abhängig von der Anzahl der Wiederholungen, siehe setRepeats().

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

Für state:

BrickletRemoteSwitch.SWITCHING_STATE_READY = 0
BrickletRemoteSwitch.SWITCHING_STATE_BUSY = 1

BrickletRemoteSwitch.switchSocketA(houseCode, receiverCode, switchTo[, returnCallback][, errorCallback])¶

Parameter:	houseCode – Typ: int, Wertebereich: [0 bis 31] receiverCode – Typ: int, Wertebereich: [0 bis 31] switchTo – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	undefined
Rückgabe:	undefined

Um eine Typ A Steckdose zu schalten muss der Housecode, Receivercode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Eine detaillierte Beschreibung wie man den House- und Receivercode herausfinden kann gibt es hier.

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

Für switch_to:

BrickletRemoteSwitch.SWITCH_TO_OFF = 0
BrickletRemoteSwitch.SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch.switchSocketB(address, unit, switchTo[, returnCallback][, errorCallback])¶

Parameter:	address – Typ: int, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: int, Wertebereich: [0 bis 15, 255] switchTo – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	undefined
Rückgabe:	undefined

Um eine Typ B Steckdose zu schalten muss die Adresse und Unit sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Um alle Geräte mit der selben Adresse zu schalten kann die Unit auf 255 gesetzt werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einer Steckdose anlernen kann gibt es hier.

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

Für switch_to:

BrickletRemoteSwitch.SWITCH_TO_OFF = 0
BrickletRemoteSwitch.SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch.dimSocketB(address, unit, dimValue[, returnCallback][, errorCallback])¶

Parameter:	address – Typ: int, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: int, Wertebereich: [0 bis 15, 255] dimValue – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:	undefined
Rückgabe:	undefined

Um eine Typ B Dimmer zu steuern muss die Adresse und Unit sowie der Dimmwert auf der Dimmer gesetzt werden soll übergeben werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einem Dimmer anlernen kann gibt es hier.

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch.switchSocketC(systemCode, deviceCode, switchTo[, returnCallback][, errorCallback])¶

Parameter:	systemCode – Typ: char, Wertebereich: ['A' bis 'P'] deviceCode – Typ: int, Wertebereich: [1 bis 16] switchTo – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	undefined
Rückgabe:	undefined

Um eine Typ C Steckdose zu schalten muss der Systemcode, Gerätecode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Eine detaillierte Beschreibung wie man den System- und Gerätecode herausfinden kann gibt es hier.

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

Für switch_to:

BrickletRemoteSwitch.SWITCH_TO_OFF = 0
BrickletRemoteSwitch.SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen¶

BrickletRemoteSwitch.setRepeats(repeats[, returnCallback][, errorCallback])¶

Parameter:	repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der Schalt-Funktionen aufgerufen wird. Die Wiederholungen korrespondieren zu der Zeit die eine Taste auf der Fernbedienung gedrückt wird.

Einige Dimmer werden über die Länge des Tastendrucks kontrolliert, dies kann simuliert werden indem man die Anzahl der Wiederholungen inkrementiert.

BrickletRemoteSwitch.getRepeats([returnCallback][, errorCallback])¶

Callback-Parameter:	repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5
Rückgabe:	undefined

Gibt die Anzahl der Wiederholungen zurück, wie von setRepeats() gesetzt.

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

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

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:

remoteSwitch.on(BrickletRemoteSwitch.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.

BrickletRemoteSwitch.CALLBACK_SWITCHING_DONE¶

Callback-Parameter:	undefined

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe getSwitchingState().

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.

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

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

BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
BrickletRemoteSwitch.FUNCTION_SET_REPEATS = 4
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
BrickletRemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9

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

BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
BrickletRemoteSwitch.FUNCTION_SET_REPEATS = 4
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
BrickletRemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9

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

BrickletRemoteSwitch.DEVICE_IDENTIFIER¶

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

BrickletRemoteSwitch.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet dar.