Struct tinkerforge::distance_ir_bricklet::DistanceIrBricklet

pub struct DistanceIrBricklet { /* fields omitted */ }

Measures distance up to 150cm with infrared light

Methods

impl DistanceIrBricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

pub fn new(uid: &str, ip_connection: &IpConnection) -> DistanceIrBricklet

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: DistanceIrBrickletFunction ) -> 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: DistanceIrBrickletFunction,     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_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_distance_callback_receiver(&self) -> ConvertingCallbackReceiver<u16>

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

The get_distance_callback_receiver receiver is only triggered if the distance 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 analog value has changed since the last triggering.

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

This receiver is triggered when the threshold as set by set_distance_callback_threshold is reached. The parameter is the distance 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_distance(&self) -> ConvertingReceiver<u16>

Returns the distance measured by the sensor. The value is in mm and possible distance ranges are 40 to 300, 100 to 800 and 200 to 1500, depending on the selected IR sensor.

If you want to get the distance periodically, it is recommended to use the get_distance_callback_receiver receiver and set the period with set_distance_callback_period.

pub fn get_analog_value(&self) -> ConvertingReceiver<u16>

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by get_distance 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_sampling_point(     &self,     position: u8,     distance: u16 ) -> ConvertingReceiver<()>

Sets a sampling point value to a specific position of the lookup table. The lookup table comprises 128 equidistant analog values with corresponding distances.

If you measure a distance of 50cm at the analog value 2048, you should call this function with (64, 5000). The utilized analog-to-digital converter has a resolution of 12 bit. With 128 sampling points on the whole range, this means that every sampling point has a size of 32 analog values. Thus the analog value 2048 has the corresponding sampling point 64 = 2048/32.

Sampling points are saved on the EEPROM of the Distance IR Bricklet and loaded again on startup.

Note

An easy way to calibrate the sampling points of the Distance IR Bricklet is implemented in the Brick Viewer. If you want to calibrate your Bricklet it is highly recommended to use this implementation.

pub fn get_sampling_point(&self, position: u8) -> ConvertingReceiver<u16>

Returns the distance to a sampling point position as set by set_sampling_point.

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

Sets the period in ms with which the get_distance_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

The get_distance_callback_receiver receiver is only triggered if the distance has changed since the last triggering.

The default value is 0.

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

Returns the period as set by set_distance_callback_period.

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

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

The default value is 0.

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

Returns the period as set by set_analog_value_callback_period.

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

Sets the thresholds for the get_distance_reached_callback_receiver receiver.

The following options are possible:

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

The default value is ('x', 0, 0).

Associated constants:

• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OFF
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_distance_callback_threshold(     &self ) -> ConvertingReceiver<DistanceCallbackThreshold>

Returns the threshold as set by set_distance_callback_threshold.

Associated constants:

• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OFF
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER
• DISTANCE_IR_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)

The default value is ('x', 0, 0).

Associated constants:

• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OFF
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER
• DISTANCE_IR_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:

• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OFF
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER
• DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_GREATER

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

Sets the period in ms with which the threshold receivers

• get_distance_reached_callback_receiver,
• get_analog_value_reached_callback_receiver

are triggered, if the thresholds

• set_distance_callback_threshold,
• set_analog_value_callback_threshold

keep 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 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 DistanceIrBricklet

fn clone(&self) -> DistanceIrBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.