Doly C++ SDK v1.00
Loading...
Searching...
No Matches
TofControl

Doly ToF (Time of Flight) control and event API. More...

Files

file  TofControl.h
 Public API for Doly ToF (Time of Flight) sensor control.
file  TofEvent.h
 Event registration helpers for the ToF (Time of Flight) subsystem.

Classes

struct  TofGesture
 Gesture description for a ToF sensor. More...
struct  TofData
 Latest ToF sample snapshot for one sensor. More...
class  TofEventListener
 Observer interface for receiving ToF gesture and threshold events. More...

Enumerations

enum class  TofError : uint8_t {
  TofError::NO_ERROR = 0 , TofError::VCSEL_Continuity_Test = 1 , TofError::VCSEL_Watchdog_Test = 2 , TofError::VCSEL_Watchdog = 3 ,
  TofError::PLL1_Lock = 4 , TofError::PLL2_Lock = 5 , TofError::Early_Convergence_Estimate = 6 , TofError::Max_Convergence = 7 ,
  TofError::No_Target_Ignore = 8 , TofError::Max_Signal_To_Noise_Ratio = 11 , TofError::Raw_Ranging_Algo_Underflow = 12 , TofError::Raw_Ranging_Algo_Overflow = 13 ,
  TofError::Ranging_Algo_Underflow = 14 , TofError::Ranging_Algo_Overflow = 15 , TofError::Filtered_by_post_processing = 16 , TofError::DataNotReady = 18
}
 ToF error codes reported by the sensor/driver. More...
enum class  TofSide : uint8_t { TofSide::LEFT , TofSide::RIGHT }
 Which ToF sensor is addressed. More...
enum class  TofGestureType : uint8_t {
  TofGestureType::UNDEFINED , TofGestureType::OBJECT_COMING , TofGestureType::OBJECT_GOING , TofGestureType::SCRUBING ,
  TofGestureType::TO_LEFT , TofGestureType::TO_RIGHT
}
 High-level gesture types derived from ToF continuous readings. More...

Detailed Description

Doly ToF (Time of Flight) control and event API.

Time-of-Flight module.

Enumeration Type Documentation

◆ TofError

enum class TofError : uint8_t
strong

ToF error codes reported by the sensor/driver.

Values are based on the VL6180 API/user manual (UM2760).

Enumerator
NO_ERROR 
VCSEL_Continuity_Test 
VCSEL_Watchdog_Test 
VCSEL_Watchdog 
PLL1_Lock 
PLL2_Lock 
Early_Convergence_Estimate 
Max_Convergence 
No_Target_Ignore 
Max_Signal_To_Noise_Ratio 
Raw_Ranging_Algo_Underflow 
Raw_Ranging_Algo_Overflow 
Ranging_Algo_Underflow 
Ranging_Algo_Overflow 
Filtered_by_post_processing 
DataNotReady 

◆ TofGestureType

enum class TofGestureType : uint8_t
strong

High-level gesture types derived from ToF continuous readings.

Enumerator
UNDEFINED 
OBJECT_COMING 
OBJECT_GOING 
SCRUBING 
TO_LEFT 
TO_RIGHT 

◆ TofSide

enum class TofSide : uint8_t
strong

Which ToF sensor is addressed.

Enumerator
LEFT 
RIGHT