Struct tinkerforge::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: &str,
    ip_connection: &IpConnection
) -> 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 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.

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 send 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_voltage_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<VoltageEvent>

This receiver is triggered periodically with the period that is set by Set Voltage Receiver 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 fn get_voltage_reached_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<VoltageReachedEvent>

This receiver is triggered when the threshold as set by Set Voltage Receiver 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 fn get_voltage(&self, channel: u8) -> ConvertingReceiver<i32>

Returns the voltage for the given channel in mV.

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 Receiver Period.

pub fn set_voltage_callback_period(
    &self,
    channel: u8,
    period: u32
) -> ConvertingReceiver<()>

Sets the period in ms 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.

The default value is 0.

pub fn get_voltage_callback_period(&self, channel: u8) -> ConvertingReceiver<u32>

Returns the period as set by Set Voltage Receiver Period.

pub fn set_voltage_callback_threshold(
    &self,
    channel: u8,
    option: char,
    min: i32,
    max: i32
) -> ConvertingReceiver<()>

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)

The default value is (‘x’, 0, 0).

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_OFF
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_OUTSIDE
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_INSIDE
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_SMALLER
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_voltage_callback_threshold(
    &self,
    channel: u8
) -> ConvertingReceiver<VoltageCallbackThreshold>

Returns the threshold as set by Set Voltage Receiver Threshold.

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_OFF
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_OUTSIDE
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_INSIDE
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_SMALLER
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_THRESHOLD_OPTION_GREATER

pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>

Sets the period in ms with which the threshold receiver

• get_voltage_reached_callback_receiver

is triggered, if the threshold

• Set Voltage Receiver Threshold

keeps being reached.

The default value is 100.

pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>

Returns the debounce period as set by Set Debounce Period.

pub fn set_sample_rate(&self, rate: u8) -> ConvertingReceiver<()>

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.

The default value is 6 (2 samples per second).

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_976_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_488_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_244_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_122_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_61_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_4_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_2_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_1_SPS

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

Returns the sample rate as set by Set Sample Rate.

Associated constants:

• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_976_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_488_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_244_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_122_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_61_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_4_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_2_SPS
• INDUSTRIAL_DUAL_ANALOG_INBRICKLET_SAMPLE_RATE_1_SPS

pub fn set_calibration(
    &self,
    offset: [i32; 2],
    gain: [i32; 2]
) -> ConvertingReceiver<()>

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 fn get_calibration(&self) -> ConvertingReceiver<Calibration>

Returns the calibration as set by Set Calibration.

pub fn get_adc_values(&self) -> ConvertingReceiver<[i32; 2]>

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see Set Calibration.

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

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’ or ‘d’.

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.