VL53L0X API Specification
1.0.2.4823Go to the source code of this file.
Functions | |
| VL53L0X_Error | VL53L0X_get_device_info (VL53L0X_DEV Dev, VL53L0X_DeviceInfo_t *pVL53L0X_DeviceInfo) |
| VL53L0X_Error | VL53L0X_get_device_error_string (VL53L0X_DeviceError ErrorCode, char *pDeviceErrorString) |
| VL53L0X_Error | VL53L0X_get_range_status_string (uint8_t RangeStatus, char *pRangeStatusString) |
| VL53L0X_Error | VL53L0X_get_pal_error_string (VL53L0X_Error PalErrorCode, char *pPalErrorString) |
| VL53L0X_Error | VL53L0X_get_pal_state_string (VL53L0X_State PalStateCode, char *pPalStateString) |
| VL53L0X_Error | VL53L0X_get_sequence_steps_info (VL53L0X_SequenceStepId SequenceStepId, char *pSequenceStepsString) |
| VL53L0X_Error | VL53L0X_get_limit_check_info (VL53L0X_DEV Dev, uint16_t LimitCheckId, char *pLimitCheckString) |
Macro Definition Documentation
| #define VL53L0X_STRING_DEVICE_INFO_NAME "VL53L0X cut1.0" |
Definition at line 145 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICE_INFO_NAME_TS0 "VL53L0X TS0" |
Definition at line 146 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICE_INFO_NAME_TS1 "VL53L0X TS1" |
Definition at line 147 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICE_INFO_NAME_TS2 "VL53L0X TS2" |
Definition at line 148 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICE_INFO_NAME_ES1 "VL53L0X ES1 or later" |
Definition at line 149 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICE_INFO_TYPE "VL53L0X" |
Definition at line 150 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_NONE "No Error" |
Definition at line 153 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_CALIBRATION_WARNING "Calibration Warning Error" |
Definition at line 155 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_MIN_CLIPPED "Min clipped error" |
Definition at line 157 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_UNDEFINED "Undefined error" |
Definition at line 159 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_INVALID_PARAMS "Invalid parameters error" |
Definition at line 161 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_NOT_SUPPORTED "Not supported error" |
Definition at line 163 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_RANGE_ERROR "Range error" |
Definition at line 165 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_TIME_OUT "Time out error" |
Definition at line 167 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_MODE_NOT_SUPPORTED "Mode not supported error" |
Definition at line 169 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_BUFFER_TOO_SMALL "Buffer too small" |
Definition at line 171 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_GPIO_NOT_EXISTING "GPIO not existing" |
Definition at line 173 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED "GPIO funct not supported" |
Definition at line 175 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_INTERRUPT_NOT_CLEARED "Interrupt not Cleared" |
Definition at line 177 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_CONTROL_INTERFACE "Control Interface Error" |
Definition at line 179 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_INVALID_COMMAND "Invalid Command Error" |
Definition at line 181 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_DIVISION_BY_ZERO "Division by zero Error" |
Definition at line 183 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_REF_SPAD_INIT "Reference Spad Init Error" |
Definition at line 185 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_ERROR_NOT_IMPLEMENTED "Not implemented error" |
Definition at line 187 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_UNKNOW_ERROR_CODE "Unknown Error Code" |
Definition at line 190 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_RANGESTATUS_NONE "No Update" |
Definition at line 196 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_RANGESTATUS_RANGEVALID "Range Valid" |
Definition at line 197 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_RANGESTATUS_SIGMA "Sigma Fail" |
Definition at line 198 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_RANGESTATUS_SIGNAL "Signal Fail" |
Definition at line 199 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_RANGESTATUS_MINRANGE "Min Range Fail" |
Definition at line 200 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_RANGESTATUS_PHASE "Phase Fail" |
Definition at line 201 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_RANGESTATUS_HW "Hardware Fail" |
Definition at line 202 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_STATE_POWERDOWN "POWERDOWN State" |
Definition at line 206 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_STATE_WAIT_STATICINIT "Wait for staticinit State" |
Definition at line 207 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_STATE_STANDBY "STANDBY State" |
Definition at line 209 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_STATE_IDLE "IDLE State" |
Definition at line 210 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_STATE_RUNNING "RUNNING State" |
Definition at line 211 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_STATE_UNKNOWN "UNKNOWN State" |
Definition at line 212 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_STATE_ERROR "ERROR State" |
Definition at line 213 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_NONE "No Update" |
Definition at line 217 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_VCSELCONTINUITYTESTFAILURE "VCSEL Continuity Test Failure" |
Definition at line 218 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_VCSELWATCHDOGTESTFAILURE "VCSEL Watchdog Test Failure" |
Definition at line 220 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_NOVHVVALUEFOUND "No VHV Value found" |
Definition at line 222 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_MSRCNOTARGET "MSRC No Target Error" |
Definition at line 224 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_SNRCHECK "SNR Check Exit" |
Definition at line 226 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_RANGEPHASECHECK "Range Phase Check Error" |
Definition at line 228 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_SIGMATHRESHOLDCHECK "Sigma Threshold Check Error" |
Definition at line 230 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_TCC "TCC Error" |
Definition at line 232 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_PHASECONSISTENCY "Phase Consistency Error" |
Definition at line 234 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_MINCLIP "Min Clip Error" |
Definition at line 236 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_RANGECOMPLETE "Range Complete" |
Definition at line 238 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_ALGOUNDERFLOW "Range Algo Underflow Error" |
Definition at line 240 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_ALGOOVERFLOW "Range Algo Overlow Error" |
Definition at line 242 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_RANGEIGNORETHRESHOLD "Range Ignore Threshold Error" |
Definition at line 244 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_DEVICEERROR_UNKNOWN "Unknown error code" |
Definition at line 246 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_CHECKENABLE_SIGMA_FINAL_RANGE "SIGMA FINAL RANGE" |
Definition at line 250 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE "SIGNAL RATE FINAL RANGE" |
Definition at line 252 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_CHECKENABLE_SIGNAL_REF_CLIP "SIGNAL REF CLIP" |
Definition at line 254 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_CHECKENABLE_RANGE_IGNORE_THRESHOLD "RANGE IGNORE THRESHOLD" |
Definition at line 256 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_MSRC "SIGNAL RATE MSRC" |
Definition at line 258 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_PRE_RANGE "SIGNAL RATE PRE RANGE" |
Definition at line 260 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_SEQUENCESTEP_TCC "TCC" |
Definition at line 264 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_SEQUENCESTEP_DSS "DSS" |
Definition at line 265 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_SEQUENCESTEP_MSRC "MSRC" |
Definition at line 266 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_SEQUENCESTEP_PRE_RANGE "PRE RANGE" |
Definition at line 267 of file vl53l0x_api_strings.h.
| #define VL53L0X_STRING_SEQUENCESTEP_FINAL_RANGE "FINAL RANGE" |
Definition at line 268 of file vl53l0x_api_strings.h.
Function Documentation
| VL53L0X_Error VL53L0X_get_device_info | ( | VL53L0X_DEV | Dev, |
| VL53L0X_DeviceInfo_t * | pVL53L0X_DeviceInfo | ||
| ) |
| VL53L0X_Error VL53L0X_get_device_error_string | ( | VL53L0X_DeviceError | ErrorCode, |
| char * | pDeviceErrorString | ||
| ) |
| VL53L0X_Error VL53L0X_get_range_status_string | ( | uint8_t | RangeStatus, |
| char * | pRangeStatusString | ||
| ) |
| VL53L0X_Error VL53L0X_get_pal_error_string | ( | VL53L0X_Error | PalErrorCode, |
| char * | pPalErrorString | ||
| ) |
| VL53L0X_Error VL53L0X_get_pal_state_string | ( | VL53L0X_State | PalStateCode, |
| char * | pPalStateString | ||
| ) |
| VL53L0X_Error VL53L0X_get_sequence_steps_info | ( | VL53L0X_SequenceStepId | SequenceStepId, |
| char * | pSequenceStepsString | ||
| ) |
| VL53L0X_Error VL53L0X_get_limit_check_info | ( | VL53L0X_DEV | Dev, |
| uint16_t | LimitCheckId, | ||
| char * | pLimitCheckString | ||
| ) |