JavaScript - Remote Switch Bricklet 2.0

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

Switch Socket (Node.js)

Download (ExampleSwitchSocket.js)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
var Tinkerforge = require('tinkerforge');

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

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

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

Remote Callback (Node.js)

Download (ExampleRemoteCallback.js)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rs = new Tinkerforge.BrickletRemoteSwitchV2(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 to receive from remote type A with minimum repeats set to 1 and enable callback
        rs.setRemoteConfiguration(Tinkerforge.BrickletRemoteSwitchV2.REMOTE_TYPE_A, 1,
                                  true);
    }
);

// Register remote status a callback
rs.on(Tinkerforge.BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_A,
    // Callback function for remote status a callback
    function (houseCode, receiverCode, switchTo, repeats) {
        console.log('House Code: ' + houseCode);
        console.log('Receiver Code: ' + receiverCode);

        if(switchTo === Tinkerforge.BrickletRemoteSwitchV2.SWITCH_TO_OFF) {
            console.log('Switch To: Off');
        }
        else if(switchTo === Tinkerforge.BrickletRemoteSwitchV2.SWITCH_TO_ON) {
            console.log('Switch To: On');
        }

        console.log('Repeats: ' + repeats);
        console.log();
    }
);

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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<!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 2.0 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.BrickletRemoteSwitchV2(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.BrickletRemoteSwitchV2.SWITCH_TO_ON);
                    }
                );
            }
        </script>
    </body>
</html>

Remote Callback (HTML)

Download (ExampleRemoteCallback.html), Test (ExampleRemoteCallback.html)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<!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 2.0 Remote 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 rs = new Tinkerforge.BrickletRemoteSwitchV2(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 to receive from remote type A with minimum repeats set to 1 and enable callback
                        rs.setRemoteConfiguration(Tinkerforge.BrickletRemoteSwitchV2.REMOTE_TYPE_A, 1,
                                                  true);
                    }
                );

                // Register remote status a callback
                rs.on(Tinkerforge.BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_A,
                    // Callback function for remote status a callback
                    function (houseCode, receiverCode, switchTo, repeats) {
                        textArea.value += 'House Code: ' + houseCode + '\n';
                        textArea.value += 'Receiver Code: ' + receiverCode + '\n';

                        if(switchTo === Tinkerforge.BrickletRemoteSwitchV2.SWITCH_TO_OFF) {
                            textArea.value += 'Switch To: Off\n';
                        }
                        else if(switchTo === Tinkerforge.BrickletRemoteSwitchV2.SWITCH_TO_ON) {
                            textArea.value += 'Switch To: On\n';
                        }

                        textArea.value += 'Repeats: ' + repeats + '\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API

Allgemein kann jede Methode der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Methode als Argumente aufgerufen, falls die Methode 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

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen

new BrickletRemoteSwitchV2(uid, ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • remoteSwitchV2 – Typ: BrickletRemoteSwitchV2

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

var remoteSwitchV2 = new BrickletRemoteSwitchV2("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletRemoteSwitchV2.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 Aufrufe der Switch Socket Funktionen 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:

  • BrickletRemoteSwitchV2.SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitchV2.SWITCHING_STATE_BUSY = 1
BrickletRemoteSwitchV2.switchSocketA(houseCode, receiverCode, switchTo[, returnCallback][, errorCallback])
Parameter:
  • houseCode – Typ: int, Wertebereich: [0 bis 255]
  • receiverCode – Typ: int, Wertebereich: [0 bis 255]
  • 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.

Der House- und Receivercode hat einen Wertebereich von 0 bis 31 (5Bit).

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.switchSocketB(address, unit, switchTo[, returnCallback][, errorCallback])
Parameter:
  • address – Typ: int, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: int, Wertebereich: [0 bis 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.

Die Adresse hat einen Wertebereich von 0 bis 67108863 (26Bit) und die Unit hat einen Wertebereich von 0 bis 15 (4Bit). 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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.dimSocketB(address, unit, dimValue[, returnCallback][, errorCallback])
Parameter:
  • address – Typ: int, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: int, Wertebereich: [0 bis 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.

Die Adresse hat einen Wertebereich von 0 bis 67108863 (26Bit), die Unit und der Dimmwert haben einen Wertebereich von 0 bis 15 (4Bit).

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

BrickletRemoteSwitchV2.switchSocketC(systemCode, deviceCode, switchTo[, returnCallback][, errorCallback])
Parameter:
  • systemCode – Typ: char
  • deviceCode – Typ: int, Wertebereich: [0 bis 255]
  • 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.

Der Systemcode hat einen Wertebereich von 'A' bis 'P' (4Bit) und der Gerätecode hat einen Wertebereich von 1 bis 16 (4Bit).

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.setRemoteConfiguration(remoteType, minimumRepeats, callbackEnabled[, returnCallback][, errorCallback])
Parameter:
  • remoteType – Typ: int, Wertebereich: Siehe Konstanten
  • minimumRepeats – Typ: int, Wertebereich: [0 bis 216 - 1]
  • callbackEnabled – Typ: boolean
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die Konfiguration für das Empfangen von Daten von Fernbedienungen der Typen A, B und C.

  • Remote Type: A, B oder C abhängig vom Typ der Fernbedienung die empfangen werden soll.
  • Minimum Repeats: Die Mindestanzahl an wiederholten Datenpaketen bevor der Callback ausgelöst wird (falls aktiviert).
  • Callback Enabled: Aktiviert/Deaktivert den Callback (siehe CALLBACK_REMOTE_STATUS_A Callback, CALLBACK_REMOTE_STATUS_B Callback und CALLBACK_REMOTE_STATUS_C Callback).

Der Standardwert ist ('A', 2, false).

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

Für remote_type:

  • BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2
BrickletRemoteSwitchV2.getRemoteConfiguration([returnCallback][, errorCallback])
Callback-Parameter:
  • remoteType – Typ: int, Wertebereich: Siehe Konstanten
  • minimumRepeats – Typ: int, Wertebereich: [0 bis 216 - 1]
  • callbackEnabled – Typ: boolean
Rückgabe:
  • undefined

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

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

Für remote_type:

  • BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2
BrickletRemoteSwitchV2.getRemoteStatusA([returnCallback][, errorCallback])
Callback-Parameter:
  • houseCode – Typ: int, Wertebereich: [0 bis 255]
  • receiverCode – Typ: int, Wertebereich: [0 bis 255]
  • switchTo – Typ: int, Wertebereich: Siehe Konstanten
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit dem angegebenen House/Receivercode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe setRemoteConfiguration() und CALLBACK_REMOTE_STATUS_A Callback.

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

Für switch_to:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.getRemoteStatusB([returnCallback][, errorCallback])
Callback-Parameter:
  • address – Typ: int, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: int, Wertebereich: [0 bis 255]
  • switchTo – Typ: int, Wertebereich: Siehe Konstanten
  • dimValue – Typ: int, Wertebereich: [0 bis 255]
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Falls die Fernbedienung Dimmen unterstützt, dann wie der Dimmwert anstatt des Schaltzustandes verwendet.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen Address/Unit auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe setRemoteConfiguration() und CALLBACK_REMOTE_STATUS_B Callback.

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

Für switch_to:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.getRemoteStatusC([returnCallback][, errorCallback])
Callback-Parameter:
  • systemCode – Typ: char
  • deviceCode – Typ: int, Wertebereich: [0 bis 255]
  • switchTo – Typ: int, Wertebereich: Siehe Konstanten
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen System/Gerätecode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe setRemoteConfiguration() und CALLBACK_REMOTE_STATUS_C Callback.

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

Für switch_to:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Fortgeschrittene Funktionen

BrickletRemoteSwitchV2.setRepeats(repeats[, returnCallback][, errorCallback])
Parameter:
  • repeats – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der Switch Socket 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.

Der Standardwert ist 5.

BrickletRemoteSwitchV2.getRepeats([returnCallback][, errorCallback])
Callback-Parameter:
  • repeats – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • undefined

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

BrickletRemoteSwitchV2.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

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

  • BrickletRemoteSwitchV2.FUNCTION_SET_REPEATS = 3
  • BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_A = 5
  • BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_B = 6
  • BrickletRemoteSwitchV2.FUNCTION_DIM_SOCKET_B = 7
  • BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_C = 8
  • BrickletRemoteSwitchV2.FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BrickletRemoteSwitchV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRemoteSwitchV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRemoteSwitchV2.FUNCTION_RESET = 243
  • BrickletRemoteSwitchV2.FUNCTION_WRITE_UID = 248
BrickletRemoteSwitchV2.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.

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:

  • BrickletRemoteSwitchV2.FUNCTION_SET_REPEATS = 3
  • BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_A = 5
  • BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_B = 6
  • BrickletRemoteSwitchV2.FUNCTION_DIM_SOCKET_B = 7
  • BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_C = 8
  • BrickletRemoteSwitchV2.FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BrickletRemoteSwitchV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRemoteSwitchV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRemoteSwitchV2.FUNCTION_RESET = 243
  • BrickletRemoteSwitchV2.FUNCTION_WRITE_UID = 248
BrickletRemoteSwitchV2.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.

BrickletRemoteSwitchV2.getSPITFPErrorCount([returnCallback][, errorCallback])
Callback-Parameter:
  • errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: int, Wertebereich: [0 bis 232 - 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.

BrickletRemoteSwitchV2.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 Bootlodaer- 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:

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

Für status:

  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_OK = 0
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletRemoteSwitchV2.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:

  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletRemoteSwitchV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])
Parameter:
  • pointer – Typ: int, Wertebereich: [0 bis 232 - 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.

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

BrickletRemoteSwitchV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten
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:

  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_ON = 1
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRemoteSwitchV2.getStatusLEDConfig([returnCallback][, errorCallback])
Callback-Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten
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:

  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_ON = 1
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRemoteSwitchV2.getChipTemperature([returnCallback][, errorCallback])
Callback-Parameter:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • undefined

Gibt die Temperatur in °C, 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.

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

BrickletRemoteSwitchV2.writeUID(uid[, returnCallback][, errorCallback])
Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 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.

BrickletRemoteSwitchV2.readUID([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 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.

BrickletRemoteSwitchV2.getIdentity([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 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 kann 'a', 'b', 'c' oder 'd' sein.

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

BrickletRemoteSwitchV2.on(callback_id, function)
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:

remoteSwitchV2.on(BrickletRemoteSwitchV2.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.

BrickletRemoteSwitchV2.CALLBACK_SWITCHING_DONE
Callback-Parameter:
  • undefined

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

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_A
Callback-Parameter:
  • houseCode – Typ: int, Wertebereich: [0 bis 255]
  • receiverCode – Typ: int, Wertebereich: [0 bis 255]
  • switchTo – Typ: int, Wertebereich: Siehe Konstanten
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels setRemoteConfiguration(). Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

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

Für switch_to:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_B
Callback-Parameter:
  • address – Typ: int, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: int, Wertebereich: [0 bis 255]
  • switchTo – Typ: int, Wertebereich: Siehe Konstanten
  • dimValue – Typ: int, Wertebereich: [0 bis 255]
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels setRemoteConfiguration(). Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

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

Für switch_to:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_C
Callback-Parameter:
  • systemCode – Typ: char
  • deviceCode – Typ: int, Wertebereich: [0 bis 255]
  • switchTo – Typ: int, Wertebereich: Siehe Konstanten
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels setRemoteConfiguration(). Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

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

Für switch_to:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Konstanten

BrickletRemoteSwitchV2.DEVICE_IDENTIFIER

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

BrickletRemoteSwitchV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet 2.0 dar.