Struct tinkerforge::rs232_v2_bricklet::Rs232V2Bricklet

source ·

pub struct Rs232V2Bricklet { /* private fields */ }

Expand description

Communicates with RS232 devices

Implementations

source

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

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: 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 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: 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 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_low_level_callback_receiver(
&self
) -> ConvertingCallbackReceiver<ReadLowLevelEvent>

This receiver is called if new data is available.

To enable this receiver, use Enable Read Receiver.

source

pub fn get_read_callback_receiver(
&self
) -> ConvertingHighLevelCallbackReceiver<char, ReadResult, ReadLowLevelEvent> ⓘ

This receiver is called if new data is available.

To enable this receiver, use Enable Read Receiver.

source

pub fn get_error_count_callback_receiver(
&self
) -> ConvertingCallbackReceiver<ErrorCountEvent>

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

source

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

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.

source

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

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.

source

pub fn read_low_level(&self, length: u16) -> ConvertingReceiver<ReadLowLevel>

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 Receiver and get_read_callback_receiver receiver.

source

pub fn 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 receiver is disabled. 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: u32,
 parity: u8,
 stopbits: u8,
 wordlength: u8,
 flowcontrol: u8
) -> ConvertingReceiver<()>

Sets the configuration for the RS232 communication. Available options:

Baud rate between 100 and 2000000 baud.
Parity of none, odd or even.
Stop bits can be 1 or 2.
Word length of 5 to 8.
Flow control can be off, software or hardware.

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

Associated constants:

RS232_V2BRICKLET_PARITY_NONE
RS232_V2BRICKLET_PARITY_ODD
RS232_V2BRICKLET_PARITY_EVEN
RS232_V2BRICKLET_STOPBITS_1
RS232_V2BRICKLET_STOPBITS_2
RS232_V2BRICKLET_WORDLENGTH_5
RS232_V2BRICKLET_WORDLENGTH_6
RS232_V2BRICKLET_WORDLENGTH_7
RS232_V2BRICKLET_WORDLENGTH_8
RS232_V2BRICKLET_FLOWCONTROL_OFF
RS232_V2BRICKLET_FLOWCONTROL_SOFTWARE
RS232_V2BRICKLET_FLOWCONTROL_HARDWARE

source

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

Returns the configuration as set by Set Configuration.

Associated constants:

RS232_V2BRICKLET_PARITY_NONE
RS232_V2BRICKLET_PARITY_ODD
RS232_V2BRICKLET_PARITY_EVEN
RS232_V2BRICKLET_STOPBITS_1
RS232_V2BRICKLET_STOPBITS_2
RS232_V2BRICKLET_WORDLENGTH_5
RS232_V2BRICKLET_WORDLENGTH_6
RS232_V2BRICKLET_WORDLENGTH_7
RS232_V2BRICKLET_WORDLENGTH_8
RS232_V2BRICKLET_FLOWCONTROL_OFF
RS232_V2BRICKLET_FLOWCONTROL_SOFTWARE
RS232_V2BRICKLET_FLOWCONTROL_HARDWARE

source

pub fn set_buffer_config(
 &self,
 send_buffer_size: u16,
 receive_buffer_size: u16
) -> ConvertingReceiver<()>

Sets the send and receive buffer size in byte. In total the buffers have to be 10240 byte (10kb) in size, the minimum buffer size is 1024 byte (1kb) 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.

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

source

pub fn get_buffer_config(&self) -> ConvertingReceiver<BufferConfig>

Returns the buffer configuration as set by Set Buffer Config.

source

pub fn get_buffer_status(&self) -> ConvertingReceiver<BufferStatus>

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

See Set Buffer Config for buffer size configuration.

source

pub fn get_error_count(&self) -> ConvertingReceiver<ErrorCount>

Returns the current number of overrun and parity errors.

source

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

source

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

Associated constants:

RS232_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
RS232_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
RS232_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
RS232_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
RS232_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
RS232_V2BRICKLET_BOOTLOADER_STATUS_OK
RS232_V2BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
RS232_V2BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
RS232_V2BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
RS232_V2BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
RS232_V2BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

source

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

Returns the current bootloader mode, see Set Bootloader Mode.

Associated constants:

RS232_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
RS232_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
RS232_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
RS232_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
RS232_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

source

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

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.

source

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

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.

source

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

Associated constants:

RS232_V2BRICKLET_STATUS_LED_CONFIG_OFF
RS232_V2BRICKLET_STATUS_LED_CONFIG_ON
RS232_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
RS232_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

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

Returns the configuration as set by Set Status LED Config

Associated constants:

RS232_V2BRICKLET_STATUS_LED_CONFIG_OFF
RS232_V2BRICKLET_STATUS_LED_CONFIG_ON
RS232_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
RS232_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

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

source