unit_VL53L1X.hpp File Reference

VL53L1X Unit for M5UnitUnified. More...

#include <M5UnitComponent.hpp>
#include <m5_utility/container/circular_buffer.hpp>
#include <m5_utility/types.hpp>
#include <array>
#include <limits>

Go to the source code of this file.

Classes
struct	m5::unit::vl53l1x::Data
	Measurement data group. More...
class	m5::unit::UnitVL53L1X
	ToF4M unit. More...
struct	m5::unit::UnitVL53L1X::config_t
	Settings for begin. More...

Namespaces
namespace	m5
	Top level namespace of M5stack.

Enumerations
enum class	m5::unit::vl53l1x::Operating : uint8_t { ConditionStandard , Condition2V8 }
	Operating condition. More...
enum class	m5::unit::vl53l1x::Distance : int8_t { Unknown = -1 , Short , Long }
	Distance mode. More...
enum class	m5::unit::vl53l1x::Timing : int8_t {   BudgetUnknown = -1 , Budget15ms , Budget20ms , Budget33ms ,   Budget50ms , Budget100ms , Budget200ms , Budget500ms }
	Timeing budget for ranging. More...
enum class	m5::unit::vl53l1x::RangeStatus : uint8_t {   OK , SigmaFailure , SignalFailure , RangeValidMinRangeClipped ,   OutOfBounds , HardwareFailure , Unknown6 , Wraparound ,   Unknown8 , XtalkSignalFailure , SynchronizationInt , Unknown11 ,   Unknown12 , MinRangeFailure , Unknown255 = 255 }
	Range status interpretation.
enum class	m5::unit::vl53l1x::Window : uint8_t {   Below , Beyond , Out , In ,   Regular = 0x20 }
	Window detection mode. More...

Detailed Description

VL53L1X Unit for M5UnitUnified.

Enumeration Type Documentation

Distance

enum class m5::unit::vl53l1x::Distance : int8_t

strong

Distance mode.

Enumerator
Short	Short (limited to 1.3m)
Long	Long (limited to 4.0m)

Operating

enum class m5::unit::vl53l1x::Operating : uint8_t

strong

Operating condition.

Enumerator
ConditionStandard	Standard mode (1.6 - 1.9 V)
Condition2V8	2V8 mode (2.6 - 3.5 V) (as default)

Timing

enum class m5::unit::vl53l1x::Timing : int8_t

strong

Timeing budget for ranging.

Warning

This value does not directly represent the measurement interval

inter-measurement period needs to be set

Enumerator
Budget15ms	15 ms (Only possible when Short mode)
Budget20ms	20 ms
Budget33ms	33 ms
Budget50ms	50 ms
Budget100ms	100 ms
Budget200ms	200 ms
Budget500ms	500 ms

Window

enum class m5::unit::vl53l1x::Window : uint8_t

strong

Window detection mode.

• Below
  • If object distance > ThreshLow or no object found: no report
  • If object distance < ThreshLow and object found: report
• Beyond
  • If object distance < ThreshHigh or no object found: no report
  • If object distance > ThreshHigh and object found: report
• Out
  • ThreshLow < object distance < ThreshHigh: no report
  • ThreshLow > object distance > ThreshHigh: report
• In
  • ThreshLow > object distance > ThreshHigh: no report
  • ThreshLow < object distance < ThreshHigh: report

Enumerator
Below	Below a certain distance.
Beyond	Beyond a certain distance.
Out	Out of distance range (min/max), "out of Window".
In	Within the distance range (min/max), "inside Window".
Regular	Regular ranging (without window)