ST VL53L1X API Manual

VL53L1X Setup and Demo
Apr 2018

Agenda
•VL53L1X OverView
•VL53L1X Software package
•Presence HOD demo
2

VL53L1X OverView

VL53L1X eco-system 4
VL53L1X : Miniature ToF Ranging
VL53L1X C API package –STSW-IMG007
Discover API Source code
VL53L1X Eval GUI - STSW-IMG008
Get ranging live curves on your PC
Change key settings of the device
Data logging capabilities
X-CUBE-53L1A1 package
Full integration in STM32 MCU (real-time)
All source code provided
Full access to product settings
Data logging capabilities
Ranging and Gesture detection demo
Hardware
P-NUCLEO-53L1A1
X-NUCLEO-53L1A1
VL53L1X GUI
User Manual VL53L1X X-CUBE
User Manual
Documentation
VL53L1X Data Brief
VL53L1X Datasheet
VL53L0X Quick Start Guide
Applications Notes
VL53L1X API Data Brief
VL53L1X API User Manual
X-NUCLEO-53L1A1 HW
User Manual

Hardware Description 5
•VL53L1X Evaluation tools are all based on the same hardware pack composed of
oNucleo F401RE board
oX-NUCLEO-53L1A1 Nucleo Expansion board
oOptional two VL53L1X satellites
oSeveral gap spacers and cover glass
Search for P-NUCLEO-53L1A1 on st.com to order the pack and get documentation

VL53L1X Application
•Advanced user detection
Ultra-low-power
Laptop, PC, tablets & IoT, portable handsets.
•Drones and Robotic
Take-off and landing phase
Obstacle avoidance
Ceiling detection
•Smart building and smart lighting
People detection, gesture control
•Sanitary
Robust user detection
•Smart shelves and vending machines
Goods inventory monitoring
6

VL53L1X Mode
•Autonomous mode is using sigma delta mechanism to measure distance:
Averages all targets in the full FoV
Allows multiple ROI
This mode is called Timed measurement, means ranging continuously and autonomously with a
programmable inter-measurement period.
7
Note: Inter measurement period is start ranging1 to ranging2. Inter measurement timing is in b/w one
ranging result to another.

Autonomous functionalities
•Autonomous ranging with selectable timing
budget from 20ms to 1000ms.
•In short distance, minimum timing budget is
20ms.
•Ideally, for all distance modes, minimum
timing budget is 33ms.
•If the inter-measurement timing is shorter
than the timing budget, once the device
completes the ranging, the next ranging
starts immediately.
8
Timing budget Ranging characteristics (tbc)
•VL53L1X running in low power autonomous mode,
no data sharing through I2C, just GPIO level change if
human / object is detected.
•4 detection thresholds criteria :
•Above High
•Below Low
•In Window (<=High AND >=Low)
•Out of Window (>High OR <Low)
•No target ( Interrupt is generated when no
target is present.)
Key figures
•No I2C data output (low
power mode)
•GPIO1 level changes (INT)
to wake-up the host
•Host can then make
VL53L1 switch to active
mode for full ranging
capabilities
INT
Key figures
•ROI size is possible ( 4x4 to 16x16 spad
array)

Timing Budget
•Timing Budget and Inter measurement budget statically configured as
part of Initialized process.
•It allows user to configure timing budget and Inter measurement budget
by calling sub sequentAPI in Application level.
•For Example : In Init time, let say default timing budget set to 41ms and inter
measurement timing budget set to 500ms.
•If user wants to update with new value then call it by followingAPI subsequently.
•VL53L1_SetMeasurementTimingBudgetMicroSeconds(Dev, 50000); // 50ms
•VL53L1_SetInterMeasurementPeriodMilliSeconds(Dev, 1000); //1sec
9

Software Package

Package
•On www.st.com
•X-CUBE-53L1A1 : Link
•VL53L1X GUI(STSW-IMG008) : Link
•VL53L1XAPI(STSW-IMG007) : Link
•Data sheet , User manual and GUI UM can get at st.com.
11

Software Flow
12
VL53L1_WaitDeviceBooted(
): It ensures that the device
is booted and ready.
DataInit():It performs device
initialization. Call once only.
StaticInit():It loads device
settings.
StartMeasurement():It must
be called to start a
measurement
Waitmeasuremetndataready
():It polls on the device
interrupt status until ranging
data are ready.
GetRangeMesurementData
Ready():To know if new
randing data is ready.
GetRangeMesurementData(
): To get ranging data.
ClearInturruptAndStartMeas
rement():Inturrupt, is
cleared. To get consistent
results, it is mandatory to
call this function after getting
the ranging measurement.

VL53L1X Calibration
13
•To gain full performance of the device, calibration functions should run
once at the customer production line.
Note: X-talk calibration distance chart, same as
Ewok.

SDK
14
•We see software distribution of an application using the X-NUCLEO-
53L1A1 expansion with either the NUCLEO-F401RE or NUCLEO-
L476RG board.
STM32 Nucleo BSP
VL53l1x Driver
STM32 HAL
Application main.c

Ranging Result
15
•Ranging result can by seen by serial communication , either using
telnet or tera term.

VL53L1X GUI : HOW TO
•Download from st.com searching for “STSW-IMG008”
•Run the installer with Admin privileges
•PC Graphical User Interface to
•Display (in live) key ranging data (distance, signal rate)
•Change key parameters of VL53L1X
•Perform calibration phases (offset and xTalk with cover glass)
•Get data logging (.csv file)
•GUI is running on the PC connected to a P-NUCLEO-53L1A1 pack
•Flash FW to Nucleo board
•Start ranging and data will be transferred via USB to COM and display it in GUI
•It supports following OS.
•Windows 7
•Windows 8
•Windows 10 (run as an admin must)
16

VL53L1X - GUI
17
•The “Low-power Autonomous” tab provides ranging distance and signal
strength reflected from target.
•You can configure various parameters :
•Distance mode
•Threshold option
•Timing budget
•Inter measurement period
•ROI selection
•Calibration Tab
•It guides the steps to calibrate.
•Date logging
•It captures range measurement data and save to a file during ranging.
•About
•Get the versioning of GUI application and flash firmware.

Source code Files
18
•Drivers: Deal with only following 7 files.
•Platform
•Application
•X-Nucleo-53L1A1

Analysis Application file
19
•The released SW package supports
•Interrupt mode:an Interrupt pin (GPIO1) sends an interrupt to the host when a new measurement is
available.
•Polling Mode: Host has to check the status of ongoing measurement by polling API.
•Just to flip this flag to switch mode in main.c
Interrupt is comping from PIN4
which is configured as an
Interrupt, get by this function
In polling, host must check ranging data is
ready ?

Interrupt mode - Threshold
20
•Threshold can be set based on signal or distance or both parameters.
•Distance detection mode is governed by CrossMode value.
•4 detection thresholds criteria :
•Above High ( CrossMode =1)
•Below Low ( CrossMode =0)
•In Window (<=High AND >=Low) ( CrossMode =3)
•Out of Window (>High OR <Low) ( CrossMode =2)
•No Target (IntrNoTarget =1)
For example: