Dies ist die Beschreibung der Mathematica API Bindings für das UV Light Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des UV Light 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 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your UV Light Bricklet*)
(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
uvl=NETNew["Tinkerforge.BrickletUVLight",uid,ipcon]
ipcon@Connect[host,port]
(*Get current UV light*)
Print["UV Light: "<>ToString[N[Quantity[uvl@GetUVLight[],"mW/m²/10"]]]]
(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[uvl]
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 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your UV Light Bricklet*)
(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
uvl=NETNew["Tinkerforge.BrickletUVLight",uid,ipcon]
ipcon@Connect[host,port]
(*Callback function for UV light callback*)
UVLightCB[sender_,uvLight_]:=
Print["UV Light: "<>ToString[N[Quantity[uvLight,"mW/m²/10"]]]]
AddEventHandler[uvl@UVLightCallback,UVLightCB]
(*Set period for UV light callback to 1s (1000ms)*)
(*Note: The UV light callback is only called every second*)
(*if the UV light has changed since the last call!*)
uvl@SetUVLightCallbackPeriod[1000]
Input["Click OK to exit"]
(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[uvl]
ReleaseNETObject[ipcon]
|
Download (ExampleThreshold.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 32 33 34 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your UV Light Bricklet*)
(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
uvl=NETNew["Tinkerforge.BrickletUVLight",uid,ipcon]
ipcon@Connect[host,port]
(*Get threshold callbacks with a debounce time of 10 seconds (10000ms)*)
uvl@SetDebouncePeriod[10000]
(*Callback function for UV light reached callback*)
UVLightReachedCB[sender_,uvLight_]:=
Module[{},
Print["UV Light: "<>ToString[N[Quantity[uvLight,"mW/m²/10"]]]];
Print["UV Index > 3. Use sunscreen!"]
]
AddEventHandler[uvl@UVLightReachedCallback,UVLightReachedCB]
(*Configure threshold for UV light "greater than 75 mW/m²"*)
option=Tinkerforge`BrickletUVLight`THRESHOLDUOPTIONUGREATER
uvl@SetUVLightCallbackThreshold[option,75*10,0]
Input["Click OK to exit"]
(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[uvl]
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.*.
Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
uvLight=NETNew["Tinkerforge.BrickletUVLight","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.
Rückgabe: |
|
---|
Gibt die UV-Licht-Intensität des Sensors zurück. Der Sensor hat die Intensität bereits mit dem Erythem-Wirkungsspektrum gewichtet, um die hautbeeinflussende Bestrahlungsstärke zu bestimmen.
Die Intensität kann dann einfach durch 250 geteilt werden um den UV Index zu bestimmen. Beispiel: Eine UV-Licht-Intensität von 500 entspricht einem UV Index von 2.
Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den UVLightCallback Callback zu nutzen und die Periode mit SetUVLightCallbackPeriod[] vorzugeben.
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 '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.
Parameter: |
|
---|
Setzt die Periode mit welcher der UVLightCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der UVLightCallback Callback wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.
Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetUVLightCallbackPeriod[] gesetzt.
Parameter: |
|
---|
Setzt den Schwellwert für den UVLightReachedCallback Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Intensität außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Intensität innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Intensität kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Intensität größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetUVLightCallbackThreshold[] gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod[] gesetzt.
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[uvLight@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.
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit SetUVLightCallbackPeriod[], ausgelöst. Der Parameter ist die UV-Licht-Intensität des Sensors.
Der UVLightCallback Callback wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetUVLightCallbackThreshold[] gesetzt, erreicht wird. Der Parameter ist die UV-Licht-Intensität des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod[] gesetzt, ausgelöst.
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.
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.
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:
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:
Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein UV Light 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.
Diese Konstante stellt den Anzeigenamen eines UV Light Bricklet dar.