Rust - RS232 Bricklet 2.0

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

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (example_loopback.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
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, rs232_v2_bricklet::*};

// For this example connect the RX pin to the TX pin on the same Bricklet

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

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

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

    let read_receiver = rs232.get_read_callback_receiver();

    // Spawn thread to handle received events.
    // This thread ends when the `rs232` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for read in read_receiver {
            match read {
                Some((payload, _)) => {
                    let message: String = payload.iter().collect();
                    println!("Message (Length: {}) {}", message.len(), message);
                }
                None => println!("Stream was out of sync."),
            }
        }
    });

    // Enable read callback
    rs232.enable_read_callback();

    // Write "test" string
    rs232.write(&['t', 'e', 's', 't'])?;

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

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

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

pub fn Rs232V2Bricklet::write(&self, message: char) → Result<usize, BrickletRecvTimeoutError>

Schreibt Zeichen auf die RS232-Schnittstelle. Die Zeichen können Binärdaten sein, ASCII o.ä. ist nicht notwendig.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben wurden.

Siehe Rs232V2Bricklet::set_configuration für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

pub fn Rs232V2Bricklet::read(&self, length: u16) → Result<Vec<char>, BrickletRecvTimeoutError>

Gibt bis zu length Zeichen aus dem Empfangsbuffer zurück.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn der Read-Callback nicht aktiv ist. Siehe Rs232V2Bricklet::enable_read_callback und Rs232V2Bricklet::get_read_callback_receiver Callback.

pub fn Rs232V2Bricklet::set_configuration(&self, baudrate: u32, parity: u8, stopbits: u8, wordlength: u8, flowcontrol: u8) → ConvertingReceiver<()>

Setzt die Konfiguration für die RS232-Kommunikation. Verfügbare Optionen sind:

  • Baudrate zwischen 100 und 2000000 Baud.
  • Parität von None, Odd und Even.
  • Stopp-Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Flow Control kann aus, Software oder Hardware sein.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8.

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

  • RS232_V2_BRICKLET_PARITY_NONE = 0
  • RS232_V2_BRICKLET_PARITY_ODD = 1
  • RS232_V2_BRICKLET_PARITY_EVEN = 2
  • RS232_V2_BRICKLET_STOPBITS_1 = 1
  • RS232_V2_BRICKLET_STOPBITS_2 = 2
  • RS232_V2_BRICKLET_WORDLENGTH_5 = 5
  • RS232_V2_BRICKLET_WORDLENGTH_6 = 6
  • RS232_V2_BRICKLET_WORDLENGTH_7 = 7
  • RS232_V2_BRICKLET_WORDLENGTH_8 = 8
  • RS232_V2_BRICKLET_FLOWCONTROL_OFF = 0
  • RS232_V2_BRICKLET_FLOWCONTROL_SOFTWARE = 1
  • RS232_V2_BRICKLET_FLOWCONTROL_HARDWARE = 2
pub fn Rs232V2Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>

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

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

  • RS232_V2_BRICKLET_PARITY_NONE = 0
  • RS232_V2_BRICKLET_PARITY_ODD = 1
  • RS232_V2_BRICKLET_PARITY_EVEN = 2
  • RS232_V2_BRICKLET_STOPBITS_1 = 1
  • RS232_V2_BRICKLET_STOPBITS_2 = 2
  • RS232_V2_BRICKLET_WORDLENGTH_5 = 5
  • RS232_V2_BRICKLET_WORDLENGTH_6 = 6
  • RS232_V2_BRICKLET_WORDLENGTH_7 = 7
  • RS232_V2_BRICKLET_WORDLENGTH_8 = 8
  • RS232_V2_BRICKLET_FLOWCONTROL_OFF = 0
  • RS232_V2_BRICKLET_FLOWCONTROL_SOFTWARE = 1
  • RS232_V2_BRICKLET_FLOWCONTROL_HARDWARE = 2

Fortgeschrittene Funktionen

pub fn Rs232V2Bricklet::set_buffer_config(&self, send_buffer_size: u16, receive_buffer_size: u16) → ConvertingReceiver<()>

Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10kb) haben, die Minimalgröße ist 1024 Byte (1kb) für beide.

Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.

Der Sendebuffer hält die Daten welche über Rs232V2Bricklet::write übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS232 empfangen wurden aber noch nicht über Rs232V2Bricklet::read oder Rs232V2Bricklet::get_read_callback_receiver Callback an ein Nutzerprogramm übertragen werden konnten.

Die Standardkonfiguration ist 5120 Byte (5kb) pro Buffer.

pub fn Rs232V2Bricklet::get_buffer_config(&self) → ConvertingReceiver<BufferConfig>

Gibt die Buffer-Konfiguration zurück, wie von Rs232V2Bricklet::set_buffer_config gesetzt.

pub fn Rs232V2Bricklet::get_buffer_status(&self) → ConvertingReceiver<BufferStatus>

Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.

Siehe Rs232V2Bricklet::set_buffer_config zur Konfiguration der Buffergrößen.

pub fn Rs232V2Bricklet::get_error_count(&self) → ConvertingReceiver<ErrorCount>

Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.

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

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

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

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels Rs232V2Bricklet::set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

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

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • RS232_V2_BRICKLET_FUNCTION_ENABLE_READ_CALLBACK = 3
  • RS232_V2_BRICKLET_FUNCTION_DISABLE_READ_CALLBACK = 4
  • RS232_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 6
  • RS232_V2_BRICKLET_FUNCTION_SET_BUFFER_CONFIG = 8
  • RS232_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • RS232_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • RS232_V2_BRICKLET_FUNCTION_RESET = 243
  • RS232_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Rs232V2Bricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

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

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

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

Die Fehler sind aufgeteilt in

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

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

pub fn Rs232V2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>

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

  • RS232_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • RS232_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • RS232_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • RS232_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • RS232_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • RS232_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • RS232_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • RS232_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn Rs232V2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

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

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

  • RS232_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • RS232_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn Rs232V2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Setzt den Firmware-Pointer für Rs232V2Bricklet::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 Rs232V2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Schreibt 64 Bytes Firmware an die Position die vorher von Rs232V2Bricklet::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 Rs232V2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

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:

  • RS232_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • RS232_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • RS232_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • RS232_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Rs232V2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

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

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

  • RS232_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • RS232_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • RS232_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • RS232_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Rs232V2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

Gibt die Temperatur in °C, 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 Rs232V2Bricklet::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 Rs232V2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

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 Rs232V2Bricklet::read_uid(&self) → ConvertingReceiver<u32>

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 Rs232V2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>

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 kann 'a', 'b', 'c' oder 'd' sein.

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 Rs232V2Bricklet::enable_read_callback(&self) → ConvertingReceiver<()>

Aktiviert den Rs232V2Bricklet::get_read_callback_receiver Callback.

Im Startzustand ist der Callback deaktiviert.

pub fn Rs232V2Bricklet::disable_read_callback(&self) → ConvertingReceiver<()>

Deaktiviert den Rs232V2Bricklet::get_read_callback_receiver Callback.

Im Startzustand ist der Callback deaktiviert.

pub fn Rs232V2Bricklet::is_read_callback_enabled(&self) → ConvertingReceiver<bool>

Gibt true zurück falls Rs232V2Bricklet::get_read_callback_receiver Callback aktiviert ist, false sonst.

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 Rs232V2Bricklet::get_read_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<char, ReadResult, ReadLowLevelEvent>

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

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.

Dieser Callback kann durch Rs232V2Bricklet::enable_read_callback aktiviert werden.

pub fn Rs232V2Bricklet::get_error_count_callback_receiver(&self) → ConvertingCallbackReceiver<ErrorCountEvent>

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

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.

Konstanten

Rs232V2Bricklet::DEVICE_IDENTIFIER

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

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

Rs232V2Bricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet 2.0 dar.