Struct tinkerforge::analog_in_bricklet::AnalogInBricklet

pub struct AnalogInBricklet { /* private fields */ }

Measures DC voltage between 0V and 45V

Implementations

impl AnalogInBricklet

pub const DEVICE_IDENTIFIER: u16 = 219u16

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

pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> AnalogInBricklet

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: AnalogInBrickletFunction ) -> 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: AnalogInBrickletFunction, 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 fn get_voltage_callback_receiver(&self) -> ConvertingCallbackReceiver<u16>

This receiver is triggered periodically with the period that is set by set_voltage_callback_period. The parameter is the voltage of the sensor.

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

pub fn get_analog_value_callback_receiver( &self ) -> ConvertingCallbackReceiver<u16>

This receiver is triggered periodically with the period that is set by [set_analog_value_callback_period]. The parameter is the analog value of the sensor.

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

pub fn get_voltage_reached_callback_receiver( &self ) -> ConvertingCallbackReceiver<u16>

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

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

pub fn get_analog_value_reached_callback_receiver( &self ) -> ConvertingCallbackReceiver<u16>

This receiver is triggered when the threshold as set by [set_analog_value_callback_threshold] is reached. The parameter is the analog value of the sensor.

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) -> ConvertingReceiver<u16>

Returns the voltage of the sensor. The resolution between 0 and 6V is about 2mV. Between 6 and 45V the resolution is about 10mV.

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 fn get_analog_value(&self) -> ConvertingReceiver<u16>

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by [get_voltage] is averaged over several samples to yield less noise, while [get_analog_value] gives back raw unfiltered analog values. The only reason to use [get_analog_value] is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the [get_analog_value_callback_receiver] receiver and set the period with [set_analog_value_callback_period].

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

Sets the period with which the [get_voltage_callback_receiver] receiver is triggered periodically. 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 fn get_voltage_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by [set_voltage_callback_period].

pub fn set_analog_value_callback_period( &self, period: u32 ) -> ConvertingReceiver<()>

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

The [get_analog_value_callback_receiver] receiver is only triggered if the analog value has changed since the last triggering.

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

Returns the period as set by [set_analog_value_callback_period].

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

Sets the thresholds for the [get_voltage_reached_callback_receiver] receiver.

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:

• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_voltage_callback_threshold( &self ) -> ConvertingReceiver<VoltageCallbackThreshold>

Returns the threshold as set by [set_voltage_callback_threshold].

Associated constants:

• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn set_analog_value_callback_threshold( &self, option: char, min: u16, max: u16 ) -> ConvertingReceiver<()>

Sets the thresholds for the [get_analog_value_reached_callback_receiver] receiver.

The following options are possible:

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

Associated constants:

• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_analog_value_callback_threshold( &self ) -> ConvertingReceiver<AnalogValueCallbackThreshold>

Returns the threshold as set by [set_analog_value_callback_threshold].

Associated constants:

• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER
• ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER

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

Sets the period with which the threshold receivers

• [get_voltage_reached_callback_receiver],
• [get_analog_value_reached_callback_receiver]

are triggered, if the thresholds

• [set_voltage_callback_threshold],
• [set_analog_value_callback_threshold]

keep being reached.

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

Returns the debounce period as set by [set_debounce_period].

pub fn set_range(&self, range: u8) -> ConvertingReceiver<()>

Sets the measurement range. Possible ranges:

• 0: Automatically switched
• 1: 0V - 6.05V, ~1.48mV resolution
• 2: 0V - 10.32V, ~2.52mV resolution
• 3: 0V - 36.30V, ~8.86mV resolution
• 4: 0V - 45.00V, ~11.25mV resolution
• 5: 0V - 3.3V, ~0.81mV resolution, new in version 2.0.3$nbsp;(Plugin)

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

Associated constants:

• ANALOG_IN_BRICKLET_RANGE_AUTOMATIC
• ANALOG_IN_BRICKLET_RANGE_UP_TO_6V
• ANALOG_IN_BRICKLET_RANGE_UP_TO_10V
• ANALOG_IN_BRICKLET_RANGE_UP_TO_36V
• ANALOG_IN_BRICKLET_RANGE_UP_TO_45V
• ANALOG_IN_BRICKLET_RANGE_UP_TO_3V

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

Returns the measurement range as set by [set_range].

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

Associated constants:

• ANALOG_IN_BRICKLET_RANGE_AUTOMATIC
• ANALOG_IN_BRICKLET_RANGE_UP_TO_6V
• ANALOG_IN_BRICKLET_RANGE_UP_TO_10V
• ANALOG_IN_BRICKLET_RANGE_UP_TO_36V
• ANALOG_IN_BRICKLET_RANGE_UP_TO_45V
• ANALOG_IN_BRICKLET_RANGE_UP_TO_3V

pub fn set_averaging(&self, average: u8) -> ConvertingReceiver<()>

Set the length of a averaging for the voltage value.

Setting the length to 0 will turn the averaging completely off. If the averaging is off, there is more noise on the data, but the data is without delay.

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

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

Returns the averaging configuration as set by [set_averaging].

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

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’, ‘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 AnalogInBricklet

fn clone(&self) -> AnalogInBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.