Dies ist die Beschreibung der Rust API Bindings für das Current12 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Current12 Bricklet 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::{current12_bricklet::*, ip_connection::IpConnection};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Current12 Bricklet.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let c = Current12Bricklet::new(UID, &ipcon); // Create device object.
ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
// Don't use device before ipcon is connected.
// Get current current.
let current = c.get_current().recv()?;
println!("Current: {} A", current as f32 / 1000.0);
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 35 36 | use std::{error::Error, io, thread};
use tinkerforge::{current12_bricklet::*, ip_connection::IpConnection};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Current12 Bricklet.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let c = Current12Bricklet::new(UID, &ipcon); // Create device object.
ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
// Don't use device before ipcon is connected.
let current_receiver = c.get_current_callback_receiver();
// Spawn thread to handle received callback messages.
// This thread ends when the `c` object
// is dropped, so there is no need for manual cleanup.
thread::spawn(move || {
for current in current_receiver {
println!("Current: {} A", current as f32 / 1000.0);
}
});
// Set period for current receiver to 1s (1000ms).
// Note: The current callback is only called every second
// if the current has changed since the last call!
c.set_current_callback_period(1000);
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 36 37 | use std::{error::Error, io, thread};
use tinkerforge::{current12_bricklet::*, ip_connection::IpConnection};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Current12 Bricklet.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let c = Current12Bricklet::new(UID, &ipcon); // Create device object.
ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
// Don't use device before ipcon is connected.
// Get threshold receivers with a debounce time of 10 seconds (10000ms).
c.set_debounce_period(10000);
let current_reached_receiver = c.get_current_reached_callback_receiver();
// Spawn thread to handle received callback messages.
// This thread ends when the `c` object
// is dropped, so there is no need for manual cleanup.
thread::spawn(move || {
for current_reached in current_reached_receiver {
println!("Current: {} A", current_reached as f32 / 1000.0);
}
});
// Configure threshold for current "greater than 5 A".
c.set_current_callback_threshold('>', 5 * 1000, 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.
Current12Bricklet::
new
(uid: &str, ip_connection: &IpConnection) → Current12Bricklet¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues Current12Bricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IP-Connection ip_connection
hinzu:
let current12 = Current12Bricklet::new("YOUR_DEVICE_UID", &ip_connection);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.
Current12Bricklet::
get_current
(&self) → ConvertingReceiver<i16>¶Rückgabe: |
|
---|
Gibt die gemessenen Stromstärke des Sensors zurück.
Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen
den Current12Bricklet::get_current_callback_receiver
Callback zu nutzen und die Periode mit
Current12Bricklet::set_current_callback_period
vorzugeben.
Current12Bricklet::
calibrate
(&self) → ConvertingReceiver<()>¶Kalibriert den Nullwert des Sensors. Diese Funktion muss aufgerufen werden, wenn kein Strom fließt.
Der Nullwert des Stromsensors ist abhängig von den exakten Eigenschaften des Analog-Digital-Wandlers, der Länge des Bricklet Kabels und der Temperatur. Daher ist es, bei Wechsel des Brick oder bei Veränderung der Umgebung in welcher das Bricklet genutzt wird, ratsam erneut zu kalibrieren.
Die resultierende Kalibrierung wird in den EEPROM des Current Bricklet gespeichert.
Current12Bricklet::
is_over_current
(&self) → ConvertingReceiver<bool>¶Rückgabe: |
|
---|
Gibt true zurück wenn mehr als 12,5A gemessen wurden.
Bemerkung
Um diesen Wert zurückzusetzen ist ein Aus- und Wiedereinschalten des Bricklet notwendig.
Current12Bricklet::
get_analog_value
(&self) → ConvertingReceiver<u16>¶Rückgabe: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von Current12Bricklet::get_current
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während Current12Bricklet::get_analog_value
unverarbeitete Analogwerte zurück gibt. Der einzige Grund Current12Bricklet::get_analog_value
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen
den Current12Bricklet::get_analog_value_callback_receiver
Callback zu nutzen und die Periode mit
Current12Bricklet::set_analog_value_callback_period
vorzugeben.
Current12Bricklet::
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.
Current12Bricklet::
set_current_callback_period
(&self, period: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Periode mit welcher der Current12Bricklet::get_current_callback_receiver
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der Current12Bricklet::get_current_callback_receiver
Callback wird nur ausgelöst, wenn sich die Stromstärke seit
der letzten Auslösung geändert hat.
Current12Bricklet::
get_current_callback_period
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von Current12Bricklet::set_current_callback_period
gesetzt.
Current12Bricklet::
set_analog_value_callback_period
(&self, period: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Periode mit welcher der Current12Bricklet::get_analog_value_callback_receiver
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der Current12Bricklet::get_analog_value_callback_receiver
Callback wird nur ausgelöst, wenn sich der Analogwert seit der
letzten Auslösung geändert hat.
Current12Bricklet::
get_analog_value_callback_period
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von Current12Bricklet::set_analog_value_callback_period
gesetzt.
Current12Bricklet::
set_current_callback_threshold
(&self, option: char, min: i16, max: i16) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt den Schwellwert für den Current12Bricklet::get_current_reached_callback_receiver
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Stromstärke größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Current12Bricklet::
get_current_callback_threshold
(&self) → ConvertingReceiver<CurrentCallbackThreshold>¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von Current12Bricklet::set_current_callback_threshold
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Current12Bricklet::
set_analog_value_callback_threshold
(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt den Schwellwert für den Current12Bricklet::get_analog_value_reached_callback_receiver
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Current12Bricklet::
get_analog_value_callback_threshold
(&self) → ConvertingReceiver<AnalogValueCallbackThreshold>¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von Current12Bricklet::set_analog_value_callback_threshold
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Current12Bricklet::
set_debounce_period
(&self, debounce: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
Current12Bricklet::get_current_reached_callback_receiver
,Current12Bricklet::get_analog_value_reached_callback_receiver
ausgelöst werden, wenn die Schwellwerte
Current12Bricklet::set_current_callback_threshold
,Current12Bricklet::set_analog_value_callback_threshold
weiterhin erreicht bleiben.
Current12Bricklet::
get_debounce_period
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von Current12Bricklet::set_debounce_period
gesetzt.
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.
Current12Bricklet::
get_current_callback_receiver
(&self) → ConvertingCallbackReceiver<i16>¶Event: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Current-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit
Current12Bricklet::set_current_callback_period
, ausgelöst. Der empfangene Variable ist
die Stromstärke des Sensors.
Der Current12Bricklet::get_current_callback_receiver
Callback wird nur ausgelöst, wenn sich die Stromstärke seit der
letzten Auslösung geändert hat.
Current12Bricklet::
get_analog_value_callback_receiver
(&self) → ConvertingCallbackReceiver<u16>¶Event: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Analog Value-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit Current12Bricklet::set_analog_value_callback_period
,
ausgelöst. Der empfangene Variable ist der Analogwert des Umgebungslichtsensors.
Der Current12Bricklet::get_analog_value_callback_receiver
Callback wird nur ausgelöst, wenn sich der Analogwert seit der
letzten Auslösung geändert hat.
Current12Bricklet::
get_current_reached_callback_receiver
(&self) → ConvertingCallbackReceiver<i16>¶Event: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Current Reached-Events.
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
Current12Bricklet::set_current_callback_threshold
gesetzt, erreicht wird.
Der empfangene Variable ist die Stromstärke des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit Current12Bricklet::set_debounce_period
gesetzt, ausgelöst.
Current12Bricklet::
get_analog_value_reached_callback_receiver
(&self) → ConvertingCallbackReceiver<u16>¶Event: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Analog Value Reached-Events.
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
Current12Bricklet::set_analog_value_callback_threshold
gesetzt, erreicht wird.
Der empfangene Variable ist der Analogwert des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit Current12Bricklet::set_debounce_period
gesetzt, ausgelöst.
Current12Bricklet::
get_over_current_callback_receiver
(&self) → ConvertingCallbackReceiver<()>¶Receiver die mit dieser Funktion erstellt werden, empfangen Over Current-Events.
Dieser Callback wird ausgelöst, wenn ein Überstrom gemessen wurde
(siehe Current12Bricklet::is_over_current
).
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.
Current12Bricklet::
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.
Current12Bricklet::
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 Current12Bricklet::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:
Current12Bricklet::
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:
Current12Bricklet::
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.
Current12Bricklet::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Current12 Bricklet zu identifizieren.
Die Current12Bricklet::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.
Current12Bricklet::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Current12 Bricklet dar.