pub struct DistanceUsBricklet { /* private fields */ }
Expand description
Measures distance between 2cm and 400cm with ultrasound
Implementations
sourceimpl DistanceUsBricklet
impl DistanceUsBricklet
pub const DEVICE_IDENTIFIER: u16 = 229u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Distance US Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> DistanceUsBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> DistanceUsBricklet
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
sourcepub fn get_response_expected(
&mut self,
fun: DistanceUsBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: DistanceUsBrickletFunction
) -> 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.
sourcepub fn set_response_expected(
&mut self,
fun: DistanceUsBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: DistanceUsBrickletFunction,
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.
sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
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.
sourcepub fn get_distance_callback_receiver(&self) -> ConvertingCallbackReceiver<u16>
pub fn get_distance_callback_receiver(&self) -> ConvertingCallbackReceiver<u16>
This receiver is triggered periodically with the period that is set by
Set Distance Receiver Period
. The parameter is the distance value
of the sensor.
The get_distance_callback_receiver
receiver is only triggered if the distance value has changed
since the last triggering.
sourcepub fn get_distance_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u16>
pub fn get_distance_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u16>
This receiver is triggered when the threshold as set by
Set Distance Receiver Threshold
is reached.
The parameter is the distance value of the sensor.
If the threshold keeps being reached, the receiver is triggered periodically
with the period as set by Set Debounce Period
.
sourcepub fn get_distance_value(&self) -> ConvertingReceiver<u16>
pub fn get_distance_value(&self) -> ConvertingReceiver<u16>
Returns the current distance value measured by the sensor. The value has a range of 0 to 4095. A small value corresponds to a small distance, a big value corresponds to a big distance. The relation between the measured distance value and the actual distance is affected by the 5V supply voltage (deviations in the supply voltage result in deviations in the distance values) and is non-linear (resolution is bigger at close range).
If you want to get the distance value periodically, it is recommended to
use the get_distance_callback_receiver
receiver and set the period with
Set Distance Receiver Period
.
sourcepub fn set_distance_callback_period(&self, period: u32) -> ConvertingReceiver<()>
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.
Der get_distance_callback_receiver
receiver is only triggered if the distance value has changed
since the last triggering.
The default value is 0.
sourcepub fn get_distance_callback_period(&self) -> ConvertingReceiver<u32>
pub fn get_distance_callback_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Distance Receiver Period
.
sourcepub fn set_distance_callback_threshold(
&self,
option: char,
min: u16,
max: u16
) -> ConvertingReceiver<()>
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 value is outside the min and max values |
‘i’ | Receiver is triggered when the distance value is inside the min and max values |
‘<’ | Receiver is triggered when the distance value is smaller than the min value (max is ignored) |
‘>’ | Receiver is triggered when the distance value is greater than the min value (max is ignored) |
The default value is (‘x’, 0, 0).
Associated constants:
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_OFF
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_OUTSIDE
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_INSIDE
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_SMALLER
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_distance_callback_threshold(
&self
) -> ConvertingReceiver<DistanceCallbackThreshold>
pub fn get_distance_callback_threshold(
&self
) -> ConvertingReceiver<DistanceCallbackThreshold>
Returns the threshold as set by Set Distance Receiver Threshold
.
Associated constants:
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_OFF
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_OUTSIDE
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_INSIDE
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_SMALLER
- DISTANCE_USBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the threshold receivers
are triggered, if the thresholds
Set Distance Receiver Threshold
,
keep being reached.
The default value is 100.
sourcepub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
Returns the debounce period as set by Set Debounce Period
.
sourcepub fn set_moving_average(&self, average: u8) -> ConvertingReceiver<()>
pub fn set_moving_average(&self, average: u8) -> ConvertingReceiver<()>
Sets the length of a moving averaging__ for the distance value.
Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.
The range for the averaging is 0-100.
The default value is 20.
sourcepub fn get_moving_average(&self) -> ConvertingReceiver<u8>
pub fn get_moving_average(&self) -> ConvertingReceiver<u8>
Returns the length moving average as set by Set Moving Average
.
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
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
sourceimpl Clone for DistanceUsBricklet
impl Clone for DistanceUsBricklet
sourcefn clone(&self) -> DistanceUsBricklet
fn clone(&self) -> DistanceUsBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more