Data Sheet

Driver errors and warnings UM2356
24/28 DocID031478 Rev 1
4 Driver errors and warnings
The driver error is reported when any driver function is called. Possible values for driver
errors are described in
Table 7.
Please note that warnings exist to inform the user that some parameters are not optimized.
The warnings are not blocking points for the host.
Table 7. Bare driver errors and warnings descriptions
Error
value
API error string Occurrence
0 VL53L1_ERROR_NONE No error
-1 VL53L1_ERROR_CALIBRATION_WARNING Invalid calibration data
-4 VL53L1_ERROR_INVALID_PARAMS Invalid parameter is set in a function
-5 VL53L1_ERROR_NOT_SUPPORTED
Requested parameter is not supported in the
programmed configuration
-6 VL53L1_ERROR_RANGE_ERROR Interrupt status is incorrect
-7 VL53L1_ERROR_TIME_OUT Ranging is aborted due to timeout
-8 VL53L1_ERROR_MODE_NOT_SUPPORTED Requested mode is not supported
-10 VL53L1_ERROR_CALIBRATION_WARNING Supplied buffer is larger than I2C supports
-14 VL53L1_ERROR_INVALID_COMMAND Command is invalid in current mode
-16 VL53L1_ERROR_REF_SPAD_INIT An error occurred during reference SPAD calibration
-22 VL53L1_ERROR_XTALK_EXTRACTION_FAIL
Thrown when crosstalk calibration function has no
successful samples to compute the crosstalk. In this
case there is not enough information to generate new
crosstalk parameter information. The function will exit
and leave the current crosstalk parameters unaltered.
-23
VL53L1_ERROR_XTALK_EXTRACTION_SIGMA_
LIMIT_FAIL
Thrown when crosstalk calibration function has found
that the sigma estimate is above 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
VL53L1_ERROR_OFFSET_CAL_NO_SAMPLE_
FAIL
Thrown when offset calibration function has found no
valid ranging.
-28
VL53L1_WARNING_REF_SPAD_CHAR_NOT_
ENOUGH_SPADS
Thrown if there are less than five good SPADs
available. Ensure calibration setup is in line with ST
recommendations.
-29
VL53L1_WARNING_REF_SPAD_CHAR_RATE_
TOO_HIGH
Thrown if the final reference rate is greater than the
upper reference rate limit - default is 40 Mcps. Ensure
calibration setup is in line with ST recommendations.
-30
VL53L1_WARNING_REF_SPAD_CHAR_RATE_
TOO_LOW
Thrown if the final reference rate is less than the
lower reference rate limit - default is 10 Mcps. Ensure
calibration setup is in line with ST recommendations.