Struct tinkerforge::rs232_bricklet::Rs232Bricklet

source ·

pub struct Rs232Bricklet { /* private fields */ }

Expand description

Communicates with RS232 devices

Implementations

source

pub fn new(uid: &str, ip_connection: &IpConnection) -> Rs232Bricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

source

pub fn get_response_expected(
&mut self,
fun: Rs232BrickletFunction
) -> Result<bool, GetResponseExpectedError>

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 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 set_response_expected for the list of function ID constants available for this function.

source

pub fn set_response_expected(
 &mut self,
 fun: Rs232BrickletFunction,
 response_expected: bool
) -> Result<(), SetResponseExpectedError>

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.

source

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

source

pub fn get_read_callback_receiver(
&self
) -> ConvertingCallbackReceiver<ReadEvent>

This receiver is called if new data is available. The message has a maximum size of 60 characters. The actual length of the message is given in addition.

To enable this receiver, use Enable Read Receiver.

source

pub fn get_error_callback_receiver(&self) -> ConvertingCallbackReceiver<u8>

This receiver is called if an error occurs. Possible errors are overrun, parity or framing error.

.. versionadded:: 2.0.1$nbsp;(Plugin)

source

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

Writes a string of up to 60 characters to the RS232 interface. The string can be binary data, ASCII or similar is not necessary.

The length of the string has to be given as an additional parameter.

The return value is the number of bytes that could be written.

See Set Configuration for configuration possibilities regarding baudrate, parity and so on.

source

pub fn read(&self) -> ConvertingReceiver<Read>

Returns the currently buffered message. The maximum length of message is 60. If the length is given as 0, there was no new data available.

Instead of polling with this function, you can also use callbacks. See Enable Read Receiver and get_read_callback_receiver receiver.

source

pub fn enable_read_callback(&self) -> ConvertingReceiver<()>

Enables the get_read_callback_receiver receiver.

By default the receiver is disabled.

source

pub fn disable_read_callback(&self) -> ConvertingReceiver<()>

Disables the get_read_callback_receiver receiver.

By default the receiver is disabled.

source

pub fn is_read_callback_enabled(&self) -> ConvertingReceiver<bool>

Returns true if the get_read_callback_receiver receiver is enabled, false otherwise.

source

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

Sets the configuration for the RS232 communication. Available options:

Baudrate between 300 and 230400 baud.
Parity of none, odd, even or forced parity.
Stopbits can be 1 or 2.
Word length of 5 to 8.
Hard-/Software flow control can either be on or off but not both simultaneously on.

The default is: 115200 baud, parity none, 1 stop bit, word length 8, hard-/software flow control off.

Associated constants: