Dies ist die Beschreibung der Mathematica 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 Mathematica API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Multi Touch Bricklet*)
(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
mt=NETNew["Tinkerforge.BrickletMultiTouch",uid,ipcon]
ipcon@Connect[host,port]
(*Get current touch state*)
touchStateBits=IntegerDigits[mt@GetTouchState[],2,13]
result={}
If[touchStateBits[[-13]]==1,AppendTo[result,"In proximity, "]]
If[Total[touchStateBits[[2;;13]]]==0,
AppendTo[result,"No electrodes touched"],
AppendTo[result,"Electrodes "];
For[i=-1,i>=-12,--i,
If[touchStateBits[[i]]==1,AppendTo[result,ToString[Abs[i]-1]<>" "]]
];
AppendTo[result,"touched"]
]
Print[StringJoin[result]]
(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[mt]
ReleaseNETObject[ipcon]
|
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 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Multi Touch Bricklet*)
(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
mt=NETNew["Tinkerforge.BrickletMultiTouch",uid,ipcon]
ipcon@Connect[host,port]
(*Callback function for touch state callback*)
TouchStateCB[sender_,state_]:=
Module[{},
touchStateBits=IntegerDigits[touchState,2,13];
result={};
If[touchStateBits[[-13]]==1,AppendTo[result,"In proximity, "]];
If[Total[touchStateBits[[2;;13]]]==0,
AppendTo[result,"No electrodes touched"],
AppendTo[result,"Electrodes "];
For[i=-1,i>=-12,--i,
If[touchStateBits[[i]]==1,AppendTo[result,ToString[Abs[i]-1]<>" "]]
];
AppendTo[result,"touched"]
];
Print[StringJoin[result]]
]
AddEventHandler[mt@TouchStateCallback,TouchStateCB]
Input["Click OK to exit"]
(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[mt]
ReleaseNETObject[ipcon]
|
Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt
eine Tinkerforge.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.
Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out
Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.
Weitere Informationen über das out
Schlüsselwort in .NET/Link sind in der
entsprechende Mathematica .NET/Link Dokumentation
zu finden.
Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist
Tinkerforge.*
.
BrickletMultiTouch
[uid, ipcon] → multiTouch¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
multiTouch=NETNew["Tinkerforge.BrickletMultiTouch","YOUR_DEVICE_UID",ipcon]
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.
Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.
BrickletMultiTouch
@
GetTouchState
[] → state¶Rückgabe: |
|
---|
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.
BrickletMultiTouch
@
Recalibrate
[] → Null¶Rekalibriert die Elektroden. Rufe diese Funktion auf wenn die Elektroden verändert oder bewegt wurden.
BrickletMultiTouch
@
SetElectrodeConfig
[enabledElectrodes] → Null¶Parameter: |
|
---|
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)
BrickletMultiTouch
@
GetElectrodeConfig
[] → enabledElectrodes¶Rückgabe: |
|
---|
Gibt die Elektrodenkonfiguration zurück, wie von SetElectrodeConfig[]
gesetzt.
BrickletMultiTouch
@
SetElectrodeSensitivity
[sensitivity] → Null¶Parameter: |
|
---|
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.
BrickletMultiTouch
@
GetElectrodeSensitivity
[] → sensitivity¶Rückgabe: |
|
---|
Gibt die aktuelle Empfindlichkeit zurück, wie von
SetElectrodeSensitivity[]
gesetzt.
BrickletMultiTouch
@
GetIdentity
[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null¶Ausgabeparameter: |
|
---|
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 können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird:
MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]] AddEventHandler[multiTouch@ExampleCallback,MyCallback]
Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.
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.
BrickletMultiTouch
@
TouchStateCallback
[sender, state]¶Callback-Parameter: |
|
---|
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 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.
BrickletMultiTouch
@
GetAPIVersion
[] → {apiVersion1, apiVersion2, apiVersion3}¶Ausgabeparameter: |
|
---|
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.
BrickletMultiTouch
@
GetResponseExpected
[functionId] → responseExpected¶Parameter: |
|
---|---|
Rückgabe: |
|
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
@
SetResponseExpected
[functionId, responseExpected] → Null¶Parameter: |
|
---|
Ä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
@
SetResponseExpectedAll
[responseExpected] → Null¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletMultiTouch
`
DEVICEUIDENTIFIER
¶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.
BrickletMultiTouch
`
DEVICEDISPLAYNAME
¶Diese Konstante stellt den Anzeigenamen eines Multi Touch Bricklet dar.