Rust - XMC1400 Breakout Bricklet

Dies ist die Beschreibung der Rust API Bindings für das XMC1400 Breakout Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des XMC1400 Breakout 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).

Gpio

Download (example_gpio.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, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, xmc1400_breakout_bricklet::*};

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

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

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

    // Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
    for _i in 0..5 {
        thread::sleep(Duration::from_millis(1000));
        xb.set_gpio_config(1, 0, XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_OUTPUT_PUSH_PULL, 0, false);
        thread::sleep(Duration::from_millis(1000));
        xb.set_gpio_config(1, 0, XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_OUTPUT_PUSH_PULL, 0, true);
    }

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

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

let xmc1400_breakout = Xmc1400BreakoutBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn Xmc1400BreakoutBricklet::set_gpio_config(&self, port: u8, pin: u8, mode: u8, input_hysteresis: u8, output_level: bool) → ConvertingReceiver<()>
Parameter:
  • port – Typ: u8, Wertebereich: [0 bis 4]
  • pin – Typ: u8, Wertebereich: ?
  • mode – Typ: u8, Wertebereich: Siehe Konstanten
  • input_hysteresis – Typ: u8, Wertebereich: Siehe Konstanten
  • output_level – Typ: bool

Beispiel für eine Setter-Funktion. Die Werte werden direkt an die Funktion XMC_GPIO_Init übergeben. Siehe communication.c in der Firmware.

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

Für mode:

  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_INPUT_TRISTATE = 0
  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_INPUT_PULL_DOWN = 1
  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_INPUT_PULL_UP = 2
  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_INPUT_SAMPLING = 3
  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_INPUT_INVERTED_TRISTATE = 4
  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_INPUT_INVERTED_PULL_DOWN = 5
  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_INPUT_INVERTED_PULL_UP = 6
  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_INPUT_INVERTED_SAMPLING = 7
  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_OUTPUT_PUSH_PULL = 8
  • XMC1400_BREAKOUT_BRICKLET_GPIO_MODE_OUTPUT_OPEN_DRAIN = 9

Für input_hysteresis:

  • XMC1400_BREAKOUT_BRICKLET_GPIO_INPUT_HYSTERESIS_STANDARD = 0
  • XMC1400_BREAKOUT_BRICKLET_GPIO_INPUT_HYSTERESIS_LARGE = 4
pub fn Xmc1400BreakoutBricklet::get_gpio_input(&self, port: u8, pin: u8) → ConvertingReceiver<bool>
Parameter:
  • port – Typ: u8, Wertebereich: [0 bis 4]
  • pin – Typ: u8, Wertebereich: ?
Rückgabe:
  • value – Typ: bool

Beispiel für eine Getter-Funktion. Gibt das Resultat eines XMC_GPIO_GetInput-Aufrufs für den gegebenen Port/Pin zurück.

pub fn Xmc1400BreakoutBricklet::set_adc_channel_config(&self, channel: u8, enable: bool) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 7]
  • enable – Typ: bool

Aktiviert einen ADC-Kanal für das ADC-Treiber Beispiel (adc.c/adc.h).

Es gibt 8 ADC-Kanäle und sie korrespondieren zu den folgenden Pinnen:

  • Kanal 0: P2_6
  • Kanal 1: P2_8
  • Kanal 2: P2_9
  • Kanal 3: P2_10
  • Kanal 4: P2_11
  • Kanal 5: P2_0
  • Kanal 6: P2_1
  • Kanal 7: P2_2
pub fn Xmc1400BreakoutBricklet::get_adc_channel_config(&self, channel: u8) → ConvertingReceiver<bool>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 7]
Rückgabe:
  • enable – Typ: bool

Gibt die Konfiguration für den gegebenen Kanal zurück, wie von Xmc1400BreakoutBricklet::set_adc_channel_config gesetzt.

pub fn Xmc1400BreakoutBricklet::get_adc_channel_value(&self, channel: u8) → ConvertingReceiver<u16>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 7]
Rückgabe:
  • value – Typ: u16, Wertebereich: [0 bis 4095]

Gibt den 12-Bit Wert für den gegebenen ADC-Kanal des ADC-Treiber-Beispiels zurück.

pub fn Xmc1400BreakoutBricklet::get_adc_values(&self) → ConvertingReceiver<[u16; 8]>
Rückgabe:
  • values – Typ: [u16; 8], Wertebereich: [0 bis 4095]

Gibt die Werte aller 8 ADC-Kanäle des ADC-Treiber-Beispiels zurück.

Diese Beispiel-Funktion hat auch einen korrespondierenden Callback.

Siehe Xmc1400BreakoutBricklet::set_adc_values_callback_configuration und Xmc1400BreakoutBricklet::get_adc_values_callback_receiver Callback.

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

Gibt den Wert des Beispiel-Zählers zurück (siehe example.c).

Diese Beispiel-Funktion nutzt die "add_callback_value_function"-Hilfsfunktion im Generator. Der Getter sowie der Callback und die Callback-Konfigurations-Funktionen werden automatisch für die API und die Firmware generiert.

Wenn der Wert periodisch benötigt wird, kann auch der Xmc1400BreakoutBricklet::get_count_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion Xmc1400BreakoutBricklet::set_count_callback_configuration konfiguriert.

Fortgeschrittene Funktionen

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

  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn Xmc1400BreakoutBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • XMC1400_BREAKOUT_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn Xmc1400BreakoutBricklet::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 Xmc1400BreakoutBricklet::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 Xmc1400BreakoutBricklet::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 Xmc1400BreakoutBricklet::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 Xmc1400BreakoutBricklet::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:

  • XMC1400_BREAKOUT_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • XMC1400_BREAKOUT_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • XMC1400_BREAKOUT_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • XMC1400_BREAKOUT_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Xmc1400BreakoutBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • XMC1400_BREAKOUT_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • XMC1400_BREAKOUT_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • XMC1400_BREAKOUT_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • XMC1400_BREAKOUT_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Xmc1400BreakoutBricklet::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 Xmc1400BreakoutBricklet::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 Xmc1400BreakoutBricklet::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 Xmc1400BreakoutBricklet::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 Xmc1400BreakoutBricklet::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 'h', '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 Xmc1400BreakoutBricklet::set_adc_values_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 Xmc1400BreakoutBricklet::get_adc_values_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 Xmc1400BreakoutBricklet::get_adc_values_callback_configuration(&self) → ConvertingReceiver<AdcValuesCallbackConfiguration>
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 Xmc1400BreakoutBricklet::set_adc_values_callback_configuration gesetzt.

pub fn Xmc1400BreakoutBricklet::set_count_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: u32, max: u32) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u32, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: u32, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den Xmc1400BreakoutBricklet::get_count_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn Xmc1400BreakoutBricklet::get_count_callback_configuration(&self) → ConvertingReceiver<CountCallbackConfiguration>
Rückgabeobjekt:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u32, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: u32, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels Xmc1400BreakoutBricklet::set_count_callback_configuration gesetzt.

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

Für option:

  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • XMC1400_BREAKOUT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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 Xmc1400BreakoutBricklet::get_adc_values_callback_receiver(&self) → ConvertingCallbackReceiver<[u16; 8]>
Event:
  • values – Typ: [u16; 8], Wertebereich: [0 bis 4095]

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels Xmc1400BreakoutBricklet::set_adc_values_callback_configuration gesetzten Konfiguration

Die Felder der empfangenen Struktur sind der gleiche wie Xmc1400BreakoutBricklet::get_adc_values.

pub fn Xmc1400BreakoutBricklet::get_count_callback_receiver(&self) → ConvertingCallbackReceiver<u32>
Event:
  • count – Typ: u32, Wertebereich: [0 bis 232 - 1]

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels Xmc1400BreakoutBricklet::set_count_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie Xmc1400BreakoutBricklet::get_count.

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

  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_GPIO_CONFIG = 1
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_RESET = 243
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Xmc1400BreakoutBricklet::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:

  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_GPIO_CONFIG = 1
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_RESET = 243
  • XMC1400_BREAKOUT_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Xmc1400BreakoutBricklet::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 Xmc1400BreakoutBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein XMC1400 Breakout Bricklet zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines XMC1400 Breakout Bricklet dar.