Struct gyuvl53l0x::VL53L0X

pub struct VL53L0X<I2C> { /* fields omitted */ }

Struct for VL53L0X

Implementations

impl<I2C, E> VL53L0X<I2C> where
    I2C: WriteRead<Error = E> + Write<Error = E> + Read<Error = E>, 

pub fn default(i2c: I2C) -> Result<VL53L0X<I2C>, Error<E>>

Creates a sensor with default configuration

pub fn new(
    i2c: I2C,
    address: u8,
    io_mode2v8: bool
) -> Result<VL53L0X<I2C>, Error<E>>

Creates a sensor with specific configuration

pub fn set_device_address(&mut self, address: u8) -> Result<bool, E>

Set new address for device

pub fn start_continuous(&mut self, period_millis: u32) -> Result<(), E>

Start continuous ranging measurements Ranging is performed in a continuous way after the API function is called. As soon as the measurement is finished, another one is started without delay. User has to stop the ranging to return to SW standby. The last measurement is completed before stopping

If period_millis is 0, continuous back-to-back mode is used (the sensor takes measurements as often as possible); otherwise, continuous timed mode is used, with the given inter-measurement period in milliseconds determining how often the sensor takes a measurement

pub fn stop_continuous(&mut self) -> Result<(), E>

Stop continuous measurements

pub fn read_range_mm(&mut self) -> Result<u16, Error<E>>

Reads and returns range measurement in millimiters

pub fn read_range_continuous_millimeters_blocking(
    &mut self
) -> Result<u16, Error<E>>

Returns a range reading in millimeters when continuous mode is active

pub fn read_range_single_millimeters_blocking(
    &mut self
) -> Result<u16, Error<E>>

Returns a single reading in millimeters

pub fn who_am_i(&mut self) -> Result<u8, E>

Returns WHO_AM_I register

pub fn set_measurement_timing_budget(
    &mut self,
    budget_microseconds: u32
) -> Result<bool, E>

Set the measurement timing budget in microseconds, which is the time allowed for one measurement; the ST API and this library take care of splitting the timing budget among the sub-steps in the ranging sequence. A longer timing budget allows for more accurate measurements. Increasing the budget by a factor of N decreases the range measurement standard deviation by a factor of sqrt(N). Defaults to about 33 milliseconds; the minimum is 20 ms

Trait Implementations

impl<I2C: Clone> Clone for VL53L0X<I2C>

fn clone(&self) -> VL53L0X<I2C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I2C: Debug> Debug for VL53L0X<I2C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<I2C: Copy> Copy for VL53L0X<I2C>