Software / API Bindings / Java / API Referenz und Beispiele / Bricklets (Abgekündigt) / Dual Button Bricklet

Java - Dual Button Bricklet¶

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

Callback¶

Download (ExampleCallback.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletDualButton;

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

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

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

        // Add state changed listener
        db.addStateChangedListener(new BrickletDualButton.StateChangedListener() {
            public void stateChanged(short buttonL, short buttonR, short ledL,
                                     short ledR) {
                if(buttonL == BrickletDualButton.BUTTON_STATE_PRESSED) {
                    System.out.println("Left Button: Pressed");
                } else if(buttonL == BrickletDualButton.BUTTON_STATE_RELEASED) {
                    System.out.println("Left Button: Released");
                }

                if(buttonR == BrickletDualButton.BUTTON_STATE_PRESSED) {
                    System.out.println("Right Button: Pressed");
                } else if(buttonR == BrickletDualButton.BUTTON_STATE_RELEASED) {
                    System.out.println("Right Button: Released");
                }

                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 BrickletDualButton(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	dualButton – Typ: BrickletDualButton

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

BrickletDualButton dualButton = new BrickletDualButton("YOUR_DEVICE_UID", ipcon);

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

void BrickletDualButton.setLEDState(short ledL, short ledR)¶

Parameter:	ledL – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1 ledR – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt den Zustand der LEDs. Möglich Zustände sind:

0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit getLEDState() ausgelesen werden oder es kann setSelectedLEDState() genutzt werden.

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

Für ledL:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

Für ledR:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.LEDState BrickletDualButton.getLEDState()¶

Rückgabeobjekt:	ledL – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1 ledR – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den aktuellen Zustand der LEDs zurück, wie von setLEDState() gesetzt.

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

Für ledL:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

Für ledR:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.ButtonState BrickletDualButton.getButtonState()¶

Rückgabeobjekt:	buttonL – Typ: short, Wertebereich: Siehe Konstanten buttonR – Typ: short, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

0 = pressed (gedrückt)
1 = released (losgelassen)

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

Für buttonL:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für buttonR:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

Fortgeschrittene Funktionen¶

void BrickletDualButton.setSelectedLEDState(short led, short state)¶

Parameter:	led – Typ: short, Wertebereich: Siehe Konstanten state – Typ: short, Wertebereich: Siehe Konstanten

Setzt den Zustand der selektierten LED (0 oder 1).

Die andere LED bleibt unangetastet.

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

Für led:

BrickletDualButton.LED_LEFT = 0
BrickletDualButton.LED_RIGHT = 1

Für state:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.Identity BrickletDualButton.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 BrickletDualButton.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 BrickletDualButton.StateChangedListener()¶

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

void stateChanged(short buttonL, short buttonR, short ledL, short ledR)

Parameter:	buttonL – Typ: short, Wertebereich: Siehe Konstanten buttonR – Typ: short, Wertebereich: Siehe Konstanten ledL – Typ: short, Wertebereich: Siehe Konstanten ledR – Typ: short, Wertebereich: Siehe Konstanten

Dieser Listener wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

0 = pressed (gedrückt)
1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

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

Für buttonL:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für buttonR:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für ledL:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

Für ledR:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

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

BrickletDualButton.FUNCTION_SET_LED_STATE = 1
BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

void BrickletDualButton.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:

BrickletDualButton.FUNCTION_SET_LED_STATE = 1
BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

void BrickletDualButton.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 BrickletDualButton.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Dual Button 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 BrickletDualButton.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet dar.