Dies ist die Beschreibung der MATLAB/Octave 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 MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (matlab_example_simple.m)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | function matlab_example_simple()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLoadCell;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Load Cell Bricklet
ipcon = IPConnection(); % Create IP connection
lc = handle(BrickletLoadCell(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current weight
weight = lc.getWeight();
fprintf('Weight: %i g\n', weight);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
|
Download (matlab_example_callback.m)
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 | function matlab_example_callback()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLoadCell;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Load Cell Bricklet
ipcon = IPConnection(); % Create IP connection
lc = handle(BrickletLoadCell(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register weight callback to function cb_weight
set(lc, 'WeightCallback', @(h, e) cb_weight(e));
% 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('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for weight callback
function cb_weight(e)
fprintf('Weight: %i g\n', e.weight);
end
|
Download (matlab_example_threshold.m)
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 | function matlab_example_threshold()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLoadCell;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Load Cell Bricklet
ipcon = IPConnection(); % Create IP connection
lc = handle(BrickletLoadCell(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get threshold callbacks with a debounce time of 1 second (1000ms)
lc.setDebouncePeriod(1000);
% Register weight reached callback to function cb_weight_reached
set(lc, 'WeightReachedCallback', @(h, e) cb_weight_reached(e));
% Configure threshold for weight "greater than 200 g"
lc.setWeightCallbackThreshold('>', 200, 0);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for weight reached callback
function cb_weight_reached(e)
fprintf('Weight: %i g\n', e.weight);
end
|
Download (octave_example_simple.m)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | function octave_example_simple()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Load Cell Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
lc = javaObject("com.tinkerforge.BrickletLoadCell", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current weight
weight = lc.getWeight();
fprintf("Weight: %d g\n", weight);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
|
Download (octave_example_callback.m)
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 | function octave_example_callback()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Load Cell Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
lc = javaObject("com.tinkerforge.BrickletLoadCell", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register weight callback to function cb_weight
lc.addWeightCallback(@cb_weight);
% 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("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for weight callback
function cb_weight(e)
fprintf("Weight: %d g\n", e.weight);
end
|
Download (octave_example_threshold.m)
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 | function octave_example_threshold()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Load Cell Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
lc = javaObject("com.tinkerforge.BrickletLoadCell", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get threshold callbacks with a debounce time of 1 second (1000ms)
lc.setDebouncePeriod(1000);
% Register weight reached callback to function cb_weight_reached
lc.addWeightReachedCallback(@cb_weight_reached);
% Configure threshold for weight "greater than 200 g"
lc.setWeightCallbackThreshold(">", 200, 0);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for weight reached callback
function cb_weight_reached(e)
fprintf("Weight: %d g\n", e.weight);
end
|
Prinzipiell kann jede Methode der MATLAB Bindings eine 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.
Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.
Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.
Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*
Alle folgend aufgelisteten Methoden sind Thread-sicher.
Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid.
In MATLAB:
import com.tinkerforge.BrickletLoadCell;
loadCell = BrickletLoadCell("YOUR_DEVICE_UID", ipcon);
In Octave:
loadCell = java_new("com.tinkerforge.BrickletLoadCell", "YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).
Rückgabe: |
|
---|
Gibt das aktuell gemessene Gewicht zurück.
Wenn das Gewicht periodisch abgefragt werden soll, wird empfohlen den WeightCallback Callback zu nutzen und die Periode mit setWeightCallbackPeriod() vorzugeben.
Aktiviert die LED.
Deaktiviert die LED.
Rückgabe: |
|
---|
Gibt true zurück wenn die LED aktiviert ist, false sonst.
Setzt das aktuell gemessene Gewicht als Leergewicht.
Parameter: |
|
---|
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.
Rückgabe: |
|
---|
Gibt die Länge des gleitenden Mittelwerts zurück, wie von setMovingAverage() gesetzt.
Parameter: |
|
---|
Zum Kalibrieren des Load Cell Bricklet müssen die folgenden zwei Schritte durchgeführt werden:
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.
Parameter: |
|
---|
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 folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
Für gain:
Rückgabeobjekt: |
|
---|
Gibt die Konfiguration zurück, wie von setConfiguration() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
Für gain:
Rückgabeobjekt: |
|
---|
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 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.
Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setWeightCallbackPeriod() gesetzt.
Parameter: |
|
---|
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) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setWeightCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
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 wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:
function my_callback(e)
fprintf('Parameter: %s\n', e.param);
end
set(device, 'ExampleCallback', @(h, e) my_callback(e));
Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:
function my_callback(e)
fprintf("Parameter: %s\n", e.param);
end
device.addExampleCallback(@my_callback);
Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.
Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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-Objekt: |
|
---|
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.
In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addWeightCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeWeightCallback() wieder entfernt werden.
Event-Objekt: |
|
---|
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.
In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addWeightReachedCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeWeightReachedCallback() wieder entfernt werden.
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.
Rückgabeobjekt: |
|
---|
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 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.
Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet dar.