Java - Remote Switch Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Switch Socket

Download (ExampleSwitchSocket.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRemoteSwitch;

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
    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
        BrickletRemoteSwitch rs = new BrickletRemoteSwitch(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((short)17, (short)1, BrickletRemoteSwitch.SWITCH_TO_ON);

        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 BrickletRemoteSwitch(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • remoteSwitch – Typ: BrickletRemoteSwitch

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

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

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

void BrickletRemoteSwitch.switchSocket(short houseCode, short receiverCode, short switchTo)
Parameter:
  • houseCode – Typ: short, Wertebereich: [0 bis 255]
  • receiverCode – Typ: short, Wertebereich: [0 bis 255]
  • switchTo – Typ: short, Wertebereich: Siehe Konstanten

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

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

Für switchTo:

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1
short BrickletRemoteSwitch.getSwitchingState()
Rückgabe:
  • state – Typ: short, 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 von switchSocket() 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
void BrickletRemoteSwitch.switchSocketA(short houseCode, short receiverCode, short switchTo)
Parameter:
  • houseCode – Typ: short, Wertebereich: [0 bis 255]
  • receiverCode – Typ: short, Wertebereich: [0 bis 255]
  • switchTo – Typ: short, 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.

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

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

void BrickletRemoteSwitch.switchSocketB(long address, short unit, short switchTo)
Parameter:
  • address – Typ: long, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: short, Wertebereich: [0 bis 255]
  • switchTo – Typ: short, 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.

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

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

void BrickletRemoteSwitch.dimSocketB(long address, short unit, short dimValue)
Parameter:
  • address – Typ: long, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: short, Wertebereich: [0 bis 255]
  • dimValue – Typ: short, 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.

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.

Neu in Version 2.0.1 (Plugin).

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

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

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

void BrickletRemoteSwitch.setRepeats(short repeats)
Parameter:
  • repeats – Typ: short, Wertebereich: [0 bis 255]

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

short BrickletRemoteSwitch.getRepeats()
Rückgabe:
  • repeats – Typ: short, Wertebereich: [0 bis 255]

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

short[] BrickletRemoteSwitch.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: short[], 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.

boolean BrickletRemoteSwitch.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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:

  • 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
void BrickletRemoteSwitch.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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.

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:

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

BrickletRemoteSwitch.Identity BrickletRemoteSwitch.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 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 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.

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 BrickletRemoteSwitch.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 BrickletRemoteSwitch.SwitchingDoneListener()

Dieser Listener kann mit der Funktion addSwitchingDoneListener() hinzugefügt werde. 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().

Konstanten

int BrickletRemoteSwitch.DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet dar.