Dies ist die Beschreibung der Rust API Bindings für das Load Cell Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Load Cell Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | use std::{error::Error, io};
use tinkerforge::{ip_connection::IpConnection, load_cell_v2_bricklet::*};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Load Cell Bricklet 2.0.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let lc = LoadCellV2Bricklet::new(UID, &ipcon); // Create device object.
ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
// Don't use device before ipcon is connected.
// Get current weight.
let weight = lc.get_weight().recv()?;
println!("Weight: {} g", weight);
println!("Press enter to exit.");
let mut _input = String::new();
io::stdin().read_line(&mut _input)?;
ipcon.disconnect();
Ok(())
}
|
Download (example_callback.rs)
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 32 33 34 | use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, load_cell_v2_bricklet::*};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Load Cell Bricklet 2.0.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let lc = LoadCellV2Bricklet::new(UID, &ipcon); // Create device object.
ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
// Don't use device before ipcon is connected.
let weight_receiver = lc.get_weight_callback_receiver();
// Spawn thread to handle received callback messages.
// This thread ends when the `lc` object
// is dropped, so there is no need for manual cleanup.
thread::spawn(move || {
for weight in weight_receiver {
println!("Weight: {} g", weight);
}
});
// Set period for weight callback to 1s (1000ms) without a threshold.
lc.set_weight_callback_configuration(1000, false, 'x', 0, 0);
println!("Press enter to exit.");
let mut _input = String::new();
io::stdin().read_line(&mut _input)?;
ipcon.disconnect();
Ok(())
}
|
Download (example_threshold.rs)
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 32 33 34 35 | use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, load_cell_v2_bricklet::*};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Load Cell Bricklet 2.0.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let lc = LoadCellV2Bricklet::new(UID, &ipcon); // Create device object.
ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
// Don't use device before ipcon is connected.
let weight_receiver = lc.get_weight_callback_receiver();
// Spawn thread to handle received callback messages.
// This thread ends when the `lc` object
// is dropped, so there is no need for manual cleanup.
thread::spawn(move || {
for weight in weight_receiver {
println!("Weight: {} g", weight);
}
});
// Configure threshold for weight "greater than 200 g"
// with a debounce period of 1s (1000ms).
lc.set_weight_callback_configuration(1000, false, '>', 200, 0);
println!("Press enter to exit.");
let mut _input = String::new();
io::stdin().read_line(&mut _input)?;
ipcon.disconnect();
Ok(())
}
|
Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.
Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.
Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.
LoadCellV2Bricklet::
new
(uid: &str, ip_connection: &IpConnection) → LoadCellV2Bricklet¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues LoadCellV2Bricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IP-Connection ip_connection
hinzu:
let load_cell_v2 = LoadCellV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.
LoadCellV2Bricklet::
get_weight
(&self) → ConvertingReceiver<i32>¶Rückgabe: |
|
---|
Gibt das aktuell gemessene Gewicht zurück.
Wenn der Wert periodisch benötigt wird, kann auch der LoadCellV2Bricklet::get_weight_callback_receiver
Callback
verwendet werden. Der Callback wird mit der Funktion
LoadCellV2Bricklet::set_weight_callback_configuration
konfiguriert.
LoadCellV2Bricklet::
set_info_led_config
(&self, config: u8) → ConvertingReceiver<()>¶Parameter: |
|
---|
Konfiguriert die Info-LED. Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
LoadCellV2Bricklet::
get_info_led_config
(&self) → ConvertingReceiver<u8>¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von LoadCellV2Bricklet::set_info_led_config
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
LoadCellV2Bricklet::
tare
(&self) → ConvertingReceiver<()>¶Setzt das aktuell gemessene Gewicht als Leergewicht.
LoadCellV2Bricklet::
set_moving_average
(&self, average: u16) → ConvertingReceiver<()>¶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.
LoadCellV2Bricklet::
get_moving_average
(&self) → ConvertingReceiver<u16>¶Rückgabe: |
|
---|
Gibt die Länge des gleitenden Mittelwerts zurück, wie von
LoadCellV2Bricklet::set_moving_average
gesetzt.
LoadCellV2Bricklet::
calibrate
(&self, weight: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Zum Kalibrieren des Load Cell Bricklet 2.0 müssen die folgenden zwei Schritte durchgeführt werden:
Die Kalibrierung wird auf dem Flash 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.
LoadCellV2Bricklet::
set_configuration
(&self, rate: u8, gain: u8) → ConvertingReceiver<()>¶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 LoadCellV2Bricklet::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 folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
Für gain:
LoadCellV2Bricklet::
get_configuration
(&self) → ConvertingReceiver<Configuration>¶Rückgabeobjekt: |
|
---|
Gibt die Konfiguration zurück, wie von LoadCellV2Bricklet::set_configuration
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
Für gain:
LoadCellV2Bricklet::
get_spitfp_error_count
(&self) → ConvertingReceiver<SpitfpErrorCount>¶Rückgabeobjekt: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
LoadCellV2Bricklet::
set_status_led_config
(&self, config: u8) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
LoadCellV2Bricklet::
get_status_led_config
(&self) → ConvertingReceiver<u8>¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von LoadCellV2Bricklet::set_status_led_config
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
LoadCellV2Bricklet::
get_chip_temperature
(&self) → ConvertingReceiver<i16>¶Rückgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
LoadCellV2Bricklet::
reset
(&self) → ConvertingReceiver<()>¶Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
LoadCellV2Bricklet::
get_identity
(&self) → ConvertingReceiver<Identity>¶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 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.
LoadCellV2Bricklet::
set_weight_callback_configuration
(&self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der LoadCellV2Bricklet::get_weight_callback_receiver
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den LoadCellV2Bricklet::get_weight_callback_receiver
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
LoadCellV2Bricklet::
get_weight_callback_configuration
(&self) → ConvertingReceiver<WeightCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels LoadCellV2Bricklet::set_weight_callback_configuration
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.
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.
LoadCellV2Bricklet::
get_weight_callback_receiver
(&self) → ConvertingCallbackReceiver<i32>¶Event: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Weight-Events.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
LoadCellV2Bricklet::set_weight_callback_configuration
gesetzten Konfiguration
Der empfangene Variable ist der gleiche wie LoadCellV2Bricklet::get_weight
.
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.
LoadCellV2Bricklet::
get_api_version
(&self) → [u8; 3]¶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.
LoadCellV2Bricklet::
get_response_expected
(&mut self, function_id: u8) → bool¶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 LoadCellV2Bricklet::set_response_expected
. 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 function_id:
LoadCellV2Bricklet::
set_response_expected
(&mut self, function_id: u8, response_expected: bool) → ()¶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 function_id:
LoadCellV2Bricklet::
set_response_expected_all
(&mut self, response_expected: bool) → ()¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
LoadCellV2Bricklet::
set_bootloader_mode
(&self, mode: u8) → ConvertingReceiver<u8>¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
LoadCellV2Bricklet::
get_bootloader_mode
(&self) → ConvertingReceiver<u8>¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe LoadCellV2Bricklet::set_bootloader_mode
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
LoadCellV2Bricklet::
set_write_firmware_pointer
(&self, pointer: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt den Firmware-Pointer für LoadCellV2Bricklet::write_firmware
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
LoadCellV2Bricklet::
write_firmware
(&self, data: [u8; 64]) → ConvertingReceiver<u8>¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
LoadCellV2Bricklet::set_write_firmware_pointer
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
LoadCellV2Bricklet::
write_uid
(&self, uid: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
LoadCellV2Bricklet::
read_uid
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
LoadCellV2Bricklet::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Load Cell Bricklet 2.0 zu identifizieren.
Die LoadCellV2Bricklet::get_identity
Funktion und der IpConnection::get_enumerate_callback_receiver
Callback der IP Connection haben ein device_identifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
LoadCellV2Bricklet::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet 2.0 dar.