Struct IsolatorBricklet

pub struct IsolatorBricklet { /* private fields */ }

Galvanically isolates any Bricklet from any Brick

Implementations

impl IsolatorBricklet

pub const DEVICE_IDENTIFIER: u16 = 2_122u16

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

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

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: IsolatorBrickletFunction, ) -> 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: IsolatorBrickletFunction, 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_statistics_callback_receiver( &mut self, ) -> impl Stream<Item = StatisticsEvent>

This receiver is triggered periodically according to the configuration set by set_statistics_callback_configuration.

The parameters are the same as get_statistics.

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

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

Returns statistics for the Isolator Bricklet.

pub async fn set_spitfp_baudrate_config( &mut self, enable_dynamic_baudrate: bool, minimum_dynamic_baudrate: u32, ) -> Result<(), TinkerforgeError>

The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Isolator Bricklet will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred.

The baudrate for communication config between Brick and Isolator Bricklet can be set through the API of the Brick.

The baudrate will be increased exponentially if lots of data is sent/received and decreased linearly if little data is sent/received.

This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.

In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance.

The maximum value of the baudrate can be set per port with the function [set_spitfp_baudrate]. If the dynamic baudrate is disabled, the baudrate as set by [set_spitfp_baudrate] will be used statically.

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

Returns the baudrate config, see [set_spitfp_baudrate_config].

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

Sets the baudrate for a the communication between Isolator Bricklet and the connected Bricklet. The baudrate for communication between Brick and Isolator Bricklet can be set through the API of the Brick.

If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (see [get_spitfp_error_count]) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see [set_spitfp_baudrate_config]).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in your applications we recommend to not change the baudrate.

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

Returns the baudrate, see [set_spitfp_baudrate].

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

Returns the error count for the communication between Isolator Bricklet and the connected Bricklet. Call [get_spitfp_error_count] to get the error count between Isolator Bricklet and Brick.

The errors are divided into

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

pub async fn set_statistics_callback_configuration( &mut self, period: u32, value_has_to_change: bool, ) -> Result<(), TinkerforgeError>

The period is the period with which the [get_statistics_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

If the value has to change-parameter is set to true, the receiver is only triggered after the value has changed. If the value didn’t change within the period, the receiver is triggered immediately on change.

If it is set to false, the receiver is continuously triggered with the period, independent of the value.

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

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

Returns the receiver configuration as set by [set_statistics_callback_configuration].

.. versionadded:: 2.0.2$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:

• ISOLATOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• ISOLATOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• ISOLATOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• ISOLATOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• ISOLATOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• ISOLATOR_BRICKLET_BOOTLOADER_STATUS_OK
• ISOLATOR_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• ISOLATOR_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• ISOLATOR_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• ISOLATOR_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• ISOLATOR_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:

• ISOLATOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• ISOLATOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• ISOLATOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• ISOLATOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• ISOLATOR_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:

• ISOLATOR_BRICKLET_STATUS_LED_CONFIG_OFF
• ISOLATOR_BRICKLET_STATUS_LED_CONFIG_ON
• ISOLATOR_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• ISOLATOR_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:

• ISOLATOR_BRICKLET_STATUS_LED_CONFIG_OFF
• ISOLATOR_BRICKLET_STATUS_LED_CONFIG_ON
• ISOLATOR_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• ISOLATOR_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 IsolatorBricklet

fn clone(&self) -> IsolatorBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.