Software / API Bindings / Rust / API Referenz und Beispiele / Bricklets / Performance DC Bricklet

Rust - Performance DC Bricklet¶

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

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration¶

Download (example_configuration.rs)

use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, performance_dc_bricklet::*};

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

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

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

    pdc.set_drive_mode(PERFORMANCE_DC_BRICKLET_DRIVE_MODE_DRIVE_COAST).recv()?;
    pdc.set_pwm_frequency(10000).recv()?; // Use PWM frequency of 10 kHz
    pdc.set_motion(4096, 4096).recv()?; // Slow ac-/deceleration (12.5 %/s)
    pdc.set_velocity(32767).recv()?; // Full speed forward (100 %)
    pdc.set_enabled(true).recv()?; // Enable motor power

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

    // Stop motor before disabling motor power
    pdc.set_motion(4096, 16384).recv()?; // Fast decceleration (50 %/s) for stopping
    pdc.set_velocity(0).recv()?; // Request motor stop
    thread::sleep(Duration::from_millis(2000)); // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    pdc.set_enabled(false).recv()?; // Disable motor power

    ipcon.disconnect();
    Ok(())
}

Callback¶

Download (example_callback.rs)

use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, performance_dc_bricklet::*};

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

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

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

    let velocity_reached_receiver = pdc.get_velocity_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `pdc` object
    // is dropped, so there is no need for manual cleanup.
    let pdc_copy = pdc.clone(); // Device objects don't implement Sync, so they can't be shared
                                // between threads (by reference). So clone the device and move the copy.
    thread::spawn(move || {
        for velocity_reached in velocity_reached_receiver {
            if velocity_reached == 32767 {
                println!("Velocity: Full speed forward, now turning backward");
                pdc_copy.set_velocity(-32767);
            } else if velocity_reached == -32767 {
                println!("Velocity: Full speed backward, now turning forward");
                pdc_copy.set_velocity(32767);
            } else {
                //can only happen if another program sets velocity
                panic!("Error");
            }
        }
    });

    // Enable velocity reached callback
    pdc.set_velocity_reached_callback_configuration(true).recv()?;

    // The acceleration has to be smaller or equal to the maximum
    // acceleration of the DC motor, otherwise the velocity reached
    // callback will be called too early
    pdc.set_motion(4096, 4096).recv()?; // Slow acceleration (12.5 %/s)
    pdc.set_velocity(32767).recv()?; // Full speed forward (100 %)

    // Enable motor power
    pdc.set_enabled(true).recv()?;

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

    // Stop motor before disabling motor power
    pdc.set_motion(4096, 16384).recv()?; // Fast decceleration (50 %/s) for stopping
    pdc.set_velocity(0).recv()?; // Request motor stop
    thread::sleep(Duration::from_millis(2000)); // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    pdc.set_enabled(false).recv()?; // Disable motor power

    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 PerformanceDcBricklet::new(uid: &str, ip_connection: &IpConnection) → PerformanceDcBricklet¶

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	performance_dc – Typ: PerformanceDcBricklet

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

let performance_dc = PerformanceDcBricklet::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.

pub fn PerformanceDcBricklet::set_enabled(&self, enabled: bool) → ConvertingReceiver<()>¶

Parameter:	enabled – Typ: bool

Aktiviert/Deaktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).

pub fn PerformanceDcBricklet::get_enabled(&self) → ConvertingReceiver<bool>¶

Rückgabe:	enabled – Typ: bool, Standardwert: false

Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.

pub fn PerformanceDcBricklet::set_velocity(&self, velocity: i16) → ConvertingReceiver<()>¶

Parameter:	velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1], Standardwert: 0

Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit vorwärts. In Abhängigkeit von der Beschleunigung (siehe PerformanceDcBricklet::set_motion) wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern gleichmäßig beschleunigt.

Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch die Frequenz der PWM verändert werden, siehe PerformanceDcBricklet::set_pwm_frequency.

pub fn PerformanceDcBricklet::get_velocity(&self) → ConvertingReceiver<i16>¶

Rückgabe:	velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1], Standardwert: 0

Gibt die Geschwindigkeit zurück, wie gesetzt von PerformanceDcBricklet::set_velocity.

pub fn PerformanceDcBricklet::get_current_velocity(&self) → ConvertingReceiver<i16>¶

Rückgabe:	velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1], Standardwert: 0

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von PerformanceDcBricklet::get_velocity, sobald der Motor auf einen neuen Zielwert, wie von PerformanceDcBricklet::set_velocity vorgegeben, beschleunigt.

pub fn PerformanceDcBricklet::set_motion(&self, acceleration: u16, deceleration: u16) → ConvertingReceiver<()>¶

Parameter:	acceleration – Typ: u16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000 deceleration – Typ: u16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000

Setzt die Beschleunigung/Debeschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).

Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.

Eine Beschleunigung/Debeschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Rampe gefahren.

pub fn PerformanceDcBricklet::get_motion(&self) → ConvertingReceiver<Motion>¶

Rückgabeobjekt:	acceleration – Typ: u16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000 deceleration – Typ: u16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000

Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von PerformanceDcBricklet::set_motion.

pub fn PerformanceDcBricklet::full_brake(&self) → ConvertingReceiver<()>¶

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von PerformanceDcBricklet::set_velocity mit 0 erlaubt einen normalen Stopp des Motors.

pub fn PerformanceDcBricklet::get_pwm_frequency(&self) → ConvertingReceiver<u16>¶

Rückgabe:	frequency – Typ: u16, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Gibt die PWM Frequenz zurück, wie gesetzt von PerformanceDcBricklet::set_pwm_frequency.

pub fn PerformanceDcBricklet::get_power_statistics(&self) → ConvertingReceiver<PowerStatistics>¶

Rückgabeobjekt:	voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] current – Typ: u16, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1] temperature – Typ: i16, Einheit: 1/10 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Eingangsspannung, den Stromverbrauch und die Temperatur des Treibers zurück.

pub fn PerformanceDcBricklet::set_thermal_shutdown(&self, temperature: u8) → ConvertingReceiver<()>¶

Parameter:	temperature – Typ: u8, Einheit: 1 °, Wertebereich: [0 bis 255], Standardwert: 125

Setzt den Temperatur-Grenzwert für eine thermale Abschaltung.

Neben diesem nutzerdefinierten Grenzwert schaltet er Treiber selbst ab einer Temperatur von 150° ab.

Wenn es zu einer thermalen Abschaltung kommt wird der Treiber deaktiviert und er muss explizit per PerformanceDcBricklet::set_enabled wieder aktiviert werden.

pub fn PerformanceDcBricklet::get_thermal_shutdown(&self) → ConvertingReceiver<u8>¶

Rückgabe:	temperature – Typ: u8, Einheit: 1 °, Wertebereich: [0 bis 255]

Gibt die thermale Abschalttemperatur zurück, wie von PerformanceDcBricklet::set_thermal_shutdown gesetzt.

pub fn PerformanceDcBricklet::set_gpio_configuration(&self, channel: u8, debounce: u16, stop_deceleration: u16) → ConvertingReceiver<()>¶

Parameter:	channel – Typ: u8, Wertebereich: [0 bis 1] debounce – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 stop_deceleration – Typ: u16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

Setzt die GPIO-Konfiguration für einen Kanal. Es kann ein Debounce und eine Debeschleunigung gesetzt werden. Letzteres wird genutzt wenn die Action auf normal stop konfiguriert ist. Siehe PerformanceDcBricklet::set_gpio_action.

pub fn PerformanceDcBricklet::get_gpio_configuration(&self, channel: u8) → ConvertingReceiver<GpioConfiguration>¶

Parameter:	channel – Typ: u8, Wertebereich: [0 bis 1]
Rückgabeobjekt:	debounce – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 stop_deceleration – Typ: u16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von PerformanceDcBricklet::set_gpio_configuration gesetzt.

pub fn PerformanceDcBricklet::set_gpio_action(&self, channel: u8, action: u32) → ConvertingReceiver<()>¶

Parameter:	channel – Typ: u8, Wertebereich: [0 bis 1] action – Typ: u32, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die GPIO-Action für einen Kanal.

Die Action kann ein normal stop, ein full brake oder ein callback sein. Jeweils für eine steigende oder fallende Flanke. Die Actions sind eine Bitmaske und sie können simultan verwendet werden. Es ist zum Beispiel möglich einen full brake und callback gleichzeitig zu triggern oder eine auf eine steigende und fallende Flanke gleichzeitig.

Die Debeschleunigung für den normal stop kann über PerformanceDcBricklet::set_gpio_configuration konfiguriert werden.

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

Für action:

PERFORMANCE_DC_BRICKLET_GPIO_ACTION_NONE = 0
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_CALLBACK_RISING_EDGE = 16
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_CALLBACK_FALLING_EDGE = 32

pub fn PerformanceDcBricklet::get_gpio_action(&self, channel: u8) → ConvertingReceiver<u32>¶

Parameter:	channel – Typ: u8, Wertebereich: [0 bis 1]
Rückgabe:	action – Typ: u32, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die GPIO-Action für einen Kanal zurück, wie von PerformanceDcBricklet::set_gpio_action gesetzt.

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

Für action:

PERFORMANCE_DC_BRICKLET_GPIO_ACTION_NONE = 0
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_CALLBACK_RISING_EDGE = 16
PERFORMANCE_DC_BRICKLET_GPIO_ACTION_CALLBACK_FALLING_EDGE = 32

pub fn PerformanceDcBricklet::get_gpio_state(&self) → ConvertingReceiver<[bool; 2]>¶

Rückgabe:	gpio_state – Typ: [bool; 2]

Gibt den GPIO-Zustand für beide Kanäle zurück. True wenn der der Zustand high ist und false wenn der Zustand low ist.

Fortgeschrittene Funktionen¶

pub fn PerformanceDcBricklet::set_drive_mode(&self, mode: u8) → ConvertingReceiver<()>¶

Parameter:	mode – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Fahrmodus. Verfügbare Modi sind:

0 = Fahren/Bremsen
1 = Fahren/Leerlauf

Diese Modi sind verschiedene Arten der Motoransteuerung.

Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.

Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.

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

Für mode:

PERFORMANCE_DC_BRICKLET_DRIVE_MODE_DRIVE_BRAKE = 0
PERFORMANCE_DC_BRICKLET_DRIVE_MODE_DRIVE_COAST = 1

pub fn PerformanceDcBricklet::get_drive_mode(&self) → ConvertingReceiver<u8>¶

Rückgabe:	mode – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den Fahrmodus zurück, wie von PerformanceDcBricklet::set_drive_mode gesetzt.

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

Für mode:

PERFORMANCE_DC_BRICKLET_DRIVE_MODE_DRIVE_BRAKE = 0
PERFORMANCE_DC_BRICKLET_DRIVE_MODE_DRIVE_COAST = 1

pub fn PerformanceDcBricklet::set_pwm_frequency(&self, frequency: u16) → ConvertingReceiver<()>¶

Parameter:	frequency – Typ: u16, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.

Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.

pub fn PerformanceDcBricklet::set_error_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den Fehler-Status anzuzeigen.

Wenn die LED konfiguriert ist um Fehler anzuzeigen gibt es drei unterschiedliche Zustände:

Aus: Es liegt kein Fehler vor.
1s Intervall-Blinken: Eingangsspannung zu klein (unter 6V).
250ms Intervall-Blinken: Übertemperatur oder Überstrom.

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

Für config:

PERFORMANCE_DC_BRICKLET_ERROR_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_ERROR_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR = 3

pub fn PerformanceDcBricklet::get_error_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von PerformanceDcBricklet::set_error_led_config gesetzt.

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

Für config:

PERFORMANCE_DC_BRICKLET_ERROR_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_ERROR_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR = 3

pub fn PerformanceDcBricklet::set_cw_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Konfiguriert die CW-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option anzuzeigen ob der Motor im Uhrzeigersinn dreht.

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

Für config:

PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_SHOW_CW_AS_FORWARD = 3
PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_SHOW_CW_AS_BACKWARD = 4

pub fn PerformanceDcBricklet::get_cw_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von PerformanceDcBricklet::set_cw_led_config gesetzt.

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

Für config:

PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_SHOW_CW_AS_FORWARD = 3
PERFORMANCE_DC_BRICKLET_CW_LED_CONFIG_SHOW_CW_AS_BACKWARD = 4

pub fn PerformanceDcBricklet::set_ccw_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Konfiguriert die CCW-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option anzuzeigen ob der Motor gegen den Uhrzeigersinn dreht.

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

Für config:

PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_SHOW_CCW_AS_FORWARD = 3
PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_SHOW_CCW_AS_BACKWARD = 4

pub fn PerformanceDcBricklet::get_ccw_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von PerformanceDcBricklet::set_ccw_led_config gesetzt.

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

Für config:

PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_SHOW_CCW_AS_FORWARD = 3
PERFORMANCE_DC_BRICKLET_CCW_LED_CONFIG_SHOW_CCW_AS_BACKWARD = 4

pub fn PerformanceDcBricklet::set_gpio_led_config(&self, channel: u8, config: u8) → ConvertingReceiver<()>¶

Parameter:	channel – Typ: u8, Wertebereich: [0 bis 1] config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 4

Konfiguriert die GPIO-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den GPIO-Zustand anzuzeigen.

Die GPIO-LED kann für beide Kanäle konfiguriert werden.

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

Für config:

PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_HIGH = 3
PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_LOW = 4

pub fn PerformanceDcBricklet::get_gpio_led_config(&self, channel: u8) → ConvertingReceiver<u8>¶

Parameter:	channel – Typ: u8, Wertebereich: [0 bis 1]
Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 4

Gibt die LED-Konfiguration zurück, wie von PerformanceDcBricklet::set_gpio_led_config gesetzt.

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

Für config:

PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_HIGH = 3
PERFORMANCE_DC_BRICKLET_GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_LOW = 4

pub fn PerformanceDcBricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>¶

Rückgabeobjekt:	error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: u32, Wertebereich: [0 bis 2³² - 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 PerformanceDcBricklet::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:

PERFORMANCE_DC_BRICKLET_STATUS_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_STATUS_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn PerformanceDcBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

PERFORMANCE_DC_BRICKLET_STATUS_LED_CONFIG_OFF = 0
PERFORMANCE_DC_BRICKLET_STATUS_LED_CONFIG_ON = 1
PERFORMANCE_DC_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
PERFORMANCE_DC_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

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

Rückgabe:	temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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 PerformanceDcBricklet::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 PerformanceDcBricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Rückgabeobjekt:

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 'h', '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 2¹⁶ - 1]

uid – Typ: String, Länge: bis zu 8
connected_uid – Typ: String, Länge: bis zu 8
position – Typ: char, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 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 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.

Konfigurationsfunktionen für Callbacks¶

pub fn PerformanceDcBricklet::set_emergency_shutdown_callback_configuration(&self, enabled: bool) → ConvertingReceiver<()>¶

Parameter:	enabled – Typ: bool, Standardwert: false

Aktiviert/Deaktiviert PerformanceDcBricklet::get_emergency_shutdown_callback_receiver Callback.

pub fn PerformanceDcBricklet::get_emergency_shutdown_callback_configuration(&self) → ConvertingReceiver<bool>¶

Rückgabe:	enabled – Typ: bool, Standardwert: true

Gibt die Callback-Konfiguration zurück, wie mittels PerformanceDcBricklet::set_emergency_shutdown_callback_configuration gesetzt.

pub fn PerformanceDcBricklet::set_velocity_reached_callback_configuration(&self, enabled: bool) → ConvertingReceiver<()>¶

Parameter:	enabled – Typ: bool, Standardwert: false

Aktiviert/Deaktiviert PerformanceDcBricklet::get_velocity_reached_callback_receiver Callback.

pub fn PerformanceDcBricklet::get_velocity_reached_callback_configuration(&self) → ConvertingReceiver<bool>¶

Rückgabe:	enabled – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels PerformanceDcBricklet::set_velocity_reached_callback_configuration gesetzt.

pub fn PerformanceDcBricklet::set_current_velocity_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶

Parameter:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

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

pub fn PerformanceDcBricklet::get_current_velocity_callback_configuration(&self) → ConvertingReceiver<CurrentVelocityCallbackConfiguration>¶

Rückgabeobjekt:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels PerformanceDcBricklet::set_current_velocity_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 PerformanceDcBricklet::get_emergency_shutdown_callback_receiver(&self) → ConvertingCallbackReceiver<()>¶

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

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch oder die Temperatur der Treiberstufe zu hoch ist (über 150°C) oder die nutzerdefinierte Abschaltungstemperatur überstiegen wird (siehe PerformanceDcBricklet::set_thermal_shutdown). Im Falle einer Spannung unter 6V (Eingangsspannung) wird dieser Callback auch ausgelöst.

Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert. Das bedeutet PerformanceDcBricklet::set_enabled muss aufgerufen werden, um den Motor erneut zu fahren.

pub fn PerformanceDcBricklet::get_velocity_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i16>¶

Event:	velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1]

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

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist, wird der PerformanceDcBricklet::get_velocity_reached_callback_receiver Callback nach ungefähr 2 Sekunden ausgelöst, wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe PerformanceDcBricklet::set_motion) kleiner oder gleich der maximalen Beschleunigung des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

pub fn PerformanceDcBricklet::get_current_velocity_callback_receiver(&self) → ConvertingCallbackReceiver<i16>¶

Event:	velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit PerformanceDcBricklet::set_current_velocity_callback_configuration, ausgelöst. Der empfangene Variable ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der PerformanceDcBricklet::get_current_velocity_callback_receiver Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

pub fn PerformanceDcBricklet::get_gpio_state_callback_receiver(&self) → ConvertingCallbackReceiver<[bool; 2]>¶

Event:	gpio_state – Typ: [bool; 2]

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

Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über PerformanceDcBricklet::set_gpio_action aktiviert wurde.

Neu in Version 2.0.1 (Plugin).

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 PerformanceDcBricklet::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 PerformanceDcBricklet::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 PerformanceDcBricklet::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:

PERFORMANCE_DC_BRICKLET_FUNCTION_SET_ENABLED = 1
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_VELOCITY = 3
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_MOTION = 6
PERFORMANCE_DC_BRICKLET_FUNCTION_FULL_BRAKE = 8
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_DRIVE_MODE = 9
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_PWM_FREQUENCY = 11
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_THERMAL_SHUTDOWN = 14
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_GPIO_CONFIGURATION = 16
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_GPIO_ACTION = 18
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_ERROR_LED_CONFIG = 21
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_CW_LED_CONFIG = 23
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_CCW_LED_CONFIG = 25
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_GPIO_LED_CONFIG = 27
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 29
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 31
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 33
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
PERFORMANCE_DC_BRICKLET_FUNCTION_RESET = 243
PERFORMANCE_DC_BRICKLET_FUNCTION_WRITE_UID = 248

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

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

Für function_id:

PERFORMANCE_DC_BRICKLET_FUNCTION_SET_ENABLED = 1
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_VELOCITY = 3
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_MOTION = 6
PERFORMANCE_DC_BRICKLET_FUNCTION_FULL_BRAKE = 8
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_DRIVE_MODE = 9
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_PWM_FREQUENCY = 11
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_THERMAL_SHUTDOWN = 14
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_GPIO_CONFIGURATION = 16
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_GPIO_ACTION = 18
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_ERROR_LED_CONFIG = 21
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_CW_LED_CONFIG = 23
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_CCW_LED_CONFIG = 25
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_GPIO_LED_CONFIG = 27
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 29
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 31
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 33
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
PERFORMANCE_DC_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
PERFORMANCE_DC_BRICKLET_FUNCTION_RESET = 243
PERFORMANCE_DC_BRICKLET_FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

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.

pub fn PerformanceDcBricklet::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:

PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

PERFORMANCE_DC_BRICKLET_BOOTLOADER_STATUS_OK = 0
PERFORMANCE_DC_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
PERFORMANCE_DC_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
PERFORMANCE_DC_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
PERFORMANCE_DC_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
PERFORMANCE_DC_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn PerformanceDcBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

Rückgabe:	mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
PERFORMANCE_DC_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn PerformanceDcBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>¶

Parameter:	pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Setzt den Firmware-Pointer für PerformanceDcBricklet::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 PerformanceDcBricklet::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 PerformanceDcBricklet::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 PerformanceDcBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameter:	uid – Typ: u32, Wertebereich: [0 bis 2³² - 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 PerformanceDcBricklet::read_uid(&self) → ConvertingReceiver<u32>¶

Rückgabe:	uid – Typ: u32, Wertebereich: [0 bis 2³² - 1]

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

Konstanten¶

pub const PerformanceDcBricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Performance DC Bricklet zu identifizieren.

Die PerformanceDcBricklet::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 PerformanceDcBricklet::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Performance DC Bricklet dar.