Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Load Cell Bricklet
# Get current weight
tinkerforge call load-cell-bricklet $uid get-weight
|
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Load Cell Bricklet
# Handle incoming weight callbacks
tinkerforge dispatch load-cell-bricklet $uid 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!
tinkerforge call load-cell-bricklet $uid set-weight-callback-period 1000
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Download (example-threshold.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Load Cell Bricklet
# Get threshold callbacks with a debounce time of 1 second (1000ms)
tinkerforge call load-cell-bricklet $uid set-debounce-period 1000
# Handle incoming weight reached callbacks
tinkerforge dispatch load-cell-bricklet $uid weight-reached &
# Configure threshold for weight "greater than 200 g"
tinkerforge call load-cell-bricklet $uid set-weight-callback-threshold threshold-option-greater 200 0
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Mögliche Exit Codes für alle tinkerforge
Befehle sind:
argparse
Modul fehltAllgemeine Optionen des call
und des dispatch
Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
call
load-cell-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des Load Cell Bricklet aufzurufen. Der
Befehl kennt mehrere Optionen:
--help
zeigt Hilfe für den spezifischen call
Befehl an und endet dann--list-functions
zeigt eine Liste der bekannten Funktionen des Load Cell Bricklet an
und endet danndispatch
load-cell-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des Load Cell Bricklet
abzufertigen. Der Befehl kennt mehrere Optionen:
--help
zeigt Hilfe für den spezifischen dispatch
Befehl an und endet
dann--list-callbacks
zeigt eine Liste der bekannten Callbacks des Load Cell Bricklet an
und endet dannload-cell-bricklet
<uid> <function>
[<option>..] [<argument>..]¶Parameter: |
|
---|
Abhängig von der Art der aufzurufenden <function>
kennt diese verschiedene
Optionen. Alle Funktionen kennen die folgenden Optionen:
--help
zeigt Hilfe für die spezifische <function>
an und endet dannGetter-Funktionen kennen zusätzlich die folgenden Optionen:
--execute <command>
Shell-Befehl der für jede eingehende Antwort
ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)Setter-Funktionen kennen zusätzlich die folgenden Optionen:
--expect-response
fragt Antwort an und wartet auf dieseMit der --expect-response
Option für Setter-Funktionen können Timeouts und
andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden.
Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option
für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom
Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht
detektiert werden können.
load-cell-bricklet
<uid> <callback>
[<option>..]¶Parameter: |
|
---|
Der abzufertigende <callback>
kennt mehrere Optionen:
--help
zeigt Hilfe für den spezifische <callback>
an und endet dann--execute <command>
Shell-Befehlszeile der für jede eingehende Antwort
ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)load-cell-bricklet
<uid> get-weight
¶Ausgabe: |
|
---|
Gibt das aktuell gemessene Gewicht zurück.
Wenn das Gewicht periodisch abgefragt werden soll, wird empfohlen
den weight
Callback zu nutzen und die Periode mit
set-weight-callback-period
vorzugeben.
load-cell-bricklet
<uid> led-on
¶Ausgabe: |
|
---|
Aktiviert die LED.
load-cell-bricklet
<uid> led-off
¶Ausgabe: |
|
---|
Deaktiviert die LED.
load-cell-bricklet
<uid> is-led-on
¶Ausgabe: |
|
---|
Gibt true zurück wenn die LED aktiviert ist, false sonst.
load-cell-bricklet
<uid> tare
¶Ausgabe: |
|
---|
Setzt das aktuell gemessene Gewicht als Leergewicht.
load-cell-bricklet
<uid> set-moving-average
<average>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
load-cell-bricklet
<uid> get-moving-average
¶Ausgabe: |
|
---|
Gibt die Länge des gleitenden Mittelwerts zurück, wie von
set-moving-average
gesetzt.
load-cell-bricklet
<uid> calibrate
<weight>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
load-cell-bricklet
<uid> set-configuration
<rate> <gain>¶Parameter: |
|
---|---|
Ausgabe: |
|
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 set-moving-average
).
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 Symbole sind für diese Funktion verfügbar:
Für <rate>:
Für <gain>:
load-cell-bricklet
<uid> get-configuration
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für rate:
Für gain:
load-cell-bricklet
<uid> get-identity
¶Ausgabe: |
|
---|
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.
load-cell-bricklet
<uid> set-weight-callback-period
<period>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Periode mit welcher der weight
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der weight
Callback wird nur ausgelöst, wenn sich das Gewicht seit der
letzten Auslösung geändert hat.
load-cell-bricklet
<uid> get-weight-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-weight-callback-period
gesetzt.
load-cell-bricklet
<uid> set-weight-callback-threshold
<option> <min> <max>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Schwellwert für den weight-reached
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 Symbole sind für diese Funktion verfügbar:
Für <option>:
load-cell-bricklet
<uid> get-weight-callback-threshold
¶Ausgabe: |
|
---|
Gibt den Schwellwert zurück, wie von set-weight-callback-threshold
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
load-cell-bricklet
<uid> set-debounce-period
<debounce>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
load-cell-bricklet
<uid> get-debounce-period
¶Ausgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von set-debounce-period
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch load-cell-bricklet <uid> example
Die verfügbaren Callbacks 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.
load-cell-bricklet
<uid> weight
¶Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit set-weight-callback-period
,
ausgelöst. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.
Der weight
Callback wird nur ausgelöst, wenn sich das Gewicht seit der
letzten Auslösung geändert hat.
load-cell-bricklet
<uid> weight-reached
¶Ausgabe: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
set-weight-callback-threshold
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 set-debounce-period
gesetzt, ausgelöst.