Mathematica - Hall Effect Bricklet

Dies ist die Beschreibung der Mathematica API Bindings für das Hall Effect Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Hall Effect 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).

Simple

Download (ExampleSimple.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Get current edge count without reset*)
Print["Count: "<>ToString[he@GetEdgeCount[False]]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[he]
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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Callback function for edge count callback*)
EdgeCountCB[sender_,count_,value_]:=
 Print["Count: "<>ToString[count]]
AddEventHandler[he@EdgeCountCallback,EdgeCountCB]

(*Set period for edge count callback to 0.05s (50ms)*)
(*Note: The edge count callback is only called every 0.05 seconds*)
(*if the edge count has changed since the last call!*)
he@SetEdgeCountCallbackPeriod[50]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[he]
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

BrickletHallEffect[uid, ipcon] → hallEffect
Parameter:
  • uid – Typ: String
  • ipcon – Typ: NETObject[IPConnection]
Rückgabe:
  • hallEffect – Typ: NETObject[BrickletHallEffect]

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

hallEffect=NETNew["Tinkerforge.BrickletHallEffect","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.

BrickletHallEffect@GetValue[] → value
Rückgabe:
  • value – Typ: True/False

Gibt true zurück wenn ein Magnetfeld mit 3,5 Millitesla oder größer detektiert wird.

BrickletHallEffect@GetEdgeCount[resetCounter] → count
Parameter:
  • resetCounter – Typ: True/False
Rückgabe:
  • count – Typ: Integer, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit SetEdgeCountConfig[] konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Fortgeschrittene Funktionen

BrickletHallEffect@SetEdgeCountConfig[edgeType, debounce] → Null
Parameter:
  • edgeType – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: 0
  • debounce – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

  • 0 = steigend
  • 1 = fallend
  • 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>3,5 Millitesla) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<2,5 Millitesla) wird entsteht ein high-Signal (steigende Flanke).

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für edgeType:

  • BrickletHallEffect`EDGEUTYPEURISING = 0
  • BrickletHallEffect`EDGEUTYPEUFALLING = 1
  • BrickletHallEffect`EDGEUTYPEUBOTH = 2
BrickletHallEffect@GetEdgeCountConfig[out edgeType, out debounce] → Null
Ausgabeparameter:
  • edgeType – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: 0
  • debounce – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von SetEdgeCountConfig[] gesetzt.

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

Für edgeType:

  • BrickletHallEffect`EDGEUTYPEURISING = 0
  • BrickletHallEffect`EDGEUTYPEUFALLING = 1
  • BrickletHallEffect`EDGEUTYPEUBOTH = 2
BrickletHallEffect@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["i"][[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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

BrickletHallEffect@SetEdgeInterrupt[edges] → Null
Parameter:
  • edges – Typ: Integer, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

BrickletHallEffect@GetEdgeInterrupt[] → edges
Rückgabe:
  • edges – Typ: Integer, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt edges zurück, wie von SetEdgeInterrupt[] gesetzt.

BrickletHallEffect@SetEdgeCountCallbackPeriod[period] → Null
Parameter:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der EdgeCountCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der EdgeCountCallback Callback wird nur ausgelöst, wenn sich die Flankenzählung seit der letzten Auslösung geändert hat.

BrickletHallEffect@GetEdgeCountCallbackPeriod[] → period
Rückgabe:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetEdgeCountCallbackPeriod[] gesetzt.

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[hallEffect@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 BrickletHallEffect@EdgeCountCallback[sender, count, value]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletHallEffect]
  • count – Typ: Integer, Wertebereich: [0 bis 232 - 1]
  • value – Typ: True/False

Dieser Callback wird mit der Periode, wie gesetzt mit SetEdgeCountCallbackPeriod[], ausgelöst. Die Parameter sind der aktuelle Zählerstand und der aktuelle Wert (siehe GetValue[] and GetEdgeCount[]).

Der EdgeCountCallback Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.

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.

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

BrickletHallEffect@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:

  • BrickletHallEffect`FUNCTIONUSETUEDGEUCOUNTUCONFIG = 3
  • BrickletHallEffect`FUNCTIONUSETUEDGEUINTERRUPT = 5
  • BrickletHallEffect`FUNCTIONUSETUEDGEUCOUNTUCALLBACKUPERIOD = 7
BrickletHallEffect@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:

  • BrickletHallEffect`FUNCTIONUSETUEDGEUCOUNTUCONFIG = 3
  • BrickletHallEffect`FUNCTIONUSETUEDGEUINTERRUPT = 5
  • BrickletHallEffect`FUNCTIONUSETUEDGEUCOUNTUCALLBACKUPERIOD = 7
BrickletHallEffect@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

BrickletHallEffect`DEVICEUIDENTIFIER

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

BrickletHallEffect`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet dar.