Struct tinkerforge_async::industrial_dual_analog_in_v2_bricklet::IndustrialDualAnalogInV2Bricklet

pub struct IndustrialDualAnalogInV2Bricklet { /* private fields */ }

Measures two DC voltages between -35V and +35V with 24bit resolution each

Implementations

impl IndustrialDualAnalogInV2Bricklet

pub const DEVICE_IDENTIFIER: u16 = 2_121u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Industrial Dual Analog In Bricklet 2.0"

pub fn new( uid: u32, connection: AsyncIpConnection ) -> IndustrialDualAnalogInV2Bricklet

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: IndustrialDualAnalogInV2BrickletFunction ) -> 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: IndustrialDualAnalogInV2BrickletFunction, 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_voltage_callback_receiver( &mut self ) -> impl Stream<Item = VoltageEvent>

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

The parameter is the same as get_voltage.

pub async fn get_all_voltages_callback_receiver( &mut self ) -> impl Stream<Item = [i32; 2]>

This receiver is triggered periodically according to the configuration set by [set_all_voltages_callback_configuration].

The parameters are the same as [get_all_voltages].

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

pub async fn get_voltage( &mut self, channel: u8 ) -> Result<i32, TinkerforgeError>

Returns the voltage for the given channel.

If you want to get the value periodically, it is recommended to use the [get_voltage_callback_receiver] receiver. You can set the receiver configuration with [set_voltage_callback_configuration].

pub async fn set_voltage_callback_configuration( &mut self, channel: u8, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32 ) -> Result<(), TinkerforgeError>

The period is the period with which the [get_voltage_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.

It is furthermore possible to constrain the receiver with thresholds.

The option-parameter together with min/max sets a threshold for the [get_voltage_callback_receiver] receiver.

The following options are possible:

Option	Description
‘x’	Threshold is turned off
‘o’	Threshold is triggered when the value is outside the min and max values
‘i’	Threshold is triggered when the value is inside or equal to the min and max values
‘<’	Threshold is triggered when the value is smaller than the min value (max is ignored)
‘>’	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_OFF
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub async fn get_voltage_callback_configuration( &mut self, channel: u8 ) -> Result<VoltageCallbackConfiguration, TinkerforgeError>

Returns the receiver configuration as set by [set_voltage_callback_configuration].

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_OFF
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub async fn set_sample_rate( &mut self, rate: u8 ) -> Result<(), TinkerforgeError>

Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_976_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_488_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_244_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_122_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_61_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_4_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_2_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_1_SPS

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

Returns the sample rate as set by [set_sample_rate].

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_976_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_488_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_244_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_122_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_61_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_4_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_2_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_1_SPS

pub async fn set_calibration( &mut self, offset: &[i32; 2], gain: &[i32; 2] ) -> Result<(), TinkerforgeError>

Sets offset and gain of MCP3911 internal calibration registers.

See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet 2.0 is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function

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

Returns the calibration as set by [set_calibration].

pub async fn get_adc_values( &mut self ) -> Result<Box<[i32; 2]>, TinkerforgeError>

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see [set_calibration].

pub async fn set_channel_led_config( &mut self, channel: u8, config: u8 ) -> Result<(), TinkerforgeError>

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to Channel Status. In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.

You can configure the channel status behavior with [set_channel_led_status_config].

By default all channel LEDs are configured as Channel Status.

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_OFF
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_ON
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS

pub async fn get_channel_led_config( &mut self, channel: u8 ) -> Result<u8, TinkerforgeError>

Returns the channel LED configuration as set by [set_channel_led_config]

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_OFF
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_ON
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS

pub async fn set_channel_led_status_config( &mut self, channel: u8, min: i32, max: i32, config: u8 ) -> Result<(), TinkerforgeError>

Sets the channel LED status config. This config is used if the channel LED is configured as Channel Status, see [set_channel_led_config].

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the min parameter to the threshold value in mV above which the LED should turn on and set the max parameter to 0. Example: If you set a positive threshold of 10V, the LED will turn on as soon as the voltage exceeds 10V and turn off again if it goes below 10V. For a negative threshold set the max parameter to the threshold value in mV below which the LED should turn on and set the min parameter to 0. Example: If you set a negative threshold of 10V, the LED will turn on as soon as the voltage goes below 10V and the LED will turn off when the voltage exceeds 10V.

In intensity mode you can define a range in mV that is used to scale the brightness of the LED. Example with min=4V, max=20V: The LED is off at 4V, on at 20V and the brightness is linearly scaled between the values 4V and 20V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_THRESHOLD
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_INTENSITY

pub async fn get_channel_led_status_config( &mut self, channel: u8 ) -> Result<ChannelLedStatusConfig, TinkerforgeError>

Returns the channel LED status configuration as set by [set_channel_led_status_config].

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_THRESHOLD
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_INTENSITY

pub async fn get_all_voltages( &mut self ) -> Result<Box<[i32; 2]>, TinkerforgeError>

Returns the voltages for all channels.

If you want to get the value periodically, it is recommended to use the [get_all_voltages_callback_receiver] receiver. You can set the receiver configuration with [set_all_voltages_callback_configuration].

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

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

The period is the period with which the [get_all_voltages_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 at least one of the values has changed. If the values 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.6$nbsp;(Plugin)

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

Returns the receiver configuration as set by [set_all_voltages_callback_configuration].

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

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_OK
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• INDUSTRIAL_DUAL_ANALOG_IN_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:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• INDUSTRIAL_DUAL_ANALOG_IN_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:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_ON
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• INDUSTRIAL_DUAL_ANALOG_IN_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:

• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_ON
• INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• INDUSTRIAL_DUAL_ANALOG_IN_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 IndustrialDualAnalogInV2Bricklet

fn clone(&self) -> IndustrialDualAnalogInV2Bricklet

Returns a copy of the value.

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

Performs copy-assignment from source.