Struct LineBricklet

Source

pub struct LineBricklet { /* private fields */ }

Expand description

Measures reflectivity of a surface

Implementations§

Source §

pub fn new(uid: Uid, connection: AsyncIpConnection) -> LineBricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

Source

pub fn get_response_expected( &mut self, fun: LineBrickletFunction, ) -> 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.

Source

pub fn set_response_expected( &mut self, fun: LineBrickletFunction, 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.

Source

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.

Source

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.

Source

pub async fn get_reflectivity_callback_receiver( &mut self, ) -> impl Stream<Item = u16>

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

The get_reflectivity_callback_receiver receiver is only triggered if the reflectivity has changed since the last triggering.

Source

pub async fn get_reflectivity_reached_callback_receiver( &mut self, ) -> impl Stream<Item = u16>

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

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

Source

pub async fn get_reflectivity(&mut self) -> Result<u16, TinkerforgeError>

Returns the currently measured reflectivity. The reflectivity is a value between 0 (not reflective) and 4095 (very reflective).

Usually black has a low reflectivity while white has a high reflectivity.

If you want to get the reflectivity periodically, it is recommended to use the [get_reflectivity_callback_receiver] receiver and set the period with [set_reflectivity_callback_period].

Source

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

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

The [get_reflectivity_callback_receiver] receiver is only triggered if the reflectivity has changed since the last triggering.

Source

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

Returns the period as set by [set_reflectivity_callback_period].

Source

pub async fn set_reflectivity_callback_threshold( &mut self, option: char, min: u16, max: u16, ) -> Result<(), TinkerforgeError>

Sets the thresholds for the [get_reflectivity_reached_callback_receiver] receiver.

The following options are possible:

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