ST VL53L1X API - Contents

Contents
1 Acronyms and abbreviations ......................................................2
2 VL53L1X system overview .........................................................3
3 Ranging API functional description ................................................4
3.1 Distance ranging description .....................................................4
3.2 Distance threshold detection description ...........................................4
3.3 Timing considerations...........................................................4
3.4 API function call flow............................................................5
3.4.1 Calibration flow ..........................................................5
3.4.2 Ranging flow ............................................................5
3.5 Mandatory functions ............................................................6
3.5.1 Sensor boot ............................................................6
3.5.2 Sensor init..............................................................6
3.5.3 Start a measurement......................................................6
3.5.4 Wait for notification ranging data to be ready ...................................7
3.5.5 Get ranging data .........................................................7
3.5.6 Clear interrupt ...........................................................7
3.5.7 Stop the measurement ....................................................7
3.6 Optional functions ..............................................................7
3.6.1 Setting distance mode.....................................................7
3.6.2 Inter-measurement period ..................................................7
3.6.3 Setting the timing budget ..................................................7
3.6.4 Setting threshold and detection mode .........................................8
3.6.5 Setting ROI .............................................................8
3.7 Ranging example pseudo code ...................................................9
4 Calibration functions .............................................................10
4.1 Offset calibration ..............................................................10
4.1.1 Offset calibration procedure ...............................................10
4.1.2 Getting offset calibration ..................................................10
4.1.3 Setting offset calibration ..................................................10
4.2 Crosstalk calibration ...........................................................10
UM2510
Contents
UM2510 - Rev 1
page 23/26