Rust - RS485 Bricklet¶

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

Modbus Slave¶

Download (example_modbus_slave.rs)

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, rs485_bricklet::*};

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

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

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

    // Set operating mode to Modbus RTU slave
    rs485.set_mode(RS485_BRICKLET_MODE_MODBUS_SLAVE_RTU);

    // Modbus specific configuration:
    // - slave address = 17
    // - master request timeout = 0ms (unused in slave mode)
    rs485.set_modbus_configuration(17, 0);

    let modbus_slave_write_single_register_request_receiver = rs485.get_modbus_slave_write_single_register_request_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `rs485` object
    // is dropped, so there is no need for manual cleanup.
    let rs485_copy = rs485.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 request in modbus_slave_write_single_register_request_receiver {
            println!("Request ID: {}", request.request_id);
            println!("Register Address: {}", request.register_address);
            println!("Register Value: {}", request.register_value);
            if request.register_address != 42 {
                println!("Error: Invalid register address");
                rs485_copy.modbus_slave_report_exception(request.request_id, RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
            } else {
                rs485_copy.modbus_slave_answer_write_single_register_request(request.request_id);
            }
        }
    });

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Modbus Master¶

Download (example_modbus_master.rs)

use std::{error::Error, io, sync::mpsc::channel, thread};
use tinkerforge::{ip_connection::IpConnection, rs485_bricklet::*};

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

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

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

    // Set operating mode to Modbus RTU master
    rs485.set_mode(RS485_BRICKLET_MODE_MODBUS_MASTER_RTU);

    // Modbus specific configuration:
    // - slave address = 1 (unused in master mode)
    // - master request timeout = 1000ms
    rs485.set_modbus_configuration(1, 1000);

    let modbus_master_write_single_register_response_receiver = rs485.get_modbus_master_write_single_register_response_callback_receiver();

    //Create channel to send expected request id to the event handling thread.
    let (tx, rx) = channel();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `rs485` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for response in modbus_master_write_single_register_response_receiver {
            println!("Request ID: {}", response.request_id);
            println!("Exception Code: {}", response.exception_code);
            let expected_request_id = rx.recv().unwrap();
            if response.request_id != expected_request_id {
                println!("Error: Unexpected request ID");
            }
        }
    });

    // Write 65535 to register 42 of slave 17
    let expected_request_id = rs485.modbus_master_write_single_register(17, 42, 65535).recv()?;
    tx.send(expected_request_id)?;

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Loopback¶

Download (example_loopback.rs)

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, rs485_bricklet::*};

// For this example connect the RX+/- pins to TX+/- pins on the same Bricklet
// and configure the DIP switch on the Bricklet to full-duplex mode

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

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

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

    // Enable full-duplex mode
    rs485.set_rs485_configuration(
        115200,
        RS485_BRICKLET_PARITY_NONE,
        RS485_BRICKLET_STOPBITS_1,
        RS485_BRICKLET_WORDLENGTH_8,
        RS485_BRICKLET_DUPLEX_FULL,
    );

    let read_receiver = rs485.get_read_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `rs485` 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
    rs485.enable_read_callback();

    // Write "test" string
    rs485.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 Rs485Bricklet::new(uid: &str, ip_connection: &IpConnection) → Rs485Bricklet¶

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	rs485 – Typ: Rs485Bricklet

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

let rs485 = Rs485Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn Rs485Bricklet::write(&self, message: &[char]) → Result<usize, BrickletRecvTimeoutError>¶

Parameter:	message – Typ: &[char]
Rückgabe:	message_written – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1]

Schreibt Zeichen auf die RS485-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 Rs485Bricklet::set_rs485_configuration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

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

Parameter:	length – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	message – Typ: Vec<char>

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 nich aktiv ist. Siehe Rs485Bricklet::enable_read_callback() und Rs485Bricklet::get_read_callback_receiver() Callback.

pub fn Rs485Bricklet::set_rs485_configuration(&self, baudrate: u32, parity: u8, stopbits: u8, wordlength: u8, duplex: u8) → ConvertingReceiver<()>¶

Parameter:	baudrate – Typ: u32, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 8 duplex – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die Konfiguration für die RS485-Kommunikation.

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

Für parity:

RS485_BRICKLET_PARITY_NONE = 0
RS485_BRICKLET_PARITY_ODD = 1
RS485_BRICKLET_PARITY_EVEN = 2

Für stopbits:

RS485_BRICKLET_STOPBITS_1 = 1
RS485_BRICKLET_STOPBITS_2 = 2

Für wordlength:

RS485_BRICKLET_WORDLENGTH_5 = 5
RS485_BRICKLET_WORDLENGTH_6 = 6
RS485_BRICKLET_WORDLENGTH_7 = 7
RS485_BRICKLET_WORDLENGTH_8 = 8

Für duplex:

RS485_BRICKLET_DUPLEX_HALF = 0
RS485_BRICKLET_DUPLEX_FULL = 1

pub fn Rs485Bricklet::get_rs485_configuration(&self) → ConvertingReceiver<Rs485Configuration>¶

Rückgabeobjekt:	baudrate – Typ: u32, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 8 duplex – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von Rs485Bricklet::set_rs485_configuration() gesetzt.

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

Für parity:

RS485_BRICKLET_PARITY_NONE = 0
RS485_BRICKLET_PARITY_ODD = 1
RS485_BRICKLET_PARITY_EVEN = 2

Für stopbits:

RS485_BRICKLET_STOPBITS_1 = 1
RS485_BRICKLET_STOPBITS_2 = 2

Für wordlength:

RS485_BRICKLET_WORDLENGTH_5 = 5
RS485_BRICKLET_WORDLENGTH_6 = 6
RS485_BRICKLET_WORDLENGTH_7 = 7
RS485_BRICKLET_WORDLENGTH_8 = 8

Für duplex:

RS485_BRICKLET_DUPLEX_HALF = 0
RS485_BRICKLET_DUPLEX_FULL = 1

pub fn Rs485Bricklet::set_modbus_configuration(&self, slave_address: u8, master_request_timeout: u32) → ConvertingReceiver<()>¶

Parameter:	slave_address – Typ: u8, Wertebereich: [1 bis 247], Standardwert: 1 master_request_timeout – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000

Setzt die Konfiguration für die RS485 Modbus Kommunikation. Verfügbare Optionen:

Slave Address: Addresse die vom Modbus-Slave im Modbus-Slave Modus genutzt wird. Der gültige Adressbereich ist 1 bis 247.
Master Request Timeout: Spezifiziert wie lange der Modbus-Master auf eine Antwort von einem Modbus-Slave wartet.

pub fn Rs485Bricklet::get_modbus_configuration(&self) → ConvertingReceiver<ModbusConfiguration>¶

Rückgabeobjekt:	slave_address – Typ: u8, Wertebereich: [1 bis 247], Standardwert: 1 master_request_timeout – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000

Gibt die Konfiguration zurück, wie von Rs485Bricklet::set_modbus_configuration() gesetzt.

pub fn Rs485Bricklet::set_mode(&self, mode: u8) → ConvertingReceiver<()>¶

Parameter:	mode – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Modus des Bricklets. Verfügbare Optionen sind

RS485,
Modbus-Master-RTU und
Modbus-Slave-RTU.

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

Für mode:

RS485_BRICKLET_MODE_RS485 = 0
RS485_BRICKLET_MODE_MODBUS_MASTER_RTU = 1
RS485_BRICKLET_MODE_MODBUS_SLAVE_RTU = 2

pub fn Rs485Bricklet::get_mode(&self) → ConvertingReceiver<u8>¶

Rückgabe:	mode – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von Rs485Bricklet::set_mode() gesetzt.

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

Für mode:

RS485_BRICKLET_MODE_RS485 = 0
RS485_BRICKLET_MODE_MODBUS_MASTER_RTU = 1
RS485_BRICKLET_MODE_MODBUS_SLAVE_RTU = 2

Fortgeschrittene Funktionen¶

pub fn Rs485Bricklet::set_communication_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die RS485 Kommunikation durch Aufblinken an.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

RS485_BRICKLET_COMMUNICATION_LED_CONFIG_OFF = 0
RS485_BRICKLET_COMMUNICATION_LED_CONFIG_ON = 1
RS485_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

pub fn Rs485Bricklet::get_communication_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von Rs485Bricklet::set_communication_led_config() gesetzt.

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

Für config:

RS485_BRICKLET_COMMUNICATION_LED_CONFIG_OFF = 0
RS485_BRICKLET_COMMUNICATION_LED_CONFIG_ON = 1
RS485_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

pub fn Rs485Bricklet::set_error_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe Rs485Bricklet::get_error_count_callback_receiver() Callback). Wenn diese Funktion danach nochmal mit der "SHOW ERROR"-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

RS485_BRICKLET_ERROR_LED_CONFIG_OFF = 0
RS485_BRICKLET_ERROR_LED_CONFIG_ON = 1
RS485_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR = 3

pub fn Rs485Bricklet::get_error_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von Rs485Bricklet::set_error_led_config() gesetzt.

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

Für config:

RS485_BRICKLET_ERROR_LED_CONFIG_OFF = 0
RS485_BRICKLET_ERROR_LED_CONFIG_ON = 1
RS485_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR = 3

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

Parameter:	send_buffer_size – Typ: u16, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 receive_buffer_size – Typ: u16, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120

Setzt die Größe des Senden- und Empfangsbuffers. In Summe können die Buffer eine Größe von 10240 Byte (10KiB) haben, die Minimalgröße ist 1024 Byte (1KiB) für beide.

Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.

Der Sendenbuffer hält die Daten welche über Rs485Bricklet::write() übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS485 empfangen wurden aber noch nicht über Rs485Bricklet::read() oder Rs485Bricklet::get_read_callback_receiver() Callback an ein Nutzerprogramm übertragen werden konnten.

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

Rückgabeobjekt:	send_buffer_size – Typ: u16, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 receive_buffer_size – Typ: u16, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120

Gibt die Buffer-Konfiguration zurück, wie von Rs485Bricklet::set_buffer_config() gesetzt.

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

Rückgabeobjekt:	send_buffer_used – Typ: u16, Einheit: 1 B, Wertebereich: [0 bis 9216] receive_buffer_used – Typ: u16, Einheit: 1 B, Wertebereich: [0 bis 9216]

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

Siehe Rs485Bricklet::set_buffer_config() zur Konfiguration der Buffergrößen.

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

Rückgabeobjekt:	overrun_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1] parity_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]

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

pub fn Rs485Bricklet::get_modbus_common_error_count(&self) → ConvertingReceiver<ModbusCommonErrorCount>¶

Rückgabeobjekt:

Rückgabeobjekt:	timeout_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1] checksum_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1] frame_too_big_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1] illegal_function_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1] illegal_data_address_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1] illegal_data_value_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1] slave_device_failure_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]

timeout_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]
checksum_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]
frame_too_big_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]
illegal_function_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]
illegal_data_address_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]
illegal_data_value_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]
slave_device_failure_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]

Gibt die aktuelle Fehleranzahl für verschiedene Fehlerarten Modbus-Modus zurück.

Timeout Error Count: Anzahl Timeouts.
Checksum Error Count: Anzahl von Modbus CRC16 Checksummen-Fehlern.
Frame Too Big Error Count: Anzahl von verworfenen Frames auf Grund einer zu großen Frame Größe (maximal 256 Byte).
Illegal Function Error Count: Anzahl der Anfragen von nicht-implementierten oder illegalen Funktionen. Entsprocht Modbus Exception Code 1.
Illegal Data Address Error Count: Anzahl der Anfragen mit ungütiger Adresse. Entspricht Modbus Exception Code 2.
Illegal Data Value Error Count: Anzahl der Anfragen mit ungültigem Datenwert. Entspricht Modbus Exception Code 3.
Slave Device Failure Error Count: Anzahl der nicht-behebaren Fehler eines Slaves. Entspricht Modbus Exception Code 4.

pub fn Rs485Bricklet::modbus_slave_report_exception(&self, request_id: u8, exception_code: i8) → ConvertingReceiver<()>¶

Parameter:	request_id – Typ: u8, Wertebereich: [0 bis 255] exception_code – Typ: i8, Wertebereich: Siehe Konstanten

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Modbus Exception auf eine Modbus-Master Anfrage zurückzugeben.

Request ID: Request ID einer Anfrage eines Slaves.
Exception Code: Modbus Exception Code für den Modbus Master.

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

Für exception_code:

RS485_BRICKLET_EXCEPTION_CODE_TIMEOUT = -1
RS485_BRICKLET_EXCEPTION_CODE_SUCCESS = 0
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_BRICKLET_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_BRICKLET_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

pub fn Rs485Bricklet::modbus_slave_answer_read_coils_request(&self, request_id: u8, coils: &[bool]) → Result<(), BrickletRecvTimeoutError>¶

Parameter:	request_id – Typ: u8, Wertebereich: [0 bis 255] coils – Typ: &[bool]

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Coils-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Coils: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom Rs485Bricklet::get_modbus_slave_read_coils_request_callback_receiver() Callback mit der Request ID des Callbacks aufgerufen werden.

pub fn Rs485Bricklet::modbus_master_read_coils(&self, slave_address: u8, starting_address: u32, count: u16) → ConvertingReceiver<u8>¶

Parameter:	slave_address – Typ: u8, Wertebereich: [0 bis 247] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] count – Typ: u16, Wertebereich: [1 bis 2000]
Rückgabe:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Coils-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 1).

Slave Addresss: Adresse des Modbus-Slave
Starting Address: Nummer der ersten zu lesenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
Count: Anzahl der zu lesenden Coils.

Nach erfolgreichen Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der Rs485Bricklet::get_modbus_master_read_coils_response_callback_receiver() Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

pub fn Rs485Bricklet::modbus_slave_answer_read_holding_registers_request(&self, request_id: u8, holding_registers: &[u16]) → Result<(), BrickletRecvTimeoutError>¶

Parameter:	request_id – Typ: u8, Wertebereich: [0 bis 255] holding_registers – Typ: &[u16], Wertebereich: [0 bis 2¹⁶ - 1]

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Holding Registers-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Holding Registers: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom Rs485Bricklet::get_modbus_slave_read_holding_registers_request_callback_receiver() Callback mit der Request ID des Callbacks aufgerufen werden.

pub fn Rs485Bricklet::modbus_master_read_holding_registers(&self, slave_address: u8, starting_address: u32, count: u16) → ConvertingReceiver<u8>¶

Parameter:	slave_address – Typ: u8, Wertebereich: [0 bis 247] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] count – Typ: u16, Wertebereich: [1 bis 125]
Rückgabe:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Holding Register-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 3).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer des ersten zu lesenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.
Count: Anzahl der zu lesenden Register.

Nach erfolgreichem Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück, die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der Rs485Bricklet::get_modbus_master_read_holding_registers_response_callback_receiver() Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

pub fn Rs485Bricklet::modbus_slave_answer_write_single_coil_request(&self, request_id: u8) → ConvertingReceiver<()>¶

Parameter:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Single Coil-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom Rs485Bricklet::get_modbus_slave_write_single_coil_request_callback_receiver() Callback mit der Request ID des Callbacks aufgerufen werden.

pub fn Rs485Bricklet::modbus_master_write_single_coil(&self, slave_address: u8, coil_address: u32, coil_value: bool) → ConvertingReceiver<u8>¶

Parameter:	slave_address – Typ: u8, Wertebereich: [0 bis 247] coil_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] coil_value – Typ: bool
Rückgabe:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine einzelne Coil eines Modbus-Slave zu schreiben (Modbus Funktionscode 5).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Coil Address: Nummer der zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
Coil Value: Zu schreibender Wert

Falls kein Fehler auftritt, wird auch der Rs485Bricklet::get_modbus_master_write_single_coil_response_callback_receiver() Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

pub fn Rs485Bricklet::modbus_slave_answer_write_single_register_request(&self, request_id: u8) → ConvertingReceiver<()>¶

Parameter:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Write Single Register-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom Rs485Bricklet::get_modbus_slave_write_single_register_request_callback_receiver() Callback mit der Request ID des Callbacks aufgerufen werden.

pub fn Rs485Bricklet::modbus_master_write_single_register(&self, slave_address: u8, register_address: u32, register_value: u16) → ConvertingReceiver<u8>¶

Parameter:	slave_address – Typ: u8, Wertebereich: [0 bis 247] register_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] register_value – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um ein einzelnes Register eines Modbus-Slave zu schreiben (Modbus Funktionscode 6).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Register Address: Nummer des zu schreibenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.
Register Value: Zu schreibender Wert

Falls kein Fehler auftritt, wird auch der Rs485Bricklet::get_modbus_master_write_single_register_response_callback_receiver() Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

pub fn Rs485Bricklet::modbus_slave_answer_write_multiple_coils_request(&self, request_id: u8) → ConvertingReceiver<()>¶

Parameter:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Write Multiple Coils-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom Rs485Bricklet::get_modbus_slave_write_multiple_coils_request_callback_receiver() Callback mit der Request ID des Callbacks aufgerufen werden.

pub fn Rs485Bricklet::modbus_master_write_multiple_coils(&self, slave_address: u8, starting_address: u32, coils: &[bool]) → Result<u8, BrickletRecvTimeoutError>¶

Parameter:	slave_address – Typ: u8, Wertebereich: [0 bis 247] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] coils – Typ: &[bool]
Rückgabe:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine mehrere Coils eines Modbus-Slave zu schreiben (Modbus Funktionscode 15).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer der ersten zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Falls kein Fehler auftritt, wird auch der Rs485Bricklet::get_modbus_master_write_multiple_coils_response_callback_receiver() Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

pub fn Rs485Bricklet::modbus_slave_answer_write_multiple_registers_request(&self, request_id: u8) → ConvertingReceiver<()>¶

Parameter:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Write Multiple Register-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom Rs485Bricklet::get_modbus_slave_write_multiple_registers_request_callback_receiver() Callback mit der Request ID des Callbacks aufgerufen werden.

pub fn Rs485Bricklet::modbus_master_write_multiple_registers(&self, slave_address: u8, starting_address: u32, registers: &[u16]) → Result<u8, BrickletRecvTimeoutError>¶

Parameter:	slave_address – Typ: u8, Wertebereich: [0 bis 247] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] registers – Typ: &[u16], Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um ein oder mehrere Holding Register eines Modbus-Slave zu schreiben (Modbus Funktionscode 16).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer des ersten zu schreibenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.

Falls kein Fehler auftritt, wird auch der Rs485Bricklet::get_modbus_master_write_multiple_registers_response_callback_receiver() Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

pub fn Rs485Bricklet::modbus_slave_answer_read_discrete_inputs_request(&self, request_id: u8, discrete_inputs: &[bool]) → Result<(), BrickletRecvTimeoutError>¶

Parameter:	request_id – Typ: u8, Wertebereich: [0 bis 255] discrete_inputs – Typ: &[bool]

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Discrete Inputs-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Discrete Inputs: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom Rs485Bricklet::get_modbus_slave_read_discrete_inputs_request_callback_receiver() Callback mit der Request ID des Callbacks aufgerufen werden.

pub fn Rs485Bricklet::modbus_master_read_discrete_inputs(&self, slave_address: u8, starting_address: u32, count: u16) → ConvertingReceiver<u8>¶

Parameter:	slave_address – Typ: u8, Wertebereich: [0 bis 247] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] count – Typ: u16, Wertebereich: [1 bis 2000]
Rückgabe:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Discrete Inputs-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 2).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer des ersten zu lesenden Discrete Inputs. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Discrete-Input-Nummer zwischen 1 und 65536. Die Präfixziffer 1 (für Discrete Input) ist implizit und muss ausgelassen werden.
Count: Anzahl der zu lesenden Register.

Falls kein Fehler auftritt, wird auch der Rs485Bricklet::get_modbus_master_read_discrete_inputs_response_callback_receiver() Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

pub fn Rs485Bricklet::modbus_slave_answer_read_input_registers_request(&self, request_id: u8, input_registers: &[u16]) → Result<(), BrickletRecvTimeoutError>¶

Parameter:	request_id – Typ: u8, Wertebereich: [0 bis 255] input_registers – Typ: &[u16], Wertebereich: [0 bis 2¹⁶ - 1]

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Input-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Input Registers: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom Rs485Bricklet::get_modbus_slave_read_input_registers_request_callback_receiver() Callback mit der Request ID des Callbacks aufgerufen werden.

pub fn Rs485Bricklet::modbus_master_read_input_registers(&self, slave_address: u8, starting_address: u32, count: u16) → ConvertingReceiver<u8>¶

Parameter:	slave_address – Typ: u8, Wertebereich: [0 bis 247] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] count – Typ: u16, Wertebereich: [1 bis 125]
Rückgabe:	request_id – Typ: u8, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Input-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 4).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer der ersten zu lesenden Input Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Input-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 3 (für Input Register) ist implizit und muss ausgelassen werden.
Count: Anzahl der zu lesenden Register.

Falls kein Fehler auftritt, wird auch der Rs485Bricklet::get_modbus_master_read_input_registers_response_callback_receiver() Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

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

Rückgabeobjekt:	error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: u32, Wertebereich: [0 bis 2³² - 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 Rs485Bricklet::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:

RS485_BRICKLET_STATUS_LED_CONFIG_OFF = 0
RS485_BRICKLET_STATUS_LED_CONFIG_ON = 1
RS485_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn Rs485Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von Rs485Bricklet::set_status_led_config() gesetzt.

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

Für config:

RS485_BRICKLET_STATUS_LED_CONFIG_OFF = 0
RS485_BRICKLET_STATUS_LED_CONFIG_ON = 1
RS485_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn Rs485Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>¶

Rückgabe:	temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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 Rs485Bricklet::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 Rs485Bricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Rückgabeobjekt:

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 2¹⁶ - 1]

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 2¹⁶ - 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 Rs485Bricklet::enable_read_callback(&self) → ConvertingReceiver<()>¶

Aktiviert den Rs485Bricklet::get_read_callback_receiver() Callback. Dies deaktiviert den Rs485Bricklet::get_frame_readable_callback_receiver() Callback.

Im Startzustand ist der Callback deaktiviert.

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

Deaktiviert den Rs485Bricklet::get_read_callback_receiver() Callback.

Im Startzustand ist der Callback deaktiviert.

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

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

Gibt true zurück falls Rs485Bricklet::get_read_callback_receiver() Callback aktiviert ist, false sonst.

pub fn Rs485Bricklet::enable_error_count_callback(&self) → ConvertingReceiver<()>¶

Aktiviert den Rs485Bricklet::get_error_count_callback_receiver() Callback.

Im Startzustand ist der Callback deaktiviert.

pub fn Rs485Bricklet::disable_error_count_callback(&self) → ConvertingReceiver<()>¶

Deaktiviert den Rs485Bricklet::get_error_count_callback_receiver() Callback.

Im Startzustand ist der Callback deaktiviert.

pub fn Rs485Bricklet::is_error_count_callback_enabled(&self) → ConvertingReceiver<bool>¶

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

Gibt true zurück falls Rs485Bricklet::get_error_count_callback_receiver() Callback aktiviert ist, false sonst.

pub fn Rs485Bricklet::set_frame_readable_callback_configuration(&self, frame_size: u16) → ConvertingReceiver<()>¶

Parameter:	frame_size – Typ: u16, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0

Konfiguriert den Rs485Bricklet::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 Rs485Bricklet::get_read_callback_receiver() Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.5$nbsp;(Plugin).

pub fn Rs485Bricklet::get_frame_readable_callback_configuration(&self) → ConvertingReceiver<u16>¶

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

Gibt die Callback-Konfiguration zurück, wie mittels Rs485Bricklet::set_frame_readable_callback_configuration() gesetzt.

Neu in Version 2.0.5$nbsp;(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.

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

Event:	message – Typ: Vec<char>

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 Rs485Bricklet::enable_read_callback() aktiviert werden.

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

Event-Objekt:	overrun_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1] parity_error_count – Typ: u32, Wertebereich: [0 bis 2³² - 1]

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 and Parity Fehler zurück.

pub fn Rs485Bricklet::get_modbus_slave_read_coils_request_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusSlaveReadCoilsRequestEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] count – Typ: u16, Wertebereich: [1 bis 2000]

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Slave Read Coils Request-Events.

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Coils erhält. Die Felder der empfangenen Struktur sind die Request ID der Anfrage, die Nummer der ersten zu lesenden Coil und die Anzahl der zu lesenden Coils. Die Nummer der ersten Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion Rs485Bricklet::modbus_slave_answer_read_coils_request() gesendet werden.

pub fn Rs485Bricklet::get_modbus_master_read_coils_response_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<bool, ModbusMasterReadCoilsResponseResult, ModbusMasterReadCoilsResponseLowLevelEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] exception_code – Typ: i8, Wertebereich: Siehe Konstanten coils – Typ: Vec<bool>

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Master Read Coils Response-Events.

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Coils-Anfrage zurück bekommt.

Die Felder der empfangenen Struktur sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per Rs485Bricklet::set_modbus_configuration() gesetzt werden.

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

Für exception_code:

RS485_BRICKLET_EXCEPTION_CODE_TIMEOUT = -1
RS485_BRICKLET_EXCEPTION_CODE_SUCCESS = 0
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_BRICKLET_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_BRICKLET_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

pub fn Rs485Bricklet::get_modbus_slave_read_holding_registers_request_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusSlaveReadHoldingRegistersRequestEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] count – Typ: u16, Wertebereich: [1 bis 125]

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Slave Read Holding Registers Request-Events.

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Holding Registern erhält. Die Felder der empfangenen Struktur sind die Request ID der Anfrage, die Nummer des ersten zu lesenden Holding Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion Rs485Bricklet::modbus_slave_answer_read_holding_registers_request() gesendet werden.

pub fn Rs485Bricklet::get_modbus_master_read_holding_registers_response_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<u16, ModbusMasterReadHoldingRegistersResponseResult, ModbusMasterReadHoldingRegistersResponseLowLevelEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] exception_code – Typ: i8, Wertebereich: Siehe Konstanten holding_registers – Typ: Vec<u16>, Wertebereich: [0 bis 2¹⁶ - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Master Read Holding Registers Response-Events.

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Holding Registers-Anfrage zurück bekommt.

Die Felder der empfangenen Struktur sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

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

Für exception_code:

RS485_BRICKLET_EXCEPTION_CODE_TIMEOUT = -1
RS485_BRICKLET_EXCEPTION_CODE_SUCCESS = 0
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_BRICKLET_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_BRICKLET_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

pub fn Rs485Bricklet::get_modbus_slave_write_single_coil_request_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusSlaveWriteSingleCoilRequestEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] coil_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] coil_value – Typ: bool

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Slave Write Single Coil Request-Events.

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer einzelnen Coil erhält. Die Felder der empfangenen Struktur sind die Request ID der Anfrage, die Nummer der Coil und der Wert der zu schreibenen Coil. Die Nummer der Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion Rs485Bricklet::modbus_slave_answer_write_single_coil_request() gesendet werden.

pub fn Rs485Bricklet::get_modbus_master_write_single_coil_response_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusMasterWriteSingleCoilResponseEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] exception_code – Typ: i8, Wertebereich: Siehe Konstanten

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Master Write Single Coil Response-Events.

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Single Coil-Anfrage zurück bekommt.

Die Felder der empfangenen Struktur sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

RS485_BRICKLET_EXCEPTION_CODE_TIMEOUT = -1
RS485_BRICKLET_EXCEPTION_CODE_SUCCESS = 0
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_BRICKLET_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_BRICKLET_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

pub fn Rs485Bricklet::get_modbus_slave_write_single_register_request_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusSlaveWriteSingleRegisterRequestEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] register_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] register_value – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Slave Write Single Register Request-Events.

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer einzelnen Holding Registers erhält. Die Felder der empfangenen Struktur sind die Request ID der Anfrage, die Nummer des Holding Registers und der Wert des zuschreibenen Registers. Die Nummer des Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion Rs485Bricklet::modbus_slave_answer_write_single_register_request() gesendet werden.

pub fn Rs485Bricklet::get_modbus_master_write_single_register_response_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusMasterWriteSingleRegisterResponseEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] exception_code – Typ: i8, Wertebereich: Siehe Konstanten

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Master Write Single Register Response-Events.

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Single Register-Anfrage zurück bekommt.

Die Felder der empfangenen Struktur sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

RS485_BRICKLET_EXCEPTION_CODE_TIMEOUT = -1
RS485_BRICKLET_EXCEPTION_CODE_SUCCESS = 0
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_BRICKLET_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_BRICKLET_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

pub fn Rs485Bricklet::get_modbus_slave_write_multiple_coils_request_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<bool, ModbusSlaveWriteMultipleCoilsRequestResult, ModbusSlaveWriteMultipleCoilsRequestLowLevelEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] coils – Typ: Vec<bool>

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Slave Write Multiple Coils Request-Events.

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer mehrerer Coils erhält. Die Felder der empfangenen Struktur sind die Request ID der Anfrage, die Nummer der ersten Coil und die zu schreibenen Daten. Die Nummer der ersten Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion Rs485Bricklet::modbus_slave_answer_write_multiple_coils_request() gesendet werden.

pub fn Rs485Bricklet::get_modbus_master_write_multiple_coils_response_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusMasterWriteMultipleCoilsResponseEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] exception_code – Typ: i8, Wertebereich: Siehe Konstanten

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Master Write Multiple Coils Response-Events.

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Multiple Coils-Anfrage zurück bekommt.

Die Felder der empfangenen Struktur sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

RS485_BRICKLET_EXCEPTION_CODE_TIMEOUT = -1
RS485_BRICKLET_EXCEPTION_CODE_SUCCESS = 0
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_BRICKLET_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_BRICKLET_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

pub fn Rs485Bricklet::get_modbus_slave_write_multiple_registers_request_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<u16, ModbusSlaveWriteMultipleRegistersRequestResult, ModbusSlaveWriteMultipleRegistersRequestLowLevelEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] registers – Typ: Vec<u16>, Wertebereich: [0 bis 2¹⁶ - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Slave Write Multiple Registers Request-Events.

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer mehrerer Holding Register erhält. Die Felder der empfangenen Struktur sind die Request ID der Anfrage, die Nummer des ersten Holding Registers und die zu schreibenen Daten. Die Nummer des ersten Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion Rs485Bricklet::modbus_slave_answer_write_multiple_registers_request() gesendet werden.

pub fn Rs485Bricklet::get_modbus_master_write_multiple_registers_response_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusMasterWriteMultipleRegistersResponseEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] exception_code – Typ: i8, Wertebereich: Siehe Konstanten

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Master Write Multiple Registers Response-Events.

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Multiple Register-Anfrage zurück bekommt.

Die Felder der empfangenen Struktur sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

RS485_BRICKLET_EXCEPTION_CODE_TIMEOUT = -1
RS485_BRICKLET_EXCEPTION_CODE_SUCCESS = 0
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_BRICKLET_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_BRICKLET_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

pub fn Rs485Bricklet::get_modbus_slave_read_discrete_inputs_request_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusSlaveReadDiscreteInputsRequestEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] count – Typ: u16, Wertebereich: [1 bis 2000]

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Slave Read Discrete Inputs Request-Events.

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Discrete Inputs erhält. Die Felder der empfangenen Struktur sind die Request ID der Anfrage, die Nummer des ersten Discrete Inputs und die Anzahl der zu lesenden Discrete Inputs. Die Nummer des ersten Discrete Inputs heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Discrete Input-Nummer zwischen 1 und 65536. Die Präfixziffer 1 (für Discrete Input) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion Rs485Bricklet::modbus_slave_answer_read_discrete_inputs_request() gesendet werden.

pub fn Rs485Bricklet::get_modbus_master_read_discrete_inputs_response_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<bool, ModbusMasterReadDiscreteInputsResponseResult, ModbusMasterReadDiscreteInputsResponseLowLevelEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] exception_code – Typ: i8, Wertebereich: Siehe Konstanten discrete_inputs – Typ: Vec<bool>

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Master Read Discrete Inputs Response-Events.

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Discrete Inputs-Anfrage zurück bekommt.

Die Felder der empfangenen Struktur sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

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

Für exception_code:

RS485_BRICKLET_EXCEPTION_CODE_TIMEOUT = -1
RS485_BRICKLET_EXCEPTION_CODE_SUCCESS = 0
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_BRICKLET_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_BRICKLET_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

pub fn Rs485Bricklet::get_modbus_slave_read_input_registers_request_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusSlaveReadInputRegistersRequestEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] starting_address – Typ: u32, Wertebereich: [1 bis 2¹⁶] count – Typ: u16, Wertebereich: [1 bis 125]

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Slave Read Input Registers Request-Events.

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Input Registern erhält. Die Felder der empfangenen Struktur sind die Request ID der Anfrage, die Nummer des ersten Input Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Input Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Input Register-Nummer zwischen 1 und 65536. Die Präfixziffer 3 (für Input Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion Rs485Bricklet::modbus_slave_answer_read_input_registers_request() gesendet werden.

pub fn Rs485Bricklet::get_modbus_master_read_input_registers_response_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<u16, ModbusMasterReadInputRegistersResponseResult, ModbusMasterReadInputRegistersResponseLowLevelEvent>¶

Event-Objekt:	request_id – Typ: u8, Wertebereich: [0 bis 255] exception_code – Typ: i8, Wertebereich: Siehe Konstanten input_registers – Typ: Vec<u16>, Wertebereich: [0 bis 2¹⁶ - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Modbus Master Read Input Registers Response-Events.

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Input Registers-Anfrage zurück bekommt.

Die Felder der empfangenen Struktur sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

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

Für exception_code:

RS485_BRICKLET_EXCEPTION_CODE_TIMEOUT = -1
RS485_BRICKLET_EXCEPTION_CODE_SUCCESS = 0
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_BRICKLET_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_BRICKLET_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_BRICKLET_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_BRICKLET_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_BRICKLET_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

pub fn Rs485Bricklet::get_frame_readable_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	frame_count – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1]

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 Rs485Bricklet::set_frame_readable_callback_configuration() konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro Rs485Bricklet::read() 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 Rs485Bricklet::read()-Funktion gelesen werden können, ohne dass der Frame Count-empfangene Variable geprüft werden muss.

Neu in Version 2.0.5$nbsp;(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 Rs485Bricklet::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 Rs485Bricklet::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 Rs485Bricklet::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:

RS485_BRICKLET_FUNCTION_ENABLE_READ_CALLBACK = 3
RS485_BRICKLET_FUNCTION_DISABLE_READ_CALLBACK = 4
RS485_BRICKLET_FUNCTION_SET_RS485_CONFIGURATION = 6
RS485_BRICKLET_FUNCTION_SET_MODBUS_CONFIGURATION = 8
RS485_BRICKLET_FUNCTION_SET_MODE = 10
RS485_BRICKLET_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
RS485_BRICKLET_FUNCTION_SET_ERROR_LED_CONFIG = 14
RS485_BRICKLET_FUNCTION_SET_BUFFER_CONFIG = 16
RS485_BRICKLET_FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
RS485_BRICKLET_FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
RS485_BRICKLET_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
RS485_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
RS485_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
RS485_BRICKLET_FUNCTION_RESET = 243
RS485_BRICKLET_FUNCTION_WRITE_UID = 248

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

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

Für function_id:

RS485_BRICKLET_FUNCTION_ENABLE_READ_CALLBACK = 3
RS485_BRICKLET_FUNCTION_DISABLE_READ_CALLBACK = 4
RS485_BRICKLET_FUNCTION_SET_RS485_CONFIGURATION = 6
RS485_BRICKLET_FUNCTION_SET_MODBUS_CONFIGURATION = 8
RS485_BRICKLET_FUNCTION_SET_MODE = 10
RS485_BRICKLET_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
RS485_BRICKLET_FUNCTION_SET_ERROR_LED_CONFIG = 14
RS485_BRICKLET_FUNCTION_SET_BUFFER_CONFIG = 16
RS485_BRICKLET_FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
RS485_BRICKLET_FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
RS485_BRICKLET_FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
RS485_BRICKLET_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
RS485_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
RS485_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
RS485_BRICKLET_FUNCTION_RESET = 243
RS485_BRICKLET_FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

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

RS485_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
RS485_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
RS485_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
RS485_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
RS485_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

RS485_BRICKLET_BOOTLOADER_STATUS_OK = 0
RS485_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
RS485_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
RS485_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
RS485_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
RS485_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn Rs485Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

Rückgabe:	mode – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe Rs485Bricklet::set_bootloader_mode().

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

Für mode:

RS485_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
RS485_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
RS485_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
RS485_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
RS485_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn Rs485Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>¶

Parameter:	pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Setzt den Firmware-Pointer für Rs485Bricklet::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 Rs485Bricklet::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 Rs485Bricklet::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 Rs485Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameter:	uid – Typ: u32, Wertebereich: [0 bis 2³² - 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 Rs485Bricklet::read_uid(&self) → ConvertingReceiver<u32>¶

Rückgabe:	uid – Typ: u32, Wertebereich: [0 bis 2³² - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

pub const Rs485Bricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein RS485 Bricklet zu identifizieren.

Die Rs485Bricklet::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 Rs485Bricklet::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines RS485 Bricklet dar.