Rust - RS232 Bricklet

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

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
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, rs232_bricklet::*};

// For this example connect the RX1 and TX pin to receive the send message

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection
    let rs232 = Rs232Bricklet::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 {
            let message: String = read.message.iter().collect();
            println!("Message (Length: {}) {}", read.length, message);
        }
    });

    // Enable read callback
    rs232.enable_read_callback();

    let mut chars = ['\0'; 60];
    let test_chars = ['t', 'e', 's', 't'];
    chars[0..4].copy_from_slice(&test_chars);

    // Write "test" string
    rs232.write(chars, 4);

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

Erzeugt ein neues Rs232Bricklet-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 Rs232Bricklet::write(&self, message: [char; 60], length: u8) → ConvertingReceiver<u8>

Schreibt einen String aus bis zu 60 Zeichen auf die RS232-Schnittstelle. Der String kann aus Binärdaten bestehen, ASCII o.ä. ist nicht notwendig.

Die Länge des Strings muss als ein zusätzlicher Parameter angegeben werden.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben werden konnten.

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

pub fn Rs232Bricklet::read(&self) → ConvertingReceiver<Read>

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die Länge als 0 gegeben wird, waren keine neuen Daten verfügbar.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe Rs232Bricklet::enable_read_callback und Rs232Bricklet::get_read_callback_receiver Callback.

pub fn Rs232Bricklet::set_configuration(&self, baudrate: u8, parity: u8, stopbits: u8, wordlength: u8, hardware_flowcontrol: u8, software_flowcontrol: u8) → ConvertingReceiver<()>

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

  • Baudrate zwischen 300 und 230400 Baud.
  • Parität von None, Odd, Even und Forced Parity.
  • Stop Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8, Hard-/Software Flow Control aus.

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

  • RS232_BRICKLET_BAUDRATE_300 = 0
  • RS232_BRICKLET_BAUDRATE_600 = 1
  • RS232_BRICKLET_BAUDRATE_1200 = 2
  • RS232_BRICKLET_BAUDRATE_2400 = 3
  • RS232_BRICKLET_BAUDRATE_4800 = 4
  • RS232_BRICKLET_BAUDRATE_9600 = 5
  • RS232_BRICKLET_BAUDRATE_14400 = 6
  • RS232_BRICKLET_BAUDRATE_19200 = 7
  • RS232_BRICKLET_BAUDRATE_28800 = 8
  • RS232_BRICKLET_BAUDRATE_38400 = 9
  • RS232_BRICKLET_BAUDRATE_57600 = 10
  • RS232_BRICKLET_BAUDRATE_115200 = 11
  • RS232_BRICKLET_BAUDRATE_230400 = 12
  • RS232_BRICKLET_PARITY_NONE = 0
  • RS232_BRICKLET_PARITY_ODD = 1
  • RS232_BRICKLET_PARITY_EVEN = 2
  • RS232_BRICKLET_PARITY_FORCED_PARITY_1 = 3
  • RS232_BRICKLET_PARITY_FORCED_PARITY_0 = 4
  • RS232_BRICKLET_STOPBITS_1 = 1
  • RS232_BRICKLET_STOPBITS_2 = 2
  • RS232_BRICKLET_WORDLENGTH_5 = 5
  • RS232_BRICKLET_WORDLENGTH_6 = 6
  • RS232_BRICKLET_WORDLENGTH_7 = 7
  • RS232_BRICKLET_WORDLENGTH_8 = 8
  • RS232_BRICKLET_HARDWARE_FLOWCONTROL_OFF = 0
  • RS232_BRICKLET_HARDWARE_FLOWCONTROL_ON = 1
  • RS232_BRICKLET_SOFTWARE_FLOWCONTROL_OFF = 0
  • RS232_BRICKLET_SOFTWARE_FLOWCONTROL_ON = 1
pub fn Rs232Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>

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

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

  • RS232_BRICKLET_BAUDRATE_300 = 0
  • RS232_BRICKLET_BAUDRATE_600 = 1
  • RS232_BRICKLET_BAUDRATE_1200 = 2
  • RS232_BRICKLET_BAUDRATE_2400 = 3
  • RS232_BRICKLET_BAUDRATE_4800 = 4
  • RS232_BRICKLET_BAUDRATE_9600 = 5
  • RS232_BRICKLET_BAUDRATE_14400 = 6
  • RS232_BRICKLET_BAUDRATE_19200 = 7
  • RS232_BRICKLET_BAUDRATE_28800 = 8
  • RS232_BRICKLET_BAUDRATE_38400 = 9
  • RS232_BRICKLET_BAUDRATE_57600 = 10
  • RS232_BRICKLET_BAUDRATE_115200 = 11
  • RS232_BRICKLET_BAUDRATE_230400 = 12
  • RS232_BRICKLET_PARITY_NONE = 0
  • RS232_BRICKLET_PARITY_ODD = 1
  • RS232_BRICKLET_PARITY_EVEN = 2
  • RS232_BRICKLET_PARITY_FORCED_PARITY_1 = 3
  • RS232_BRICKLET_PARITY_FORCED_PARITY_0 = 4
  • RS232_BRICKLET_STOPBITS_1 = 1
  • RS232_BRICKLET_STOPBITS_2 = 2
  • RS232_BRICKLET_WORDLENGTH_5 = 5
  • RS232_BRICKLET_WORDLENGTH_6 = 6
  • RS232_BRICKLET_WORDLENGTH_7 = 7
  • RS232_BRICKLET_WORDLENGTH_8 = 8
  • RS232_BRICKLET_HARDWARE_FLOWCONTROL_OFF = 0
  • RS232_BRICKLET_HARDWARE_FLOWCONTROL_ON = 1
  • RS232_BRICKLET_SOFTWARE_FLOWCONTROL_OFF = 0
  • RS232_BRICKLET_SOFTWARE_FLOWCONTROL_ON = 1
pub fn Rs232Bricklet::set_break_condition(&self, break_time: u16) → ConvertingReceiver<()>

Setzt eine Break Condition (die TX-Ausgabe wird fest of logisch 0 gezwungen). Der Parameter setzt die Haltezeit der Break Condition (in ms).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

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

  • RS232_BRICKLET_FUNCTION_ENABLE_READ_CALLBACK = 3
  • RS232_BRICKLET_FUNCTION_DISABLE_READ_CALLBACK = 4
  • RS232_BRICKLET_FUNCTION_SET_CONFIGURATION = 6
  • RS232_BRICKLET_FUNCTION_SET_BREAK_CONDITION = 10
pub fn Rs232Bricklet::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 Konstanten sind für diese Funktion verfügbar:

  • RS232_BRICKLET_FUNCTION_ENABLE_READ_CALLBACK = 3
  • RS232_BRICKLET_FUNCTION_DISABLE_READ_CALLBACK = 4
  • RS232_BRICKLET_FUNCTION_SET_CONFIGURATION = 6
  • RS232_BRICKLET_FUNCTION_SET_BREAK_CONDITION = 10
pub fn Rs232Bricklet::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 Rs232Bricklet::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 Rs232Bricklet::enable_read_callback(&self) → ConvertingReceiver<()>

Aktiviert den Rs232Bricklet::get_read_callback_receiver Callback.

Im Startzustand ist der Callback deaktiviert

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

Deaktiviert den Rs232Bricklet::get_read_callback_receiver Callback.

Im Startzustand ist der Callback deaktiviert

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

Gibt true zurück falls Rs232Bricklet::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 Rs232Bricklet::get_read_callback_receiver(&self) → ConvertingCallbackReceiver<ReadEvent>

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

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen. Die Nachricht hat eine Maximalgröße von 60 Zeichen. Die Länge der Nachricht wird zusätzlich übergeben.

Dieser Callback kann durch Rs232Bricklet::enable_read_callback aktiviert werden.

pub fn Rs232Bricklet::get_error_callback_receiver(&self) → ConvertingCallbackReceiver<u8>

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

Dieser Callback wird aufgerufen wenn ein Fehler auftritt. Mögliche Fehler sind Overrun-, Parity- oder Framing-Fehler.

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

  • RS232_BRICKLET_ERROR_OVERRUN = 1
  • RS232_BRICKLET_ERROR_PARITY = 2
  • RS232_BRICKLET_ERROR_FRAMING = 4

Neu in Version 2.0.1 (Plugin).

Konstanten

Rs232Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS232 Bricklet zu identifizieren.

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

Rs232Bricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.