Java - Multi Touch Bricklet

Dies ist die Beschreibung der Java API Bindings für das Multi Touch Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Multi Touch 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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletMultiTouch;

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

    // Change XYZ to the UID of your Multi Touch 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
        BrickletMultiTouch mt = new BrickletMultiTouch(UID, ipcon); // Create device object

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

        // Get current touch state
        int state = mt.getTouchState(); // Can throw com.tinkerforge.TimeoutException
        String str = "";

        if((state & (1 << 12)) == (1 << 12)) {
            str += "In proximity, ";
        }

        if((state & 0xfff) == 0) {
            str += "No electrodes touched";
        } else {
            str += "Electrodes ";
            for(int i = 0; i < 12; i++) {
                if((state & (1 << i)) == (1 << i)) {
                    str += i + " ";
                }
            }
            str += "touched";
        }

        System.out.println(str);

        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
38
39
40
41
42
43
44
45
46
47
48
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletMultiTouch;

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

    // Change XYZ to the UID of your Multi Touch 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
        BrickletMultiTouch mt = new BrickletMultiTouch(UID, ipcon); // Create device object

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

        // Add touch state listener
        mt.addTouchStateListener(new BrickletMultiTouch.TouchStateListener() {
            public void touchState(int state) {
                String str = "";

                if((state & (1 << 12)) == (1 << 12)) {
                    str += "In proximity, ";
                }

                if((state & 0xfff) == 0) {
                    str += "No electrodes touched";
                } else {
                    str += "Electrodes ";
                    for(int i = 0; i < 12; i++) {
                        if((state & (1 << i)) == (1 << i)) {
                            str += i + " ";
                        }
                    }
                    str += "touched";
                }

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

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

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

BrickletMultiTouch multiTouch = new BrickletMultiTouch("YOUR_DEVICE_UID", ipcon);

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

int BrickletMultiTouch.getTouchState()
Rückgabe:
  • state – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt den aktuellen Tastzustand zurück. Der Zustand ist als ein Bitfeld repräsentiert.

Bits 0 bis 11 repräsentieren die 12 Elektroden und Bit 12 repräsentiert die Proximity (Nähe).

Wird eine Elektrode berührt, ist das korrespondierende Bit true. Wenn eine Hand oder vergleichbares in der Nähe der Elektroden ist wird Bit 12 auf true gesetzt.

Beispiel: Der Zustand 4103 = 0x1007 = 0b1000000000111 bedeutet dass die Elektroden 0, 1 und 2 berührt werden und das sich etwas in der nähe der Elektroden befindet.

Das Proximity Bit wird ab einer Distanz von ca. 1-2cm aktiviert. Eine Elektrode wird schon als berührt gezählt wenn ein Finger sie beinahe berührt. Dadurch ist es möglich ein Stück Papier oder Folie über die Elektrode zu kleben um damit ein Touchpanel mit einem professionellen Aussehen zu bauen.

void BrickletMultiTouch.recalibrate()

Rekalibriert die Elektroden. Rufe diese Funktion auf wenn die Elektroden verändert oder bewegt wurden.

void BrickletMultiTouch.setElectrodeConfig(int enabledElectrodes)
Parameter:
  • enabledElectrodes – Typ: int, Wertebereich: [0 bis 216 - 1]

Aktiviert/deaktiviert Elektroden mit einem Bitfeld (siehe getTouchState()).

True aktiviert eine Elektrode, false deaktiviert eine Elektrode. Eine deaktivierte Elektrode hat immer den Zustand false. Wenn nicht alle Elektroden gebraucht werden können die ungebrauchten deaktiviert werden.

Wir empfehlen das Proximity Bit (Bit 12) zu deaktivieren wenn das Proximity-Feature nicht benötigt wird. Das verringert den Datenverkehr der durch den TouchStateListener Listener ausgelöst wird.

Eine deaktivierte Elektrode verringert zusätzlich den Stromverbrauch.

Standardwert: 8191 = 0x1FFF = 0b1111111111111 (alle Elektroden aktiviert)

int BrickletMultiTouch.getElectrodeConfig()
Rückgabe:
  • enabledElectrodes – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Elektrodenkonfiguration zurück, wie von setElectrodeConfig() gesetzt.

void BrickletMultiTouch.setElectrodeSensitivity(short sensitivity)
Parameter:
  • sensitivity – Typ: short, Wertebereich: [0 bis 255]

Setzt die Empfindlichkeit der Elektrode. Eine Elektrode mit einer hohen Empfindlichkeit registriert eine Berührung früher als eine Elektrode mit einer niedrigen Empfindlichkeit.

Wenn eine große Elektrode verwendet wird sollte die Empfindlichkeit verringert werden, da eine größere Fläche aufgeladen werden kann. Wenn eine Elektrode aus größerem Abstand aktivierbar seien soll, muss die Empfindlichkeit vergrößert werden.

Nachdem eine neue Empfindlichkeit gesetzt wurde, macht es Sinn recalibrate() aufzurufen damit die Elektroden mit der neu definierten Empfindlichkeit kalibriert werden.

Der zulässige Wertebereich für den Empfindlichkeitswert ist 5-201.

Der voreingestellte Empfindlichkeitswert ist 181.

short BrickletMultiTouch.getElectrodeSensitivity()
Rückgabe:
  • sensitivity – Typ: short, Wertebereich: [0 bis 255]

Gibt die aktuelle Empfindlichkeit zurück, wie von setElectrodeSensitivity() gesetzt.

Fortgeschrittene Funktionen

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

  • BrickletMultiTouch.FUNCTION_RECALIBRATE = 2
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_CONFIG = 3
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_SENSITIVITY = 6
void BrickletMultiTouch.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:

  • BrickletMultiTouch.FUNCTION_RECALIBRATE = 2
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_CONFIG = 3
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_SENSITIVITY = 6
void BrickletMultiTouch.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.

BrickletMultiTouch.Identity BrickletMultiTouch.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 BrickletMultiTouch.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 BrickletMultiTouch.TouchStateListener()

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

void touchState(int state)
Parameter:
  • state – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt den aktuellen Tastzustand zurück, siehe getTouchState() für mehr Informationen über den Zustand.

Dieser Listener wird ausgelöst, wenn sich ein Tastzustand ändert.

Konstanten

int BrickletMultiTouch.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Multi Touch 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 BrickletMultiTouch.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Multi Touch Bricklet dar.