Rust - Accelerometer Bricklet 2.0

Dies ist die Beschreibung der Rust API Bindings für das Accelerometer Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.

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

use tinkerforge::{accelerometer_v2_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Accelerometer Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let a = AccelerometerV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Get current acceleration.
    let acceleration = a.get_acceleration().recv()?;

    println!("Acceleration [X]: {} g", acceleration.x as f32 / 10000.0);
    println!("Acceleration [Y]: {} g", acceleration.y as f32 / 10000.0);
    println!("Acceleration [Z]: {} g", acceleration.z as f32 / 10000.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
use std::{error::Error, io, thread};
use tinkerforge::{accelerometer_v2_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Accelerometer Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let a = AccelerometerV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let acceleration_receiver = a.get_acceleration_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `a` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for acceleration in acceleration_receiver {
            println!("Acceleration [X]: {} g", acceleration.x as f32 / 10000.0);
            println!("Acceleration [Y]: {} g", acceleration.y as f32 / 10000.0);
            println!("Acceleration [Z]: {} g", acceleration.z as f32 / 10000.0);
            println!();
        }
    });

    // Set period for acceleration callback to 1s (1000ms).
    a.set_acceleration_callback_configuration(1000, false);

    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 AccelerometerV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → AccelerometerV2Bricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • accelerometer_v2 – Typ: AccelerometerV2Bricklet

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

let accelerometer_v2 = AccelerometerV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn AccelerometerV2Bricklet::get_acceleration(&self) → ConvertingReceiver<Acceleration>
Rückgabeobjekt:
  • x – Typ: i32, Einheit: 1/10000 gₙ, Wertebereich: ?
  • y – Typ: i32, Einheit: 1/10000 gₙ, Wertebereich: ?
  • z – Typ: i32, Einheit: 1/10000 gₙ, Wertebereich: ?

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit gₙ/10000 (1gₙ = 9,80665m/s²). Der Wertebereich wird mit AccelerometerV2Bricklet::set_configuration konfiguriert.

Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen den AccelerometerV2Bricklet::get_acceleration_callback_receiver Callback zu nutzen und die Periode mit AccelerometerV2Bricklet::set_acceleration_callback_configuration vorzugeben.

pub fn AccelerometerV2Bricklet::set_configuration(&self, data_rate: u8, full_scale: u8) → ConvertingReceiver<()>
Parameter:
  • data_rate – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 7
  • full_scale – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Datenrate und den Wertebereich. Mögliche Konfigurationswerte sind:

  • Datenrate zwischen 0,781Hz und 25600Hz.
  • Wertebereich von ±2g bis zu ±8g.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.

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

Für data_rate:

  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_0_781HZ = 0
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_1_563HZ = 1
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_3_125HZ = 2
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_6_2512HZ = 3
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_12_5HZ = 4
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_25HZ = 5
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_50HZ = 6
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_100HZ = 7
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_200HZ = 8
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_400HZ = 9
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_800HZ = 10
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_1600HZ = 11
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_3200HZ = 12
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_6400HZ = 13
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_12800HZ = 14
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_25600HZ = 15

Für full_scale:

  • ACCELEROMETER_V2_BRICKLET_FULL_SCALE_2G = 0
  • ACCELEROMETER_V2_BRICKLET_FULL_SCALE_4G = 1
  • ACCELEROMETER_V2_BRICKLET_FULL_SCALE_8G = 2
pub fn AccelerometerV2Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>
Rückgabeobjekt:
  • data_rate – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 7
  • full_scale – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von AccelerometerV2Bricklet::set_configuration gesetzt.

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

Für data_rate:

  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_0_781HZ = 0
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_1_563HZ = 1
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_3_125HZ = 2
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_6_2512HZ = 3
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_12_5HZ = 4
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_25HZ = 5
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_50HZ = 6
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_100HZ = 7
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_200HZ = 8
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_400HZ = 9
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_800HZ = 10
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_1600HZ = 11
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_3200HZ = 12
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_6400HZ = 13
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_12800HZ = 14
  • ACCELEROMETER_V2_BRICKLET_DATA_RATE_25600HZ = 15

Für full_scale:

  • ACCELEROMETER_V2_BRICKLET_FULL_SCALE_2G = 0
  • ACCELEROMETER_V2_BRICKLET_FULL_SCALE_4G = 1
  • ACCELEROMETER_V2_BRICKLET_FULL_SCALE_8G = 2
pub fn AccelerometerV2Bricklet::set_info_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameter:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Info-LED (als "Force" auf dem Bricklet gekennzeichnet). Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.

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

Für config:

  • ACCELEROMETER_V2_BRICKLET_INFO_LED_CONFIG_OFF = 0
  • ACCELEROMETER_V2_BRICKLET_INFO_LED_CONFIG_ON = 1
  • ACCELEROMETER_V2_BRICKLET_INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
pub fn AccelerometerV2Bricklet::get_info_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die LED-Konfiguration zurück, wie von AccelerometerV2Bricklet::set_info_led_config gesetzt.

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

Für config:

  • ACCELEROMETER_V2_BRICKLET_INFO_LED_CONFIG_OFF = 0
  • ACCELEROMETER_V2_BRICKLET_INFO_LED_CONFIG_ON = 1
  • ACCELEROMETER_V2_BRICKLET_INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
pub fn AccelerometerV2Bricklet::set_continuous_acceleration_configuration(&self, enable_x: bool, enable_y: bool, enable_z: bool, resolution: u8) → ConvertingReceiver<()>
Parameter:
  • enable_x – Typ: bool, Standardwert: false
  • enable_y – Typ: bool, Standardwert: false
  • enable_z – Typ: bool, Standardwert: false
  • resolution – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen die AccelerometerV2Bricklet::get_continuous_acceleration_16_bit_callback_receiver oder AccelerometerV2Bricklet::get_continuous_acceleration_8_bit_callback_receiver Callbacks genutzt werden.

Die Callbacks können für die Achsen (x, y, z) individuell aktiviert werden. Des weiteren kann eine Auflösung von 8-Bit oder 16-Bit ausgewählt werden.

Wenn mindestens eine Achse aktiviert ist mit 8-Bit Auflösung, wird der AccelerometerV2Bricklet::get_continuous_acceleration_8_bit_callback_receiver-Callback aktiviert. Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung, wird der AccelerometerV2Bricklet::get_continuous_acceleration_16_bit_callback_receiver-Callback aktiviert.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit gₙ/10000 (gleiche Einheit wie von AccelerometerV2Bricklet::get_acceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von der eingestelleten Auflösung (8/16-Bit) und dem eingestellten Wertebereich (siehe AccelerometerV2Bricklet::set_configuration):

  • 16-Bit, Wertebereich 2g: Beschleunigung = Rohwert * 625 / 1024
  • 16-Bit, Wertebereich 4g: Beschleunigung = Rohwert * 1250 / 1024
  • 16-Bit, Wertebereich 8g: Beschleunigung = Rohwert * 2500 / 1024

Bei einer Auflösung von 8-Bit werden nur die 8 höchstwertigen Bits übertragen, daher sehen die Formeln wie folgt aus:

  • 8-Bit, Wertebereich 2g: Beschleunigung = Rohwert * 256 * 625 / 1024
  • 8-Bit, Wertebereich 4g: Beschleunigung = Rohwert * 256 * 1250 / 1024
  • 8-Bit, Wertebereich 8g: Beschleunigung = Rohwert * 256 * 2500 / 1024

Wenn keine Achse aktiviert is, sind beide Callbacks deaktiviert. Wenn einer der "Continuous Callbacks" genutzt wird, wird der AccelerometerV2Bricklet::get_acceleration_callback_receiver-Callback automatisch deaktiviert.

Der maximale Durchsatz hängt von der Konfiguration ab:

Anzahl aktiviert Achsen Durchsatz 8-Bit Durchsatz 16-Bit
1 25600Hz 25600Hz
2 25600Hz 15000Hz
3 20000Hz 10000Hz

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

Für resolution:

  • ACCELEROMETER_V2_BRICKLET_RESOLUTION_8BIT = 0
  • ACCELEROMETER_V2_BRICKLET_RESOLUTION_16BIT = 1
pub fn AccelerometerV2Bricklet::get_continuous_acceleration_configuration(&self) → ConvertingReceiver<ContinuousAccelerationConfiguration>
Rückgabeobjekt:
  • enable_x – Typ: bool, Standardwert: false
  • enable_y – Typ: bool, Standardwert: false
  • enable_z – Typ: bool, Standardwert: false
  • resolution – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels AccelerometerV2Bricklet::set_continuous_acceleration_configuration gesetzt.

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

Für resolution:

  • ACCELEROMETER_V2_BRICKLET_RESOLUTION_8BIT = 0
  • ACCELEROMETER_V2_BRICKLET_RESOLUTION_16BIT = 1

Fortgeschrittene Funktionen

pub fn AccelerometerV2Bricklet::set_filter_configuration(&self, iir_bypass: u8, low_pass_filter: u8) → ConvertingReceiver<()>
Parameter:
  • iir_bypass – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • low_pass_filter – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert den IIR Bypass Filter Modus und die Low Pass Filter Roll Off Corner Frequenz.

Der Filter kann angewendet oder umgangen werden und die Frequenz kann die halbe oder ein Neuntel der Ausgabe-Datenrate sein.

Accelerometer filter

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

Für iir_bypass:

  • ACCELEROMETER_V2_BRICKLET_IIR_BYPASS_APPLIED = 0
  • ACCELEROMETER_V2_BRICKLET_IIR_BYPASS_BYPASSED = 1

Für low_pass_filter:

  • ACCELEROMETER_V2_BRICKLET_LOW_PASS_FILTER_NINTH = 0
  • ACCELEROMETER_V2_BRICKLET_LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

pub fn AccelerometerV2Bricklet::get_filter_configuration(&self) → ConvertingReceiver<FilterConfiguration>
Rückgabeobjekt:
  • iir_bypass – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • low_pass_filter – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von AccelerometerV2Bricklet::set_filter_configuration gesetzt.

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

Für iir_bypass:

  • ACCELEROMETER_V2_BRICKLET_IIR_BYPASS_APPLIED = 0
  • ACCELEROMETER_V2_BRICKLET_IIR_BYPASS_BYPASSED = 1

Für low_pass_filter:

  • ACCELEROMETER_V2_BRICKLET_LOW_PASS_FILTER_NINTH = 0
  • ACCELEROMETER_V2_BRICKLET_LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

pub fn AccelerometerV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Rückgabeobjekt:
  • error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: u32, Wertebereich: [0 bis 232 - 1]

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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

pub fn AccelerometerV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameter:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: u8, Wertebereich: Siehe Konstanten

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:

  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn AccelerometerV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe AccelerometerV2Bricklet::set_bootloader_mode.

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

Für mode:

  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ACCELEROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn AccelerometerV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>
Parameter:
  • pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für AccelerometerV2Bricklet::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.

pub fn AccelerometerV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameter:
  • data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: u8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von AccelerometerV2Bricklet::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.

pub fn AccelerometerV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameter:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

  • ACCELEROMETER_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • ACCELEROMETER_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • ACCELEROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ACCELEROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn AccelerometerV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von AccelerometerV2Bricklet::set_status_led_config gesetzt.

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

Für config:

  • ACCELEROMETER_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • ACCELEROMETER_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • ACCELEROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ACCELEROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn AccelerometerV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>
Rückgabe:
  • temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

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

pub fn AccelerometerV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameter:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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.

pub fn AccelerometerV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>
Rückgabe:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

pub fn AccelerometerV2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connected_uid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'i', 'z']
  • hardware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: u16, Wertebereich: [0 bis 216 - 1]

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

Konfigurationsfunktionen für Callbacks

pub fn AccelerometerV2Bricklet::set_acceleration_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der AccelerometerV2Bricklet::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.

Wenn dieser Callback aktiviert ist, werden der AccelerometerV2Bricklet::get_continuous_acceleration_16_bit_callback_receiver Callback und AccelerometerV2Bricklet::get_continuous_acceleration_8_bit_callback_receiver Callback automatisch deaktiviert.

pub fn AccelerometerV2Bricklet::get_acceleration_callback_configuration(&self) → ConvertingReceiver<AccelerationCallbackConfiguration>
Rückgabeobjekt:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels AccelerometerV2Bricklet::set_acceleration_callback_configuration 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 AccelerometerV2Bricklet::get_acceleration_callback_receiver(&self) → ConvertingCallbackReceiver<AccelerationEvent>
Event-Objekt:
  • x – Typ: i32, Einheit: 1/10000 gₙ, Wertebereich: ?
  • y – Typ: i32, Einheit: 1/10000 gₙ, Wertebereich: ?
  • z – Typ: i32, Einheit: 1/10000 gₙ, Wertebereich: ?

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels AccelerometerV2Bricklet::set_acceleration_callback_configuration gesetzten Konfiguration.

Die Felder der empfangenen Struktur sind die gleichen wie AccelerometerV2Bricklet::get_acceleration.

pub fn AccelerometerV2Bricklet::get_continuous_acceleration_16_bit_callback_receiver(&self) → ConvertingCallbackReceiver<[i16; 30]>
Event:
  • acceleration – Typ: [i16; 30], Einheit: ? gₙ, Wertebereich: ?

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

Gibt 30 Beschleunigungswerte mit 16 bit Auflösung zurück. Die Datenrate kann mit der Funktion AccelerometerV2Bricklet::set_configuration eingestellt werden und der Callback kann per AccelerometerV2Bricklet::set_continuous_acceleration_configuration aktiviert werden.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit gₙ/10000 (gleiche Einheit wie von AccelerometerV2Bricklet::get_acceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe AccelerometerV2Bricklet::set_configuration):

  • Wertebereich 2g: Beschleunigung = Rohwert * 625 / 1024
  • Wertebereich 4g: Beschleunigung = Rohwert * 1250 / 1024
  • Wertebereich 8g: Beschleunigung = Rohwert * 2500 / 1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

  • x, y, z aktiviert: "x, y, z, ..." 10x wiederholt
  • x, z aktiviert: "x, z, ..." 15x wiederholt
  • y aktiviert: "y, ..." 30x wiederholt
pub fn AccelerometerV2Bricklet::get_continuous_acceleration_8_bit_callback_receiver(&self) → ConvertingCallbackReceiver<[i8; 60]>
Event:
  • acceleration – Typ: [i8; 60], Einheit: ? gₙ, Wertebereich: ?

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

Gibt 60 Beschleunigungswerte mit 8 bit Auflösung zurück. Die Datenrate kann mit der Funktion AccelerometerV2Bricklet::set_configuration eingestellt werden und der Callback kann per AccelerometerV2Bricklet::set_continuous_acceleration_configuration aktiviert werden.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit gₙ/10000 (gleiche Einheit wie von AccelerometerV2Bricklet::get_acceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe AccelerometerV2Bricklet::set_configuration):

  • Wertebereich 2g: Beschleunigung = Rohwert * 256 * 625 / 1024
  • Wertebereich 4g: Beschleunigung = Rohwert * 256 * 1250 / 1024
  • Wertebereich 8g: Beschleunigung = Rohwert * 256 * 2500 / 1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

  • x, y, z aktiviert: "x, y, z, ..." 20x wiederholt
  • x, z aktiviert: "x, z, ..." 30x wiederholt
  • y aktiviert: "y, ..." 60x wiederholt

Virtuelle Funktionen

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.

pub fn AccelerometerV2Bricklet::get_api_version(&self) → [u8; 3]
Rückgabeobjekt:
  • api_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]

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.

pub fn AccelerometerV2Bricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: 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 AccelerometerV2Bricklet::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:

  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 2
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_INFO_LED_CONFIG = 6
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_FILTER_CONFIGURATION = 13
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_RESET = 243
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn AccelerometerV2Bricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
  • response_expected – Typ: 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 Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 2
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_INFO_LED_CONFIG = 6
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_FILTER_CONFIGURATION = 13
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_RESET = 243
  • ACCELEROMETER_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn AccelerometerV2Bricklet::set_response_expected_all(&mut self, response_expected: bool) → ()
Parameter:
  • response_expected – Typ: bool

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

Konstanten

pub const AccelerometerV2Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Accelerometer Bricklet 2.0 zu identifizieren.

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

pub const AccelerometerV2Bricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet 2.0 dar.