Mathematica - Dual Button Bricklet

Dies ist die Beschreibung der Mathematica API Bindings für das Dual Button Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Dual Button Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Mathematica API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

Download (ExampleCallback.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Dual Button Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
db=NETNew["Tinkerforge.BrickletDualButton",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for state changed callback*)
StateChangedCB[sender_,buttonL_,buttonR_,ledL_,ledR_]:=
 Module[{},
  If[buttonL==Tinkerforge`BrickletDualButton`BUTTONUSTATEUPRESSED,Print["Left Button: Pressed"]];
  If[buttonL==Tinkerforge`BrickletDualButton`BUTTONUSTATEURELEASED,Print["Left Button: Released"]];
  If[buttonR==Tinkerforge`BrickletDualButton`BUTTONUSTATEUPRESSED,Print["Right Button: Pressed"]];
  If[buttonR==Tinkerforge`BrickletDualButton`BUTTONUSTATEURELEASED,Print["Right Button: Released"]]
 ]

AddEventHandler[db@StateChangedCallback,StateChangedCB]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[db]
ReleaseNETObject[ipcon]

API

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

Grundfunktionen

BrickletDualButton[uid, ipcon] → dualButton
Parameter:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Rückgabe:
  • dualButton -- NETObject[BrickletDualButton]

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

dualButton=NETNew["Tinkerforge.BrickletDualButton","YOUR_DEVICE_UID",ipcon]

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

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.

BrickletDualButton@SetLEDState[ledL, ledR] → Null
Parameter:
  • ledL -- Integer
  • ledR -- Integer

Setzt den Zustand der LEDs. Möglich Zustände sind:

  • 0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
  • 1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
  • 2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit GetLEDState[] ausgelesen werden oder es kann SetSelectedLEDState[] genutzt werden.

Der Standardwert ist (1, 1).

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

  • BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0
  • BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1
  • BrickletDualButton`LEDUSTATEUON = 2
  • BrickletDualButton`LEDUSTATEUOFF = 3
BrickletDualButton@GetLEDState[out ledL, out ledR] → Null
Parameter:
  • ledL -- Integer
  • ledR -- Integer

Gibt den aktuellen Zustand der LEDs zurück, wie von SetLEDState[] gesetzt.

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

  • BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0
  • BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1
  • BrickletDualButton`LEDUSTATEUON = 2
  • BrickletDualButton`LEDUSTATEUOFF = 3
BrickletDualButton@GetButtonState[out buttonL, out buttonR] → Null
Parameter:
  • buttonL -- Integer
  • buttonR -- Integer

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

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

  • BrickletDualButton`BUTTONUSTATEUPRESSED = 0
  • BrickletDualButton`BUTTONUSTATEURELEASED = 1

Fortgeschrittene Funktionen

BrickletDualButton@SetSelectedLEDState[led, state] → Null
Parameter:
  • led -- Integer
  • state -- Integer

Setzt den Zustand der selektierten LED (0 oder 1).

Die andere LED bleibt unangetastet.

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

  • BrickletDualButton`LEDULEFT = 0
  • BrickletDualButton`LEDURIGHT = 1
  • BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0
  • BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1
  • BrickletDualButton`LEDUSTATEUON = 2
  • BrickletDualButton`LEDUSTATEUOFF = 3
BrickletDualButton@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni -- Integer

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.

BrickletDualButton@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId -- Integer
Rückgabe:
  • responseExpected -- True/False

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.

BrickletDualButton@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId -- Integer
  • responseExpected -- True/False

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

  • BrickletDualButton`FUNCTIONUSETULEDUSTATE = 1
  • BrickletDualButton`FUNCTIONUSETUSELECTEDULEDUSTATE = 5
BrickletDualButton@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected -- True/False

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

BrickletDualButton@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- 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 Funktion einem Callback Property des Geräte Objektes zugewiesen wird:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[dualButton@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.

event BrickletDualButton@StateChangedCallback[sender, buttonL, buttonR, ledL, ledR]
Parameter:
  • sender -- NETObject[BrickletDualButton]
  • buttonL -- Integer
  • buttonR -- Integer
  • ledL -- Integer
  • ledR -- Integer

Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

  • 0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
  • 1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
  • 2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

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

  • BrickletDualButton`BUTTONUSTATEUPRESSED = 0
  • BrickletDualButton`BUTTONUSTATEURELEASED = 1
  • BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0
  • BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1
  • BrickletDualButton`LEDUSTATEUON = 2
  • BrickletDualButton`LEDUSTATEUOFF = 3

Konstanten

BrickletDualButton`DEVICEUIDENTIFIER

Diese Konstante wird verwendet um ein Dual Button 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.

BrickletDualButton`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet dar.