Dies ist die Beschreibung der Rust API Bindings für das IMU Bricklet 3.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Bricklet 3.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 26 27 28 29 | use std::{error::Error, io};
use tinkerforge::{imu_v3_bricklet::*, ip_connection::IpConnection};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your IMU Bricklet 3.0.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let imu = ImuV3Bricklet::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 [W]: {}", quaternion.w as f32 / 16383.0);
println!("Quaternion [X]: {}", quaternion.x as f32 / 16383.0);
println!("Quaternion [Y]: {}", quaternion.y as f32 / 16383.0);
println!("Quaternion [Z]: {}", quaternion.z as f32 / 16383.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 37 38 | use std::{error::Error, io, thread};
use tinkerforge::{imu_v3_bricklet::*, ip_connection::IpConnection};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your IMU Bricklet 3.0.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let imu = ImuV3Bricklet::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 [W]: {}", quaternion.w as f32 / 16383.0);
println!("Quaternion [X]: {}", quaternion.x as f32 / 16383.0);
println!("Quaternion [Y]: {}", quaternion.y as f32 / 16383.0);
println!("Quaternion [Z]: {}", quaternion.z as f32 / 16383.0);
println!();
}
});
// Set period for quaternion callback to 0.1s (100ms).
imu.set_quaternion_callback_configuration(100, false);
println!("Press enter to exit.");
let mut _input = String::new();
io::stdin().read_line(&mut _input)?;
ipcon.disconnect();
Ok(())
}
|
Download (example_all_data.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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | use std::{error::Error, io, thread};
use tinkerforge::{imu_v3_bricklet::*, ip_connection::IpConnection};
const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your IMU Bricklet 3.0.
fn main() -> Result<(), Box<dyn Error>> {
let ipcon = IpConnection::new(); // Create IP connection.
let imu = ImuV3Bricklet::new(UID, &ipcon); // Create device object.
ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
// Don't use device before ipcon is connected.
let all_data_receiver = imu.get_all_data_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 all_data in all_data_receiver {
println!("Acceleration [X]: {} m/s²", all_data.acceleration[0] as f32 / 100.0);
println!("Acceleration [Y]: {} m/s²", all_data.acceleration[1] as f32 / 100.0);
println!("Acceleration [Z]: {} m/s²", all_data.acceleration[2] as f32 / 100.0);
println!("Magnetic Field [X]: {} µT", all_data.magnetic_field[0] as f32 / 16.0);
println!("Magnetic Field [Y]: {} µT", all_data.magnetic_field[1] as f32 / 16.0);
println!("Magnetic Field [Z]: {} µT", all_data.magnetic_field[2] as f32 / 16.0);
println!("Angular Velocity [X]: {} °/s", all_data.angular_velocity[0] as f32 / 16.0);
println!("Angular Velocity [Y]: {} °/s", all_data.angular_velocity[1] as f32 / 16.0);
println!("Angular Velocity [Z]: {} °/s", all_data.angular_velocity[2] as f32 / 16.0);
println!("Euler Angle [Heading]: {} °", all_data.euler_angle[0] as f32 / 16.0);
println!("Euler Angle [Roll]: {} °", all_data.euler_angle[1] as f32 / 16.0);
println!("Euler Angle [Pitch]: {} °", all_data.euler_angle[2] as f32 / 16.0);
println!("Quaternion [W]: {}", all_data.quaternion[0] as f32 / 16383.0);
println!("Quaternion [X]: {}", all_data.quaternion[1] as f32 / 16383.0);
println!("Quaternion [Y]: {}", all_data.quaternion[2] as f32 / 16383.0);
println!("Quaternion [Z]: {}", all_data.quaternion[3] as f32 / 16383.0);
println!("Linear Acceleration [X]: {} m/s²", all_data.linear_acceleration[0] as f32 / 100.0);
println!("Linear Acceleration [Y]: {} m/s²", all_data.linear_acceleration[1] as f32 / 100.0);
println!("Linear Acceleration [Z]: {} m/s²", all_data.linear_acceleration[2] as f32 / 100.0);
println!("Gravity Vector [X]: {} m/s²", all_data.gravity_vector[0] as f32 / 100.0);
println!("Gravity Vector [Y]: {} m/s²", all_data.gravity_vector[1] as f32 / 100.0);
println!("Gravity Vector [Z]: {} m/s²", all_data.gravity_vector[2] as f32 / 100.0);
println!("Temperature: {} °C", all_data.temperature);
println!("Calibration Status: {:b}", all_data.calibration_status);
println!();
}
});
// Set period for all data callback to 0.1s (100ms).
imu.set_all_data_callback_configuration(100, false);
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.
ImuV3Bricklet::
new
(uid: &str, ip_connection: &IpConnection) → ImuV3Bricklet¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues ImuV3Bricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IP-Connection ip_connection
hinzu:
let imu_v3 = ImuV3Bricklet::new("YOUR_DEVICE_UID", &ip_connection);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.
ImuV3Bricklet::
get_orientation
(&self) → ConvertingReceiver<Orientation>¶Rückgabeobjekt: |
|
---|
Gibt die aktuelle Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in unabhängigen Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren. Wir empfehlen daher stattdessen Quaternionen zu verwenden, wenn die absolute Lage im Raum bestimmt werden soll.
Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den
ImuV3Bricklet::get_orientation_callback_receiver
Callback zu nutzen und die Periode mit
ImuV3Bricklet::set_orientation_callback_configuration
vorzugeben.
ImuV3Bricklet::
get_linear_acceleration
(&self) → ConvertingReceiver<LinearAcceleration>¶Rückgabeobjekt: |
|
---|
Gibt die lineare Beschleunigungen des IMU Brick für die
X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit
ImuV3Bricklet::set_sensor_configuration
konfiguriert wurde.
Die lineare Beschleunigung ist die Beschleunigung in jede der drei Achsen. Der Einfluss von Erdbeschleunigung ist entfernt.
Es ist auch möglich einen Vektor der Erdbeschleunigung zu bekommen, siehe
ImuV3Bricklet::get_gravity_vector
Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen
den ImuV3Bricklet::get_linear_acceleration_callback_receiver
Callback zu nutzen und die Periode mit
ImuV3Bricklet::set_linear_acceleration_callback_configuration
vorzugeben.
ImuV3Bricklet::
get_gravity_vector
(&self) → ConvertingReceiver<GravityVector>¶Rückgabeobjekt: |
|
---|
Gibt den Vektor der Erdbeschleunigung des IMU Brick für die X-, Y- und Z-Achse zurück.
Die Erdbeschleunigung ist die Beschleunigung die auf Grund von Schwerkraft entsteht. Einflüsse von linearen Beschleunigungen sind entfernt.
Es ist auch möglich die lineare Beschleunigung zu bekommen, siehe
ImuV3Bricklet::get_linear_acceleration
Wenn die Erdbeschleunigungen periodisch abgefragt werden soll, wird empfohlen
den ImuV3Bricklet::get_gravity_vector_callback_receiver
Callback zu nutzen und die Periode mit
ImuV3Bricklet::set_gravity_vector_callback_configuration
vorzugeben.
ImuV3Bricklet::
get_quaternion
(&self) → ConvertingReceiver<Quaternion>¶Rückgabeobjekt: |
|
---|
Gibt die aktuelle Orientierung (w, x, y, z) des IMU Brick als Quaterinonen zurück.
Die Rückgabewerte müssen mit 16383 (14 Bit) dividiert werden, um in den üblichen Wertebereich für Quaternionen (-1,0 bis +1,0) gebracht zu werden.
Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den
ImuV3Bricklet::get_quaternion_callback_receiver
Callback zu nutzen und die Periode mit
ImuV3Bricklet::set_quaternion_callback_configuration
vorzugeben.
ImuV3Bricklet::
get_all_data
(&self) → ConvertingReceiver<AllData>¶Rückgabeobjekt: |
|
---|
Gibt alle Daten zurück die dem IMU Brick zur Verfügung stehen.
ImuV3Bricklet::get_acceleration
)ImuV3Bricklet::get_magnetic_field
)ImuV3Bricklet::get_angular_velocity
)ImuV3Bricklet::get_orientation
)ImuV3Bricklet::get_quaternion
)ImuV3Bricklet::get_linear_acceleration
)ImuV3Bricklet::get_gravity_vector
)ImuV3Bricklet::get_temperature
)Der Kalibrierungsstatus besteht aus vier Paaren von je zwei Bits. Jedes Paar von Bits repräsentiert den Status der aktuellen Kalibrierung.
Ein Wert von 0 bedeutet "nicht kalibriert" und ein Wert von 3 bedeutet "vollständig kalibriert". Normalerweise kann der Kalibrierungsstatus vollständig ignoriert werden. Er wird vom Brick Viewer im Kalibrierungsfenster benutzt und nur für die initiale Kalibrierung benötigt. Mehr Information zur Kalibrierung des IMU Bricks gibt es im Kalibrierungsfenster.
Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den
ImuV3Bricklet::get_all_data_callback_receiver
Callback zu nutzen und die Periode mit
ImuV3Bricklet::set_all_data_callback_configuration
vorzugeben.
ImuV3Bricklet::
get_acceleration
(&self) → ConvertingReceiver<Acceleration>¶Rückgabeobjekt: |
|
---|
Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die
X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit
ImuV3Bricklet::set_sensor_configuration
konfiguriert wurde.
Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen
den ImuV3Bricklet::get_acceleration_callback_receiver
Callback zu nutzen und die Periode mit
ImuV3Bricklet::set_acceleration_callback_configuration
vorzugeben.
ImuV3Bricklet::
get_magnetic_field
(&self) → ConvertingReceiver<MagneticField>¶Rückgabeobjekt: |
|
---|
Gibt das kalibrierte Magnetfeld des Magnetometers für die X-, Y- und Z-Komponenten zurück.
Wenn das Magnetfeld periodisch abgefragt werden soll, wird empfohlen
den ImuV3Bricklet::get_magnetic_field_callback_receiver
Callback zu nutzen und die Periode mit
ImuV3Bricklet::set_magnetic_field_callback_configuration
vorzugeben.
ImuV3Bricklet::
get_angular_velocity
(&self) → ConvertingReceiver<AngularVelocity>¶Rückgabeobjekt: |
|
---|
Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und
Z-Achse zurück. Die Winkelgeschwindigkeiten liegen im Wertebereich, der mit
ImuV3Bricklet::set_sensor_configuration
konfiguriert wurde.
Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird
empfohlen den ImuV3Bricklet::get_angular_velocity_callback_receiver
Callback zu nutzen und die Periode mit
ImuV3Bricklet::set_angular_velocity_callback_configuration
vorzugeben.
ImuV3Bricklet::
get_temperature
(&self) → ConvertingReceiver<i8>¶Rückgabe: |
|
---|
Gibt die Temperatur des IMU Brick zurück. Die Temperatur wird im Kern des BNO055 ICs gemessen, es handelt sich nicht um die Umgebungstemperatur.
ImuV3Bricklet::
save_calibration
(&self) → ConvertingReceiver<bool>¶Rückgabe: |
|
---|
Ein Aufruf dieser Funktion speichert die aktuelle Kalibrierung damit sie beim nächsten Neustart des IMU Brick als Startpunkt für die kontinuierliche Kalibrierung genutzt werden kann.
Ein Rückgabewert von true bedeutet das die Kalibrierung genutzt werden konnte und false bedeutet das die Kalibrierung nicht genutzt werden konnte (dies passiert wenn der Kalibrierungsstatus nicht "fully calibrated" ist).
Diese Funktion wird vom Kalibrierungsfenster des Brick Viewer benutzt. Sie sollte in einem normalen Benutzerprogramm nicht aufgerufen werden müssen.
ImuV3Bricklet::
set_sensor_configuration
(&self, magnetometer_rate: u8, gyroscope_range: u8, gyroscope_bandwidth: u8, accelerometer_range: u8, accelerometer_bandwidth: u8) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt die verfügbaren Sensor-Konfigurationen für Magnetometer, Gyroskop und Beschleunigungssensor. Der Beschleunigungssensor-Wertebereich ist in allen Fusion-Modi wählbar, während alle anderen Konfigurationen im Fusion-Modus automatisch kontrolliert werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für magnetometer_rate:
Für gyroscope_range:
Für gyroscope_bandwidth:
Für accelerometer_range:
Für accelerometer_bandwidth:
ImuV3Bricklet::
get_sensor_configuration
(&self) → ConvertingReceiver<SensorConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Sensor-Konfiguration zurück, wie von ImuV3Bricklet::set_sensor_configuration
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für magnetometer_rate:
Für gyroscope_range:
Für gyroscope_bandwidth:
Für accelerometer_range:
Für accelerometer_bandwidth:
ImuV3Bricklet::
set_sensor_fusion_mode
(&self, mode: u8) → ConvertingReceiver<()>¶Parameter: |
|
---|
Wenn der Fusion-Modus deaktiviert wird, geben die Funktionen
ImuV3Bricklet::get_acceleration
, ImuV3Bricklet::get_magnetic_field
und
ImuV3Bricklet::get_angular_velocity
unkalibrierte und umkompensierte Sensorwerte
zurück. Alle anderen Sensordaten-Getter geben keine Daten zurück.
Seit Firmware Version 2.0.6 kann auch ein Fusion-Modus ohne Magnetometer ausgewählt werden. In diesem Modus wird die Orientierung relativ berechnet (mit Magnetometer ist sie absolut in Bezug auf die Erde). Allerdings kann die Berechnung in diesem Fall nicht von störenden Magnetfeldern beeinflusst werden.
Seit Firmware Version 2.0.13 kann auch ein Fusion-Modus ohne schnelle Magnetometer-Kalibrierung ausgewählt werden. Dieser Modus ist der gleiche wie der "normale" Fusion-Modus, aber die schnelle Magnetometer-Kalibrierung ist aus. D.h. die Orientierung zu finden mag beim ersten start länger dauern, allerdings mag es sein das kleine magnetische einflüsse die automatische Kalibrierung nicht so stark stören.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
ImuV3Bricklet::
get_sensor_fusion_mode
(&self) → ConvertingReceiver<u8>¶Rückgabe: |
|
---|
Gibt den aktuellen Sensor-Fusion-Modus zurück, wie von
ImuV3Bricklet::set_sensor_fusion_mode
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
ImuV3Bricklet::
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.
ImuV3Bricklet::
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:
ImuV3Bricklet::
get_status_led_config
(&self) → ConvertingReceiver<u8>¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von ImuV3Bricklet::set_status_led_config
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
ImuV3Bricklet::
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.
ImuV3Bricklet::
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.
ImuV3Bricklet::
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.
ImuV3Bricklet::
set_acceleration_callback_configuration
(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ImuV3Bricklet::get_acceleration_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.
ImuV3Bricklet::
get_acceleration_callback_configuration
(&self) → ConvertingReceiver<AccelerationCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels ImuV3Bricklet::set_acceleration_callback_configuration
gesetzt.
ImuV3Bricklet::
set_magnetic_field_callback_configuration
(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ImuV3Bricklet::get_magnetic_field_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.
ImuV3Bricklet::
get_magnetic_field_callback_configuration
(&self) → ConvertingReceiver<MagneticFieldCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels ImuV3Bricklet::set_magnetic_field_callback_configuration
gesetzt.
ImuV3Bricklet::
set_angular_velocity_callback_configuration
(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ImuV3Bricklet::get_angular_velocity_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.
ImuV3Bricklet::
get_angular_velocity_callback_configuration
(&self) → ConvertingReceiver<AngularVelocityCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels ImuV3Bricklet::set_angular_velocity_callback_configuration
gesetzt.
ImuV3Bricklet::
set_temperature_callback_configuration
(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ImuV3Bricklet::get_temperature_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.
ImuV3Bricklet::
get_temperature_callback_configuration
(&self) → ConvertingReceiver<TemperatureCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels ImuV3Bricklet::set_temperature_callback_configuration
gesetzt.
ImuV3Bricklet::
set_orientation_callback_configuration
(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ImuV3Bricklet::get_orientation_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.
ImuV3Bricklet::
get_orientation_callback_configuration
(&self) → ConvertingReceiver<OrientationCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels ImuV3Bricklet::set_orientation_callback_configuration
gesetzt.
ImuV3Bricklet::
set_linear_acceleration_callback_configuration
(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ImuV3Bricklet::get_linear_acceleration_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.
ImuV3Bricklet::
get_linear_acceleration_callback_configuration
(&self) → ConvertingReceiver<LinearAccelerationCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels ImuV3Bricklet::set_linear_acceleration_callback_configuration
gesetzt.
ImuV3Bricklet::
set_gravity_vector_callback_configuration
(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ImuV3Bricklet::get_gravity_vector_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.
ImuV3Bricklet::
get_gravity_vector_callback_configuration
(&self) → ConvertingReceiver<GravityVectorCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels ImuV3Bricklet::set_gravity_vector_callback_configuration
gesetzt.
ImuV3Bricklet::
set_quaternion_callback_configuration
(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ImuV3Bricklet::get_quaternion_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.
ImuV3Bricklet::
get_quaternion_callback_configuration
(&self) → ConvertingReceiver<QuaternionCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels ImuV3Bricklet::set_quaternion_callback_configuration
gesetzt.
ImuV3Bricklet::
set_all_data_callback_configuration
(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ImuV3Bricklet::get_all_data_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.
ImuV3Bricklet::
get_all_data_callback_configuration
(&self) → ConvertingReceiver<AllDataCallbackConfiguration>¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels ImuV3Bricklet::set_all_data_callback_configuration
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.
ImuV3Bricklet::
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
ImuV3Bricklet::set_acceleration_callback_configuration
, ausgelöst. Die Felder der empfangenen Struktur sind die
Beschleunigungen der X, Y und Z-Achse.
ImuV3Bricklet::
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
ImuV3Bricklet::set_magnetic_field_callback_configuration
, ausgelöst. Die Felder der empfangenen Struktur sind die
Magnetfeldkomponenten der X, Y und Z-Achse.
ImuV3Bricklet::
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
ImuV3Bricklet::set_angular_velocity_callback_configuration
, ausgelöst. Die Felder der empfangenen Struktur sind die
Winkelgeschwindigkeiten der X, Y und Z-Achse.
ImuV3Bricklet::
get_temperature_callback_receiver
(&self) → ConvertingCallbackReceiver<i8>¶Event: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Temperature-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit
ImuV3Bricklet::set_temperature_callback_configuration
, ausgelöst. Der empfangene Variable ist die
Temperatur.
ImuV3Bricklet::
get_linear_acceleration_callback_receiver
(&self) → ConvertingCallbackReceiver<LinearAccelerationEvent>¶Event-Objekt: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Linear Acceleration-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit
ImuV3Bricklet::set_linear_acceleration_callback_configuration
, ausgelöst. Die empfangene Variable sind
die linearen Beschleunigungen der X, Y und Z-Achse.
ImuV3Bricklet::
get_gravity_vector_callback_receiver
(&self) → ConvertingCallbackReceiver<GravityVectorEvent>¶Event-Objekt: |
|
---|
Receiver die mit dieser Funktion erstellt werden, empfangen Gravity Vector-Events.
Dieser Callback wird mit der Periode, wie gesetzt mit
ImuV3Bricklet::set_gravity_vector_callback_configuration
, ausgelöst. Die empfangene Variable sind die
Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.
ImuV3Bricklet::
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
ImuV3Bricklet::set_orientation_callback_configuration
, ausgelöst. Die Felder der empfangenen Struktur sind die
Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe
ImuV3Bricklet::get_orientation
für Details.
ImuV3Bricklet::
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
ImuV3Bricklet::set_quaternion_callback_configuration
, ausgelöst. Die Felder der empfangenen Struktur sind die
Orientierung (w, x, y, z) des IMU Brick in Quaternionen. Siehe
ImuV3Bricklet::get_quaternion
für Details.
ImuV3Bricklet::
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
ImuV3Bricklet::set_all_data_callback_configuration
, ausgelöst. Die empfangene Variable sind die
gleichen wie bei ImuV3Bricklet::get_all_data
.
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.
ImuV3Bricklet::
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.
ImuV3Bricklet::
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 ImuV3Bricklet::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:
ImuV3Bricklet::
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:
ImuV3Bricklet::
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.
ImuV3Bricklet::
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:
ImuV3Bricklet::
get_bootloader_mode
(&self) → ConvertingReceiver<u8>¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe ImuV3Bricklet::set_bootloader_mode
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
ImuV3Bricklet::
set_write_firmware_pointer
(&self, pointer: u32) → ConvertingReceiver<()>¶Parameter: |
|
---|
Setzt den Firmware-Pointer für ImuV3Bricklet::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.
ImuV3Bricklet::
write_firmware
(&self, data: [u8; 64]) → ConvertingReceiver<u8>¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
ImuV3Bricklet::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.
ImuV3Bricklet::
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.
ImuV3Bricklet::
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.
ImuV3Bricklet::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein IMU Bricklet 3.0 zu identifizieren.
Die ImuV3Bricklet::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.
ImuV3Bricklet::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines IMU Bricklet 3.0 dar.