To Next PageTo Next Page
Need help?Do you have a question about the ST VL53L1X API and is the answer not in the manual?
General| Brand | ST |
|---|---|
| Model | VL53L1X API |
| Category | Control Unit |
| Language | English |
Describes the autonomous ranging process and host interaction for distance measurement.
Explains how to detect objects based on predefined distance criteria using specific functions.
Details timing budget (TB) and inter-measurement period (IMP) for measurement accuracy and power.
Outlines the sequence of API calls for sensor calibration during manufacturing.
Describes the sequence of API calls for distance measurements and object detection.
Explains the VL53L1X_BootState function to verify sensor boot-up before I2C access.
Describes the VL53L1X_SensorInit function for initializing the sensor with default configuration.
Details the VL53L1X_StartRanging function to initiate a distance measurement.
Explains methods for receiving notifications when ranging data is ready (polling or interrupt).
Describes functions like GetRangeStatus and GetDistance to retrieve measurement results.
Explains the VL53L1X_ClearInterrupt function to reset the interrupt for new data events.
Details the VL53L1X_Stop function to halt ongoing ranging operations.
Describes how to set distance modes (Short/Long) affecting range and ambient light performance.
Explains setting the time between ranging operations (IMP) and its relation to timing budget.
Details setting the timing budget (TB) for measurement accuracy and power consumption.
Configures detection criteria and interrupts based on distance thresholds and window modes.
Explains how to program the Region of Interest (ROI) to reduce FoV and SPAD usage.
Covers running, getting, and setting offset calibration for device-to-device variations.
Details crosstalk calibration to compensate for cover glass effects on ranging performance.
Details the step-by-step procedure for performing crosstalk calibration.
Explains how to apply the calibrated crosstalk value to the sensor.
Returns the software driver version.
Sets the sensor's I2C address for multi-device applications.
Loads configuration values to initialize the sensor.
Clears the interrupt flag after data reading to arm the next event.
Programs the interrupt polarity (active high or low).
Returns the current interrupt polarity setting.
Starts the continuous distance ranging operation.
Stops the ongoing ranging operation.
Checks if new ranging data is available by polling a register.
Programs the timing budget in milliseconds for measurements.
Returns the current timing budget in milliseconds.
Sets the distance mode (Short or Long) affecting range and performance.
Returns the current distance mode setting.
Programs the inter-measurement period in milliseconds.
Returns the current inter-measurement period in milliseconds.
Returns the boot state of the device (booted or not).
Returns the sensor ID, which should be 0xEEAC.
Returns the measured distance in millimeters.
Gives the returned signal per SPAD in kcps/SPAD.
Returns the ambient per SPAD in kcps/SPAD.
Gives the returned signal in kcps.
Returns the current number of enabled SPADs.
Returns the ambient rate in kcps.
Returns the ranging status error code.
Programs the offset correction value in millimeters.
Returns the programmed offset correction value in millimeters.
Programs the crosstalk correction value in cps.
Returns the current programmed crosstalk correction value in cps.
Programs the threshold detection mode and criteria.
Returns the window detection mode (below, above, out, in).
Returns the low distance threshold in millimeters.
Returns the high distance threshold in millimeters.
Programs the Region of Interest (ROI) width and height.
Returns the current ROI width and height.
Programs a new signal threshold in kcps.
Returns the current signal threshold in kcps.
Programs a new sigma threshold in millimeters.
Returns the current sigma threshold in millimeters.
Performs temperature calibration or update.
