Rust - IMU Brick 2.0

Dies ist die Beschreibung der Rust API Bindings für den IMU Brick 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick 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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.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
use std::{error::Error, io};

use tinkerforge::{imu_v2_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 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let imu = ImuV2Brick::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(())
}

Callback

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_v2_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 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let imu = ImuV2Brick::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 receiver to 0.1s (100ms).
    imu.set_quaternion_period(100);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

All Data

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_v2_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 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let imu = ImuV2Brick::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 [X]: {} °", all_data.euler_angle[0] as f32 / 16.0);
            println!("Euler Angle [Y]: {} °", all_data.euler_angle[1] as f32 / 16.0);
            println!("Euler Angle [Z]: {} °", 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 receiver to 0.1s (100ms).
    imu.set_all_data_period(100);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

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.

Grundfunktionen

pub fn ImuV2Brick::new(uid: &str, ip_connection: &IpConnection) → ImuV2Brick

Erzeugt ein neues ImuV2Brick-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ipcon hinzu:

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden wurde (siehe Beispiele oben).

pub fn ImuV2Brick::get_orientation(&self) → ConvertingReceiver<Orientation>

Gibt die aktuelle Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in unabhängigen Eulerwinkeln (in 1/16 °) 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.

Die Rotationswinkel haben den folgenden Wertebereich:

  • Gierwinkel: 0° bis 360°
  • Rollwinkel: -90° bis +90°
  • Nickwinkel: -180° bis +180°

Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den ImuV2Brick::get_orientation_callback_receiver Callback zu nutzen und die Periode mit ImuV2Brick::set_orientation_period vorzugeben.

pub fn ImuV2Brick::get_linear_acceleration(&self) → ConvertingReceiver<LinearAcceleration>

Gibt die lineare Beschleunigungen des IMU Brick für die X-, Y- und Z-Achse in 1/100 m/s² zurück.

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 ImuV2Brick::get_gravity_vector

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den ImuV2Brick::get_linear_acceleration_callback_receiver Callback zu nutzen und die Periode mit ImuV2Brick::set_linear_acceleration_period vorzugeben.

pub fn ImuV2Brick::get_gravity_vector(&self) → ConvertingReceiver<GravityVector>

Gibt den Vektor der Erdbeschleunigung des IMU Brick für die X-, Y- und Z-Achse in 1/100 m/s² 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 ImuV2Brick::get_linear_acceleration

Wenn die Erdbeschleunigungen periodisch abgefragt werden soll, wird empfohlen den ImuV2Brick::get_gravity_vector_callback_receiver Callback zu nutzen und die Periode mit ImuV2Brick::set_gravity_vector_period vorzugeben.

pub fn ImuV2Brick::get_quaternion(&self) → ConvertingReceiver<Quaternion>

Gibt die aktuelle Orientierung (w, x, y, z) des IMU Brick als Quaterinonen zurück.

Die zurückgegebenen Werte 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 ImuV2Brick::get_quaternion_callback_receiver Callback zu nutzen und die Periode mit ImuV2Brick::set_quaternion_period vorzugeben.

pub fn ImuV2Brick::get_all_data(&self) → ConvertingReceiver<AllData>

Gibt alle Daten zurück die dem IMU Brick zur Verfügung stehen.

Der Kalibrierungsstatus besteht aus vier paaren von je zwei Bits. Jedes Paar von Bits repräsentiert den Status der aktuellen Kalibrierung.

  • Bit 0-1: Magnetometer
  • Bit 2-3: Beschleunigungsmesser
  • Bit 4-5: Gyroskop
  • Bit 6-7: System

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 ImuV2Brick::get_all_data_callback_receiver Callback zu nutzen und die Periode mit ImuV2Brick::set_all_data_period vorzugeben.

pub fn ImuV2Brick::leds_on(&self) → ConvertingReceiver<()>

Aktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

pub fn ImuV2Brick::leds_off(&self) → ConvertingReceiver<()>

Deaktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

pub fn ImuV2Brick::are_leds_on(&self) → ConvertingReceiver<bool>

Gibt zurück ob die Orientierungs- und Richtungs-LEDs des IMU Brick aktiv sind.

Fortgeschrittene Funktionen

pub fn ImuV2Brick::get_acceleration(&self) → ConvertingReceiver<Acceleration>

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X-, Y- und Z-Achse in 1/100 m/s².

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den ImuV2Brick::get_acceleration_callback_receiver Callback zu nutzen und die Periode mit ImuV2Brick::set_acceleration_period vorzugeben.

pub fn ImuV2Brick::get_magnetic_field(&self) → ConvertingReceiver<MagneticField>

Gibt das kalibrierte magnetische Feld des Magnetometers mit den X-, Y- und Z-Komponenten in 1/16 µT zurück (Microtesla).

Wenn das magnetische Feld periodisch abgefragt werden soll, wird empfohlen den ImuV2Brick::get_magnetic_field_callback_receiver Callback zu nutzen und die Periode mit ImuV2Brick::set_magnetic_field_period vorzugeben.

pub fn ImuV2Brick::get_angular_velocity(&self) → ConvertingReceiver<AngularVelocity>

Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse in 1/16 °/s zurück.

Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird empfohlen den ImuV2Brick::get_angular_velocity_callback_receiver Callback zu nutzen und die Periode mit ImuV2Brick::set_angular_velocity_period vorzugeben.

pub fn ImuV2Brick::get_temperature(&self) → ConvertingReceiver<i8>

Gibt die Temperatur (in °C) des IMU Brick zurück. Die Temperatur wird im Kern des BNO055 ICs gemessen, es handelt sich nicht um die Umgebungstemperatur.

pub fn ImuV2Brick::save_calibration(&self) → ConvertingReceiver<bool>

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.

pub fn ImuV2Brick::set_sensor_configuration(&self, magnetometer_rate: u8, gyroscope_range: u8, gyroscope_bandwidth: u8, accelerometer_range: u8, accelerometer_bandwidth: u8) → ConvertingReceiver<()>

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 Standardwerte sind:

  • Magnetometer-Rate 20Hz
  • Gyroskop-Wertebereich 2000°/s
  • Gyroskop-Bandweite 32Hz
  • Beschleunigungssensor-Wertebereich +/-4G
  • Beschleunigungssensor-Bandweite 62.5Hz

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • IMU_V2_BRICK_MAGNETOMETER_RATE_2HZ = 0
  • IMU_V2_BRICK_MAGNETOMETER_RATE_6HZ = 1
  • IMU_V2_BRICK_MAGNETOMETER_RATE_8HZ = 2
  • IMU_V2_BRICK_MAGNETOMETER_RATE_10HZ = 3
  • IMU_V2_BRICK_MAGNETOMETER_RATE_15HZ = 4
  • IMU_V2_BRICK_MAGNETOMETER_RATE_20HZ = 5
  • IMU_V2_BRICK_MAGNETOMETER_RATE_25HZ = 6
  • IMU_V2_BRICK_MAGNETOMETER_RATE_30HZ = 7
  • IMU_V2_BRICK_GYROSCOPE_RANGE_2000DPS = 0
  • IMU_V2_BRICK_GYROSCOPE_RANGE_1000DPS = 1
  • IMU_V2_BRICK_GYROSCOPE_RANGE_500DPS = 2
  • IMU_V2_BRICK_GYROSCOPE_RANGE_250DPS = 3
  • IMU_V2_BRICK_GYROSCOPE_RANGE_125DPS = 4
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_523HZ = 0
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_230HZ = 1
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_116HZ = 2
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_47HZ = 3
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_23HZ = 4
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_12HZ = 5
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_64HZ = 6
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_32HZ = 7
  • IMU_V2_BRICK_ACCELEROMETER_RANGE_2G = 0
  • IMU_V2_BRICK_ACCELEROMETER_RANGE_4G = 1
  • IMU_V2_BRICK_ACCELEROMETER_RANGE_8G = 2
  • IMU_V2_BRICK_ACCELEROMETER_RANGE_16G = 3
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_125HZ = 4
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_250HZ = 5
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_500HZ = 6
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_1000HZ = 7

Neu in Version 2.0.5 (Firmware).

pub fn ImuV2Brick::get_sensor_configuration(&self) → ConvertingReceiver<SensorConfiguration>

Gibt die Sensor-Konfiguration zurück, wie von ImuV2Brick::set_sensor_configuration gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • IMU_V2_BRICK_MAGNETOMETER_RATE_2HZ = 0
  • IMU_V2_BRICK_MAGNETOMETER_RATE_6HZ = 1
  • IMU_V2_BRICK_MAGNETOMETER_RATE_8HZ = 2
  • IMU_V2_BRICK_MAGNETOMETER_RATE_10HZ = 3
  • IMU_V2_BRICK_MAGNETOMETER_RATE_15HZ = 4
  • IMU_V2_BRICK_MAGNETOMETER_RATE_20HZ = 5
  • IMU_V2_BRICK_MAGNETOMETER_RATE_25HZ = 6
  • IMU_V2_BRICK_MAGNETOMETER_RATE_30HZ = 7
  • IMU_V2_BRICK_GYROSCOPE_RANGE_2000DPS = 0
  • IMU_V2_BRICK_GYROSCOPE_RANGE_1000DPS = 1
  • IMU_V2_BRICK_GYROSCOPE_RANGE_500DPS = 2
  • IMU_V2_BRICK_GYROSCOPE_RANGE_250DPS = 3
  • IMU_V2_BRICK_GYROSCOPE_RANGE_125DPS = 4
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_523HZ = 0
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_230HZ = 1
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_116HZ = 2
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_47HZ = 3
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_23HZ = 4
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_12HZ = 5
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_64HZ = 6
  • IMU_V2_BRICK_GYROSCOPE_BANDWIDTH_32HZ = 7
  • IMU_V2_BRICK_ACCELEROMETER_RANGE_2G = 0
  • IMU_V2_BRICK_ACCELEROMETER_RANGE_4G = 1
  • IMU_V2_BRICK_ACCELEROMETER_RANGE_8G = 2
  • IMU_V2_BRICK_ACCELEROMETER_RANGE_16G = 3
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_125HZ = 4
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_250HZ = 5
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_500HZ = 6
  • IMU_V2_BRICK_ACCELEROMETER_BANDWIDTH_1000HZ = 7

Neu in Version 2.0.5 (Firmware).

pub fn ImuV2Brick::set_sensor_fusion_mode(&self, mode: u8) → ConvertingReceiver<()>

Wenn der Fusion-Modus deaktiviert wird, geben die Funktionen ImuV2Brick::get_acceleration, ImuV2Brick::get_magnetic_field und ImuV2Brick::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.

Standardmäßig ist der Fusion-Modus aktiviert.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • IMU_V2_BRICK_SENSOR_FUSION_OFF = 0
  • IMU_V2_BRICK_SENSOR_FUSION_ON = 1
  • IMU_V2_BRICK_SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • IMU_V2_BRICK_SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

Neu in Version 2.0.5 (Firmware).

pub fn ImuV2Brick::get_sensor_fusion_mode(&self) → ConvertingReceiver<u8>

Gibt den aktuellen Sensor-Fusion-Modus zurück, wie von ImuV2Brick::set_sensor_fusion_mode gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • IMU_V2_BRICK_SENSOR_FUSION_OFF = 0
  • IMU_V2_BRICK_SENSOR_FUSION_ON = 1
  • IMU_V2_BRICK_SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • IMU_V2_BRICK_SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

Neu in Version 2.0.5 (Firmware).

pub fn ImuV2Brick::get_api_version(&self) → [u8; 3]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

pub fn ImuV2Brick::get_response_expected(&mut self, function_id: u8) → bool

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 ImuV2Brick::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.

Siehe ImuV2Brick::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

pub fn ImuV2Brick::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • IMU_V2_BRICK_FUNCTION_LEDS_ON = 10
  • IMU_V2_BRICK_FUNCTION_LEDS_OFF = 11
  • IMU_V2_BRICK_FUNCTION_SET_ACCELERATION_PERIOD = 14
  • IMU_V2_BRICK_FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 16
  • IMU_V2_BRICK_FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 18
  • IMU_V2_BRICK_FUNCTION_SET_TEMPERATURE_PERIOD = 20
  • IMU_V2_BRICK_FUNCTION_SET_ORIENTATION_PERIOD = 22
  • IMU_V2_BRICK_FUNCTION_SET_LINEAR_ACCELERATION_PERIOD = 24
  • IMU_V2_BRICK_FUNCTION_SET_GRAVITY_VECTOR_PERIOD = 26
  • IMU_V2_BRICK_FUNCTION_SET_QUATERNION_PERIOD = 28
  • IMU_V2_BRICK_FUNCTION_SET_ALL_DATA_PERIOD = 30
  • IMU_V2_BRICK_FUNCTION_SET_SENSOR_CONFIGURATION = 41
  • IMU_V2_BRICK_FUNCTION_SET_SENSOR_FUSION_MODE = 43
  • IMU_V2_BRICK_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • IMU_V2_BRICK_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • IMU_V2_BRICK_FUNCTION_ENABLE_STATUS_LED = 238
  • IMU_V2_BRICK_FUNCTION_DISABLE_STATUS_LED = 239
  • IMU_V2_BRICK_FUNCTION_RESET = 243
pub fn ImuV2Brick::set_response_expected_all(&mut self, response_expected: bool) → ()

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

pub fn ImuV2Brick::set_spitfp_baudrate_config(&self, enable_dynamic_baudrate: bool, minimum_dynamic_baudrate: u32) → ConvertingReceiver<()>

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 ImuV2Brick::set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von ImuV2Brick::set_spitfp_baudrate gesetzt statisch verwendet.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

Neu in Version 2.0.10 (Firmware).

pub fn ImuV2Brick::get_spitfp_baudrate_config(&self) → ConvertingReceiver<SpitfpBaudrateConfig>

Gibt die Baudratenkonfiguration zurück, siehe ImuV2Brick::set_spitfp_baudrate_config.

Neu in Version 2.0.10 (Firmware).

pub fn ImuV2Brick::get_send_timeout_count(&self, communication_method: u8) → ConvertingReceiver<u32>

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:

  • IMU_V2_BRICK_COMMUNICATION_METHOD_NONE = 0
  • IMU_V2_BRICK_COMMUNICATION_METHOD_USB = 1
  • IMU_V2_BRICK_COMMUNICATION_METHOD_SPI_STACK = 2
  • IMU_V2_BRICK_COMMUNICATION_METHOD_CHIBI = 3
  • IMU_V2_BRICK_COMMUNICATION_METHOD_RS485 = 4
  • IMU_V2_BRICK_COMMUNICATION_METHOD_WIFI = 5
  • IMU_V2_BRICK_COMMUNICATION_METHOD_ETHERNET = 6
  • IMU_V2_BRICK_COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.0.7 (Firmware).

pub fn ImuV2Brick::set_spitfp_baudrate(&self, bricklet_port: char, baudrate: u32) → ConvertingReceiver<()>

Setzt die Baudrate eines spezifischen Bricklet Ports ('a' - 'd'). Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

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 ImuV2Brick::get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe ImuV2Brick::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.

Die Standardbaudrate für alle Ports ist 1400000.

Neu in Version 2.0.5 (Firmware).

pub fn ImuV2Brick::get_spitfp_baudrate(&self, bricklet_port: char) → ConvertingReceiver<u32>

Gibt die Baudrate für einen Bricklet Port zurück, siehe ImuV2Brick::set_spitfp_baudrate.

Neu in Version 2.0.5 (Firmware).

pub fn ImuV2Brick::get_spitfp_error_count(&self, bricklet_port: char) → ConvertingReceiver<SpitfpErrorCount>

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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.0.5 (Firmware).

pub fn ImuV2Brick::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.

pub fn ImuV2Brick::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.

pub fn ImuV2Brick::is_status_led_enabled(&self) → ConvertingReceiver<bool>

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

pub fn ImuV2Brick::get_protocol1_bricklet_name(&self, port: char) → ConvertingReceiver<Protocol1BrickletName>

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.

pub fn ImuV2Brick::get_chip_temperature(&self) → ConvertingReceiver<i16>

Gibt die Temperatur in °C/10, 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.

pub fn ImuV2Brick::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.

pub fn ImuV2Brick::get_identity(&self) → ConvertingReceiver<Identity>

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 kann '0'-'8' (Stack Position) sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Konfigurationsfunktionen für Callbacks

pub fn ImuV2Brick::set_acceleration_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der ImuV2Brick::get_acceleration_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der Standardwert ist 0.

pub fn ImuV2Brick::get_acceleration_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ImuV2Brick::set_acceleration_period gesetzt.

pub fn ImuV2Brick::set_magnetic_field_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der ImuV2Brick::get_magnetic_field_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn ImuV2Brick::get_magnetic_field_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ImuV2Brick::set_magnetic_field_period gesetzt.

pub fn ImuV2Brick::set_angular_velocity_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der ImuV2Brick::get_angular_velocity_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn ImuV2Brick::get_angular_velocity_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ImuV2Brick::set_angular_velocity_period gesetzt.

pub fn ImuV2Brick::set_temperature_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der ImuV2Brick::get_temperature_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn ImuV2Brick::get_temperature_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ImuV2Brick::set_temperature_period gesetzt.

pub fn ImuV2Brick::set_orientation_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der ImuV2Brick::get_orientation_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn ImuV2Brick::get_orientation_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ImuV2Brick::set_orientation_period gesetzt.

pub fn ImuV2Brick::set_linear_acceleration_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der ImuV2Brick::get_linear_acceleration_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn ImuV2Brick::get_linear_acceleration_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ImuV2Brick::set_linear_acceleration_period gesetzt.

pub fn ImuV2Brick::set_gravity_vector_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der ImuV2Brick::get_gravity_vector_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn ImuV2Brick::get_gravity_vector_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ImuV2Brick::set_gravity_vector_period gesetzt.

pub fn ImuV2Brick::set_quaternion_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der ImuV2Brick::get_quaternion_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn ImuV2Brick::get_quaternion_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ImuV2Brick::set_quaternion_period gesetzt.

pub fn ImuV2Brick::set_all_data_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der ImuV2Brick::get_all_data_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn ImuV2Brick::get_all_data_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ImuV2Brick::set_all_data_period gesetzt.

Callbacks

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.

pub fn ImuV2Brick::get_acceleration_callback_receiver(&self) → ConvertingCallbackReceiver<AccelerationEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Acceleration-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit ImuV2Brick::set_acceleration_period, ausgelöst. Die Felder der empfangenen Struktur sind die Beschleunigungen der X, Y und Z-Achse.
pub fn ImuV2Brick::get_magnetic_field_callback_receiver(&self) → ConvertingCallbackReceiver<MagneticFieldEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Magnetic Field-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit ImuV2Brick::set_magnetic_field_period, ausgelöst. Die Felder der empfangenen Struktur sind die Magnetfeldkomponenten der X, Y und Z-Achse.
pub fn ImuV2Brick::get_angular_velocity_callback_receiver(&self) → ConvertingCallbackReceiver<AngularVelocityEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Angular Velocity-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit ImuV2Brick::set_angular_velocity_period, ausgelöst. Die Felder der empfangenen Struktur sind die Winkelgeschwindigkeiten der X, Y und Z-Achse.
pub fn ImuV2Brick::get_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<i8>

Receiver die mit dieser Funktion erstellt werden, empfangen Temperature-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit ImuV2Brick::set_temperature_period, ausgelöst. Der empfangene Variable ist die Temperatur.
pub fn ImuV2Brick::get_linear_acceleration_callback_receiver(&self) → ConvertingCallbackReceiver<LinearAccelerationEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Linear Acceleration-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit ImuV2Brick::set_linear_acceleration_period, ausgelöst. Die empfangene Variable sind die linearen Beschleunigungen der X, Y und Z-Achse.
pub fn ImuV2Brick::get_gravity_vector_callback_receiver(&self) → ConvertingCallbackReceiver<GravityVectorEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Gravity Vector-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit ImuV2Brick::set_gravity_vector_period, ausgelöst. Die empfangene Variable sind die Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.
pub fn ImuV2Brick::get_orientation_callback_receiver(&self) → ConvertingCallbackReceiver<OrientationEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Orientation-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit ImuV2Brick::set_orientation_period, ausgelöst. Die Felder der empfangenen Struktur sind die Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe ImuV2Brick::get_orientation für Details.
pub fn ImuV2Brick::get_quaternion_callback_receiver(&self) → ConvertingCallbackReceiver<QuaternionEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Quaternion-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit ImuV2Brick::set_quaternion_period, ausgelöst. Die Felder der empfangenen Struktur sind die Orientierung (x, y, z, w) des IMU Brick in Quaternionen. Siehe ImuV2Brick::get_quaternion für Details.
pub fn ImuV2Brick::get_all_data_callback_receiver(&self) → ConvertingCallbackReceiver<AllDataEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen All Data-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit ImuV2Brick::set_all_data_period, ausgelöst. Die empfangene Variable sind die gleichen wie bei ImuV2Brick::get_all_data.

Konstanten

ImuV2Brick::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen IMU Brick 2.0 zu identifizieren.

Die ImuV2Brick::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.

ImuV2Brick::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines IMU Brick 2.0 dar.