Mathematica - Moisture Bricklet

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

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

(*Get current moisture value*)
Print["Moisture Value: "<>ToString[m@GetMoistureValue[]]]

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

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

(*Callback function for moisture value callback*)
MoistureCB[sender_,moisture_]:=
 Print["Moisture Value: "<>ToString[moisture]]
AddEventHandler[m@MoistureCallback,MoistureCB]

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

Input["Click OK to exit"]

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

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

(*Get threshold callbacks with a debounce time of 1 second (1000ms)*)
m@SetDebouncePeriod[1000]

(*Callback function for moisture value reached callback*)
MoistureReachedCB[sender_,moisture_]:=
 Print["Moisture Value: "<>ToString[moisture]]
AddEventHandler[m@MoistureReachedCallback,MoistureReachedCB]

(*Configure threshold for moisture value "greater than 200"*)
option=Tinkerforge`BrickletMoisture`THRESHOLDUOPTIONUGREATER
m@SetMoistureCallbackThreshold[option,200,0]

Input["Click OK to exit"]

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

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

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

moisture=NETNew["Tinkerforge.BrickletMoisture","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.

BrickletMoisture@GetMoistureValue[] → moisture
Rückgabe:
  • moisture -- Integer

Gibt den aktuellen Feuchtigkeitswert zurück. Der Wert hat einen Wertebereich von 0 bis 4095. Ein kleiner Wert entspricht einer geringen Feuchtigkeit, ein großer Wert entspricht einer hohen Feuchtigkeit.

Wenn der Feuchtigkeitswert periodisch abgefragt werden soll, wird empfohlen den MoistureCallback Callback zu nutzen und die Periode mit SetMoistureCallbackPeriod[] vorzugeben.

Fortgeschrittene Funktionen

BrickletMoisture@SetMovingAverage[average] → Null
Parameter:
  • average -- Integer

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

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.

Der Wertebereich liegt bei 0-100.

Der Standardwert ist 100.

BrickletMoisture@GetMovingAverage[] → average
Rückgabe:
  • average -- Integer

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

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

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

  • BrickletMoisture`FUNCTIONUSETUMOISTUREUCALLBACKUPERIOD = 2
  • BrickletMoisture`FUNCTIONUSETUMOISTUREUCALLBACKUTHRESHOLD = 4
  • BrickletMoisture`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
  • BrickletMoisture`FUNCTIONUSETUMOVINGUAVERAGE = 10
BrickletMoisture@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:

  • BrickletMoisture`FUNCTIONUSETUMOISTUREUCALLBACKUPERIOD = 2
  • BrickletMoisture`FUNCTIONUSETUMOISTUREUCALLBACKUTHRESHOLD = 4
  • BrickletMoisture`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
  • BrickletMoisture`FUNCTIONUSETUMOVINGUAVERAGE = 10
BrickletMoisture@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.

BrickletMoisture@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

BrickletMoisture@SetMoistureCallbackPeriod[period] → Null
Parameter:
  • period -- Integer

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

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

Der Standardwert ist 0.

BrickletMoisture@GetMoistureCallbackPeriod[] → period
Rückgabe:
  • period -- Integer

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

BrickletMoisture@SetMoistureCallbackThreshold[option, min, max] → Null
Parameter:
  • option -- Integer
  • min -- Integer
  • max -- Integer

Setzt den Schwellwert für den MoistureReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Feuchtigkeitswert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Feuchtigkeitswert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Feuchtigkeitswert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Feuchtigkeitswert 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:

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

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

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

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

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

BrickletMoisture@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[moisture@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 BrickletMoisture@MoistureCallback[sender, moisture]
Parameter:
  • sender -- NETObject[BrickletMoisture]
  • moisture -- Integer

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

The MoistureCallback Callback wird nur ausgelöst, wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

event BrickletMoisture@MoistureReachedCallback[sender, moisture]
Parameter:
  • sender -- NETObject[BrickletMoisture]
  • moisture -- Integer

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

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

Konstanten

BrickletMoisture`DEVICEUIDENTIFIER

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

BrickletMoisture`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Moisture Bricklet dar.