Visual Basic .NET - Multi Touch Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Multi Touch Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim mt As 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
        Dim state As Integer = mt.GetTouchState()
        Dim s As String = ""

        If ((state And (1 << 12)) = (1 << 12)) Then
            s &= "In proximity, "
        End If

        If ((state And &Hfff) = 0) Then
            s &= "No electrodes touched"
        Else
            s &= "Electrodes "
            For i As Integer = 0 To 11
                If ((state And (1 << i)) = (1 << i)) Then
                    s &= i.ToString() & " "
                End If
            Next
            s &= "touched"
        End If

        Console.WriteLine(s)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback

Download (ExampleCallback.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Multi Touch Bricklet

    ' Callback subroutine for touch state callback
    Sub TouchStateCB(ByVal sender As BrickletMultiTouch, ByVal state As Integer)
        Dim s As String = ""

        If ((state And (1 << 12)) = (1 << 12)) Then
            s &= "In proximity, "
        End If

        If ((state And &Hfff) = 0) Then
            s &= "No electrodes touched"
        Else
            s &= "Electrodes "
            For i As Integer = 0 To 11
                If ((state And (1 << i)) = (1 << i)) Then
                    s &= i.ToString() & " "
                End If
            Next
            s &= "touched"
        End If

        Console.WriteLine(s)
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim mt As New BrickletMultiTouch(UID, ipcon) ' Create device object

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

        ' Register touch state callback to subroutine TouchStateCB
        AddHandler mt.TouchStateCallback, AddressOf TouchStateCB

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

Class BrickletMultiTouch(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim multiTouch As New BrickletMultiTouch("YOUR_DEVICE_UID", ipcon)

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

Function BrickletMultiTouch.GetTouchState() As Integer

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.

Sub BrickletMultiTouch.Recalibrate()

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

Sub BrickletMultiTouch.SetElectrodeConfig(ByVal enabledElectrodes As Integer)

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 TouchStateCallback Callback ausgelöst wird.

Eine deaktivierte Elektrode verringert zusätzlich den Stromverbrauch.

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

Function BrickletMultiTouch.GetElectrodeConfig() As Integer

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

Sub BrickletMultiTouch.SetElectrodeSensitivity(ByVal sensitivity As Byte)

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.

Function BrickletMultiTouch.GetElectrodeSensitivity() As Byte

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

Fortgeschrittene Funktionen

Function BrickletMultiTouch.GetAPIVersion() As Byte()

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.

Function BrickletMultiTouch.GetResponseExpected(ByVal functionId As Byte) As 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 Callbacks 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.

Sub BrickletMultiTouch.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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 Callbacks (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:

  • BrickletMultiTouch.FUNCTION_RECALIBRATE = 2
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_CONFIG = 3
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_SENSITIVITY = 6
Sub BrickletMultiTouch.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletMultiTouch.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

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.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletMultiTouch, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler multiTouch.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Bemerkung

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

Event BrickletMultiTouch.TouchStateCallback(ByVal sender As BrickletMultiTouch, ByVal state As Integer)

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

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

Konstanten

Const BrickletMultiTouch.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Multi Touch Bricklet zu identifizieren.

Die GetIdentity() Funktion und der EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Const BrickletMultiTouch.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Multi Touch Bricklet dar.