Software / API Bindings / Java / API Referenz und Beispiele / Bricklets / Remote Switch Bricklet 2.0

Java - Remote Switch Bricklet 2.0¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Switch Socket¶

Download (ExampleSwitchSocket.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRemoteSwitchV2;

public class ExampleSwitchSocket {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Remote Switch Bricklet 2.0
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRemoteSwitchV2 rs = new BrickletRemoteSwitchV2(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // 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, BrickletRemoteSwitchV2.SWITCH_TO_ON);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Remote Callback¶

Download (ExampleRemoteCallback.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRemoteSwitchV2;

public class ExampleRemoteCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Remote Switch Bricklet 2.0
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRemoteSwitchV2 rs = new BrickletRemoteSwitchV2(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Configure to receive from remote type A with minimum repeats set to 1 and enable callback
        rs.setRemoteConfiguration(BrickletRemoteSwitchV2.REMOTE_TYPE_A, 1, true);

        // Add remote status a listener
        rs.addRemoteStatusAListener(new BrickletRemoteSwitchV2.RemoteStatusAListener() {
            public void remoteStatusA(int houseCode, int receiverCode, int switchTo,
                                      int repeats) {
                System.out.println("House Code: " + houseCode);
                System.out.println("Receiver Code: " + receiverCode);

                if(switchTo == BrickletRemoteSwitchV2.SWITCH_TO_OFF) {
                    System.out.println("Switch To: Off");
                } else if(switchTo == BrickletRemoteSwitchV2.SWITCH_TO_ON) {
                    System.out.println("Switch To: On");
                }

                System.out.println("Repeats: " + repeats);
                System.out.println("");
            }
        });

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API¶

Prinzipiell kann jede Methode der Java Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen¶

class BrickletRemoteSwitchV2(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	remoteSwitchV2 – Typ: BrickletRemoteSwitchV2

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

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

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

int BrickletRemoteSwitchV2.getSwitchingState()¶

Rückgabe:	state – Typ: int, Wertebereich: Siehe Konstanten

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

void BrickletRemoteSwitchV2.switchSocketA(int houseCode, int receiverCode, int switchTo)¶

Parameter:	houseCode – Typ: int, Wertebereich: [0 bis 31] receiverCode – Typ: int, Wertebereich: [0 bis 31] switchTo – Typ: int, Wertebereich: Siehe Konstanten

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

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

void BrickletRemoteSwitchV2.switchSocketB(long address, int unit, int switchTo)¶

Parameter:	address – Typ: long, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: int, Wertebereich: [0 bis 15, 255] switchTo – Typ: int, Wertebereich: Siehe Konstanten

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

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

void BrickletRemoteSwitchV2.dimSocketB(long address, int unit, int dimValue)¶

Parameter:	address – Typ: long, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: int, Wertebereich: [0 bis 15, 255] dimValue – Typ: int, Wertebereich: [0 bis 255]

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.

void BrickletRemoteSwitchV2.switchSocketC(char systemCode, int deviceCode, int switchTo)¶

Parameter:	systemCode – Typ: char, Wertebereich: ['A' bis 'P'] deviceCode – Typ: int, Wertebereich: [1 bis 16] switchTo – Typ: int, Wertebereich: Siehe Konstanten

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

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

void BrickletRemoteSwitchV2.setRemoteConfiguration(int remoteType, int minimumRepeats, boolean callbackEnabled)¶

Parameter:	remoteType – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 minimumRepeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2 callbackEnabled – Typ: boolean, Standardwert: false

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 Listener ausgelöst wird (falls aktiviert).
Listener Enabled: Aktiviert/Deaktivert den Listener (siehe RemoteStatusAListener Listener, RemoteStatusBListener Listener und RemoteStatusCListener Listener).

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

Für remoteType:

BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2

BrickletRemoteSwitchV2.RemoteConfiguration BrickletRemoteSwitchV2.getRemoteConfiguration()¶

Rückgabeobjekt:	remoteType – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 minimumRepeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2 callbackEnabled – Typ: boolean, Standardwert: false

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

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

Für remoteType:

BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2

BrickletRemoteSwitchV2.RemoteStatusA BrickletRemoteSwitchV2.getRemoteStatusA()¶

Rückgabeobjekt:	houseCode – Typ: int, Wertebereich: [0 bis 31] receiverCode – Typ: int, Wertebereich: [0 bis 31] switchTo – Typ: int, Wertebereich: Siehe Konstanten repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

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 Listener ausgelöst werden, wenn Daten empfangen werden, siehe setRemoteConfiguration() und RemoteStatusAListener Listener.

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

Für switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

BrickletRemoteSwitchV2.RemoteStatusB BrickletRemoteSwitchV2.getRemoteStatusB()¶

Rückgabeobjekt:	address – Typ: long, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: int, Wertebereich: [0 bis 15] switchTo – Typ: int, Wertebereich: Siehe Konstanten dimValue – Typ: int, Wertebereich: [0 bis 255] repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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.

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 Listener ausgelöst werden, wenn Daten empfangen werden, siehe setRemoteConfiguration() und RemoteStatusBListener Listener.

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

Für switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

BrickletRemoteSwitchV2.RemoteStatusC BrickletRemoteSwitchV2.getRemoteStatusC()¶

Rückgabeobjekt:	systemCode – Typ: char, Wertebereich: ['A' bis 'P'] deviceCode – Typ: int, Wertebereich: [1 bis 16] switchTo – Typ: int, Wertebereich: Siehe Konstanten repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

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 Listener ausgelöst werden, wenn Daten empfangen werden, siehe setRemoteConfiguration() und RemoteStatusCListener Listener.

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

Für switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Fortgeschrittene Funktionen¶

void BrickletRemoteSwitchV2.setRepeats(int repeats)¶

Parameter:	repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5

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.

int BrickletRemoteSwitchV2.getRepeats()¶

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

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

BrickletRemoteSwitchV2.SPITFPErrorCount BrickletRemoteSwitchV2.getSPITFPErrorCount()¶

Rückgabeobjekt:	errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: long, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: long, Wertebereich: [0 bis 2³² - 1]

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.

void BrickletRemoteSwitchV2.setStatusLEDConfig(int config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

int BrickletRemoteSwitchV2.getStatusLEDConfig()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

int BrickletRemoteSwitchV2.getChipTemperature()¶

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

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.

void BrickletRemoteSwitchV2.reset()¶

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.Identity BrickletRemoteSwitchV2.getIdentity()¶

Rückgabeobjekt:

Rückgabeobjekt:	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: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

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: short[], Länge: 3

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

firmwareVersion – Typ: short[], Länge: 3

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

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

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.

Listener¶

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

device.addExampleListener(new BrickletRemoteSwitchV2.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden remove*Listener() wieder zu entfernen.

Bemerkung

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

class BrickletRemoteSwitchV2.SwitchingDoneListener()¶

Dieser Listener kann mit der Funktion addSwitchingDoneListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeSwitchingDoneListener() wieder entfernt werden.

void switchingDone(): Dieser Listener wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe getSwitchingState().

class BrickletRemoteSwitchV2.RemoteStatusAListener()¶

Dieser Listener kann mit der Funktion addRemoteStatusAListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeRemoteStatusAListener() wieder entfernt werden.

void remoteStatusA(int houseCode, int receiverCode, int switchTo, int repeats)

Parameter:	houseCode – Typ: int, Wertebereich: [0 bis 31] receiverCode – Typ: int, Wertebereich: [0 bis 31] switchTo – Typ: int, Wertebereich: Siehe Konstanten repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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 Listener wird bei jeder Wiederholung ausgelöst.

Der Listener 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 Listener das erste mal ausgelöst wird.

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

Für switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

class BrickletRemoteSwitchV2.RemoteStatusBListener()¶

Dieser Listener kann mit der Funktion addRemoteStatusBListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeRemoteStatusBListener() wieder entfernt werden.

void remoteStatusB(long address, int unit, int switchTo, int dimValue, int repeats)

Parameter:	address – Typ: long, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: int, Wertebereich: [0 bis 15, 255] switchTo – Typ: int, Wertebereich: Siehe Konstanten dimValue – Typ: int, Wertebereich: [0 bis 255] repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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 folgenden Konstanten sind für diese Funktion verfügbar:

Für switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

class BrickletRemoteSwitchV2.RemoteStatusCListener()¶

Dieser Listener kann mit der Funktion addRemoteStatusCListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeRemoteStatusCListener() wieder entfernt werden.

void remoteStatusC(char systemCode, int deviceCode, int switchTo, int repeats)

Parameter:	systemCode – Typ: char, Wertebereich: ['A' bis 'P'] deviceCode – Typ: int, Wertebereich: [1 bis 16] switchTo – Typ: int, Wertebereich: Siehe Konstanten repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

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

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

Für switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

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.

short[] BrickletRemoteSwitchV2.getAPIVersion()¶

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

boolean BrickletRemoteSwitchV2.getResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, 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 Listeners 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 functionId:

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

void BrickletRemoteSwitchV2.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean

Ä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 Listeners (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 functionId:

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

void BrickletRemoteSwitchV2.setResponseExpectedAll(boolean responseExpected)¶

Parameter:	responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners 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.

int BrickletRemoteSwitchV2.setBootloaderMode(int mode)¶

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

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:

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

int BrickletRemoteSwitchV2.getBootloaderMode()¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

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

void BrickletRemoteSwitchV2.setWriteFirmwarePointer(long pointer)¶

Parameter:	pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

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.

int BrickletRemoteSwitchV2.writeFirmware(int[] data)¶

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

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.

void BrickletRemoteSwitchV2.writeUID(long uid)¶

Parameter:	uid – Typ: long, Wertebereich: [0 bis 2³² - 1]

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.

long BrickletRemoteSwitchV2.readUID()¶

Rückgabe:	uid – Typ: long, Wertebereich: [0 bis 2³² - 1]

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

Konstanten¶

int BrickletRemoteSwitchV2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Remote Switch Bricklet 2.0 zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateListener Listener der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletRemoteSwitchV2.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet 2.0 dar.