ST VL53L3CX User Manual
  1. Manuals
  2. Brands
  3. ST Manuals
  4. Accessories
  5. VL53L3CX
  6. User manual

ST VL53L3CX User Manual

Time-of-flight ranging module with multi object detection
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
UM2778
User manual
VL53L3CX Time-of-Flight ranging module with multi object detection
Introduction
VL53L3CX is a Time-of-Flight (ToF) ranging sensor module.
The purpose of this user manual is to describe the integration model and the set of functions to call to get ranging data using the
VL53L3CX bare driver.
UM2778 - Rev 1 - September 2020
www.st.com
For further information contact your local STMicroelectronics sales office.

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the VL53L3CX and is the answer not in the manual?

Questions and answers

Related Manuals for ST VL53L3CX

Summary of Contents for ST VL53L3CX

  • Page 1 UM2778 User manual VL53L3CX Time-of-Flight ranging module with multi object detection Introduction VL53L3CX is a Time-of-Flight (ToF) ranging sensor module. The purpose of this user manual is to describe the integration model and the set of functions to call to get ranging data using the VL53L3CX bare driver.

  • Page 2: Vl53L3Cx System Overview

    The bare driver is an implementation of a set of functions required to use the VL53L3CX device. It makes minimal assumptions on the OS integration and services. As such, sequencing of actions, execution/threading model, platform adaptation, and device structures allocation are not part of the bare driver implementation but left open to the integrator.

  • Page 3: Ranging Functional Description

    UM2778 Ranging functional description Ranging functional description This section briefly describes the functional capabilities of VL53L3CX ranging device. Ranging sequence The device is running with a handshake mechanism, based on a standard interrupt management scheme. After each ranging, the host acquires the ranging data and enables the next ranging by clearing the interrupt. This process is referred to as the handshake mechanism.
  • Page 4 UM2778 Ranging sequence Figure 2. VL53L3CX ranging sequence overview Power Up & XSHUT released Host action Boot Bare Driver internal action Ranging Start VL53L3CX Init internal action Get and Ignore Interrupt raised ranging data Range1 Interrupt Clear interrupt init cleared...

  • Page 5: Timing Considerations

    UM2778 Timing considerations The handshake must be performed by the user of the bare driver. The delay to enable a new ranging after a new measurement has been received is key to overall system measurement rate. Timing considerations Timings are presented in Figure 3.

  • Page 6: Bare Driver Basic Functions Description

    Factory applications used for device calibration, typically at end product manufacturing test (factory flow) • Field applications, which gather all end-user applications using the VL53L3CX device (ranging flow) Bare driver Bare driver factory flow is illustrated in the following figure.
  • Page 7 UM2778 Bare driver Figure 5. VL53L3CX API ranging flow (field) WaitDeviceBooted() Host calls driver Host action function DataInit() Driver internal Data result SetCalibrationData() action Host calls Optional SetDistanceMode() driver function StartMeasurement() Polling/ Interrupt mode Host polling mode interrupt Driver polling mode...

  • Page 8: System Initialization

    UM2778 System initialization System initialization The following section shows the API functions calls required to perform the system initialization, before starting a measurement. 3.2.1 Wait for boot VL53LX_WaitDeviceBooted() function ensures that the device is booted and ready. It is not mandatory to call this function. Note: This function blocks the host execution.

  • Page 9: Ranging With Vl53L3Cx

    UM2778 Ranging with VL53L3CX Ranging with VL53L3CX On non-Linux hosts, the user of the bare driver sequences calls to the driver in a way that is appropriate to the application needs, the platform capabilities and the bare driver call sequence rules.

  • Page 10: Ranging Data Structures

    UM2778 Ranging data structures Ranging data structures The structure named VL53LX_MultiRangingData_t contains the following data applicable to all targets detected: • TimeStamp: not implemented. • StreamCount: this 8-bit integer gives a counter incremented at each range. The value starts at 0, incrementing 1 by 1 up to 255.
  • Page 11 UM2778 Ranging data structures Table 1. Range Status Value RangeStatus String Comment VL53LX_RANGESTATUS_RANGE_VALID Ranging measurement is valid Raised if sigma estimator check is above the internal VL53LX_RANGESTATUS_SIGMA_FAIL defined threshold. Sigma estimator gives a qualitative information about the signal. VL53LX_RANGESTATUS_SIGNAL_FAIL Raised when signal is too low to detect a target. VL53LX_RANGESTATUS_OUTOFBOUNDS_FAIL Raised when range result is out of bounds VL53LX_RANGESTATUS_HARDWARE_FAIL...

  • Page 12: Additional Driver Functions Description

    5.3.1 Set a tuning parameter An extra function exists to load tuning parameters. For specific use cases, ST can recommend some specific parameters composed of a key and a value. The list of tuning parameters and their default values is given in the vl53lx_tuning_parm_defaults.h file. Either change a tuning parameter value in this file and recompile the code, or use the VL53LX_SetTuningParameter() function to load this tuning parameter.

  • Page 13: Improve Accuracy

    If the user increases the value, the maximum ranging distance can be improved, but latency is impacted. Coverglass smudge detection The crosstalk can be affected by smudge on the coverglass. VL53L3CX embeds a function able to detect smudge on the fly and apply a new crosstalk correction value.

  • Page 14: Customer Factory Calibration Functions

    Customer factory calibration functions Customer factory calibration functions In order to get benefit of full performance of the device, VL53L3CX driver includes calibration functions to be run once at customer production line. Calibration procedures have to be run to compensate part to part parameters that may affect the device performances.

  • Page 15: Getting Refspad Calibration Results

    (coverglass) added on top of the module for aesthetic reasons. Depending on the coverglass quality, this parasitic signal can affect the device performances. VL53L3CX has a built in correction that allows to compensate this problem.

  • Page 16: Getting Crosstalk Calibration Results

    UM2778 Offset calibration 6.2.3 Getting crosstalk calibration results Calibration results consist, among others, of an histogram and a parameter called “plane offset”. The plane offset represents the amount of correction applied, and the histogram is the repartition of the correction on each bin. The function VL53LX_GetCalibrationData() returns all the calibration data.

  • Page 17: Offset Calibration Procedure

    UM2778 Offset calibration 6.3.2 Offset calibration procedure Customers can select any chart reflectance placed at any distance (using the same setup as the crosstalk calibration). The only point to check is to ensure the signal rate is measured between 2 and 80MCps with the chosen setup.

  • Page 18: Setting Offset Calibration Data

    UM2778 Offset calibration 6.3.5 Setting offset calibration data The customer can load the offset calibration data after VL53LX_DataInit() function is called, by using VL53LX_SetCalibrationData(). It is better to call VL53LX_GetCalibrationData(), modify the parameters described in previous sections and call VL53LX_SetCalibrationData() UM2778 - Rev 1 page 18/25...

  • Page 19: Customer Repair Shop Calibrations

    UM2778 Customer repair shop calibrations Customer repair shop calibrations In case the calibration values are lost, due to component change in a repair shop, customer can apply a dedicated procedure, where no specific setup (targets) are needed. The calibration is composed of three steps: RefSpad Crosstalk Offset calibrations...

  • Page 20: Bare Driver Errors And Warnings

    IMIT_FAIL function will exit and leave the current crosstalk parameters unaltered VL53LX_ERROR_OFFSET_CAL_NO_SAMPLE_FA An error occurred during offset calibration. Check setup is in line with ST recommendations. VL53LX_ERROR_OFFSET_CAL_NO_SPADS_ENA BLED_FAIL Warning: number of spads found is too low to get VL53LX_WARNING_REF_SPAD_CHAR_NOT_EN accurate refSpadManagement calibration. Ensure OUGH_SPADS setup is in line with ST recommendations.
  • Page 21 Warning occurred during offset calibration. Ensure setup is in line with ST recommendations. VL53LX_WARNING_OFFSET_CAL_RATE_TOO_HI VL53LX_WARNING_OFFSET_CAL_SPAD_COUNT _TOO_LOW Warning occurred during crosstalk calibration. VL53LX_WARNING_XTALK_MISSING_SAMPLES Ensure setup is in line with ST recommendations. VL53LX_ERROR_NOT_IMPLEMENTED Function called is not implemented UM2778 - Rev 1 page 21/25...

  • Page 22: Revision History

    UM2778 Revision history Table 6. Document revision history Date Version Changes 28-Sep-2020 Initial release UM2778 - Rev 1 page 22/25...

  • Page 23: Table Of Contents

    VL53L3CX system overview ........
  • Page 24 UM2778 Contents 6.1.1 RefSPAD calibration function ..........14 6.1.2 RefSPAD calibration procedure.
  • Page 25 ST’s terms and conditions of sale in place at the time of order acknowledgement. Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the design of Purchasers’...

Table of Contents