Mathematica - Load Cell Bricklet

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

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

(*Get current weight*)
Print["Weight: "<>ToString[N[Quantity[lc@GetWeight[],"g"]]]]

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

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

(*Callback function for weight callback*)
WeightCB[sender_,weight_]:=
 Print["Weight: "<>ToString[N[Quantity[weight,"g"]]]]
AddEventHandler[lc@WeightCallback,WeightCB]

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

Input["Click OK to exit"]

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

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

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

(*Callback function for weight reached callback*)
WeightReachedCB[sender_,weight_]:=
 Print["Weight: "<>ToString[N[Quantity[weight,"g"]]]]
AddEventHandler[lc@WeightReachedCallback,WeightReachedCB]

(*Configure threshold for weight "greater than 200 g"*)
option=Tinkerforge`BrickletLoadCell`THRESHOLDUOPTIONUGREATER
lc@SetWeightCallbackThreshold[option,200,0]

Input["Click OK to exit"]

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

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

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

loadCell=NETNew["Tinkerforge.BrickletLoadCell","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.

BrickletLoadCell@GetWeight[] → weight
Rückgabe:
  • weight -- Integer

Gibt das aktuell gemessene Gewicht in Gramm zurück.

Wenn das Gewicht periodisch abgefragt werden soll, wird empfohlen den WeightCallback Callback zu nutzen und die Periode mit SetWeightCallbackPeriod[] vorzugeben.

BrickletLoadCell@LEDOn[] → Null

Aktiviert die LED.

BrickletLoadCell@LEDOff[] → Null

Deaktiviert die LED.

BrickletLoadCell@IsLEDOn[] → on
Rückgabe:
  • on -- True/False

Gibt true zurück wenn die LED aktiviert ist, false sonst.

BrickletLoadCell@Tare[] → Null

Setzt das aktuell gemessene Gewicht als Leergewicht.

Fortgeschrittene Funktionen

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

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

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

Der Wertebereich liegt bei 1-40.

Der Standardwert ist 4.

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

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

BrickletLoadCell@Calibrate[weight] → Null
Parameter:
  • weight -- Integer

Zum Kalibrieren des Load Cell Bricklet müssen die folgenden zwei Schritte durchgeführt werden:

  • Die Waage leeren und die Funktion mit 0 aufrufen.
  • Eine bekanntes Gewicht auf die Waage legen und die Funktion mit dem Gewicht in Gramm aufrufen.

Die Kalibrierung wird auf dem EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

Wir empfehlen die Kalibrierung über den Brick Viewer zu setzen, diese Funktion muss nicht im Quelltext genutzt werden.

BrickletLoadCell@SetConfiguration[rate, gain] → Null
Parameter:
  • rate -- Integer
  • gain -- Integer

Für die Messungen sind Rate und Gain konfigurierbar.

Die Rate kann auf 10Hz oder 80Hz gesetzt werden. Eine schnellere Rate erzeugt mehr Störungen. Zusätzlich ist es möglich einen gleitenden Mittelwert auf die Werte anzuwenden (siehe SetMovingAverage[]).

Der Gain kann zwischen 128x, 64x und 32x konfiguriert werden. Er repräsentiert einen Messbereich von ±20mV, ±40mV und ±80mV respektive. Das Load Cell Bricklet nutzt eine Erregerspannung (Excitation Voltage) von 5V und die meisten Wägezellen haben eine Ausgabe von 2mV/V. Dies bedeutet, der Spannungsbereich ist ±15mV für die meisten Wägezellen (d.h. ein Gain von 128x ist am geeignetsten). Falls nicht klar ist was dies alles bedeutet, ein Gain von 128x ist höchstwahrscheinlich korrekt.

Die Konfiguration wird auf dem EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

Wir empfehlen die Konfiguration über den Brick Viewer zu setzen, diese Funktion muss nicht im Quelltext genutzt werden.

Die Standardwerte sind 10Hz für die Rate und 128x für den Gain.

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

  • BrickletLoadCell`RATEU10HZ = 0
  • BrickletLoadCell`RATEU80HZ = 1
  • BrickletLoadCell`GAINU128X = 0
  • BrickletLoadCell`GAINU64X = 1
  • BrickletLoadCell`GAINU32X = 2
BrickletLoadCell@GetConfiguration[out rate, out gain] → Null
Parameter:
  • rate -- Integer
  • gain -- Integer

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

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

  • BrickletLoadCell`RATEU10HZ = 0
  • BrickletLoadCell`RATEU80HZ = 1
  • BrickletLoadCell`GAINU128X = 0
  • BrickletLoadCell`GAINU64X = 1
  • BrickletLoadCell`GAINU32X = 2
BrickletLoadCell@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.

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

Siehe SetResponseExpected[] für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletLoadCell@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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletLoadCell`FUNCTIONUSETUWEIGHTUCALLBACKUPERIOD = 2
  • BrickletLoadCell`FUNCTIONUSETUWEIGHTUCALLBACKUTHRESHOLD = 4
  • BrickletLoadCell`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
  • BrickletLoadCell`FUNCTIONUSETUMOVINGUAVERAGE = 8
  • BrickletLoadCell`FUNCTIONULEDUON = 10
  • BrickletLoadCell`FUNCTIONULEDUOFF = 11
  • BrickletLoadCell`FUNCTIONUCALIBRATE = 13
  • BrickletLoadCell`FUNCTIONUTARE = 14
  • BrickletLoadCell`FUNCTIONUSETUCONFIGURATION = 15
BrickletLoadCell@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.

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

BrickletLoadCell@SetWeightCallbackPeriod[period] → Null
Parameter:
  • period -- Integer

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

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

Der Standardwert ist 0.

BrickletLoadCell@GetWeightCallbackPeriod[] → period
Rückgabe:
  • period -- Integer

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

BrickletLoadCell@SetWeightCallbackThreshold[option, min, max] → Null
Parameter:
  • option -- Integer
  • min -- Integer
  • max -- Integer

Setzt den Schwellwert für den WeightReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

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

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

  • BrickletLoadCell`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletLoadCell`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletLoadCell`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletLoadCell`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletLoadCell`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletLoadCell@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.

BrickletLoadCell@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[loadCell@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 BrickletLoadCell@WeightCallback[sender, weight]
Parameter:
  • sender -- NETObject[BrickletLoadCell]
  • weight -- Integer

Dieser Callback wird mit der Periode, wie gesetzt mit SetWeightCallbackPeriod[], ausgelöst. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.

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

event BrickletLoadCell@WeightReachedCallback[sender, weight]
Parameter:
  • sender -- NETObject[BrickletLoadCell]
  • weight -- Integer

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetWeightCallbackThreshold[] gesetzt, erreicht wird. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.

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

Konstanten

BrickletLoadCell`DEVICEUIDENTIFIER

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

BrickletLoadCell`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet dar.