Rust - RS485 Bricklet

This is the description of the Rust API bindings for the RS485 Bricklet. General information and technical specifications for the RS485 Bricklet are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

The example code below is Public Domain (CC0 1.0).

Modbus Slave

Download (example_modbus_slave.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, rs485_bricklet::*};

const HOST: &str = "127.0.0.1";
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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
use std::{error::Error, io, sync::mpsc::channel, thread};
use tinkerforge::{ip_connection::IpConnection, rs485_bricklet::*};

const HOST: &str = "127.0.0.1";
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 events.
    // 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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
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 = "127.0.0.1";
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 events.
    // 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

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occured.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

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

Creates a new Rs485Bricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IP connection has been connected (see examples above).

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

Writes characters to the RS485 interface. The characters can be binary data, ASCII or similar is not necessary.

The return value is the number of characters that were written.

See Rs485Bricklet::set_rs485_configuration for configuration possibilities regarding baudrate, parity and so on.

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

Returns up to length characters from receive buffer.

Instead of polling with this function, you can also use callbacks. But note that this function will return available data only when the read callback is disabled. See Rs485Bricklet::enable_read_callback and Rs485Bricklet::get_read_callback_receiver callback.

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

Sets the configuration for the RS485 communication. Available options:

  • Baudrate between 100 and 2000000 baud.
  • Parity of none, odd or even.
  • Stopbits can be 1 or 2.
  • Word length of 5 to 8.
  • Half- or Full-Duplex.

The default is: 115200 baud, parity none, 1 stop bit, word length 8, half duplex.

The following constants are available for this function:

  • RS485_BRICKLET_PARITY_NONE = 0
  • RS485_BRICKLET_PARITY_ODD = 1
  • RS485_BRICKLET_PARITY_EVEN = 2
  • RS485_BRICKLET_STOPBITS_1 = 1
  • RS485_BRICKLET_STOPBITS_2 = 2
  • RS485_BRICKLET_WORDLENGTH_5 = 5
  • RS485_BRICKLET_WORDLENGTH_6 = 6
  • RS485_BRICKLET_WORDLENGTH_7 = 7
  • RS485_BRICKLET_WORDLENGTH_8 = 8
  • RS485_BRICKLET_DUPLEX_HALF = 0
  • RS485_BRICKLET_DUPLEX_FULL = 1
pub fn Rs485Bricklet::get_rs485_configuration(&self) → ConvertingReceiver<Rs485Configuration>

Returns the configuration as set by Rs485Bricklet::set_rs485_configuration.

The following constants are available for this function:

  • RS485_BRICKLET_PARITY_NONE = 0
  • RS485_BRICKLET_PARITY_ODD = 1
  • RS485_BRICKLET_PARITY_EVEN = 2
  • RS485_BRICKLET_STOPBITS_1 = 1
  • RS485_BRICKLET_STOPBITS_2 = 2
  • RS485_BRICKLET_WORDLENGTH_5 = 5
  • RS485_BRICKLET_WORDLENGTH_6 = 6
  • RS485_BRICKLET_WORDLENGTH_7 = 7
  • RS485_BRICKLET_WORDLENGTH_8 = 8
  • 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<()>

Sets the configuration for the RS485 Modbus communication. Available options:

  • Slave Address: Address to be used as the Modbus slave address in Modbus slave mode. Valid Modbus slave address range is 1 to 247.
  • Master Request Timeout: Specifies how long the master should wait for a response from a slave in milliseconds when in Modbus master mode.

The default is: Slave Address = 1 and Master Request Timeout = 1000 milliseconds (1 second).

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

Returns the configuration as set by Rs485Bricklet::set_modbus_configuration.

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

Sets the mode of the Bricklet in which it operates. Available options are

  • RS485,
  • Modbus Master RTU and
  • Modbus Slave RTU.

The default is: RS485 mode.

The following constants are available for this function:

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

Returns the configuration as set by Rs485Bricklet::set_mode.

The following constants are available for this function:

  • RS485_BRICKLET_MODE_RS485 = 0
  • RS485_BRICKLET_MODE_MODBUS_MASTER_RTU = 1
  • RS485_BRICKLET_MODE_MODBUS_SLAVE_RTU = 2

Advanced Functions

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

Sets the communication LED configuration. By default the LED shows RS485 communication traffic by flickering.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

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

Returns the configuration as set by Rs485Bricklet::set_communication_led_config

The following constants are available for this function:

  • 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<()>

Sets the error LED configuration.

By default the error LED turns on if there is any error (see Rs485Bricklet::get_error_count_callback_receiver callback). If you call this function with the SHOW ERROR option again, the LED will turn off until the next error occurs.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

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

Returns the configuration as set by Rs485Bricklet::set_error_led_config.

The following constants are available for this function:

  • 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<()>

Sets the send and receive buffer size in byte. In sum there is 10240 byte (10kb) buffer available and the minimum buffer size is 1024 byte (1kb) for both.

The current buffer content is lost if this function is called.

The send buffer holds data that was given by Rs485Bricklet::write and could not be written yet. The receive buffer holds data that is received through RS485 but could not yet be send to the user, either by Rs485Bricklet::read or through Rs485Bricklet::get_read_callback_receiver callback.

The default configuration is 5120 byte (5kb) per buffer.

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

Returns the buffer configuration as set by Rs485Bricklet::set_buffer_config.

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

Returns the currently used bytes for the send and received buffer.

See Rs485Bricklet::set_buffer_config for buffer size configuration.

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

Returns the current number of overrun and parity errors.

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

Returns the current number of errors occurred in Modbus mode.

  • Timeout Error Count: Number of timeouts occurred.
  • Checksum Error Count: Number of failures due to Modbus frame CRC16 checksum mismatch.
  • Frame Too Big Error Count: Number of times frames were rejected because they exceeded maximum Modbus frame size which is 256 bytes.
  • Illegal Function Error Count: Number of errors when an unimplemented or illegal function is requested. This corresponds to Modbus exception code 1.
  • Illegal Data Address Error Count: Number of errors due to invalid data address. This corresponds to Modbus exception code 2.
  • Illegal Data Value Error Count: Number of errors due to invalid data value. This corresponds to Modbus exception code 3.
  • Slave Device Failure Error Count: Number of errors occurred on the slave device which were unrecoverable. This corresponds to Modbus exception code 4.
pub fn Rs485Bricklet::modbus_slave_report_exception(&self, request_id: u8, exception_code: i8) → ConvertingReceiver<()>

In Modbus slave mode this function can be used to report a Modbus exception for a Modbus master request.

  • Request ID: Request ID of the request received by the slave.
  • Exception Code: Modbus exception code to report to the Modbus master.

The following constants are available for this function:

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

In Modbus slave mode this function can be used to answer a master request to read coils.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Coils: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the Rs485Bricklet::get_modbus_slave_read_coils_request_callback_receiver callback with the Request ID as provided by the argument of the callback.

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

In Modbus master mode this function can be used to read coils from a slave. This function creates a Modbus function code 1 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of coils to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the Rs485Bricklet::get_modbus_master_read_coils_response_callback_receiver callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

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

In Modbus slave mode this function can be used to answer a master request to read holding registers.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Holding Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the Rs485Bricklet::get_modbus_slave_read_holding_registers_request_callback_receiver callback with the Request ID as provided by the argument of the callback.

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

In Modbus master mode this function can be used to read holding registers from a slave. This function creates a Modbus function code 3 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of holding registers to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the Rs485Bricklet::get_modbus_master_read_holding_registers_response_callback_receiver callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

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

In Modbus slave mode this function can be used to answer a master request to write a single coil.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the Rs485Bricklet::get_modbus_slave_write_single_coil_request_callback_receiver callback with the Request ID as provided by the arguments of the callback.

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

In Modbus master mode this function can be used to write a single coil of a slave. This function creates a Modbus function code 5 request.

  • Slave Address: Address of the target Modbus slave.
  • Coil Address: Address of the coil.
  • Coil Value: Value to be written.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the Rs485Bricklet::get_modbus_master_write_single_coil_response_callback_receiver callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

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

In Modbus slave mode this function can be used to answer a master request to write a single register.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the Rs485Bricklet::get_modbus_slave_write_single_register_request_callback_receiver callback with the Request ID, Register Address and Register Value as provided by the arguments of the callback.

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

In Modbus master mode this function can be used to write a single register of a slave. This function creates a Modbus function code 6 request.

  • Slave Address: Address of the target Modbus slave.
  • Register Address: Address of the register.
  • Register Value: Value to be written.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the Rs485Bricklet::get_modbus_master_write_single_register_response_callback_receiver callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

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

In Modbus slave mode this function can be used to answer a master request to write multiple coils.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the Rs485Bricklet::get_modbus_slave_write_multiple_coils_request_callback_receiver callback with the Request ID of the callback.

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

In Modbus master mode this function can be used to write multiple coils of a slave. This function creates a Modbus function code 15 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the write.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the Rs485Bricklet::get_modbus_master_write_multiple_coils_response_callback_receiver callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

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

In Modbus slave mode this function can be used to answer a master request to write multiple registers.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the Rs485Bricklet::get_modbus_slave_write_multiple_registers_request_callback_receiver callback with the Request ID of the callback.

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

In Modbus master mode this function can be used to write multiple registers of a slave. This function creates a Modbus function code 16 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting Address of the write.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the Rs485Bricklet::get_modbus_master_write_multiple_registers_response_callback_receiver callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

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

In Modbus slave mode this function can be used to answer a master request to read discrete inputs.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Discrete Inputs: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the Rs485Bricklet::get_modbus_slave_read_discrete_inputs_request_callback_receiver callback with the Request ID as provided by the argument of the callback.

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

In Modbus master mode this function can be used to read discrete inputs from a slave. This function creates a Modbus function code 2 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of discrete inputs to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the Rs485Bricklet::get_modbus_master_read_discrete_inputs_response_callback_receiver callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

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

In Modbus slave mode this function can be used to answer a master request to read input registers.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Input Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the Rs485Bricklet::get_modbus_slave_read_input_registers_request_callback_receiver callback with the Request ID as provided by the argument of the callback.

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

In Modbus master mode this function can be used to read input registers from a slave. This function creates a Modbus function code 4 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of input registers to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the Rs485Bricklet::get_modbus_master_read_input_registers_response_callback_receiver callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

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

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

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

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by Rs485Bricklet::set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See Rs485Bricklet::set_response_expected for the list of function ID constants available for this function.

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

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • 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_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) → ()

Changes the response expected flag for all setter and callback configuration functions of this device at once.

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

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

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

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

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

Returns the current bootloader mode, see Rs485Bricklet::set_bootloader_mode.

The following constants are available for this function:

  • 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<()>

Sets the firmware pointer for Rs485Bricklet::write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

pub fn Rs485Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Writes 64 Bytes of firmware at the position as written by Rs485Bricklet::set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

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

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

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

Returns the configuration as set by Rs485Bricklet::set_status_led_config

The following constants are available for this function:

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

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

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

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

pub fn Rs485Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

pub fn Rs485Bricklet::read_uid(&self) → ConvertingReceiver<u32>

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

pub fn Rs485Bricklet::get_identity(&self) → ConvertingReceiver<Identity>

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

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

Enables the Rs485Bricklet::get_read_callback_receiver callback.

By default the callback is disabled.

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

Disables the Rs485Bricklet::get_read_callback_receiver callback.

By default the callback is disabled.

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

Returns true if the Rs485Bricklet::get_read_callback_receiver callback is enabled, false otherwise.

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

Enables the Rs485Bricklet::get_error_count_callback_receiver callback.

By default the callback is disabled.

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

Disables the Rs485Bricklet::get_error_count_callback_receiver callback.

By default the callback is disabled.

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

Returns true if the Rs485Bricklet::get_error_count_callback_receiver callback is enabled, false otherwise.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

pub fn Rs485Bricklet::get_read_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<char, ReadResult, ReadLowLevelEvent>

Receivers created with this function receive Read events.

This callback is called if new data is available.

To enable this callback, use Rs485Bricklet::enable_read_callback.

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

Receivers created with this function receive Error Count events.

This callback is called if a new error occurs. It returns the current overrun and parity error count.
pub fn Rs485Bricklet::get_modbus_slave_read_coils_request_callback_receiver(&self) → ConvertingCallbackReceiver<ModbusSlaveReadCoilsRequestEvent>

Receivers created with this function receive Modbus Slave Read Coils Request events.

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read coils. The members of the received struct are request ID of the request, the starting address and the number of coils to be read as received by the request.

To send a response of this request use Rs485Bricklet::modbus_slave_answer_read_coils_request.

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

Receivers created with this function receive Modbus Master Read Coils Response events.

This callback is called only in Modbus master mode when the master receives a valid response of a request to read coils.

The members of the received struct are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by Rs485Bricklet::set_modbus_configuration.

The following constants are available for this function:

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

Receivers created with this function receive Modbus Slave Read Holding Registers Request events.

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read holding registers. The members of the received struct are request ID of the request, the starting address and the number of holding registers to be read as received by the request.

To send a response of this request use Rs485Bricklet::modbus_slave_answer_read_holding_registers_request.

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

Receivers created with this function receive Modbus Master Read Holding Registers Response events.

This callback is called only in Modbus master mode when the master receives a valid response of a request to read holding registers.

The members of the received struct are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by Rs485Bricklet::set_modbus_configuration.

The following constants are available for this function:

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

Receivers created with this function receive Modbus Slave Write Single Coil Request events.

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write a single coil. The members of the received struct are request ID of the request, the coil address and the value of coil to be written as received by the request.

To send a response of this request use Rs485Bricklet::modbus_slave_answer_write_single_coil_request.

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

Receivers created with this function receive Modbus Master Write Single Coil Response events.

This callback is called only in Modbus master mode when the master receives a valid response of a request to write a single coil.

The members of the received struct are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by Rs485Bricklet::set_modbus_configuration.

The following constants are available for this function:

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

Receivers created with this function receive Modbus Slave Write Single Register Request events.

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write a single register. The members of the received struct are request ID of the request, the register address and the register value to be written as received by the request.

To send a response of this request use Rs485Bricklet::modbus_slave_answer_write_single_register_request.

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

Receivers created with this function receive Modbus Master Write Single Register Response events.

This callback is called only in Modbus master mode when the master receives a valid response of a request to write a single register.

The members of the received struct are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by Rs485Bricklet::set_modbus_configuration.

The following constants are available for this function:

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

Receivers created with this function receive Modbus Slave Write Multiple Coils Request events.

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write multiple coils. The members of the received struct are request ID of the request, the starting address and the data to be written as received by the request.

To send a response of this request use Rs485Bricklet::modbus_slave_answer_write_multiple_coils_request.

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

Receivers created with this function receive Modbus Master Write Multiple Coils Response events.

This callback is called only in Modbus master mode when the master receives a valid response of a request to read coils.

The members of the received struct are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by Rs485Bricklet::set_modbus_configuration.

The following constants are available for this function:

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

Receivers created with this function receive Modbus Slave Write Multiple Registers Request events.

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write multiple registers. The members of the received struct are request ID of the request, the starting address and the data to be written as received by the request.

To send a response of this request use Rs485Bricklet::modbus_slave_answer_write_multiple_registers_request.

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

Receivers created with this function receive Modbus Master Write Multiple Registers Response events.

This callback is called only in Modbus master mode when the master receives a valid response of a request to write multiple registers.

The members of the received struct are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by Rs485Bricklet::set_modbus_configuration.

The following constants are available for this function:

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

Receivers created with this function receive Modbus Slave Read Discrete Inputs Request events.

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read discrete inputs. The members of the received struct are request ID of the request, the starting address and the number of discrete inputs to be read as received by the request.

To send a response of this request use Rs485Bricklet::modbus_slave_answer_read_discrete_inputs_request.

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

Receivers created with this function receive Modbus Master Read Discrete Inputs Response events.

This callback is called only in Modbus master mode when the master receives a valid response of a request to read discrete inputs.

The members of the received struct are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by Rs485Bricklet::set_modbus_configuration.

The following constants are available for this function:

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

Receivers created with this function receive Modbus Slave Read Input Registers Request events.

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read input registers. The members of the received struct are request ID of the request, the starting address and the number of input registers to be read as received by the request.

To send a response of this request use Rs485Bricklet::modbus_slave_answer_read_input_registers_request.

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

Receivers created with this function receive Modbus Master Read Input Registers Response events.

This callback is called only in Modbus master mode when the master receives a valid response of a request to read input registers.

The members of the received struct are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by Rs485Bricklet::set_modbus_configuration.

The following constants are available for this function:

  • 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

Constants

Rs485Bricklet::DEVICE_IDENTIFIER

This constant is used to identify a RS485 Bricklet.

The Rs485Bricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

Rs485Bricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a RS485 Bricklet.