Rust - DC Brick

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

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration

Download (example_configuration.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::{dc_brick::*, ip_connection::IpConnection};

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

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

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

    dc.set_drive_mode(DC_BRICK_DRIVE_MODE_DRIVE_COAST);
    dc.set_pwm_frequency(10000); // Use PWM frequency of 10kHz
    dc.set_acceleration(5000); // Slow acceleration
    dc.set_velocity(32767); // Full speed forward
    dc.enable(); // Enable motor power

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    dc.disable(); // Disable motor power
    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
39
40
41
42
43
44
45
46
47
48
49
50
use std::{error::Error, io, thread};
use tinkerforge::{dc_brick::*, ip_connection::IpConnection};

const HOST: &str = "127.0.0.1";
const PORT: u16 = 4223;
const UID: &str = "XXYYZZ"; // Change XXYYZZ to the UID of your DC Brick

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

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

    // 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
    dc.set_acceleration(5000); // Slow acceleration
    dc.set_velocity(32767); // Full speed forward

    let velocity_reached_receiver = dc.get_velocity_reached_callback_receiver();

    // Spawn thread to handle received callback messages. This thread ends when the dc
    // is dropped, so there is no need for manual cleanup.
    let dc_copy = dc.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");
                dc_copy.set_velocity(-32767);
            } else if velocity_reached == -32767 {
                println!("Velocity: Full speed backward, now turning forward");
                dc_copy.set_velocity(32767);
            } else {
                //can only happen if another program sets velocity
                panic!("Error");
            }
        }
    });

    // Enable motor power
    dc.enable();

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    dc.disable(); // 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 DcBrick::new(uid: &str, ip_connection: &IpConnection) → DcBrick
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • dc – Typ: DcBrick

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

let dc = DcBrick::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn DcBrick::set_velocity(&self, velocity: i16) → ConvertingReceiver<()>
Parameter:
  • velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 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 DcBrick::set_acceleration) 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 DcBrick::set_pwm_frequency.

pub fn DcBrick::get_velocity(&self) → ConvertingReceiver<i16>
Rückgabe:
  • velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0

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

pub fn DcBrick::get_current_velocity(&self) → ConvertingReceiver<i16>
Rückgabe:
  • velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0

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

pub fn DcBrick::set_acceleration(&self, acceleration: u16) → ConvertingReceiver<()>
Parameter:
  • acceleration – Typ: u16, Einheit: 100/32767 %, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Setzt die Beschleunigung 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 von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Beschleunigungsrampe gefahren.

pub fn DcBrick::get_acceleration(&self) → ConvertingReceiver<u16>
Rückgabe:
  • acceleration – Typ: u16, Einheit: 100/32767 %, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt die Beschleunigung zurück, wie gesetzt von DcBrick::set_acceleration.

pub fn DcBrick::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 DcBrick::set_velocity mit 0 erlaubt einen normalen Stopp des Motors.

pub fn DcBrick::enable(&self) → ConvertingReceiver<()>

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

pub fn DcBrick::disable(&self) → ConvertingReceiver<()>

Deaktiviert die Treiberstufe. Die Konfiguration (Geschwindigkeit, Beschleunigung, etc.) bleibt erhalten aber der Motor wird nicht angesteuert bis eine erneute Aktivierung erfolgt.

pub fn DcBrick::is_enabled(&self) → ConvertingReceiver<bool>
Rückgabe:
  • enabled – Typ: bool, Standardwert: false

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

Fortgeschrittene Funktionen

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

pub fn DcBrick::get_stack_input_voltage(&self) → ConvertingReceiver<u16>
Rückgabe:
  • voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die Eingangsspannung des Stapels zurück. Die Eingangsspannung des Stapel wird über diesen bereitgestellt und von einer Step-Down oder Step-Up Power Supply erzeugt.

pub fn DcBrick::get_external_input_voltage(&self) → ConvertingReceiver<u16>
Rückgabe:
  • voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den DC Brick, eingespeist.

Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, wird der Motor über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung des Motors über diese.

Warnung

Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung des Motors über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung des Motors über die höhere Versorgungsspannung des Stapels.

pub fn DcBrick::get_current_consumption(&self) → ConvertingReceiver<u16>
Rückgabe:
  • voltage – Typ: u16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt die Stromaufnahme des Motors zurück.

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

  • DC_BRICK_DRIVE_MODE_DRIVE_BRAKE = 0
  • DC_BRICK_DRIVE_MODE_DRIVE_COAST = 1
pub fn DcBrick::get_drive_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für mode:

  • DC_BRICK_DRIVE_MODE_DRIVE_BRAKE = 0
  • DC_BRICK_DRIVE_MODE_DRIVE_COAST = 1
pub fn DcBrick::set_spitfp_baudrate_config(&self, enable_dynamic_baudrate: bool, minimum_dynamic_baudrate: u32) → ConvertingReceiver<()>
Parameter:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: u32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

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

Neu in Version 2.3.5 (Firmware).

pub fn DcBrick::get_spitfp_baudrate_config(&self) → ConvertingReceiver<SpitfpBaudrateConfig>
Rückgabeobjekt:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: u32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

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

Neu in Version 2.3.5 (Firmware).

pub fn DcBrick::get_send_timeout_count(&self, communication_method: u8) → ConvertingReceiver<u32>
Parameter:
  • communication_method – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • timeout_count – Typ: u32, Wertebereich: [0 bis 232 - 1]

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

Für communication_method:

  • DC_BRICK_COMMUNICATION_METHOD_NONE = 0
  • DC_BRICK_COMMUNICATION_METHOD_USB = 1
  • DC_BRICK_COMMUNICATION_METHOD_SPI_STACK = 2
  • DC_BRICK_COMMUNICATION_METHOD_CHIBI = 3
  • DC_BRICK_COMMUNICATION_METHOD_RS485 = 4
  • DC_BRICK_COMMUNICATION_METHOD_WIFI = 5
  • DC_BRICK_COMMUNICATION_METHOD_ETHERNET = 6
  • DC_BRICK_COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.3 (Firmware).

pub fn DcBrick::set_spitfp_baudrate(&self, bricklet_port: char, baudrate: u32) → ConvertingReceiver<()>
Parameter:
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: u32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Setzt die Baudrate eines spezifischen Bricklet Ports .

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe DcBrick::get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe DcBrick::set_spitfp_baudrate_config).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Neu in Version 2.3.3 (Firmware).

pub fn DcBrick::get_spitfp_baudrate(&self, bricklet_port: char) → ConvertingReceiver<u32>
Parameter:
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Rückgabe:
  • baudrate – Typ: u32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

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

Neu in Version 2.3.3 (Firmware).

pub fn DcBrick::get_spitfp_error_count(&self, bricklet_port: char) → ConvertingReceiver<SpitfpErrorCount>
Parameter:
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.3 (Firmware).

pub fn DcBrick::enable_status_led(&self) → ConvertingReceiver<()>

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

pub fn DcBrick::disable_status_led(&self) → ConvertingReceiver<()>

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

pub fn DcBrick::is_status_led_enabled(&self) → ConvertingReceiver<bool>
Rückgabe:
  • enabled – Typ: bool, Standardwert: true

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

Neu in Version 2.3.1 (Firmware).

pub fn DcBrick::get_protocol1_bricklet_name(&self, port: char) → ConvertingReceiver<Protocol1BrickletName>
Parameter:
  • port – Typ: char, Wertebereich: ['a' bis 'b']
Rückgabeobjekt:
  • protocol_version – 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]
  • name – Typ: String, Länge: bis zu 40

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 DcBrick::get_chip_temperature(&self) → ConvertingReceiver<i16>
Rückgabe:
  • temperature – Typ: i16, Einheit: 1/10 °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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

pub fn DcBrick::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 DcBrick::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: ['0' bis '8']
  • 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 der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

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

Konfigurationsfunktionen für Callbacks

pub fn DcBrick::set_minimum_voltage(&self, voltage: u16) → ConvertingReceiver<()>
Parameter:
  • voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000

Setzt die minimale Spannung, bei welcher der DcBrick::get_under_voltage_callback_receiver Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der DC Brick noch funktioniert, ist 6V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität höchstwahrscheinlich nicht benötigt.

pub fn DcBrick::get_minimum_voltage(&self) → ConvertingReceiver<u16>
Rückgabe:
  • voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000

Gibt die minimale Spannung zurück, wie von DcBrick::set_minimum_voltage gesetzt.

pub fn DcBrick::set_current_velocity_period(&self, period: u16) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt die Periode mit welcher der DcBrick::get_current_velocity_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn DcBrick::get_current_velocity_period(&self) → ConvertingReceiver<u16>
Rückgabe:
  • period – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt die Periode zurück, wie von DcBrick::set_current_velocity_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 DcBrick::get_under_voltage_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

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

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels DcBrick::set_minimum_voltage gesetzten, Schwellwert sinkt. Der empfangene Variable ist die aktuelle Spannung.

pub fn DcBrick::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 (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.

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

Bemerkung

Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe DcBrick::set_drive_mode). Im Fahren/Leerlauf Modus ist es leider nicht möglich das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe auszulesen.

pub fn DcBrick::get_velocity_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i16>
Event:
  • velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 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 DcBrick::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 DcBrick::set_acceleration) 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 DcBrick::get_current_velocity_callback_receiver(&self) → ConvertingCallbackReceiver<i16>
Event:
  • velocity – Typ: i16, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1]

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

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

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

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

  • DC_BRICK_FUNCTION_SET_VELOCITY = 1
  • DC_BRICK_FUNCTION_SET_ACCELERATION = 4
  • DC_BRICK_FUNCTION_SET_PWM_FREQUENCY = 6
  • DC_BRICK_FUNCTION_FULL_BRAKE = 8
  • DC_BRICK_FUNCTION_ENABLE = 12
  • DC_BRICK_FUNCTION_DISABLE = 13
  • DC_BRICK_FUNCTION_SET_MINIMUM_VOLTAGE = 15
  • DC_BRICK_FUNCTION_SET_DRIVE_MODE = 17
  • DC_BRICK_FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
  • DC_BRICK_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • DC_BRICK_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • DC_BRICK_FUNCTION_ENABLE_STATUS_LED = 238
  • DC_BRICK_FUNCTION_DISABLE_STATUS_LED = 239
  • DC_BRICK_FUNCTION_RESET = 243
pub fn DcBrick::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:

  • DC_BRICK_FUNCTION_SET_VELOCITY = 1
  • DC_BRICK_FUNCTION_SET_ACCELERATION = 4
  • DC_BRICK_FUNCTION_SET_PWM_FREQUENCY = 6
  • DC_BRICK_FUNCTION_FULL_BRAKE = 8
  • DC_BRICK_FUNCTION_ENABLE = 12
  • DC_BRICK_FUNCTION_DISABLE = 13
  • DC_BRICK_FUNCTION_SET_MINIMUM_VOLTAGE = 15
  • DC_BRICK_FUNCTION_SET_DRIVE_MODE = 17
  • DC_BRICK_FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
  • DC_BRICK_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • DC_BRICK_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • DC_BRICK_FUNCTION_ENABLE_STATUS_LED = 238
  • DC_BRICK_FUNCTION_DISABLE_STATUS_LED = 239
  • DC_BRICK_FUNCTION_RESET = 243
pub fn DcBrick::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 DcBrick::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen DC Brick zu identifizieren.

Die DcBrick::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 DcBrick::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines DC Brick dar.