Condensed Version of Public VL53L0X

Dependents:   ToF-Only-Tryout

Embed: (wiki syntax)

« Back to documentation index

Init functions

Init functions

Wrapper functions. More...

Functions

VL53L0X_Error Prepare ()
 Prepare device for operation.
void Range_start_continuous_mode ()
 Start continuous ranging mode.
uint32_t Get_distance ()
 Get ranging result and only that.

Detailed Description

Wrapper functions.

API init functions


Function Documentation

uint32_t Get_distance (  ) [inherited]

Get ranging result and only that.

Function Description
Unlike Get_ranging_results() this function only retrieves the range in millimeter
It does any required up-scale translation
It can be called after success ErrState polling or in interrupt mode
Warning:
these function is not doing wrap around filtering
This function doesn't perform any data ready check!
Parameters:
p_dataPointer to range distance "0" on success

Definition at line 325 of file VL53L0X.cpp.

VL53L0X_Error Prepare (  ) [inherited]

Prepare device for operation.

Function Description
Does static initialization and reprogram common default settings
Device is prepared for new measure, ready single shot ranging or ALS typical polling operation
After prepare user can :
  • Call other API function to set other settings
  • Configure the interrupt pins, etc...
  • Then start ranging or ALS operations in single shot or continuous mode
Parameters:
void
Returns:
"0" on success
void Range_start_continuous_mode (  ) [inherited]

Start continuous ranging mode.

End user should ensure device is in idle state and not already running

Returns:
"0" on success

Definition at line 241 of file VL53L0X.h.