Mathematica - Ambient Light Bricklet 2.0

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

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

(*Get current illuminance*)
Print["Illuminance: "<>ToString[N[Quantity[al@GetIlluminance[],"lx/100"]]]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[al]
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 Ambient Light Bricklet 2.0*)

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

(*Callback function for illuminance callback*)
IlluminanceCB[sender_,illuminance_]:=
 Print["Illuminance: "<>ToString[N[Quantity[illuminance,"lx/100"]]]]
AddEventHandler[al@IlluminanceCallback,IlluminanceCB]

(*Set period for illuminance callback to 1s (1000ms)*)
(*Note: The illuminance callback is only called every second*)
(*if the illuminance has changed since the last call!*)
al@SetIlluminanceCallbackPeriod[1000]

Input["Click OK to exit"]

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

Threshold

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 Ambient Light Bricklet 2.0*)

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

(*Get threshold callbacks with a debounce time of 10 seconds (10000ms)*)
al@SetDebouncePeriod[10000]

(*Callback function for illuminance reached callback*)
IlluminanceReachedCB[sender_,illuminance_]:=
 Module[{},
  Print["Illuminance: "<>ToString[N[Quantity[illuminance,"lx/100"]]]];
  Print["Too bright, close the curtains!"]
 ]

AddEventHandler[al@IlluminanceReachedCallback,IlluminanceReachedCB]

(*Configure threshold for illuminance "greater than 500 lx"*)
option=Tinkerforge`BrickletAmbientLightV2`THRESHOLDUOPTIONUGREATER
al@SetIlluminanceCallbackThreshold[option,500*100,0]

Input["Click OK to exit"]

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

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

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

ambientLightV2=NETNew["Tinkerforge.BrickletAmbientLightV2","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.

BrickletAmbientLightV2@GetIlluminance[] → illuminance
Rückgabe:
  • illuminance -- Integer

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Messbereich erstreckt sich bis über 100000Lux, aber ab 64000Lux nimmt die Messgenauigkeit ab. Die Beleuchtungsstärke ist in Lux/100 angegeben, d.h. bei einem Wert von 450000 wurde eine Beleuchtungsstärke von 4500Lux gemessen.

Geändert in Version 2.0.2 (Plugin): Eine Beleuchtungsstärke von 0Lux bedeutet, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte, siehe SetConfiguration[].

Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen den IlluminanceCallback Callback zu nutzen und die Periode mit SetIlluminanceCallbackPeriod[] vorzugeben.

Fortgeschrittene Funktionen

BrickletAmbientLightV2@SetConfiguration[illuminanceRange, integrationTime] → Null
Parameter:
  • illuminanceRange -- Integer
  • integrationTime -- Integer

Setzt die Konfiguration. Es ist möglich den Helligkeitswertebereich zwischen 0-600Lux und 0-64000Lux sowie eine Integrationszeit zwischen 50ms und 400ms zu konfigurieren.

Neu in Version 2.0.2 (Plugin): Der unbeschränkt (unlimited) Helligkeitswertebereich ermöglicht es bis über 100000Lux zu messen, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Ein kleinerer Helligkeitswertebereich erhöht die Auflösung der Daten. Eine längere Integrationszeit verringert das Rauschen auf den Daten.

Geändert in Version 2.0.2 (Plugin): Wenn der eigentliche Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt, dann geben GetIlluminance[] und der IlluminanceCallback Callback das Maximum des eingestellten Helligkeitswertebereichs +0,01Lux zurück. Also z.B. 800001 für den 0-8000Lux Bereich.

Geändert in Version 2.0.2 (Plugin): Bei einer langen Integrationszeit kann es sein, dass der Sensor gesättigt (saturated) ist bevor der Messwert das Maximum des ausgewählten Helligkeitswertebereichs erreicht hat. In diesem Fall geben GetIlluminance[] und der IlluminanceCallback Callback 0Lux zurück.

Wenn der Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt oder der Sensor gesättigt ist, dann sollte der nächst höhere Helligkeitswertebereich eingestellt werden. Wenn der höchste Helligkeitswertebereich schon erreicht ist, dann kann noch die Integrationszeit verringert werden.

Die Standardwerte sind 0-8000Lux Helligkeitsbereich und 200ms Integrationszeit.

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

  • BrickletAmbientLightV2`ILLUMINANCEURANGEUUNLIMITED = 6
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU64000LUX = 0
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU32000LUX = 1
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU16000LUX = 2
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU8000LUX = 3
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU1300LUX = 4
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU600LUX = 5
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU50MS = 0
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU100MS = 1
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU150MS = 2
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU200MS = 3
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU250MS = 4
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU300MS = 5
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU350MS = 6
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU400MS = 7
BrickletAmbientLightV2@GetConfiguration[out illuminanceRange, out integrationTime] → Null
Parameter:
  • illuminanceRange -- Integer
  • integrationTime -- Integer

Gibt die Konfiguration zurück, wie von SetConfiguration[] gesetzt.

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

  • BrickletAmbientLightV2`ILLUMINANCEURANGEUUNLIMITED = 6
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU64000LUX = 0
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU32000LUX = 1
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU16000LUX = 2
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU8000LUX = 3
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU1300LUX = 4
  • BrickletAmbientLightV2`ILLUMINANCEURANGEU600LUX = 5
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU50MS = 0
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU100MS = 1
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU150MS = 2
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU200MS = 3
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU250MS = 4
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU300MS = 5
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU350MS = 6
  • BrickletAmbientLightV2`INTEGRATIONUTIMEU400MS = 7
BrickletAmbientLightV2@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.

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

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

  • BrickletAmbientLightV2`FUNCTIONUSETUILLUMINANCEUCALLBACKUPERIOD = 2
  • BrickletAmbientLightV2`FUNCTIONUSETUILLUMINANCEUCALLBACKUTHRESHOLD = 4
  • BrickletAmbientLightV2`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
  • BrickletAmbientLightV2`FUNCTIONUSETUCONFIGURATION = 8
BrickletAmbientLightV2@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 Konstanten sind für diese Funktion verfügbar:

  • BrickletAmbientLightV2`FUNCTIONUSETUILLUMINANCEUCALLBACKUPERIOD = 2
  • BrickletAmbientLightV2`FUNCTIONUSETUILLUMINANCEUCALLBACKUTHRESHOLD = 4
  • BrickletAmbientLightV2`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
  • BrickletAmbientLightV2`FUNCTIONUSETUCONFIGURATION = 8
BrickletAmbientLightV2@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.

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

Konfigurationsfunktionen für Callbacks

BrickletAmbientLightV2@SetIlluminanceCallbackPeriod[period] → Null
Parameter:
  • period -- Integer

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

Der IlluminanceCallback Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

BrickletAmbientLightV2@GetIlluminanceCallbackPeriod[] → period
Rückgabe:
  • period -- Integer

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

BrickletAmbientLightV2@SetIlluminanceCallbackThreshold[option, min, max] → Null
Parameter:
  • option -- Integer
  • min -- Integer
  • max -- Integer

Setzt den Schwellwert für den IlluminanceReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Beleuchtungsstärke außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Beleuchtungsstärke innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Beleuchtungsstärke kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Beleuchtungsstärke größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • BrickletAmbientLightV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAmbientLightV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAmbientLightV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAmbientLightV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAmbientLightV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAmbientLightV2@GetIlluminanceCallbackThreshold[out option, out min, out max] → Null
Parameter:
  • option -- Integer
  • min -- Integer
  • max -- Integer

Gibt den Schwellwert zurück, wie von SetIlluminanceCallbackThreshold[] gesetzt.

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

  • BrickletAmbientLightV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAmbientLightV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAmbientLightV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAmbientLightV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAmbientLightV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAmbientLightV2@SetDebouncePeriod[debounce] → Null
Parameter:
  • debounce -- Integer

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

BrickletAmbientLightV2@GetDebouncePeriod[] → debounce
Rückgabe:
  • debounce -- Integer

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod[] 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[ambientLightV2@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 BrickletAmbientLightV2@IlluminanceCallback[sender, illuminance]
Parameter:
  • sender -- NETObject[BrickletAmbientLightV2]
  • illuminance -- Integer

Dieser Callback wird mit der Periode, wie gesetzt mit SetIlluminanceCallbackPeriod[], ausgelöst. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.

Der IlluminanceCallback Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

event BrickletAmbientLightV2@IlluminanceReachedCallback[sender, illuminance]
Parameter:
  • sender -- NETObject[BrickletAmbientLightV2]
  • illuminance -- Integer

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetIlluminanceCallbackThreshold[] gesetzt, erreicht wird. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod[] gesetzt, ausgelöst.

Konstanten

BrickletAmbientLightV2`DEVICEUIDENTIFIER

Diese Konstante wird verwendet um ein Ambient Light Bricklet 2.0 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.

BrickletAmbientLightV2`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet 2.0 dar.