Mathematica - Tilt Bricklet¶

Simple¶

Download (ExampleSimple.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Get current tilt state*)
state=t@GetTiltState[]

If[state==Tinkerforge`BrickletTilt`TILTUSTATEUCLOSED,Print["Tilt State: Closed"]]
If[state==Tinkerforge`BrickletTilt`TILTUSTATEUOPEN,Print["Tilt State: Open"]]
If[state==Tinkerforge`BrickletTilt`TILTUSTATEUCLOSEDUVIBRATING,Print["Tilt State: Closed Vibrating"]]

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

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

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Enable tilt state callback*)
t@EnableTiltStateCallback[]

(*Callback function for tilt state callback*)
TiltStateCB[sender_,state_]:=
 Module[{},
  If[state==Tinkerforge`BrickletTilt`TILTUSTATEUCLOSED,Print["Tilt State: Closed"]];
  If[state==Tinkerforge`BrickletTilt`TILTUSTATEUOPEN,Print["Tilt State: Open"]];
  If[state==Tinkerforge`BrickletTilt`TILTUSTATEUCLOSEDUVIBRATING,Print["Tilt State: Closed Vibrating"]]
 ]

AddEventHandler[t@TiltStateCallback,TiltStateCB]

Input["Click OK to exit"]

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

Grundfunktionen¶

BrickletTilt[uid, ipcon] → tilt¶

Parameter:	uid – Typ: String ipcon – Typ: NETObject[IPConnection]
Rückgabe:	tilt – Typ: NETObject[BrickletTilt]

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

tilt=NETNew["Tinkerforge.BrickletTilt","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.

BrickletTilt@GetTiltState[] → state¶

Rückgabe:	state – Typ: Integer, Wertebereich: Siehe Konstanten

Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:

• 0 = Closed: Der Ball im Neigungsschalter schließt den Stromkreis.
• 1 = Open: Der Ball im Neigungsschalter schließt den Stromkreis nicht.
• 2 = Closed Vibrating: Der Neigungsschalter ist in Bewegung (schnelle Änderungen zwischen open und close).

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

Für state:

• BrickletTilt`TILTUSTATEUCLOSED = 0
• BrickletTilt`TILTUSTATEUOPEN = 1
• BrickletTilt`TILTUSTATEUCLOSEDUVIBRATING = 2

Fortgeschrittene Funktionen¶

BrickletTilt@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null¶

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Integer, Wertebereich: [ToCharacterCode["a"][[0]] bis ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]] hardwareVersioni – Typ: Integer 1: major – Typ: Integer, Wertebereich: [0 bis 255] 2: minor – Typ: Integer, Wertebereich: [0 bis 255] 3: revision – Typ: Integer, Wertebereich: [0 bis 255] firmwareVersioni – Typ: Integer 1: major – Typ: Integer, Wertebereich: [0 bis 255] 2: minor – Typ: Integer, Wertebereich: [0 bis 255] 3: revision – Typ: Integer, 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.

Konfigurationsfunktionen für Callbacks¶

BrickletTilt@EnableTiltStateCallback[] → Null¶

Aktiviert den TiltStateCallback Callback.

BrickletTilt@DisableTiltStateCallback[] → Null¶

Deaktiviert den TiltStateCallback Callback.

BrickletTilt@IsTiltStateCallbackEnabled[] → enabled¶

Rückgabe:	enabled – Typ: True/False, Standardwert: False

Gibt true zurück wenn der TiltStateCallback Callback aktiviert ist.

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[tilt@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.

event BrickletTilt@TiltStateCallback[sender, state]¶

Callback-Parameter:	sender – Typ: NETObject[BrickletTilt] state – Typ: Integer, Wertebereich: Siehe Konstanten

Dieser Callback übergibt den aktuellen Tilt-Status. Der Callback wird aufgerufen wenn sich der Status ändert.

Siehe GetTiltState[] für eine Beschreibung der Zustände.

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

Für state:

• BrickletTilt`TILTUSTATEUCLOSED = 0
• BrickletTilt`TILTUSTATEUOPEN = 1
• BrickletTilt`TILTUSTATEUCLOSEDUVIBRATING = 2

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.

BrickletTilt@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}¶

Ausgabeparameter:	apiVersioni – Typ: Integer 1: major – Typ: Integer, Wertebereich: [0 bis 255] 2: minor – Typ: Integer, Wertebereich: [0 bis 255] 3: revision – Typ: Integer, 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.

BrickletTilt@GetResponseExpected[functionId] → responseExpected¶

Parameter:	functionId – Typ: Integer, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: 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.

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

Für functionId:

• BrickletTilt`FUNCTIONUENABLEUTILTUSTATEUCALLBACK = 2
• BrickletTilt`FUNCTIONUDISABLEUTILTUSTATEUCALLBACK = 3

BrickletTilt@SetResponseExpected[functionId, responseExpected] → Null¶

Parameter:	functionId – Typ: Integer, Wertebereich: Siehe Konstanten responseExpected – Typ: 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 Konstanten sind für diese Funktion verfügbar:

Für functionId:

• BrickletTilt`FUNCTIONUENABLEUTILTUSTATEUCALLBACK = 2
• BrickletTilt`FUNCTIONUDISABLEUTILTUSTATEUCALLBACK = 3

BrickletTilt@SetResponseExpectedAll[responseExpected] → Null¶

Parameter:	responseExpected – Typ: True/False

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

Konstanten¶

BrickletTilt`DEVICEUIDENTIFIER¶

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

BrickletTilt`DEVICEDISPLAYNAME¶

Diese Konstante stellt den Anzeigenamen eines Tilt Bricklet dar.