Struct Rs232V2Bricklet

pub struct Rs232V2Bricklet { /* private fields */ }

Communicates with RS232 devices

Implementations

impl Rs232V2Bricklet

pub const DEVICE_IDENTIFIER: u16 = 2_108u16

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

pub fn new(uid: Uid, connection: AsyncIpConnection) -> Rs232V2Bricklet

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: Rs232V2BrickletFunction, ) -> 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: Rs232V2BrickletFunction, 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 async fn get_read_low_level_callback_receiver( &mut self, ) -> impl Stream<Item = ReadLowLevelEvent>

See get_read_callback_receiver

pub async fn get_error_count_callback_receiver( &mut self, ) -> impl Stream<Item = ErrorCountEvent>

This receiver is called if a new error occurs. It returns the current overrun and parity error count.

pub async fn get_frame_readable_callback_receiver( &mut self, ) -> impl Stream<Item = u16>

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] is called. This means, that if you have configured a frame size of X bytes, you can read exactly X bytes using the [read] function, every time the receiver triggers without checking the frame count parameter.

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

pub async fn write_low_level( &mut self, message_length: u16, message_chunk_offset: u16, message_chunk_data: &[char; 60], ) -> Result<WriteLowLevel, TinkerforgeError>

Writes characters to the RS232 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 [set_configuration] for configuration possibilities regarding baud rate, parity and so on.

pub async fn read_low_level( &mut self, length: u16, ) -> Result<ReadLowLevel, TinkerforgeError>

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 receiver is disabled. See [enable_read_callback] and [get_read_callback_receiver] receiver.

pub async fn enable_read_callback(&mut self) -> Result<(), TinkerforgeError>

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

By default the receiver is disabled.

pub async fn disable_read_callback(&mut self) -> Result<(), TinkerforgeError>

Disables the [get_read_callback_receiver] receiver.

By default the receiver is disabled.

pub async fn is_read_callback_enabled( &mut self, ) -> Result<bool, TinkerforgeError>

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

pub async fn set_configuration( &mut self, baudrate: u32, parity: u8, stopbits: u8, wordlength: u8, flowcontrol: u8, ) -> Result<(), TinkerforgeError>

Sets the configuration for the RS232 communication.

Associated constants:

• RS232_V2_BRICKLET_PARITY_NONE
• RS232_V2_BRICKLET_PARITY_ODD
• RS232_V2_BRICKLET_PARITY_EVEN
• RS232_V2_BRICKLET_STOPBITS_1
• RS232_V2_BRICKLET_STOPBITS_2
• RS232_V2_BRICKLET_WORDLENGTH_5
• RS232_V2_BRICKLET_WORDLENGTH_6
• RS232_V2_BRICKLET_WORDLENGTH_7
• RS232_V2_BRICKLET_WORDLENGTH_8
• RS232_V2_BRICKLET_FLOWCONTROL_OFF
• RS232_V2_BRICKLET_FLOWCONTROL_SOFTWARE
• RS232_V2_BRICKLET_FLOWCONTROL_HARDWARE

pub async fn get_configuration( &mut self, ) -> Result<Configuration, TinkerforgeError>

Returns the configuration as set by [set_configuration].

Associated constants:

• RS232_V2_BRICKLET_PARITY_NONE
• RS232_V2_BRICKLET_PARITY_ODD
• RS232_V2_BRICKLET_PARITY_EVEN
• RS232_V2_BRICKLET_STOPBITS_1
• RS232_V2_BRICKLET_STOPBITS_2
• RS232_V2_BRICKLET_WORDLENGTH_5
• RS232_V2_BRICKLET_WORDLENGTH_6
• RS232_V2_BRICKLET_WORDLENGTH_7
• RS232_V2_BRICKLET_WORDLENGTH_8
• RS232_V2_BRICKLET_FLOWCONTROL_OFF
• RS232_V2_BRICKLET_FLOWCONTROL_SOFTWARE
• RS232_V2_BRICKLET_FLOWCONTROL_HARDWARE

pub async fn set_buffer_config( &mut self, send_buffer_size: u16, receive_buffer_size: u16, ) -> Result<(), TinkerforgeError>

Sets the send and receive buffer size in byte. In total the buffers have to be 10240 byte (10KiB) in size, the minimum buffer size is 1024 byte (1KiB) for each.

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

The send buffer holds data that is given by write and can not be written yet. The receive buffer holds data that is received through RS232 but could not yet be send to the user, either by [read] or through [get_read_callback_receiver] receiver.

pub async fn get_buffer_config( &mut self, ) -> Result<BufferConfig, TinkerforgeError>

Returns the buffer configuration as set by [set_buffer_config].

pub async fn get_buffer_status( &mut self, ) -> Result<BufferStatus, TinkerforgeError>

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

See [set_buffer_config] for buffer size configuration.

pub async fn get_error_count(&mut self) -> Result<ErrorCount, TinkerforgeError>

Returns the current number of overrun and parity errors.

pub async fn set_frame_readable_callback_configuration( &mut self, frame_size: u16, ) -> Result<(), TinkerforgeError>

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.3$nbsp;(Plugin)

pub async fn get_frame_readable_callback_configuration( &mut self, ) -> Result<u16, TinkerforgeError>

Returns the receiver configuration as set by [set_frame_readable_callback_configuration].

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

pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>

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 async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>

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.

Associated constants:

• RS232_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• RS232_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• RS232_V2_BRICKLET_BOOTLOADER_STATUS_OK
• RS232_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• RS232_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• RS232_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• RS232_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• RS232_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

• RS232_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• RS232_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• RS232_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>

Sets the firmware pointer for [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 async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>

Writes 64 Bytes of firmware at the position as written by [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 async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>

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.

Associated constants:

• RS232_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• RS232_V2_BRICKLET_STATUS_LED_CONFIG_ON
• RS232_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• RS232_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>

Returns the configuration as set by [set_status_led_config]

Associated constants:

• RS232_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• RS232_V2_BRICKLET_STATUS_LED_CONFIG_ON
• RS232_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• RS232_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>

Returns the temperature 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 async fn reset(&mut self) -> Result<(), TinkerforgeError>

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 async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>

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 async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>

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

pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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 Rs232V2Bricklet

fn clone(&self) -> Rs232V2Bricklet

Returns a copy of the value.

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

Performs copy-assignment from source.