VL53L0X API Specification: Error and Warning code returned by API


Error and Warning code returned by API

The following DEFINE are used to identify the PAL ERROR. More...


#define VL53L0X_ERROR_NONE   ((VL53L0X_Error) 0)
#define VL53L0X_ERROR_CALIBRATION_WARNING   ((VL53L0X_Error) -1)
#define VL53L0X_ERROR_MIN_CLIPPED   ((VL53L0X_Error) -2)
#define VL53L0X_ERROR_UNDEFINED   ((VL53L0X_Error) -3)
#define VL53L0X_ERROR_INVALID_PARAMS   ((VL53L0X_Error) -4)
#define VL53L0X_ERROR_NOT_SUPPORTED   ((VL53L0X_Error) -5)
#define VL53L0X_ERROR_RANGE_ERROR   ((VL53L0X_Error) -6)
#define VL53L0X_ERROR_TIME_OUT   ((VL53L0X_Error) -7)
#define VL53L0X_ERROR_MODE_NOT_SUPPORTED   ((VL53L0X_Error) -8)
#define VL53L0X_ERROR_BUFFER_TOO_SMALL   ((VL53L0X_Error) -9)
#define VL53L0X_ERROR_GPIO_NOT_EXISTING   ((VL53L0X_Error) -10)
#define VL53L0X_ERROR_INTERRUPT_NOT_CLEARED   ((VL53L0X_Error) -12)
#define VL53L0X_ERROR_CONTROL_INTERFACE   ((VL53L0X_Error) -20)
#define VL53L0X_ERROR_INVALID_COMMAND   ((VL53L0X_Error) -30)
#define VL53L0X_ERROR_DIVISION_BY_ZERO   ((VL53L0X_Error) -40)
#define VL53L0X_ERROR_REF_SPAD_INIT   ((VL53L0X_Error) -50)
#define VL53L0X_ERROR_NOT_IMPLEMENTED   ((VL53L0X_Error) -99)


typedef int8_t VL53L0X_Error

Detailed Description

The following DEFINE are used to identify the PAL ERROR.

Macro Definition Documentation

#define VL53L0X_ERROR_NONE   ((VL53L0X_Error) 0)

Definition at line 133 of file vl53l0x_def.h.

#define VL53L0X_ERROR_CALIBRATION_WARNING   ((VL53L0X_Error) -1)

Warning invalid calibration data may be in used VL53L0X_InitData() VL53L0X_GetOffsetCalibrationData VL53L0X_SetOffsetCalibrationData

Definition at line 134 of file vl53l0x_def.h.

#define VL53L0X_ERROR_MIN_CLIPPED   ((VL53L0X_Error) -2)

Warning parameter passed was clipped to min before to be applied

Definition at line 139 of file vl53l0x_def.h.

#define VL53L0X_ERROR_UNDEFINED   ((VL53L0X_Error) -3)

Unqualified error

Definition at line 142 of file vl53l0x_def.h.

#define VL53L0X_ERROR_INVALID_PARAMS   ((VL53L0X_Error) -4)

Parameter passed is invalid or out of range

Definition at line 144 of file vl53l0x_def.h.

#define VL53L0X_ERROR_NOT_SUPPORTED   ((VL53L0X_Error) -5)

Function is not supported in current mode or configuration

Definition at line 146 of file vl53l0x_def.h.

#define VL53L0X_ERROR_RANGE_ERROR   ((VL53L0X_Error) -6)

Device report a ranging error interrupt status

Definition at line 148 of file vl53l0x_def.h.

#define VL53L0X_ERROR_TIME_OUT   ((VL53L0X_Error) -7)

Aborted due to time out

Definition at line 150 of file vl53l0x_def.h.

#define VL53L0X_ERROR_MODE_NOT_SUPPORTED   ((VL53L0X_Error) -8)

Asked mode is not supported by the device

Definition at line 152 of file vl53l0x_def.h.

#define VL53L0X_ERROR_BUFFER_TOO_SMALL   ((VL53L0X_Error) -9)


Definition at line 154 of file vl53l0x_def.h.

#define VL53L0X_ERROR_GPIO_NOT_EXISTING   ((VL53L0X_Error) -10)

User tried to setup a non-existing GPIO pin

Definition at line 156 of file vl53l0x_def.h.


unsupported GPIO functionality

Definition at line 158 of file vl53l0x_def.h.

#define VL53L0X_ERROR_INTERRUPT_NOT_CLEARED   ((VL53L0X_Error) -12)

Error during interrupt clear

Definition at line 160 of file vl53l0x_def.h.

#define VL53L0X_ERROR_CONTROL_INTERFACE   ((VL53L0X_Error) -20)

error reported from IO functions

Definition at line 162 of file vl53l0x_def.h.

#define VL53L0X_ERROR_INVALID_COMMAND   ((VL53L0X_Error) -30)

The command is not allowed in the current device state (power down)

Definition at line 164 of file vl53l0x_def.h.

#define VL53L0X_ERROR_DIVISION_BY_ZERO   ((VL53L0X_Error) -40)

In the function a division by zero occurs

Definition at line 167 of file vl53l0x_def.h.

#define VL53L0X_ERROR_REF_SPAD_INIT   ((VL53L0X_Error) -50)

Error during reference SPAD initialization

Definition at line 169 of file vl53l0x_def.h.

#define VL53L0X_ERROR_NOT_IMPLEMENTED   ((VL53L0X_Error) -99)

Tells requested functionality has not been implemented yet or not compatible with the device

Definition at line 171 of file vl53l0x_def.h.

Typedef Documentation

Definition at line 131 of file vl53l0x_def.h.