Struct tinkerforge_async::industrial_dual_analog_in_bricklet::IndustrialDualAnalogInBricklet

pub struct IndustrialDualAnalogInBricklet { /* private fields */ }

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

Implementations

impl IndustrialDualAnalogInBricklet

pub const DEVICE_IDENTIFIER: u16 = 249u16

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

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

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: IndustrialDualAnalogInBrickletFunction ) -> 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: IndustrialDualAnalogInBrickletFunction, 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 with the period that is set by set_voltage_callback_period. The parameter is the voltage of the channel.

The get_voltage_callback_receiver receiver is only triggered if the voltage has changed since the last triggering.

pub async fn get_voltage_reached_callback_receiver( &mut self ) -> impl Stream<Item = VoltageReachedEvent>

This receiver is triggered when the threshold as set by [set_voltage_callback_threshold] is reached. The parameter is the voltage of the channel.

If the threshold keeps being reached, the receiver is triggered periodically with the period as set by [set_debounce_period].

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 voltage periodically, it is recommended to use the [get_voltage_callback_receiver] receiver and set the period with [set_voltage_callback_period].

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

Sets the period with which the [get_voltage_callback_receiver] receiver is triggered periodically for the given channel. A value of 0 turns the receiver off.

The [get_voltage_callback_receiver] receiver is only triggered if the voltage has changed since the last triggering.

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

Returns the period as set by [set_voltage_callback_period].

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

Sets the thresholds for the [get_voltage_reached_callback_receiver] receiver for the given channel.

The following options are possible:

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

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER

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

Returns the threshold as set by [set_voltage_callback_threshold].

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER

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

Sets the period with which the threshold receiver

• [get_voltage_reached_callback_receiver]

is triggered, if the threshold

• [set_voltage_callback_threshold]

keeps being reached.

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

Returns the debounce period as set by [set_debounce_period].

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_BRICKLET_SAMPLE_RATE_976_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_488_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_244_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_122_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_61_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_4_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_2_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_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_BRICKLET_SAMPLE_RATE_976_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_488_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_244_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_122_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_61_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_4_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_2_SPS
• INDUSTRIAL_DUAL_ANALOG_IN_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 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 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 IndustrialDualAnalogInBricklet

fn clone(&self) -> IndustrialDualAnalogInBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.