FastArduino v1.10
C++ library to build fast but small Arduino/AVR projects
Loading...
Searching...
No Matches
devices::vl53l0x::SequenceStepsTimeout Class Reference

Hold VL53L0X sequence steps timeouts and other related settings used for ranging. More...

#include <fastarduino/devices/vl53l0x_types.h>

Public Member Functions

uint8_t pre_range_vcsel_period_pclks () const
 VCSEL PCLK value for pre-range step. More...
 
uint8_t final_range_vcsel_period_pclks () const
 VCSEL PCLK value for final-range step. More...
 
uint16_t msrc_dss_tcc_mclks () const
 MCLK for any of MSRC, DSS or TCC steps. More...
 
uint16_t pre_range_mclks () const
 MCLK for PRE-RANGE step. More...
 
uint16_t final_range_mclks (bool is_pre_range) const
 MCLK for FINAL-RANGE step. More...
 
uint32_t msrc_dss_tcc_us () const
 Calculate the timing in us of any of MSRC, DSS or TCC steps. More...
 
uint32_t pre_range_us () const
 Calculate the timing in us of PRE-RANGE step. More...
 
uint32_t final_range_us (bool is_pre_range) const
 Calculate the timing in us of FINAL-RANGE step. More...
 

Friends

template<typename MANAGER >
class VL53L0X
 

Detailed Description

Hold VL53L0X sequence steps timeouts and other related settings used for ranging.

See also
VL53L0X::get_sequence_steps_timeout()

Definition at line 790 of file vl53l0x_types.h.

Member Function Documentation

◆ pre_range_vcsel_period_pclks()

uint8_t devices::vl53l0x::SequenceStepsTimeout::pre_range_vcsel_period_pclks ( ) const
inline

VCSEL PCLK value for pre-range step.

Definition at line 800 of file vl53l0x_types.h.

◆ final_range_vcsel_period_pclks()

uint8_t devices::vl53l0x::SequenceStepsTimeout::final_range_vcsel_period_pclks ( ) const
inline

VCSEL PCLK value for final-range step.

Definition at line 808 of file vl53l0x_types.h.

◆ msrc_dss_tcc_mclks()

uint16_t devices::vl53l0x::SequenceStepsTimeout::msrc_dss_tcc_mclks ( ) const
inline

MCLK for any of MSRC, DSS or TCC steps.

Definition at line 816 of file vl53l0x_types.h.

◆ pre_range_mclks()

uint16_t devices::vl53l0x::SequenceStepsTimeout::pre_range_mclks ( ) const
inline

MCLK for PRE-RANGE step.

Definition at line 824 of file vl53l0x_types.h.

◆ final_range_mclks()

uint16_t devices::vl53l0x::SequenceStepsTimeout::final_range_mclks ( bool  is_pre_range) const
inline

MCLK for FINAL-RANGE step.

Parameters
is_pre_rangeindicate if calculation is performed on a sequence including PRE-RANGE step; this impacts calculation.
See also
SequenceSteps

Definition at line 835 of file vl53l0x_types.h.

◆ msrc_dss_tcc_us()

uint32_t devices::vl53l0x::SequenceStepsTimeout::msrc_dss_tcc_us ( ) const
inline

Calculate the timing in us of any of MSRC, DSS or TCC steps.

Definition at line 846 of file vl53l0x_types.h.

◆ pre_range_us()

uint32_t devices::vl53l0x::SequenceStepsTimeout::pre_range_us ( ) const
inline

Calculate the timing in us of PRE-RANGE step.

Definition at line 854 of file vl53l0x_types.h.

◆ final_range_us()

uint32_t devices::vl53l0x::SequenceStepsTimeout::final_range_us ( bool  is_pre_range) const
inline

Calculate the timing in us of FINAL-RANGE step.

Parameters
is_pre_rangeindicate if calculation is performed on a sequence including PRE-RANGE step; this impacts calculation.
See also
SequenceSteps

Definition at line 865 of file vl53l0x_types.h.

Friends And Related Function Documentation

◆ VL53L0X

template<typename MANAGER >
friend class VL53L0X
friend

Definition at line 887 of file vl53l0x_types.h.


The documentation for this class was generated from the following file: