Dies ist die Beschreibung der Rust API Bindings für den IMU Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick 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 26 27 28 29 | use std::{error::Error, io};
use tinkerforge::{imu_brick::*, ip_connection::IpConnection};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XXYYZZ"; // Change XXYYZZ to the UID of your IMU Brick.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let imu = ImuBrick::new(UID, &ipcon); // Create device object.
ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
// Don't use device before ipcon is connected.
// Get current quaternion.
let quaternion = imu.get_quaternion().recv()?;
println!("Quaternion [X]: {}", quaternion.x);
println!("Quaternion [Y]: {}", quaternion.y);
println!("Quaternion [Z]: {}", quaternion.z);
println!("Quaternion [W]: {}", quaternion.w);
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 37 38 | use std::{error::Error, io, thread};
use tinkerforge::{imu_brick::*, ip_connection::IpConnection};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XXYYZZ"; // Change XXYYZZ to the UID of your IMU Brick.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let imu = ImuBrick::new(UID, &ipcon); // Create device object.
ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
// Don't use device before ipcon is connected.
let quaternion_receiver = imu.get_quaternion_callback_receiver();
// Spawn thread to handle received callback messages.
// This thread ends when the `imu` object
// is dropped, so there is no need for manual cleanup.
thread::spawn(move || {
for quaternion in quaternion_receiver {
println!("Quaternion [X]: {}", quaternion.x);
println!("Quaternion [Y]: {}", quaternion.y);
println!("Quaternion [Z]: {}", quaternion.z);
println!("Quaternion [W]: {}", quaternion.w);
println!();
}
});
// Set period for quaternion receiver to 1s (1000ms).
imu.set_quaternion_period(1000);
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.
ImuBrick::
new
(uid: &str, ip_connection: &IpConnection) → ImuBrick¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues ImuBrick
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IP-Connection ip_connection
hinzu:
let imu = ImuBrick::new("YOUR_DEVICE_UID", &ip_connection);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.
ImuBrick::
get_orientation
(&self) → ConvertingReceiver<Orientation>¶Rückgabeobjekt: |
|
---|
Gibt die aktuelle Orientierung (Roll-, Nick-, Gierwinkel) des IMU Brick in Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren.
Wir empfehlen die Verwendung von Quaternionen stattdessen.
Die Reihenfolge in denen die Orientierungswerte angewandt werden sollten, ist Roll-, Nick-, Gierwinkel.
Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den
ImuBrick::get_orientation_callback_receiver
Callback zu nutzen und die Periode mit
ImuBrick::set_orientation_period
vorzugeben.
ImuBrick::
get_quaternion
(&self) → ConvertingReceiver<Quaternion>¶Rückgabeobjekt: |
|
---|
Gibt die aktuelle Orientierung (x, y, z, w) des IMU Brick als Quaterinonen zurück.
Die Umrechnung von Quaternionen in Eulerwinkel ist mit folgender Formel möglich:
xAngle = atan2(2*y*w - 2*x*z, 1 - 2*y*y - 2*z*z)
yAngle = atan2(2*x*w - 2*y*z, 1 - 2*x*x - 2*z*z)
zAngle = asin(2*x*y + 2*z*w)
Es ist auch möglich unabhängige Winkel zu berechen. Yaw, Pitch und Roll in einem rechtshändigen Fahrzeugkoordinatensystem nach DIN70000 können wie folgt berechnet werden:
yaw = atan2(2*x*y + 2*w*z, w*w + x*x - y*y - z*z)
pitch = -asin(2*w*y - 2*x*z)
roll = -atan2(2*y*z + 2*w*x, -w*w + x*x + y*y - z*z))
Diese Umrechnung ist irreversibel aufgrund der kardanischen Blockade.
Die Umrechnung von Quaternionen in eine OpenGL Transformationsmatrix ist mit folgender Formel möglich:
matrix = [[1 - 2*(y*y + z*z), 2*(x*y - w*z), 2*(x*z + w*y), 0],
[ 2*(x*y + w*z), 1 - 2*(x*x + z*z), 2*(y*z - w*x), 0],
[ 2*(x*z - w*y), 2*(y*z + w*x), 1 - 2*(x*x + y*y), 0],
[ 0, 0, 0, 1]]
Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den
ImuBrick::get_quaternion_callback_receiver
Callback zu nutzen und die Periode mit
ImuBrick::set_quaternion_period
vorzugeben.
ImuBrick::
leds_on
(&self) → ConvertingReceiver<()>¶Aktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.
ImuBrick::
leds_off
(&self) → ConvertingReceiver<()>¶Deaktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.
ImuBrick::
are_leds_on
(&self) → ConvertingReceiver<bool>¶Rückgabe: |
|
---|
Gibt zurück ob die Orientierungs- und Richtungs-LEDs des IMU Brick aktiv sind.
ImuBrick::
set_convergence_speed
(&self, speed: u16) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Konvergenzgeschwindigkeit des IMU Brick. Die Konvergenzgeschwindigkeit bestimmt wie die unterschiedlichen Sensormessungen vereinigt werden.
Wenn die Orientierung des IMU Brick eine Abweichung von 10° hat und die Konvergenzgeschwindigkeit auf 20°/s konfiguriert ist, dann dauert es 0,5s bis die Orientierung korrigiert ist. Bei einer zu hohen Konvergenzgeschwindigkeit wird nach Erreichen der korrekten Orientierung, diese um die Fluktuationen des Beschleunigungsmessers und des Magnetometers schwanken.
Wenn die Konvergenzgeschwindigkeit auf 0 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Gyroskopdaten. Dies ergibt sehr gleichmäßige Bewegungen aber Fehler des Gyroskops werden nicht korrigiert. Wenn die Konvergenzgeschwindigkeit über 500 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Beschleunigungsmesser- und Magnetometerdaten. In diesem Fall sind die Bewegungen abrupt und die Werte werden schwanken. Es treten aber keine akkumulativen Fehler auf.
In Anwendungen mit hohen Winkelgeschwindigkeiten wird eine hohe Konvergenzgeschwindigkeit empfohlen, so dass Fehler des Gyroskops schnell korrigiert werden können. In Anwendungen mit langsamen Bewegungen wird entsprechend eine geringe Konvergenzgeschwindigkeit empfohlen. Es ist möglich die Konvergenzgeschwindigkeit spontan zu ändern. Dadurch ist es möglich (und empfohlen) direkt vor einer abrupten Bewegung die Konvergenzgeschwindigkeit zu erhöhen und im Anschluss wieder zu verringern.
Um ein Gefühl für einen guten Wert, für die Konvergenzgeschwindigkeit, in deiner Anwendung zu bekommen ist es ratsam im Brick Viewer verschiedenste Werte auszuprobieren.
ImuBrick::
get_convergence_speed
(&self) → ConvertingReceiver<u16>¶Rückgabe: |
|
---|
Gibt die Konvergenzgeschwindigkeit zurück, wie von ImuBrick::set_convergence_speed
gesetzt.
ImuBrick::
get_acceleration
(&self) → ConvertingReceiver<Acceleration>¶Rückgabeobjekt: |
|
---|
Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X, Y und Z-Achse zurück.
Wenn die kalibrierten Beschleunigungen periodisch abgefragt werden soll, wird
empfohlen den ImuBrick::get_acceleration_callback_receiver
Callback zu nutzen und die Periode mit
ImuBrick::set_acceleration_period
vorzugeben.
ImuBrick::
get_magnetic_field
(&self) → ConvertingReceiver<MagneticField>¶Rückgabeobjekt: |
|
---|
Gibt das kalibrierte Magnetfeld des Magnetometers mit den X-, Y- und Z-Komponenten zurück.
Wenn das Magnetfeld periodisch abgefragt werden soll, wird empfohlen
den ImuBrick::get_magnetic_field_callback_receiver
Callback zu nutzen und die Periode mit
ImuBrick::set_magnetic_field_period
vorzugeben.
ImuBrick::
get_angular_velocity
(&self) → ConvertingReceiver<AngularVelocity>¶Rückgabeobjekt: |
|
---|
Gibt die kalibrierten Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse in °/14,375s zurück. (Um den Wert in °/s zu erhalten ist es notwendig durch 14,375 zu teilen)
Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird
empfohlen den ImuBrick::get_angular_velocity_callback_receiver
Callback zu nutzen und die Periode mit
ImuBrick::set_angular_velocity_period
vorzugeben.
ImuBrick::
get_all_data
(&self) → ConvertingReceiver<AllData>¶Rückgabeobjekt: |
|
---|
Gibt die Daten von ImuBrick::get_acceleration
, ImuBrick::get_magnetic_field
und ImuBrick::get_angular_velocity
sowie die Temperatur des IMU Brick zurück.
Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den
ImuBrick::get_all_data_callback_receiver
Callback zu nutzen und die Periode mit
ImuBrick::set_all_data_period
vorzugeben.
ImuBrick::
get_imu_temperature
(&self) → ConvertingReceiver<i16>¶Rückgabe: |
|
---|
Gibt die Temperatur des IMU Brick zurück.
ImuBrick::
set_acceleration_range
(&self, range: u8) → ConvertingReceiver<()>¶Parameter: |
|
---|
Bisher nicht implementiert.
ImuBrick::
get_acceleration_range
(&self) → ConvertingReceiver<u8>¶Rückgabe: |
|
---|
Bisher nicht implementiert.
ImuBrick::
set_magnetometer_range
(&self, range: u8) → ConvertingReceiver<()>¶Parameter: |
|
---|
Bisher nicht implementiert.
ImuBrick::
get_magnetometer_range
(&self) → ConvertingReceiver<u8>¶Rückgabe: |
|
---|
Bisher nicht implementiert.
ImuBrick::
set_calibration
(&self, typ: u8, data: [i16; 10]) → ConvertingReceiver<()>¶Parameter: |
|
---|
Es sind folgende verschiedene Kalibrierungen möglich:
Typ | Beschreibung | Werte |
---|---|---|
0 | Beschleunigungsmesser Verstärkung | [mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0] |
1 | Beschleunigungsmesser Versatz | [bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0] |
2 | Magnetometer Verstärkung | [mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0] |
3 | Magnetometer Versatz | [bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0] |
4 | Gyroskop Verstärkung | [mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0] |
5 | Gyroskop Versatz | [bias xl, bias yl, bias zl, temp l, bias xh, bias yh, bias zh, temp h, 0, 0] |
Die Kalibrierung mittels Verstärkung und Versatz wird über folgende Formel realisiert:
new_value = (bias + orig_value) * gain_mul / gain_div
Für die Implementierung einer eigenen Kalibriersoftware sollte beachtet werden, dass zuerst die bisherige Kalibrierung rückgängig gemacht werden muss (Versatz auf 0 und Verstärkung auf 1/1 setzen) und das über mehrere tausend Werte gemittelt werden sollte um ein benutzbares Ergebnis zu erhalten.
Der Versatz des Gyroskops ist sehr temperaturabhängig und daher muss die
Kalibrierung des Versatzes mit zwei unterschiedlichen Temperaturen erfolgen.
Die Werte xl
, yl
, zl
und temp l
sind der Versatz für x
,
y
, z
und die zugehörige geringe Temperatur. Die Werte xh
, yh
,
zh
und temp h
sind entsprechend für eine höhere Temperatur. Die
Temperaturdifferenz sollte mindestens 5°C betragen. Die übliche
Betriebstemperatur des IMU Brick sollte einer der Kalibrierpunkte sein.
Bemerkung
Wir empfehlen dringend den Brick Viewer zur Kalibrierung des IMU Brick zu verwenden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für typ:
ImuBrick::
get_calibration
(&self, typ: u8) → ConvertingReceiver<[i16; 10]>¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Kalibrierung für den ausgewählten Typ zurück, wie von
ImuBrick::set_calibration
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für typ:
ImuBrick::
orientation_calculation_on
(&self) → ConvertingReceiver<()>¶Aktiviert die Orientierungsberechnungen des IMU Brick.
Standardmäßig sind die Berechnungen an.
Neu in Version 2.0.2 (Firmware).
ImuBrick::
orientation_calculation_off
(&self) → ConvertingReceiver<()>¶Deaktiviert die Orientierungsberechnungen des IMU Brick.
Wenn die Berechnungen deaktiviert sind, gibt ImuBrick::get_orientation
solange
den letzten berechneten Wer zurück bis die Berechnungen wieder
aktiviert werden.
Die trigonometrischen Funktionen die zur Berechnung der Orientierung benötigt werden sind sehr teuer. Wir empfehlen die Orientierungsberechnungen zu deaktivieren wenn sie nicht benötigt werden. Dadurch wird mehr Rechenzeit für den Sensorfusions-Algorithmus freigegeben.
Standardmäßig sind die Berechnungen an.
Neu in Version 2.0.2 (Firmware).
ImuBrick::
is_orientation_calculation_on
(&self) → ConvertingReceiver<bool>¶Rückgabe: |
|
---|
Gibt zurück ob die Orientierungsberechnungen des IMU Brick aktiv sind.
Neu in Version 2.0.2 (Firmware).
ImuBrick::
set_spitfp_baudrate_config
(&self, enable_dynamic_baudrate: bool, minimum_dynamic_baudrate: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.
Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.
Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.
In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.
Die maximale Baudrate kann pro Port mit der Funktion ImuBrick::set_spitfp_baudrate
.
gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate
wie von ImuBrick::set_spitfp_baudrate
gesetzt statisch verwendet.
Neu in Version 2.3.5 (Firmware).
ImuBrick::
get_spitfp_baudrate_config
(&self) → ConvertingReceiver<SpitfpBaudrateConfig>¶Rückgabeobjekt: |
|
---|
Gibt die Baudratenkonfiguration zurück, siehe ImuBrick::set_spitfp_baudrate_config
.
Neu in Version 2.3.5 (Firmware).
ImuBrick::
get_send_timeout_count
(&self, communication_method: u8) → ConvertingReceiver<u32>¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück
Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.
Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für communication_method:
Neu in Version 2.3.3 (Firmware).
ImuBrick::
set_spitfp_baudrate
(&self, bricklet_port: char, baudrate: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Baudrate eines spezifischen Bricklet Ports .
Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden.
Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist
(siehe ImuBrick::get_spitfp_error_count
) kann die Baudrate verringert werden.
Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion
die maximale Baudrate (siehe ImuBrick::set_spitfp_baudrate_config
).
EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.
Neu in Version 2.3.3 (Firmware).
ImuBrick::
get_spitfp_baudrate
(&self, bricklet_port: char) → ConvertingReceiver<u32>¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Baudrate für einen Bricklet Port zurück, siehe
ImuBrick::set_spitfp_baudrate
.
Neu in Version 2.3.3 (Firmware).
ImuBrick::
get_spitfp_error_count
(&self, bricklet_port: char) → ConvertingReceiver<SpitfpErrorCount>¶Parameter: |
|
---|---|
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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.
Neu in Version 2.3.3 (Firmware).
ImuBrick::
enable_status_led
(&self) → ConvertingReceiver<()>¶Aktiviert die Status LED.
Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.
Der Standardzustand ist aktiviert.
Neu in Version 2.3.1 (Firmware).
ImuBrick::
disable_status_led
(&self) → ConvertingReceiver<()>¶Deaktiviert die Status LED.
Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.
Der Standardzustand ist aktiviert.
Neu in Version 2.3.1 (Firmware).
ImuBrick::
is_status_led_enabled
(&self) → ConvertingReceiver<bool>¶Rückgabe: |
|
---|
Gibt true zurück wenn die Status LED aktiviert ist, false sonst.
Neu in Version 2.3.1 (Firmware).
ImuBrick::
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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
ImuBrick::
reset
(&self) → ConvertingReceiver<()>¶Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.
Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.
ImuBrick::
get_identity
(&self) → ConvertingReceiver<Identity>¶Rückgabeobjekt: |
|
---|
Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.
ImuBrick::
set_acceleration_period
(&self, period: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Periode mit welcher der ImuBrick::get_acceleration_callback_receiver
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
ImuBrick::
get_acceleration_period
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von ImuBrick::set_acceleration_period
gesetzt.
ImuBrick::
set_magnetic_field_period
(&self, period: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Periode mit welcher der ImuBrick::get_magnetic_field_callback_receiver
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
ImuBrick::
get_magnetic_field_period
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von ImuBrick::set_magnetic_field_period
gesetzt.
ImuBrick::
set_angular_velocity_period
(&self, period: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Periode mit welcher der ImuBrick::get_angular_velocity_callback_receiver
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
ImuBrick::
get_angular_velocity_period
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von ImuBrick::set_angular_velocity_period
gesetzt.
ImuBrick::
set_all_data_period
(&self, period: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Periode mit welcher der ImuBrick::get_all_data_callback_receiver
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
ImuBrick::
get_all_data_period
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von ImuBrick::set_all_data_period
gesetzt.
ImuBrick::
set_orientation_period
(&self, period: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Periode mit welcher der ImuBrick::get_orientation_callback_receiver
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
ImuBrick::
get_orientation_period
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von ImuBrick::set_orientation_period
gesetzt.
ImuBrick::
set_quaternion_period
(&self, period: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die Periode mit welcher der ImuBrick::get_quaternion_callback_receiver
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
ImuBrick::
get_quaternion_period
(&self) → ConvertingReceiver<u32>¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von ImuBrick::set_quaternion_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.
ImuBrick::
get_acceleration_callback_receiver
(&self) → ConvertingCallbackReceiver<AccelerationEvent>¶Event-Objekt: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Acceleration-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit
ImuBrick::set_acceleration_period
, ausgelöst. Die Felder der empfangenen Struktur sind die
Beschleunigungen der X, Y und Z-Achse.
ImuBrick::
get_magnetic_field_callback_receiver
(&self) → ConvertingCallbackReceiver<MagneticFieldEvent>¶Event-Objekt: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Magnetic Field-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit
ImuBrick::set_magnetic_field_period
, ausgelöst. Die Felder der empfangenen Struktur sind die
Magnetfeldkomponenten der X, Y und Z-Achse.
ImuBrick::
get_angular_velocity_callback_receiver
(&self) → ConvertingCallbackReceiver<AngularVelocityEvent>¶Event-Objekt: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Angular Velocity-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit
ImuBrick::set_angular_velocity_period
, ausgelöst. Die Felder der empfangenen Struktur sind die
Winkelgeschwindigkeiten der X, Y und Z-Achse.
ImuBrick::
get_all_data_callback_receiver
(&self) → ConvertingCallbackReceiver<AllDataEvent>¶Event-Objekt: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen All Data-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit ImuBrick::set_all_data_period
,
ausgelöst. Die Felder der empfangenen Struktur sind die Beschleunigungen, Magnetfeldkomponenten
und die Winkelgeschwindigkeiten der X, Y und Z-Achse sowie die Temperatur
des IMU Brick.
ImuBrick::
get_orientation_callback_receiver
(&self) → ConvertingCallbackReceiver<OrientationEvent>¶Event-Objekt: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Orientation-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit ImuBrick::set_orientation_period
,
ausgelöst. Die Felder der empfangenen Struktur sind die Orientierung (Roll-, Nick-, Gierwinkel) des
IMU Brick in Eulerwinkeln. Siehe ImuBrick::get_orientation
für Details.
ImuBrick::
get_quaternion_callback_receiver
(&self) → ConvertingCallbackReceiver<QuaternionEvent>¶Event-Objekt: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Quaternion-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit ImuBrick::set_quaternion_period
,
ausgelöst. Die Felder der empfangenen Struktur sind die Orientierung (x, y, z, w) des
IMU Brick in Quaternionen. Siehe ImuBrick::get_quaternion
für Details.
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.
ImuBrick::
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.
ImuBrick::
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 ImuBrick::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:
ImuBrick::
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:
ImuBrick::
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.
ImuBrick::
get_protocol1_bricklet_name
(&self, port: char) → ConvertingReceiver<Protocol1BrickletName>¶Parameter: |
|
---|---|
Rückgabeobjekt: |
|
Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.
Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.
ImuBrick::
write_bricklet_plugin
(&self, port: char, offset: u8, chunk: [u8; 32]) → ConvertingReceiver<()>¶Parameter: |
|
---|
Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
ImuBrick::
read_bricklet_plugin
(&self, port: char, offset: u8) → ConvertingReceiver<[u8; 32]>¶Parameter: |
|
---|---|
Rückgabe: |
|
Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
ImuBrick::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um einen IMU Brick zu identifizieren.
Die ImuBrick::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.
ImuBrick::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines IMU Brick dar.