Visual Basic .NET - Multi Touch Bricklet¶

Simple¶

Download (ExampleSimple.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleSimple
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Multi Touch Bricklet
 8
 9    Sub Main()
10        Dim ipcon As New IPConnection() ' Create IP connection
11        Dim mt As New BrickletMultiTouch(UID, ipcon) ' Create device object
12
13        ipcon.Connect(HOST, PORT) ' Connect to brickd
14        ' Don't use device before ipcon is connected
15
16        ' Get current touch state
17        Dim state As Integer = mt.GetTouchState()
18        Dim s As String = ""
19
20        If ((state And (1 << 12)) = (1 << 12)) Then
21            s &= "In proximity, "
22        End If
23
24        If ((state And &Hfff) = 0) Then
25            s &= "No electrodes touched"
26        Else
27            s &= "Electrodes "
28            For i As Integer = 0 To 11
29                If ((state And (1 << i)) = (1 << i)) Then
30                    s &= i.ToString() & " "
31                End If
32            Next
33            s &= "touched"
34        End If
35
36        Console.WriteLine(s)
37
38        Console.WriteLine("Press key to exit")
39        Console.ReadLine()
40        ipcon.Disconnect()
41    End Sub
42End Module

Callback¶

Download (ExampleCallback.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleCallback
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Multi Touch Bricklet
 8
 9    ' Callback subroutine for touch state callback
10    Sub TouchStateCB(ByVal sender As BrickletMultiTouch, ByVal state As Integer)
11        Dim s As String = ""
12
13        If ((state And (1 << 12)) = (1 << 12)) Then
14            s &= "In proximity, "
15        End If
16
17        If ((state And &Hfff) = 0) Then
18            s &= "No electrodes touched"
19        Else
20            s &= "Electrodes "
21            For i As Integer = 0 To 11
22                If ((state And (1 << i)) = (1 << i)) Then
23                    s &= i.ToString() & " "
24                End If
25            Next
26            s &= "touched"
27        End If
28
29        Console.WriteLine(s)
30    End Sub
31
32    Sub Main()
33        Dim ipcon As New IPConnection() ' Create IP connection
34        Dim mt As New BrickletMultiTouch(UID, ipcon) ' Create device object
35
36        ipcon.Connect(HOST, PORT) ' Connect to brickd
37        ' Don't use device before ipcon is connected
38
39        ' Register touch state callback to subroutine TouchStateCB
40        AddHandler mt.TouchStateCallback, AddressOf TouchStateCB
41
42        Console.WriteLine("Press key to exit")
43        Console.ReadLine()
44        ipcon.Disconnect()
45    End Sub
46End Module

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.

Function BrickletMultiTouch.GetTouchState() As Integer¶

Rückgabe:	state – Typ: Integer, Wertebereich: [0 bis 213 - 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.

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)¶

Parameter:	enabledElectrodes – Typ: Integer, Wertebereich: [0 bis 213 - 1], Standardwert: 213 - 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 TouchStateCallback Callback ausgelöst wird.

Eine deaktivierte Elektrode verringert zusätzlich den Stromverbrauch.

Standardwert: 8191 = 0x1FFF = 0b1111111111111 (alle Elektroden und Proximity-Feature aktiviert)

Function BrickletMultiTouch.GetElectrodeConfig() As Integer¶

Rückgabe:	enabledElectrodes – Typ: Integer, Wertebereich: [0 bis 213 - 1], Standardwert: 213 - 1

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

Sub BrickletMultiTouch.SetElectrodeSensitivity(ByVal sensitivity As Byte)¶

Parameter:	sensitivity – Typ: Byte, Wertebereich: [5 bis 201], Standardwert: 181

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.

Function BrickletMultiTouch.GetElectrodeSensitivity() As Byte¶

Rückgabe:	sensitivity – Typ: Byte, Wertebereich: [5 bis 201], Standardwert: 181

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

Fortgeschrittene Funktionen¶

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)¶

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: Integer, 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 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.

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.

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

Callback-Parameter:	sender – Typ: BrickletMultiTouch state – Typ: Integer, Wertebereich: [0 bis 213 - 1]

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.

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.

Function BrickletMultiTouch.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, 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.

Function BrickletMultiTouch.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

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

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

Sub BrickletMultiTouch.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

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

Sub BrickletMultiTouch.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameter:	responseExpected – Typ: Boolean

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

Konstanten¶

Const BrickletMultiTouch.DEVICE_IDENTIFIER¶

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

Die GetIdentity() Funktion und der IPConnection.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.