Struct tinkerforge::rs232_bricklet::Rs232Bricklet

pub struct Rs232Bricklet { /* private fields */ }

Communicates with RS232 devices

Implementations

impl Rs232Bricklet

pub const DEVICE_IDENTIFIER: u16 = 254u16

pub const DEVICE_DISPLAY_NAME: &'static str = "RS232 Bricklet"

pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> Rs232Bricklet

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

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 sent 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.

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 sent and errors are silently ignored, because they cannot be detected.

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.

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

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)

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

This receiver is called if at least one frame of data is readable. The frame size is configured with [set_frame_readable_callback_configuration]. The frame count parameter is the number of frames that can be read. This receiver is triggered only once until [read] or [read_frame] is called. This means, that if you have configured a frame size of X bytes, you can read exactly X bytes using the [read_frame] function, every time the receiver triggers without checking the frame count parameter.

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

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.

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

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

Instead of polling with this function, you can also use callbacks. See [enable_read_callback] and [get_read_callback_receiver] receiver.

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

Enables the [get_read_callback_receiver] receiver. This will disable the [get_frame_readable_callback_receiver] receiver.

By default the receiver is disabled.

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

Disables the [get_read_callback_receiver] receiver.

By default the receiver is disabled.

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

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

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.

Hard-/Software flow control can either be on or off but not both simultaneously on.

Associated constants:

• RS232_BRICKLET_BAUDRATE_300
• RS232_BRICKLET_BAUDRATE_600
• RS232_BRICKLET_BAUDRATE_1200
• RS232_BRICKLET_BAUDRATE_2400
• RS232_BRICKLET_BAUDRATE_4800
• RS232_BRICKLET_BAUDRATE_9600
• RS232_BRICKLET_BAUDRATE_14400
• RS232_BRICKLET_BAUDRATE_19200
• RS232_BRICKLET_BAUDRATE_28800
• RS232_BRICKLET_BAUDRATE_38400
• RS232_BRICKLET_BAUDRATE_57600
• RS232_BRICKLET_BAUDRATE_115200
• RS232_BRICKLET_BAUDRATE_230400
• RS232_BRICKLET_PARITY_NONE
• RS232_BRICKLET_PARITY_ODD
• RS232_BRICKLET_PARITY_EVEN
• RS232_BRICKLET_PARITY_FORCED_PARITY_1
• RS232_BRICKLET_PARITY_FORCED_PARITY_0
• RS232_BRICKLET_STOPBITS_1
• RS232_BRICKLET_STOPBITS_2
• RS232_BRICKLET_WORDLENGTH_5
• RS232_BRICKLET_WORDLENGTH_6
• RS232_BRICKLET_WORDLENGTH_7
• RS232_BRICKLET_WORDLENGTH_8
• RS232_BRICKLET_HARDWARE_FLOWCONTROL_OFF
• RS232_BRICKLET_HARDWARE_FLOWCONTROL_ON
• RS232_BRICKLET_SOFTWARE_FLOWCONTROL_OFF
• RS232_BRICKLET_SOFTWARE_FLOWCONTROL_ON

pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>

Returns the configuration as set by [set_configuration].

Associated constants:

• RS232_BRICKLET_BAUDRATE_300
• RS232_BRICKLET_BAUDRATE_600
• RS232_BRICKLET_BAUDRATE_1200
• RS232_BRICKLET_BAUDRATE_2400
• RS232_BRICKLET_BAUDRATE_4800
• RS232_BRICKLET_BAUDRATE_9600
• RS232_BRICKLET_BAUDRATE_14400
• RS232_BRICKLET_BAUDRATE_19200
• RS232_BRICKLET_BAUDRATE_28800
• RS232_BRICKLET_BAUDRATE_38400
• RS232_BRICKLET_BAUDRATE_57600
• RS232_BRICKLET_BAUDRATE_115200
• RS232_BRICKLET_BAUDRATE_230400
• RS232_BRICKLET_PARITY_NONE
• RS232_BRICKLET_PARITY_ODD
• RS232_BRICKLET_PARITY_EVEN
• RS232_BRICKLET_PARITY_FORCED_PARITY_1
• RS232_BRICKLET_PARITY_FORCED_PARITY_0
• RS232_BRICKLET_STOPBITS_1
• RS232_BRICKLET_STOPBITS_2
• RS232_BRICKLET_WORDLENGTH_5
• RS232_BRICKLET_WORDLENGTH_6
• RS232_BRICKLET_WORDLENGTH_7
• RS232_BRICKLET_WORDLENGTH_8
• RS232_BRICKLET_HARDWARE_FLOWCONTROL_OFF
• RS232_BRICKLET_HARDWARE_FLOWCONTROL_ON
• RS232_BRICKLET_SOFTWARE_FLOWCONTROL_OFF
• RS232_BRICKLET_SOFTWARE_FLOWCONTROL_ON

pub fn set_break_condition(&self, break_time: u16) -> ConvertingReceiver<()>

Sets a break condition (the TX output is forced to a logic 0 state). The parameter sets the hold-time of the break condition.

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

pub fn set_frame_readable_callback_configuration( &self, frame_size: u8 ) -> ConvertingReceiver<()>

Configures the [get_frame_readable_callback_receiver] receiver. The frame size is the number of bytes, that have to be readable to trigger the receiver. A frame size of 0 disables the receiver. A frame size greater than 0 enables the receiver and disables the [get_read_callback_receiver] receiver.

By default the receiver is disabled.

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

pub fn get_frame_readable_callback_configuration( &self ) -> ConvertingReceiver<u8>

Returns the receiver configuration as set by [set_frame_readable_callback_configuration].

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

pub fn read_frame(&self) -> ConvertingReceiver<ReadFrame>

Returns up to one frame of bytes from the read buffer. The frame size is configured with [set_frame_readable_callback_configuration]. If the returned length is 0, no new data was available.

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

pub fn 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’, ‘d’, ‘e’, ‘f’, ‘g’ or ‘h’ (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position ‘z’.

The device identifier numbers can be found here. |device_identifier_constant|

Trait Implementations

impl Clone for Rs232Bricklet

fn clone(&self) -> Rs232Bricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.