Mathematica - Dust Detector Bricklet¶

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 Dust Detector Bricklet*)

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

(*Get current dust density*)
Print["Dust Density: "<>ToString[N[Quantity[dd@GetDustDensity[],"µg/m³"]]]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[dd]
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 Dust Detector Bricklet*)

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

(*Callback function for dust density callback*)
DustDensityCB[sender_,dustDensity_]:=
 Print["Dust Density: "<>ToString[N[Quantity[dustDensity,"µg/m³"]]]]
AddEventHandler[dd@DustDensityCallback,DustDensityCB]

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

Input["Click OK to exit"]

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

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

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

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

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

(*Callback function for dust density reached callback*)
DustDensityReachedCB[sender_,dustDensity_]:=
 Print["Dust Density: "<>ToString[N[Quantity[dustDensity,"µg/m³"]]]]
AddEventHandler[dd@DustDensityReachedCallback,DustDensityReachedCB]

(*Configure threshold for dust density "greater than 10 µg/m³"*)
option=Tinkerforge`BrickletDustDetector`THRESHOLDUOPTIONUGREATER
dd@SetDustDensityCallbackThreshold[option,10,0]

Input["Click OK to exit"]

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

Grundfunktionen¶

BrickletDustDetector[uid, ipcon] → dustDetector¶

Parameter:	uid – Typ: String ipcon – Typ: NETObject[IPConnection]
Rückgabe:	dustDetector – Typ: NETObject[BrickletDustDetector]

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

dustDetector=NETNew["Tinkerforge.BrickletDustDetector","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.

BrickletDustDetector@GetDustDensity[] → dustDensity¶

Rückgabe:	dustDensity – Typ: Integer, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Gibt die Staubdichte zurück.

Wenn die Staubdichte periodisch abgefragt werden soll, wird empfohlen den DustDensityCallback Callback zu nutzen und die Periode mit SetDustDensityCallbackPeriod[] vorzugeben.

Fortgeschrittene Funktionen¶

BrickletDustDetector@SetMovingAverage[average] → Null¶

Parameter:	average – Typ: Integer, Wertebereich: [0 bis 100], Standardwert: 100

Setzt die Länge eines gleitenden Mittelwerts für die Staubdichte.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

BrickletDustDetector@GetMovingAverage[] → average¶

Rückgabe:	average – Typ: Integer, Wertebereich: [0 bis 100], Standardwert: 100

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage[] gesetzt.

BrickletDustDetector@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¶

BrickletDustDetector@SetDustDensityCallbackPeriod[period] → Null¶

Parameter:	period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

BrickletDustDetector@GetDustDensityCallbackPeriod[] → period¶

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

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

BrickletDustDetector@SetDustDensityCallbackThreshold[option, min, max] → Null¶

Parameter:	option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]] min – Typ: Integer, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den DustDensityReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• BrickletDustDetector`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
• BrickletDustDetector`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
• BrickletDustDetector`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
• BrickletDustDetector`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
• BrickletDustDetector`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]

BrickletDustDetector@GetDustDensityCallbackThreshold[out option, out min, out max] → Null¶

Ausgabeparameter:	option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]] min – Typ: Integer, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• BrickletDustDetector`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
• BrickletDustDetector`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
• BrickletDustDetector`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
• BrickletDustDetector`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
• BrickletDustDetector`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]

BrickletDustDetector@SetDebouncePeriod[debounce] → Null¶

Parameter:	debounce – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

• DustDensityReachedCallback

ausgelöst wird, wenn der Schwellwert

• SetDustDensityCallbackThreshold[]

weiterhin erreicht bleibt.

BrickletDustDetector@GetDebouncePeriod[] → debounce¶

Rückgabe:	debounce – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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[dustDetector@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 BrickletDustDetector@DustDensityCallback[sender, dustDensity]¶

Callback-Parameter:	sender – Typ: NETObject[BrickletDustDetector] dustDensity – Typ: Integer, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Dieser Callback wird mit der Periode, wie gesetzt mit SetDustDensityCallbackPeriod[], ausgelöst. Der Parameter ist die Staubdichte des Sensors.

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

event BrickletDustDetector@DustDensityReachedCallback[sender, dustDensity]¶

Callback-Parameter:	sender – Typ: NETObject[BrickletDustDetector] dustDensity – Typ: Integer, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetDustDensityCallbackThreshold[] gesetzt, erreicht wird. Der Parameter ist die Staubdichte des Sensors.

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

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.

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

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

• BrickletDustDetector`FUNCTIONUSETUDUSTUDENSITYUCALLBACKUPERIOD = 2
• BrickletDustDetector`FUNCTIONUSETUDUSTUDENSITYUCALLBACKUTHRESHOLD = 4
• BrickletDustDetector`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
• BrickletDustDetector`FUNCTIONUSETUMOVINGUAVERAGE = 10

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

• BrickletDustDetector`FUNCTIONUSETUDUSTUDENSITYUCALLBACKUPERIOD = 2
• BrickletDustDetector`FUNCTIONUSETUDUSTUDENSITYUCALLBACKUTHRESHOLD = 4
• BrickletDustDetector`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
• BrickletDustDetector`FUNCTIONUSETUMOVINGUAVERAGE = 10

BrickletDustDetector@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¶

BrickletDustDetector`DEVICEUIDENTIFIER¶

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

BrickletDustDetector`DEVICEDISPLAYNAME¶

Diese Konstante stellt den Anzeigenamen eines Dust Detector Bricklet dar.