The following DEFINE are used to identify the PAL ERROR. More...
Typedefs | |
| typedef int8_t | VL53L1_Error |
The following DEFINE are used to identify the PAL ERROR.
| #define VL53L1_ERROR_BUFFER_TOO_SMALL ((VL53L1_Error) - 9) |
...
Definition at line 112 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_CALIBRATION_WARNING ((VL53L1_Error) - 1) |
Warning invalid calibration data may be in used VL53L1_InitData() VL53L1_GetOffsetCalibrationData VL53L1_SetOffsetCalibrationData
Definition at line 92 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_COMMS_BUFFER_TOO_SMALL ((VL53L1_Error) - 10) |
Supplied buffer is larger than I2C supports
Definition at line 114 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_CONTROL_INTERFACE ((VL53L1_Error) - 13) |
error reported from IO functions
Definition at line 120 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_DIVISION_BY_ZERO ((VL53L1_Error) - 15) |
In the function a division by zero occurs
Definition at line 125 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_GPH_ID_CHECK_FAIL ((VL53L1_Error) - 19) |
GPH ID check fail - API out of sync with device
Definition at line 133 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_GPH_SYNC_CHECK_FAIL ((VL53L1_Error) - 17) |
GPH sync interrupt check fail - API out of sync with device
Definition at line 129 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED ((VL53L1_Error) - 12) |
unsupported GPIO functionality
Definition at line 118 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_GPIO_NOT_EXISTING ((VL53L1_Error) - 11) |
User tried to setup a non-existing GPIO pin
Definition at line 116 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_INVALID_COMMAND ((VL53L1_Error) - 14) |
The command is not allowed in the current device state (power down)
Definition at line 122 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_INVALID_PARAMS ((VL53L1_Error) - 4) |
Parameter passed is invalid or out of range
Definition at line 102 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_MIN_CLIPPED ((VL53L1_Error) - 2) |
Warning parameter passed was clipped to min before to be applied
Definition at line 97 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_MODE_NOT_SUPPORTED ((VL53L1_Error) - 8) |
Asked mode is not supported by the device
Definition at line 110 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_NONE ((VL53L1_Error) 0) |
Definition at line 91 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_NOT_IMPLEMENTED ((VL53L1_Error) - 41) |
Tells requested functionality has not been implemented yet or not compatible with the device
Definition at line 240 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_NOT_SUPPORTED ((VL53L1_Error) - 5) |
Function is not supported in current mode or configuration
Definition at line 104 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_OFFSET_CAL_NO_SAMPLE_FAIL ((VL53L1_Error) - 24) |
Thrown if there one of stages has no valid offset calibration samples. A fatal error calibration not valid
Definition at line 153 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_OFFSET_CAL_NO_SPADS_ENABLED_FAIL ((VL53L1_Error) - 25) |
Thrown if there one of stages has zero effective SPADS Traps the case when MM1 SPADs is zero. A fatal error calibration not valid
Definition at line 156 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_PLATFORM_SPECIFIC_START ((VL53L1_Error) - 60) |
Tells the starting code for platform
Definition at line 243 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_RANGE_ERROR ((VL53L1_Error) - 6) |
Device report a ranging error interrupt status
Definition at line 106 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_REF_SPAD_INIT ((VL53L1_Error) - 16) |
Error during reference SPAD initialization
Definition at line 127 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_STREAM_COUNT_CHECK_FAIL ((VL53L1_Error) - 18) |
Stream count check fail - API out of sync with device
Definition at line 131 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_TIME_OUT ((VL53L1_Error) - 7) |
Aborted due to time out
Definition at line 108 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_TUNING_PARM_KEY_MISMATCH ((VL53L1_Error) - 27) |
Thrown if the tuning file key table version does not match with expected value. The driver expects the key table version to match the compiled default version number in the define VL53L1_TUNINGPARM_KEY_TABLE_VERSION_DEFAULT
Definition at line 164 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_UNDEFINED ((VL53L1_Error) - 3) |
Unqualified error
Definition at line 100 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_XTALK_EXTRACTION_NO_SAMPLE_FAIL ((VL53L1_Error) - 22) |
Thrown when run_xtalk_extraction fn has 0 succesful samples when using the full array to sample the xtalk. In this case there is not enough information to generate new Xtalk parm info. The function will exit and leave the current xtalk parameters unaltered
Definition at line 140 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_XTALK_EXTRACTION_SIGMA_LIMIT_FAIL ((VL53L1_Error) - 23) |
Thrown when run_xtalk_extraction fn has found that the avg sigma estimate of the full array xtalk sample is > than the maximal limit allowed. In this case the xtalk sample is too noisy for measurement. The function will exit and leave the current xtalk parameters unaltered.
Definition at line 145 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_ZONE_CAL_NO_SAMPLE_FAIL ((VL53L1_Error) - 26) |
Thrown if then some of the zones have no valid samples A fatal error calibration not valid
Definition at line 160 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_ZONE_GPH_ID_CHECK_FAIL ((VL53L1_Error) - 21) |
Zone dynamic config GPH ID check failed - API out of sync
Definition at line 137 of file vl53l1_error_codes.h.
| #define VL53L1_ERROR_ZONE_STREAM_COUNT_CHECK_FAIL ((VL53L1_Error) - 20) |
Zone dynamic config stream count check failed - API out of sync
Definition at line 135 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_OFFSET_CAL_MISSING_SAMPLES ((VL53L1_Error) - 31) |
Thrown if there is less than the requested number of valid samples.
Definition at line 183 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_OFFSET_CAL_RATE_TOO_HIGH ((VL53L1_Error) - 33) |
Thrown when VL53L1_run_offset_calibration() peak rate is greater than that 50.0Mcps. This is the recommended max rate to avoid pile-up influencing the offset measurement
Definition at line 190 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_OFFSET_CAL_SIGMA_TOO_HIGH ((VL53L1_Error) - 32) |
Thrown if the offset calibration range sigma estimate is greater than 8.0 mm. This is the recommended min value to yield a stable offset measurement
Definition at line 186 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_OFFSET_CAL_SPAD_COUNT_TOO_LOW ((VL53L1_Error) - 34) |
Thrown when VL53L1_run_offset_calibration() when one of stages range has less that 5.0 effective SPADS. This is the recommended min value to yield a stable offset
Definition at line 194 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_REF_SPAD_CHAR_NOT_ENOUGH_SPADS ((VL53L1_Error) - 28) |
Thrown if there are less than 5 good SPADs are available.
Definition at line 171 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_REF_SPAD_CHAR_RATE_TOO_HIGH ((VL53L1_Error) - 29) |
Thrown if the final reference rate is greater than the upper reference rate limit - default is 40 Mcps. Implies a minimum Q3 (x10) SPAD (5) selected
Definition at line 173 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_REF_SPAD_CHAR_RATE_TOO_LOW ((VL53L1_Error) - 30) |
Thrown if the final reference rate is less than the lower reference rate limit - default is 10 Mcps. Implies maximum Q1 (x1) SPADs selected
Definition at line 177 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_XTALK_MISSING_SAMPLES ((VL53L1_Error) - 38) |
Thrown to notify that some of the xtalk samples did not yield valid ranging pulse data while attempting to measure the xtalk signal in vl53l1_run_xtalk_extract(). This can signify any of the zones are missing samples, for further debug information the xtalk_results struct should be referred to. This warning is for notification only, the xtalk pulse and shape have still been generated
Definition at line 213 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_XTALK_NO_SAMPLES_FOR_GRADIENT ((VL53L1_Error) - 39) |
Thrown to notify that some of teh xtalk samples used for gradient generation did not yield valid ranging pulse data while attempting to measure the xtalk signal in vl53l1_run_xtalk_extract(). This can signify that any one of the zones 0-3 yielded no successful samples. The xtalk_results struct should be referred to for further debug info. This warning is for notification only, the xtalk pulse and shape have still been generated.
Definition at line 221 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_XTALK_SIGMA_LIMIT_FOR_GRADIENT ((VL53L1_Error) - 40) |
Thrown to notify that some of the xtalk samples used for gradient generation did not pass the sigma limit check while attempting to measure the xtalk signal in vl53l1_run_xtalk_extract(). This can signify that any one of the zones 0-3 yielded an avg sigma_mm value > the limit. The xtalk_results struct should be referred to for further debug info. This warning is for notification only, the xtalk pulse and shape have still been generated.
Definition at line 230 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_ZONE_CAL_MISSING_SAMPLES ((VL53L1_Error) - 35) |
Thrown if one of more of the zones have less than the requested number of valid samples
Definition at line 200 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_ZONE_CAL_RATE_TOO_HIGH ((VL53L1_Error) - 37) |
Thrown if one of more zones have peak rate higher than that 50.0Mcps. This is the recommended max rate to avoid pile-up influencing the offset measurement
Definition at line 207 of file vl53l1_error_codes.h.
| #define VL53L1_WARNING_ZONE_CAL_SIGMA_TOO_HIGH ((VL53L1_Error) - 36) |
Thrown if one or more zones have sigma estimate value greater than 8.0 mm. This is the recommended min value to yield a stable offset measurement
Definition at line 203 of file vl53l1_error_codes.h.
| typedef int8_t VL53L1_Error |
Definition at line 89 of file vl53l1_error_codes.h.