ST VL53L3CX - Bare Driver Errors and Warnings

8 Bare driver errors and warnings
Driver error is reported when any driver function is called. Possible values for driver errors are described in the
following table.
Warning are there to inform user that some parameters are not optimized.
The warnings are not blocking for the host.
Table 5. Bare driver errors and warnings description
Error value API error string Occurrence
0 VL53LX_ERROR_NONE No error
-1 VL53LX_ERROR_CALIBRATION_WARNING Invalid calibration data
-4 VL53LX_ERROR_INVALID_PARAMS Invalid parameter is set in a function
-5 VL53LX_ERROR_NOT_SUPPORTED
Requested parameter is not supported in the
programmed configuration
-6 VL53LX_ERROR_RANGE_ERROR Interrupt status is incorrect
-7 VL53LX_ERROR_TIME_OUT Ranging is aborted due to timeout
-8 VL53LX_ERROR_MODE_NOT_SUPPORTED Requested mode is not supported
-10 VL53LX_ERROR_COMMS_BUFFER_TOO_SMALL Supplied buffer is larger than I2C supports
-13 VL53LX_ERROR_CONTROL_INTERFACE Error reported from IO function
-14 VL53LX_ERROR_INVALID_COMMAND Command is invalid
-16 VL53LX_ERROR_REF_SPAD_INIT
An error occurred during Reference SPAD
calibration
-17 VL53LX_ERROR_GPH_SYNC_CHECK_FAIL
Driver out of sync with device. A stop/start or a
reboot may be needed
-18 VL53LX_ERROR_STREAM_COUNT_CHECK_FAIL
-19 VL53LX_ERROR_GPH_ID_CHECK_FAIL
-20
VL53LX_ERROR_ZONE_STREAM_COUNT_CHEC
K_FAIL
-21 VL53LX_ERROR_ZONE_GPH_ID_CHECK_FAIL
-22 VL53LX_ERROR_XTALK_EXTRACTION_FAIL
No successful samples when using the full array to
sample the crosstalk. In this case there is not
enough information to generate new crosstalk value.
The function will exit and leave the current crosstalk
parameters unaltered
-23
VL53LX_ERROR_XTALK_EXTRACTION_SIGMA_L
IMIT_FAIL
The avg sigma estimate of the crosstalk sample is >
than the maximal limit allowed. In this case the
crosstalk sample is too noisy for measurement. The
function will exit and leave the current crosstalk
parameters unaltered
-24
VL53LX_ERROR_OFFSET_CAL_NO_SAMPLE_FA
IL
An error occurred during offset calibration. Check
setup is in line with ST recommendations.
-25
VL53LX_ERROR_OFFSET_CAL_NO_SPADS_ENA
BLED_FAIL
-28
VL53LX_WARNING_REF_SPAD_CHAR_NOT_EN
OUGH_SPADS
Warning: number of spads found is too low to get
accurate refSpadManagement calibration. Ensure
setup is in line with ST recommendations.
-29
VL53LX_WARNING_REF_SPAD_CHAR_RATE_TO
O_HIGH
Warning: signal rate found too low to get accurate
refSpadManagement calibration. Ensure setup is in
line with ST recommendations.
UM2778
Bare driver errors and warnings
UM2778 - Rev 1
page 20/25