VL53L1 function declarations for decoding error codes to a text strings. More...
#include "vl53l1_error_codes.h"
Go to the source code of this file.
Macros | |
| #define | VL53L1_STRING_ERROR_BUFFER_TOO_SMALL "Buffer too small" |
| #define | VL53L1_STRING_ERROR_CALIBRATION_WARNING "Calibration Warning Error" |
| #define | VL53L1_STRING_ERROR_COMMS_BUFFER_TOO_SMALL "Comms Buffer too small" |
| #define | VL53L1_STRING_ERROR_CONTROL_INTERFACE "Control Interface Error" |
| #define | VL53L1_STRING_ERROR_DEVICE_FIRMWARE_TOO_NEW "Device Firmware too new" |
| #define | VL53L1_STRING_ERROR_DEVICE_FIRMWARE_TOO_OLD "Device Firmware too old" |
| #define | VL53L1_STRING_ERROR_DIVISION_BY_ZERO "Division by zero Error" |
| #define | VL53L1_STRING_ERROR_FILE_READ_FAIL "File Read Fail" |
| #define | VL53L1_STRING_ERROR_FILE_WRITE_FAIL "File Write Fail" |
| #define | VL53L1_STRING_ERROR_GPH_ID_CHECK_FAIL "GPH ID Check Fail - API out of sync" |
| #define | VL53L1_STRING_ERROR_GPH_SYNC_CHECK_FAIL "GPH Sync Check Fail - API out of sync" |
| #define | VL53L1_STRING_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED "GPIO funct not supported" |
| #define | VL53L1_STRING_ERROR_GPIO_NOT_EXISTING "GPIO not existing" |
| #define | VL53L1_STRING_ERROR_INVALID_COMMAND "Invalid Command Error" |
| #define | VL53L1_STRING_ERROR_INVALID_PARAMS "Invalid parameters error" |
| #define | VL53L1_STRING_ERROR_MIN_CLIPPED "Min clipped error" |
| #define | VL53L1_STRING_ERROR_MODE_NOT_SUPPORTED "Mode not supported error" |
| #define | VL53L1_STRING_ERROR_NONE "No Error" |
| #define | VL53L1_STRING_ERROR_NOT_IMPLEMENTED "Not implemented error" |
| #define | VL53L1_STRING_ERROR_NOT_SUPPORTED "Not supported error" |
| #define | VL53L1_STRING_ERROR_OFFSET_CAL_NO_SAMPLE_FAIL "Offset Cal - one of more stages with no valid samples - fatal" |
| #define | VL53L1_STRING_ERROR_OFFSET_CAL_NO_SPADS_ENABLED_FAIL "Offset Cal - one of more stages with no SPADS enables - fatal" |
| #define | VL53L1_STRING_ERROR_RANGE_ERROR "Range error" |
| #define | VL53L1_STRING_ERROR_REF_SPAD_INIT "Reference Spad Init Error" |
| #define | VL53L1_STRING_ERROR_STREAM_COUNT_CHECK_FAIL "Stream Count Check Fail - API out of sync" |
| #define | VL53L1_STRING_ERROR_TIME_OUT "Time out error" |
| #define | VL53L1_STRING_ERROR_UNDEFINED "Undefined error" |
| #define | VL53L1_STRING_ERROR_UNIT_TEST_FAIL "Unit Test Fail" |
| #define | VL53L1_STRING_ERROR_XTALK_EXTRACTION_NO_SAMPLES_FAIL "No Xtalk using full array - Xtalk Extract Fail" |
| #define | VL53L1_STRING_ERROR_XTALK_EXTRACTION_SIGMA_LIMIT_FAIL "Xtalk does not meet required sigma limit - Xtalk Extract Fail" |
| #define | VL53L1_STRING_ERROR_ZONE_CAL_NO_SAMPLE_FAIL "Zone Cal - one of more zones with no valid samples - fatal" |
| #define | VL53L1_STRING_ERROR_ZONE_GPH_ID_CHECK_FAIL "Zone GPH ID Check Fail - API out of sync" |
| #define | VL53L1_STRING_ERROR_ZONE_STREAM_COUNT_CHECK_FAIL "Zone Stream Count Check Fail - API out of sync" |
| #define | VL53L1_STRING_UNKNOW_ERROR_CODE "Unknown Error Code" |
| #define | VL53L1_STRING_WARNING_OFFSET_CAL_MISSING_SAMPLES "Offset Cal - Less than the requested number of valid samples" |
| #define | VL53L1_STRING_WARNING_OFFSET_CAL_RATE_TOO_HIGH "Offset Cal - Rate too high - in pile up" |
| #define | VL53L1_STRING_WARNING_OFFSET_CAL_SIGMA_TOO_HIGH "Offset Cal - Sigma estimate value too high - offset not stable" |
| #define | VL53L1_STRING_WARNING_OFFSET_CAL_SPAD_COUNT_TOO_LOW "Offset Cal - Insufficient SPADs - offset may not be stable" |
| #define | VL53L1_STRING_WARNING_REF_SPAD_CHAR_NOT_ENOUGH_SPADS "Ref SPAD Char - Not Enough Good SPADs" |
| #define | VL53L1_STRING_WARNING_REF_SPAD_CHAR_RATE_TOO_HIGH "Ref SPAD Char - Final Ref Rate too high" |
| #define | VL53L1_STRING_WARNING_REF_SPAD_CHAR_RATE_TOO_LOW "Ref SPAD Char - Final Ref Rate too low" |
| #define | VL53L1_STRING_WARNING_XTALK_MISSING_SAMPLES "Xtalk - Some missing and invalid samples" |
| #define | VL53L1_STRING_WARNING_XTALK_NO_SAMPLES_FOR_GRADIENT "Xtalk - Gradient sample num = 0" |
| #define | VL53L1_STRING_WARNING_XTALK_SIGMA_LIMIT_FOR_GRADIENT "Xtalk - Gradient Sigma > Limit" |
| #define | VL53L1_STRING_WARNING_ZONE_CAL_MISSING_SAMPLES "Zone Cal - One or more zone with less than requested valid samples" |
| #define | VL53L1_STRING_WARNING_ZONE_CAL_RATE_TOO_HIGH "Zone Cal - One of more zones with rate too high - in pile up" |
| #define | VL53L1_STRING_WARNING_ZONE_CAL_SIGMA_TOO_HIGH "Zone Cal - One of more zones the sigma estimate too high" |
Functions | |
| VL53L1_Error | VL53L1_get_pal_error_string (VL53L1_Error PalErrorCode, char *pPalErrorString) |
| Generates an error string for the input PAL error code. More... | |
Detailed Description
VL53L1 function declarations for decoding error codes to a text strings.
Definition in file vl53l1_error_strings.h.
Macro Definition Documentation
◆ VL53L1_STRING_ERROR_BUFFER_TOO_SMALL
| #define VL53L1_STRING_ERROR_BUFFER_TOO_SMALL "Buffer too small" |
Definition at line 116 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_CALIBRATION_WARNING
| #define VL53L1_STRING_ERROR_CALIBRATION_WARNING "Calibration Warning Error" |
Definition at line 100 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_COMMS_BUFFER_TOO_SMALL
| #define VL53L1_STRING_ERROR_COMMS_BUFFER_TOO_SMALL "Comms Buffer too small" |
Definition at line 118 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_CONTROL_INTERFACE
| #define VL53L1_STRING_ERROR_CONTROL_INTERFACE "Control Interface Error" |
Definition at line 124 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_DEVICE_FIRMWARE_TOO_NEW
| #define VL53L1_STRING_ERROR_DEVICE_FIRMWARE_TOO_NEW "Device Firmware too new" |
Definition at line 187 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_DEVICE_FIRMWARE_TOO_OLD
| #define VL53L1_STRING_ERROR_DEVICE_FIRMWARE_TOO_OLD "Device Firmware too old" |
Definition at line 185 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_DIVISION_BY_ZERO
| #define VL53L1_STRING_ERROR_DIVISION_BY_ZERO "Division by zero Error" |
Definition at line 128 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_FILE_READ_FAIL
| #define VL53L1_STRING_ERROR_FILE_READ_FAIL "File Read Fail" |
Definition at line 191 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_FILE_WRITE_FAIL
| #define VL53L1_STRING_ERROR_FILE_WRITE_FAIL "File Write Fail" |
Definition at line 193 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_GPH_ID_CHECK_FAIL
| #define VL53L1_STRING_ERROR_GPH_ID_CHECK_FAIL "GPH ID Check Fail - API out of sync" |
Definition at line 136 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_GPH_SYNC_CHECK_FAIL
| #define VL53L1_STRING_ERROR_GPH_SYNC_CHECK_FAIL "GPH Sync Check Fail - API out of sync" |
Definition at line 132 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED
| #define VL53L1_STRING_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED "GPIO funct not supported" |
Definition at line 122 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_GPIO_NOT_EXISTING
| #define VL53L1_STRING_ERROR_GPIO_NOT_EXISTING "GPIO not existing" |
Definition at line 120 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_INVALID_COMMAND
| #define VL53L1_STRING_ERROR_INVALID_COMMAND "Invalid Command Error" |
Definition at line 126 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_INVALID_PARAMS
| #define VL53L1_STRING_ERROR_INVALID_PARAMS "Invalid parameters error" |
Definition at line 106 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_MIN_CLIPPED
| #define VL53L1_STRING_ERROR_MIN_CLIPPED "Min clipped error" |
Definition at line 102 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_MODE_NOT_SUPPORTED
| #define VL53L1_STRING_ERROR_MODE_NOT_SUPPORTED "Mode not supported error" |
Definition at line 114 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_NONE
| #define VL53L1_STRING_ERROR_NONE "No Error" |
Definition at line 98 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_NOT_IMPLEMENTED
| #define VL53L1_STRING_ERROR_NOT_IMPLEMENTED "Not implemented error" |
Definition at line 196 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_NOT_SUPPORTED
| #define VL53L1_STRING_ERROR_NOT_SUPPORTED "Not supported error" |
Definition at line 108 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_OFFSET_CAL_NO_SAMPLE_FAIL
| #define VL53L1_STRING_ERROR_OFFSET_CAL_NO_SAMPLE_FAIL "Offset Cal - one of more stages with no valid samples - fatal" |
Definition at line 148 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_OFFSET_CAL_NO_SPADS_ENABLED_FAIL
| #define VL53L1_STRING_ERROR_OFFSET_CAL_NO_SPADS_ENABLED_FAIL "Offset Cal - one of more stages with no SPADS enables - fatal" |
Definition at line 150 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_RANGE_ERROR
| #define VL53L1_STRING_ERROR_RANGE_ERROR "Range error" |
Definition at line 110 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_REF_SPAD_INIT
| #define VL53L1_STRING_ERROR_REF_SPAD_INIT "Reference Spad Init Error" |
Definition at line 130 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_STREAM_COUNT_CHECK_FAIL
| #define VL53L1_STRING_ERROR_STREAM_COUNT_CHECK_FAIL "Stream Count Check Fail - API out of sync" |
Definition at line 134 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_TIME_OUT
| #define VL53L1_STRING_ERROR_TIME_OUT "Time out error" |
Definition at line 112 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_UNDEFINED
| #define VL53L1_STRING_ERROR_UNDEFINED "Undefined error" |
Definition at line 104 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_UNIT_TEST_FAIL
| #define VL53L1_STRING_ERROR_UNIT_TEST_FAIL "Unit Test Fail" |
Definition at line 189 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_XTALK_EXTRACTION_NO_SAMPLES_FAIL
| #define VL53L1_STRING_ERROR_XTALK_EXTRACTION_NO_SAMPLES_FAIL "No Xtalk using full array - Xtalk Extract Fail" |
Definition at line 143 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_XTALK_EXTRACTION_SIGMA_LIMIT_FAIL
| #define VL53L1_STRING_ERROR_XTALK_EXTRACTION_SIGMA_LIMIT_FAIL "Xtalk does not meet required sigma limit - Xtalk Extract Fail" |
Definition at line 145 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_ZONE_CAL_NO_SAMPLE_FAIL
| #define VL53L1_STRING_ERROR_ZONE_CAL_NO_SAMPLE_FAIL "Zone Cal - one of more zones with no valid samples - fatal" |
Definition at line 152 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_ZONE_GPH_ID_CHECK_FAIL
| #define VL53L1_STRING_ERROR_ZONE_GPH_ID_CHECK_FAIL "Zone GPH ID Check Fail - API out of sync" |
Definition at line 140 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_ERROR_ZONE_STREAM_COUNT_CHECK_FAIL
| #define VL53L1_STRING_ERROR_ZONE_STREAM_COUNT_CHECK_FAIL "Zone Stream Count Check Fail - API out of sync" |
Definition at line 138 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_UNKNOW_ERROR_CODE
| #define VL53L1_STRING_UNKNOW_ERROR_CODE "Unknown Error Code" |
Definition at line 198 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_OFFSET_CAL_MISSING_SAMPLES
| #define VL53L1_STRING_WARNING_OFFSET_CAL_MISSING_SAMPLES "Offset Cal - Less than the requested number of valid samples" |
Definition at line 162 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_OFFSET_CAL_RATE_TOO_HIGH
| #define VL53L1_STRING_WARNING_OFFSET_CAL_RATE_TOO_HIGH "Offset Cal - Rate too high - in pile up" |
Definition at line 166 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_OFFSET_CAL_SIGMA_TOO_HIGH
| #define VL53L1_STRING_WARNING_OFFSET_CAL_SIGMA_TOO_HIGH "Offset Cal - Sigma estimate value too high - offset not stable" |
Definition at line 164 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_OFFSET_CAL_SPAD_COUNT_TOO_LOW
| #define VL53L1_STRING_WARNING_OFFSET_CAL_SPAD_COUNT_TOO_LOW "Offset Cal - Insufficient SPADs - offset may not be stable" |
Definition at line 168 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_REF_SPAD_CHAR_NOT_ENOUGH_SPADS
| #define VL53L1_STRING_WARNING_REF_SPAD_CHAR_NOT_ENOUGH_SPADS "Ref SPAD Char - Not Enough Good SPADs" |
Definition at line 155 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_REF_SPAD_CHAR_RATE_TOO_HIGH
| #define VL53L1_STRING_WARNING_REF_SPAD_CHAR_RATE_TOO_HIGH "Ref SPAD Char - Final Ref Rate too high" |
Definition at line 157 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_REF_SPAD_CHAR_RATE_TOO_LOW
| #define VL53L1_STRING_WARNING_REF_SPAD_CHAR_RATE_TOO_LOW "Ref SPAD Char - Final Ref Rate too low" |
Definition at line 159 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_XTALK_MISSING_SAMPLES
| #define VL53L1_STRING_WARNING_XTALK_MISSING_SAMPLES "Xtalk - Some missing and invalid samples" |
Definition at line 182 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_XTALK_NO_SAMPLES_FOR_GRADIENT
| #define VL53L1_STRING_WARNING_XTALK_NO_SAMPLES_FOR_GRADIENT "Xtalk - Gradient sample num = 0" |
Definition at line 178 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_XTALK_SIGMA_LIMIT_FOR_GRADIENT
| #define VL53L1_STRING_WARNING_XTALK_SIGMA_LIMIT_FOR_GRADIENT "Xtalk - Gradient Sigma > Limit" |
Definition at line 180 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_ZONE_CAL_MISSING_SAMPLES
| #define VL53L1_STRING_WARNING_ZONE_CAL_MISSING_SAMPLES "Zone Cal - One or more zone with less than requested valid samples" |
Definition at line 171 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_ZONE_CAL_RATE_TOO_HIGH
| #define VL53L1_STRING_WARNING_ZONE_CAL_RATE_TOO_HIGH "Zone Cal - One of more zones with rate too high - in pile up" |
Definition at line 175 of file vl53l1_error_strings.h.
◆ VL53L1_STRING_WARNING_ZONE_CAL_SIGMA_TOO_HIGH
| #define VL53L1_STRING_WARNING_ZONE_CAL_SIGMA_TOO_HIGH "Zone Cal - One of more zones the sigma estimate too high" |
Definition at line 173 of file vl53l1_error_strings.h.
Function Documentation
◆ VL53L1_get_pal_error_string()
| VL53L1_Error VL53L1_get_pal_error_string | ( | VL53L1_Error | PalErrorCode, |
| char * | pPalErrorString | ||
| ) |
Generates an error string for the input PAL error code.
- Parameters
-
[in] PalErrorCode : PAL Error Code [out] pPalErrorString : pointer to character buffer
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 86 of file vl53l1_error_strings.c.