Java - Dual Relay Bricklet

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

Simple

Download (ExampleSimple.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
31
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletDualRelay;

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

    // Change XYZ to the UID of your Dual Relay 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
        BrickletDualRelay dr = new BrickletDualRelay(UID, ipcon); // Create device object

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

        // Turn relays alternating on/off 10 times with 1 second delay
        for(int i = 0; i < 5; i++) {
            Thread.sleep(1000);
            dr.setState(true, false);
            Thread.sleep(1000);
            dr.setState(false, true);
        }

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

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

BrickletDualRelay dualRelay = new BrickletDualRelay("YOUR_DEVICE_UID", ipcon);

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

void BrickletDualRelay.setState(boolean relay1, boolean relay2)
Parameter:
  • relay1 – Typ: boolean, Standardwert: false
  • relay2 – Typ: boolean, Standardwert: false

Setzt den Zustand der Relais, true bedeutet ein und false aus. Beispiel: (true, false) schaltet Relais 1 ein und Relais 2 aus.

Wenn nur eines der Relais gesetzt werden soll und der aktuelle Zustand des anderen Relais nicht bekannt ist, dann kann der Zustand mit getState() ausgelesen werden oder es kann setSelectedState() genutzt werden.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

BrickletDualRelay.State BrickletDualRelay.getState()
Rückgabeobjekt:
  • relay1 – Typ: boolean, Standardwert: false
  • relay2 – Typ: boolean, Standardwert: false

Gibt den Zustand der Relais zurück, true bedeutet ein und false aus.

Fortgeschrittene Funktionen

void BrickletDualRelay.setMonoflop(short relay, boolean state, long time)
Parameter:
  • relay – Typ: short, Wertebereich: [1 bis 2]
  • state – Typ: boolean
  • time – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Der erste Parameter kann 1 oder 2 sein (Relais 1 oder Relais 2). Der zweite Parameter ist der gewünschte Zustand des Relais (true bedeutet ein und false aus). Der dritte Parameter stellt die Zeit dar, welche das Relais den Zustand halten soll.

Wenn diese Funktion mit den Parametern (1, true, 1500) aufgerufen wird: Relais 1 wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Dual Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Das Relais wird die gesamte Zeit ein sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird das Relais nach spätestens zwei Sekunden ausschalten.

BrickletDualRelay.Monoflop BrickletDualRelay.getMonoflop(short relay)
Parameter:
  • relay – Typ: short, Wertebereich: [1 bis 2]
Rückgabeobjekt:
  • state – Typ: boolean
  • time – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
  • timeRemaining – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt (für das angegebene Relais) den aktuellen Zustand und die Zeit, wie von setMonoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

void BrickletDualRelay.setSelectedState(short relay, boolean state)
Parameter:
  • relay – Typ: short, Wertebereich: [1 bis 2]
  • state – Typ: boolean

Setzt den Zustand des ausgewählte Relais (1 oder 2), true bedeutet ein und false aus.

Ein laufender Monoflop Timer für das ausgewählte Relais wird abgebrochen, wenn diese Funktion aufgerufen wird.

Das andere Relais bleibt unangetastet.

BrickletDualRelay.Identity BrickletDualRelay.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'i', '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 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 BrickletDualRelay.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 BrickletDualRelay.MonoflopDoneListener()

Dieser Listener kann mit der Funktion addMonoflopDoneListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeMonoflopDoneListener() wieder entfernt werden.

void monoflopDone(short relay, boolean state)
Parameter:
  • relay – Typ: short, Wertebereich: [1 bis 2]
  • state – Typ: boolean

Dieser Listener wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Die Parameter enthalten das auslösende Relais (1 oder 2) und den aktuellen Zustand des Relais (der Zustand nach dem Monoflop).

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[] BrickletDualRelay.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 BrickletDualRelay.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:

  • BrickletDualRelay.FUNCTION_SET_STATE = 1
  • BrickletDualRelay.FUNCTION_SET_MONOFLOP = 3
  • BrickletDualRelay.FUNCTION_SET_SELECTED_STATE = 6
void BrickletDualRelay.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:

  • BrickletDualRelay.FUNCTION_SET_STATE = 1
  • BrickletDualRelay.FUNCTION_SET_MONOFLOP = 3
  • BrickletDualRelay.FUNCTION_SET_SELECTED_STATE = 6
void BrickletDualRelay.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.

Konstanten

int BrickletDualRelay.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Dual Relay 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 BrickletDualRelay.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Dual Relay Bricklet dar.