Java - Joystick Bricklet

Dies ist die Beschreibung der Java API Bindings für das Joystick Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Joystick 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletJoystick;
import com.tinkerforge.BrickletJoystick.Position;

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

    // Change XYZ to the UID of your Joystick 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
        BrickletJoystick j = new BrickletJoystick(UID, ipcon); // Create device object

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

        // Get current position
        Position position = j.getPosition(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("Position [X]: " + position.x);
        System.out.println("Position [Y]: " + position.y);

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

Callback

Download (ExampleCallback.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
32
33
34
35
36
37
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletJoystick;

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

    // Change XYZ to the UID of your Joystick 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
        BrickletJoystick j = new BrickletJoystick(UID, ipcon); // Create device object

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

        // Add pressed listener
        j.addPressedListener(new BrickletJoystick.PressedListener() {
            public void pressed() {
                System.out.println("Pressed");
            }
        });

        // Add released listener
        j.addReleasedListener(new BrickletJoystick.ReleasedListener() {
            public void released() {
                System.out.println("Released");
            }
        });

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

Find Borders

Download (ExampleFindBorders.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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletJoystick;

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

    // Change XYZ to the UID of your Joystick 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
        BrickletJoystick j = new BrickletJoystick(UID, ipcon); // Create device object

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

        // Get threshold callbacks with a debounce time of 0.2 seconds (200ms)
        j.setDebouncePeriod(200);

        // Add position reached listener
        j.addPositionReachedListener(new BrickletJoystick.PositionReachedListener() {
            public void positionReached(short x, short y) {
                if(y == 100) {
                    System.out.println("Top");
                } else if(y == -100) {
                    System.out.println("Bottom");
                }

                if(x == 100) {
                    System.out.println("Right");
                } else if(x == -100) {
                    System.out.println("Left");
                }

                System.out.println("");
            }
        });

        // Configure threshold for position "outside of -99, -99 to 99, 99"
        j.setPositionCallbackThreshold('o', (short)(-99), (short)99, (short)(-99),
                                       (short)99);

        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

public class BrickletJoystick(String uid, IPConnection ipcon)

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

BrickletJoystick joystick = new BrickletJoystick("YOUR_DEVICE_UID", ipcon);

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

public BrickletJoystick.Position getPosition()

Gibt die Position des Joystick zurück. Der Wertebereich ist von -100 bis 100 für beide Achsen. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe calibrate()).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den PositionListener Listener zu nutzen und die Periode mit setPositionCallbackPeriod() vorzugeben.

Das zurückgegebene Objekt enthält die Public-Member-Variablen short x und short y.

public boolean isPressed()

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Es wird empfohlen die PressedListener und ReleasedListener Listeners zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen

public BrickletJoystick.AnalogValue getAnalogValue()

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von getPosition() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund getAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den AnalogValueListener Listener zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

Das zurückgegebene Objekt enthält die Public-Member-Variablen int x und int y.

public void calibrate()

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

public short[] getAPIVersion()

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.

public boolean getResponseExpected(short functionId)

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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void setResponseExpected(short functionId, boolean responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletJoystick.FUNCTION_CALIBRATE = 4
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13
public void setResponseExpectedAll(boolean responseExpected)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.

public BrickletJoystick.Identity getIdentity()

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Listener

public void setPositionCallbackPeriod(long period)

Setzt die Periode in ms mit welcher der PositionListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

The PositionListener Listener wird nur ausgelöst wenn sich die Position seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

public long getPositionCallbackPeriod()

Gibt die Periode zurück, wie von setPositionCallbackPeriod() gesetzt.

public void setAnalogValueCallbackPeriod(long period)

Setzt die Periode in ms mit welcher der AnalogValueListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

Der AnalogValueListener Listener wird nur ausgelöst wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

public long getAnalogValueCallbackPeriod()

Gibt die Periode zurück, wie von setAnalogValueCallbackPeriod() gesetzt.

public void setPositionCallbackThreshold(char option, short minX, short maxX, short minY, short maxY)

Setzt den Schwellwert für den PositionReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst wenn die Position außerhalb der min und max Werte ist
'i' Listener wird ausgelöst wenn die Position innerhalb der min und max Werte ist
'<' Listener wird ausgelöst wenn die Position kleiner als die min Werte ist (max wird ignoriert)
'>' Listener wird ausgelöst wenn die Position größer als die min Werte ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0, 0, 0).

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

  • BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'
public BrickletJoystick.PositionCallbackThreshold getPositionCallbackThreshold()

Gibt den Schwellwert zurück, wie von setPositionCallbackThreshold() gesetzt.

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

  • BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

Das zurückgegebene Objekt enthält die Public-Member-Variablen char option, short minX, short maxX, short minY und short maxY.

public void setAnalogValueCallbackThreshold(char option, int minX, int maxX, int minY, int maxY)

Setzt den Schwellwert für den AnalogValueReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst wenn die Analogwerte außerhalb der min und max Werte ist
'i' Listener wird ausgelöst wenn die Analogwerte innerhalb der min und max Werte ist
'<' Listener wird ausgelöst wenn die Analogwerte kleiner als die min Werte ist (max wird ignoriert)
'>' Listener wird ausgelöst wenn die Analogwerte größer als die min Werte ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0, 0, 0).

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

  • BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'
public BrickletJoystick.AnalogValueCallbackThreshold getAnalogValueCallbackThreshold()

Gibt den Schwellwert zurück, wie von setAnalogValueCallbackThreshold() gesetzt.

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

  • BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

Das zurückgegebene Objekt enthält die Public-Member-Variablen char option, int minX, int maxX, int minY und int maxY.

public void setDebouncePeriod(long debounce)

Setzt die Periode in ms mit welcher die Schwellwert Listeners

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

public long getDebouncePeriod()

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

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

public class BrickletJoystick.PositionListener()

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

public void position(short x, short y)

Dieser Listener wird mit der Periode, wie gesetzt mit setPositionCallbackPeriod(), ausgelöst. Der Parameter ist die Position des Joysticks.

Der PositionListener Listener wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

public class BrickletJoystick.AnalogValueListener()

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

public void analogValue(int x, int y)

Dieser Listener wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter sind die Analogwerte des Joysticks.

Der AnalogValueListener Listener wird nur ausgelöst wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

public class BrickletJoystick.PositionReachedListener()

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

public void positionReached(short x, short y)

Dieser Listener wird ausgelöst wenn der Schwellwert, wie von setPositionCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Position des Joysticks.

Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

public class BrickletJoystick.AnalogValueReachedListener()

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

public void analogValueReached(int x, int y)

Dieser Listener wird ausgelöst wenn der Schwellwert, wie von setAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter sind die Analogwerte des Joystick.

Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

public class BrickletJoystick.PressedListener()

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

public void pressed()

Dieser Listener wird ausgelöst wenn die Taste gedrückt wird.

public class BrickletJoystick.ReleasedListener()

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

public void released()

Dieser Listener wird ausgelöst wenn die Taste losgelassen wird.

Konstanten

public static final int BrickletJoystick.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Joystick Bricklet zu identifizieren.

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

public static final String BrickletJoystick.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.