Rust - RS232 Bricklet¶

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 = "localhost";
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 callback messages.
    // 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(())
}

Grundfunktionen¶

pub fn Rs232Bricklet::new(uid: &str, ip_connection: &IpConnection) → Rs232Bricklet¶

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	rs232 – Typ: Rs232Bricklet

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

let rs232 = Rs232Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn Rs232Bricklet::write(&self, message: [char; 60], length: u8) → ConvertingReceiver<u8>¶

Parameter:	message – Typ: [char; 60] length – Typ: u8, Wertebereich: [0 bis 60]
Rückgabe:	written – Typ: u8, Wertebereich: [0 bis 60]

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>¶

Rückgabeobjekt:	message – Typ: [char; 60] length – Typ: u8, Wertebereich: [0 bis 60]

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die zurückgegebene Länge 0 ist, 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<()>¶

Parameter:

baudrate – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 11 parity – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 8 hardware_flowcontrol – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0 software_flowcontrol – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die Konfiguration für die RS232-Kommunikation.

Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

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

Für baudrate:

• 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

Für parity:

• 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

Für stopbits:

• RS232_BRICKLET_STOPBITS_1 = 1
• RS232_BRICKLET_STOPBITS_2 = 2

Für wordlength:

• RS232_BRICKLET_WORDLENGTH_5 = 5
• RS232_BRICKLET_WORDLENGTH_6 = 6
• RS232_BRICKLET_WORDLENGTH_7 = 7
• RS232_BRICKLET_WORDLENGTH_8 = 8

Für hardware_flowcontrol:

• RS232_BRICKLET_HARDWARE_FLOWCONTROL_OFF = 0
• RS232_BRICKLET_HARDWARE_FLOWCONTROL_ON = 1

Für software_flowcontrol:

• RS232_BRICKLET_SOFTWARE_FLOWCONTROL_OFF = 0
• RS232_BRICKLET_SOFTWARE_FLOWCONTROL_ON = 1

pub fn Rs232Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>¶

Rückgabeobjekt:

baudrate – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 11 parity – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 8 hardware_flowcontrol – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0 software_flowcontrol – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für baudrate:

• 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

Für parity:

• 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

Für stopbits:

• RS232_BRICKLET_STOPBITS_1 = 1
• RS232_BRICKLET_STOPBITS_2 = 2

Für wordlength:

• RS232_BRICKLET_WORDLENGTH_5 = 5
• RS232_BRICKLET_WORDLENGTH_6 = 6
• RS232_BRICKLET_WORDLENGTH_7 = 7
• RS232_BRICKLET_WORDLENGTH_8 = 8

Für hardware_flowcontrol:

• RS232_BRICKLET_HARDWARE_FLOWCONTROL_OFF = 0
• RS232_BRICKLET_HARDWARE_FLOWCONTROL_ON = 1

Für software_flowcontrol:

• RS232_BRICKLET_SOFTWARE_FLOWCONTROL_OFF = 0
• RS232_BRICKLET_SOFTWARE_FLOWCONTROL_ON = 1

pub fn Rs232Bricklet::set_break_condition(&self, break_time: u16) → ConvertingReceiver<()>¶

Parameter:	break_time – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Neu in Version 2.0.2 (Plugin).

pub fn Rs232Bricklet::read_frame(&self) → ConvertingReceiver<ReadFrame>¶

Rückgabeobjekt:	message – Typ: [char; 60] length – Typ: u8, Wertebereich: [0 bis 60]

Gibt bis zu einem Frame an Daten aus dem Lesebuffer zurück. Die Größe eines Frames kann mit Rs232Bricklet::set_frame_readable_callback_configuration konfiguriert werden. Wenn die zurückgegebene Länge 0 ist, waren keine neuen Daten verfügbar.

Neu in Version 2.0.4 (Plugin).

Fortgeschrittene Funktionen¶

pub fn Rs232Bricklet::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', '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 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 Rs232Bricklet::enable_read_callback(&self) → ConvertingReceiver<()>¶

Aktiviert den Rs232Bricklet::get_read_callback_receiver Callback. Dies deaktiviert den Rs232Bricklet::get_frame_readable_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>¶

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

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

pub fn Rs232Bricklet::set_frame_readable_callback_configuration(&self, frame_size: u8) → ConvertingReceiver<()>¶

Parameter:	frame_size – Typ: u8, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0

Konfiguriert den Rs232Bricklet::get_frame_readable_callback_receiver Callback. Die Frame Size ist die Anzahl an Bytes, die lesbar sein müssen, damit der Callback auslöst. Eine Frame Size von 0 deaktiviert den Callback. Eine Frame Size größer als 0 aktiviert diesen und deaktiviert den Rs232Bricklet::get_read_callback_receiver Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.4 (Plugin).

pub fn Rs232Bricklet::get_frame_readable_callback_configuration(&self) → ConvertingReceiver<u8>¶

Rückgabe:	frame_size – Typ: u8, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels Rs232Bricklet::set_frame_readable_callback_configuration gesetzt.

Neu in Version 2.0.4 (Plugin).

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.

pub fn Rs232Bricklet::get_read_callback_receiver(&self) → ConvertingCallbackReceiver<ReadEvent>¶

Event-Objekt:	message – Typ: [char; 60] length – Typ: u8, Wertebereich: [1 bis 60]

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>¶

Event:	error – Typ: u8, Wertebereich: Siehe Konstanten

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:

Für error:

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

Neu in Version 2.0.1 (Plugin).

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

Event:	frame_count – Typ: u8, Wertebereich: [0 bis 255]

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

Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit Rs232Bricklet::set_frame_readable_callback_configuration konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro Rs232Bricklet::read oder Rs232Bricklet::read_frame Aufruf ausgelöst. Das heißt, dass wenn eine Framegröße von X Bytes konfiguriert wird, jedes Mal wenn das Callback ausgelöst wird, X Bytes mit der Rs232Bricklet::read_frame-Funktion gelesen werden können, ohne dass der Frame Count-empfangene Variable geprüft werden muss.

Neu in Version 2.0.4 (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 Rs232Bricklet::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 Rs232Bricklet::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 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:

Für function_id:

• 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
• RS232_BRICKLET_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

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

• 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
• RS232_BRICKLET_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

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

pub const Rs232Bricklet::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.