Functions definition. More...

#include "vl53l1_platform.h"

Include dependency graph for vl53l1x_api.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	VL53L1X_Version_t
	defines SW Version More...

struct	VL53L1X_Result_t
	defines packed reading results type More...

Macros
#define	VL53L1X_IMPLEMENTATION_VER_MAJOR 3

#define	VL53L1X_IMPLEMENTATION_VER_MINOR 3

#define	VL53L1X_IMPLEMENTATION_VER_SUB 0

#define	VL53L1X_IMPLEMENTATION_VER_REVISION 0000

#define	SOFT_RESET 0x0000

#define	VL53L1_I2C_SLAVE__DEVICE_ADDRESS 0x0001

#define	VL53L1_VHV_CONFIG__TIMEOUT_MACROP_LOOP_BOUND 0x0008

#define	ALGO__CROSSTALK_COMPENSATION_PLANE_OFFSET_KCPS 0x0016

#define	ALGO__CROSSTALK_COMPENSATION_X_PLANE_GRADIENT_KCPS 0x0018

#define	ALGO__CROSSTALK_COMPENSATION_Y_PLANE_GRADIENT_KCPS 0x001A

#define	ALGO__PART_TO_PART_RANGE_OFFSET_MM 0x001E

#define	MM_CONFIG__INNER_OFFSET_MM 0x0020

#define	MM_CONFIG__OUTER_OFFSET_MM 0x0022

#define	GPIO_HV_MUX__CTRL 0x0030

#define	GPIO__TIO_HV_STATUS 0x0031

#define	SYSTEM__INTERRUPT_CONFIG_GPIO 0x0046

#define	PHASECAL_CONFIG__TIMEOUT_MACROP 0x004B

#define	RANGE_CONFIG__TIMEOUT_MACROP_A_HI 0x005E

#define	RANGE_CONFIG__VCSEL_PERIOD_A 0x0060

#define	RANGE_CONFIG__VCSEL_PERIOD_B 0x0063

#define	RANGE_CONFIG__TIMEOUT_MACROP_B_HI 0x0061

#define	RANGE_CONFIG__TIMEOUT_MACROP_B_LO 0x0062

#define	RANGE_CONFIG__SIGMA_THRESH 0x0064

#define	RANGE_CONFIG__MIN_COUNT_RATE_RTN_LIMIT_MCPS 0x0066

#define	RANGE_CONFIG__VALID_PHASE_HIGH 0x0069

#define	VL53L1_SYSTEM__INTERMEASUREMENT_PERIOD 0x006C

#define	SYSTEM__THRESH_HIGH 0x0072

#define	SYSTEM__THRESH_LOW 0x0074

#define	SD_CONFIG__WOI_SD0 0x0078

#define	SD_CONFIG__INITIAL_PHASE_SD0 0x007A

#define	ROI_CONFIG__USER_ROI_CENTRE_SPAD 0x007F

#define	ROI_CONFIG__USER_ROI_REQUESTED_GLOBAL_XY_SIZE 0x0080

#define	SYSTEM__SEQUENCE_CONFIG 0x0081

#define	VL53L1_SYSTEM__GROUPED_PARAMETER_HOLD 0x0082

#define	SYSTEM__INTERRUPT_CLEAR 0x0086

#define	SYSTEM__MODE_START 0x0087

#define	VL53L1_RESULT__RANGE_STATUS 0x0089

#define	VL53L1_RESULT__DSS_ACTUAL_EFFECTIVE_SPADS_SD0 0x008C

#define	RESULT__AMBIENT_COUNT_RATE_MCPS_SD 0x0090

#define	VL53L1_RESULT__FINAL_CROSSTALK_CORRECTED_RANGE_MM_SD0 0x0096

#define	VL53L1_RESULT__PEAK_SIGNAL_COUNT_RATE_CROSSTALK_CORRECTED_MCPS_SD0 0x0098

#define	VL53L1_RESULT__OSC_CALIBRATE_VAL 0x00DE

#define	VL53L1_FIRMWARE__SYSTEM_STATUS 0x00E5

#define	VL53L1_IDENTIFICATION__MODEL_ID 0x010F

#define	VL53L1_ROI_CONFIG__MODE_ROI_CENTRE_SPAD 0x013E

Typedefs
typedef int8_t	VL53L1X_ERROR

Functions
VL53L1X_ERROR	VL53L1X_GetSWVersion (VL53L1X_Version_t *pVersion)
	This function returns the SW driver version. More...

VL53L1X_ERROR	VL53L1X_SetI2CAddress (VL53L1_DEV, uint8_t new_address)
	This function sets the sensor I2C address used in case multiple devices application, default address 0x52. More...

VL53L1X_ERROR	VL53L1X_SensorInit (VL53L1_DEV dev)
	This function loads the 135 bytes default values to initialize the sensor. More...

void	VL53L1X_BootDevice (VL53L1_DEV dev, uint16_t TimingBudgetInMs, uint16_t DistanceMode, uint32_t InterMeasurementInMs)
	Implement boot sequence of VL53L1 device as described in documentation See VL53L1X_SetTimingBudgetInMs, VL53L1X_SetDistanceMode and VL53L1X_SetInterMeasurementInMs for params details. More...

VL53L1X_ERROR	VL53L1X_ClearInterrupt (VL53L1_DEV dev)
	This function clears the interrupt, to be called after a ranging data reading to arm the interrupt for the next data ready event. More...

VL53L1X_ERROR	VL53L1X_SetInterruptPolarity (VL53L1_DEV dev, uint8_t IntPol)
	This function programs the interrupt polarity 1=active high (default), 0=active low. More...

VL53L1X_ERROR	VL53L1X_GetInterruptPolarity (VL53L1_DEV dev, uint8_t *pIntPol)
	This function returns the current interrupt polarity 1=active high (default), 0=active low. More...

VL53L1X_ERROR	VL53L1X_StartRanging (VL53L1_DEV dev)
	This function starts the ranging distance operation The ranging operation is continuous. More...

VL53L1X_ERROR	VL53L1X_StopRanging (VL53L1_DEV dev)
	This function stops the ranging. More...

VL53L1X_ERROR	VL53L1X_CheckForDataReady (VL53L1_DEV dev, uint8_t *isDataReady)
	This function checks if the new ranging data is available by polling the dedicated register. More...

VL53L1X_ERROR	VL53L1X_SetTimingBudgetInMs (VL53L1_DEV dev, uint16_t TimingBudgetInMs)
	This function programs the timing budget in ms. More...

VL53L1X_ERROR	VL53L1X_GetTimingBudgetInMs (VL53L1_DEV dev, uint16_t *pTimingBudgetInMs)
	This function returns the current timing budget in ms. More...

VL53L1X_ERROR	VL53L1X_SetDistanceMode (VL53L1_DEV dev, uint16_t DistanceMode)
	This function programs the distance mode (1=short, 2=long(default)). More...

VL53L1X_ERROR	VL53L1X_GetDistanceMode (VL53L1_DEV dev, uint16_t *pDistanceMode)
	This function returns the current distance mode (1=short, 2=long). More...

VL53L1X_ERROR	VL53L1X_SetInterMeasurementInMs (VL53L1_DEV dev, uint32_t InterMeasurementInMs)
	This function programs the Intermeasurement period in ms Intermeasurement period must be >/= timing budget. More...

VL53L1X_ERROR	VL53L1X_GetInterMeasurementInMs (VL53L1_DEV dev, uint16_t *pIM)
	This function returns the Intermeasurement period in ms. More...

VL53L1X_ERROR	VL53L1X_BootState (VL53L1_DEV dev, uint8_t *state)
	This function returns the boot state of the device (1:booted, 0:not booted) More...

VL53L1X_ERROR	VL53L1X_GetSensorId (VL53L1_DEV dev, uint16_t *id)
	This function returns the sensor id, sensor Id must be 0xEEAC. More...

VL53L1X_ERROR	VL53L1X_GetDistance (VL53L1_DEV dev, uint16_t *distance)
	This function returns the distance measured by the sensor in mm. More...

VL53L1X_ERROR	VL53L1X_GetSignalPerSpad (VL53L1_DEV dev, uint16_t *signalPerSp)
	This function returns the returned signal per SPAD in kcps/SPAD. More...

VL53L1X_ERROR	VL53L1X_GetAmbientPerSpad (VL53L1_DEV dev, uint16_t *amb)
	This function returns the ambient per SPAD in kcps/SPAD. More...

VL53L1X_ERROR	VL53L1X_GetSignalRate (VL53L1_DEV dev, uint16_t *signalRate)
	This function returns the returned signal in kcps. More...

VL53L1X_ERROR	VL53L1X_GetSpadNb (VL53L1_DEV dev, uint16_t *spNb)
	This function returns the current number of enabled SPADs. More...

VL53L1X_ERROR	VL53L1X_GetAmbientRate (VL53L1_DEV dev, uint16_t *ambRate)
	This function returns the ambient rate in kcps. More...

VL53L1X_ERROR	VL53L1X_GetRangeStatus (VL53L1_DEV dev, uint8_t *rangeStatus)
	This function returns the ranging status error (0:no error, 1:sigma failed, 2:signal failed, ..., 7:wrap-around) More...

VL53L1X_ERROR	VL53L1X_GetResult (VL53L1_DEV dev, VL53L1X_Result_t *pResult)
	This function returns measurements and the range status in a single read access. More...

VL53L1X_ERROR	VL53L1X_SetOffset (VL53L1_DEV dev, int16_t OffsetValue)
	This function programs the offset correction in mm. More...

VL53L1X_ERROR	VL53L1X_GetOffset (VL53L1_DEV dev, int16_t *Offset)
	This function returns the programmed offset correction value in mm. More...

VL53L1X_ERROR	VL53L1X_SetXtalk (VL53L1_DEV dev, uint16_t XtalkValue)
	This function programs the xtalk correction value in cps (Count Per Second). More...

VL53L1X_ERROR	VL53L1X_GetXtalk (VL53L1_DEV dev, uint16_t *Xtalk)
	This function returns the current programmed xtalk correction value in cps. More...

VL53L1X_ERROR	VL53L1X_SetDistanceThreshold (VL53L1_DEV dev, uint16_t ThreshLow, uint16_t ThreshHigh, uint8_t Window, uint8_t IntOnNoTarget)
	This function programs the threshold detection mode Example: VL53L1X_SetDistanceThreshold(dev,100,300,0,1): Below 100 VL53L1X_SetDistanceThreshold(dev,100,300,1,1): Above 300 VL53L1X_SetDistanceThreshold(dev,100,300,2,1): Out of window VL53L1X_SetDistanceThreshold(dev,100,300,3,1): In window . More...

VL53L1X_ERROR	VL53L1X_GetDistanceThresholdWindow (VL53L1_DEV dev, uint16_t *window)
	This function returns the window detection mode (0=below; 1=above; 2=out; 3=in) More...

VL53L1X_ERROR	VL53L1X_GetDistanceThresholdLow (VL53L1_DEV dev, uint16_t *low)
	This function returns the low threshold in mm. More...

VL53L1X_ERROR	VL53L1X_GetDistanceThresholdHigh (VL53L1_DEV dev, uint16_t *high)
	This function returns the high threshold in mm. More...

VL53L1X_ERROR	VL53L1X_SetROI (VL53L1_DEV dev, uint16_t X, uint16_t Y)
	This function programs the ROI (Region of Interest) The ROI position is centered, only the ROI size can be reprogrammed. More...

VL53L1X_ERROR	VL53L1X_GetROI_XY (VL53L1_DEV dev, uint16_t ROI_X, uint16_t ROI_Y)
	This function returns width X and height Y. More...

VL53L1X_ERROR	VL53L1X_SetROICenter (VL53L1_DEV dev, uint8_t ROICenter)
	This function programs the new user ROI center, please to be aware that there is no check in this function. More...

VL53L1X_ERROR	VL53L1X_GetROICenter (VL53L1_DEV dev, uint8_t *ROICenter)
	This function returns the current user ROI center. More...

VL53L1X_ERROR	VL53L1X_SetSignalThreshold (VL53L1_DEV dev, uint16_t signal)
	This function programs a new signal threshold in kcps (default=1024 kcps . More...

VL53L1X_ERROR	VL53L1X_GetSignalThreshold (VL53L1_DEV dev, uint16_t *signal)
	This function returns the current signal threshold in kcps. More...

VL53L1X_ERROR	VL53L1X_SetSigmaThreshold (VL53L1_DEV dev, uint16_t sigma)
	This function programs a new sigma threshold in mm (default=15 mm) More...

VL53L1X_ERROR	VL53L1X_GetSigmaThreshold (VL53L1_DEV dev, uint16_t *signal)
	This function returns the current sigma threshold in mm. More...

VL53L1X_ERROR	VL53L1X_StartTemperatureUpdate (VL53L1_DEV dev)
	This function performs the temperature calibration. More...

Detailed Description

Functions definition.

Definition in file vl53l1x_api.h.

Data Structure Documentation

struct VL53L1X_Version_t

defines SW Version

Definition at line 129 of file vl53l1x_api.h.

Data Fields
uint8_t	build	build number
uint8_t	major	major number
uint8_t	minor	minor number
uint32_t	revision	revision number

struct VL53L1X_Result_t

defines packed reading results type

Definition at line 139 of file vl53l1x_api.h.

Data Fields
uint16_t	Ambient	ResultAmbient
uint16_t	Distance	ResultDistance
uint16_t	NumSPADs	ResultNumSPADs
uint16_t	SigPerSPAD	ResultSignalPerSPAD
uint8_t	Status	ResultStatus

Macro Definition Documentation

#define ALGO__CROSSTALK_COMPENSATION_PLANE_OFFSET_KCPS 0x0016

Definition at line 83 of file vl53l1x_api.h.

Referenced by VL53L1X_GetXtalk(), and VL53L1X_SetXtalk().

#define ALGO__CROSSTALK_COMPENSATION_X_PLANE_GRADIENT_KCPS 0x0018

Definition at line 84 of file vl53l1x_api.h.

Referenced by VL53L1X_SetXtalk().

#define ALGO__CROSSTALK_COMPENSATION_Y_PLANE_GRADIENT_KCPS 0x001A

Definition at line 85 of file vl53l1x_api.h.

Referenced by VL53L1X_SetXtalk().

#define ALGO__PART_TO_PART_RANGE_OFFSET_MM 0x001E

Definition at line 86 of file vl53l1x_api.h.

Referenced by VL53L1X_GetOffset(), and VL53L1X_SetOffset().

#define GPIO__TIO_HV_STATUS 0x0031

Definition at line 90 of file vl53l1x_api.h.

Referenced by VL53L1X_CheckForDataReady(), and VL53L1X_NonBlocking_CheckForDataReady().

#define GPIO_HV_MUX__CTRL 0x0030

Definition at line 89 of file vl53l1x_api.h.

Referenced by VL53L1X_GetInterruptPolarity(), VL53L1X_NonBlocking_CheckForDataReady(), and VL53L1X_SetInterruptPolarity().

#define MM_CONFIG__INNER_OFFSET_MM 0x0020

Definition at line 87 of file vl53l1x_api.h.

Referenced by VL53L1X_SetOffset().

#define MM_CONFIG__OUTER_OFFSET_MM 0x0022

Definition at line 88 of file vl53l1x_api.h.

Referenced by VL53L1X_SetOffset().

#define PHASECAL_CONFIG__TIMEOUT_MACROP 0x004B

Definition at line 92 of file vl53l1x_api.h.

Referenced by VL53L1X_GetDistanceMode(), and VL53L1X_SetDistanceMode().

#define RANGE_CONFIG__MIN_COUNT_RATE_RTN_LIMIT_MCPS 0x0066

Definition at line 99 of file vl53l1x_api.h.

Referenced by VL53L1X_GetSignalThreshold(), and VL53L1X_SetSignalThreshold().

#define RANGE_CONFIG__SIGMA_THRESH 0x0064

Definition at line 98 of file vl53l1x_api.h.

Referenced by VL53L1X_GetSigmaThreshold(), and VL53L1X_SetSigmaThreshold().

#define RANGE_CONFIG__TIMEOUT_MACROP_A_HI 0x005E

Definition at line 93 of file vl53l1x_api.h.

Referenced by VL53L1X_GetTimingBudgetInMs(), and VL53L1X_SetTimingBudgetInMs().

#define RANGE_CONFIG__TIMEOUT_MACROP_B_HI 0x0061

Definition at line 96 of file vl53l1x_api.h.

Referenced by VL53L1X_SetTimingBudgetInMs().

#define RANGE_CONFIG__TIMEOUT_MACROP_B_LO 0x0062

Definition at line 97 of file vl53l1x_api.h.

#define RANGE_CONFIG__VALID_PHASE_HIGH 0x0069

Definition at line 100 of file vl53l1x_api.h.

Referenced by VL53L1X_SetDistanceMode().

#define RANGE_CONFIG__VCSEL_PERIOD_A 0x0060

Definition at line 94 of file vl53l1x_api.h.

Referenced by VL53L1X_SetDistanceMode().

#define RANGE_CONFIG__VCSEL_PERIOD_B 0x0063

Definition at line 95 of file vl53l1x_api.h.

Referenced by VL53L1X_SetDistanceMode().

#define RESULT__AMBIENT_COUNT_RATE_MCPS_SD 0x0090

Definition at line 114 of file vl53l1x_api.h.

Referenced by VL53L1X_GetAmbientPerSpad(), and VL53L1X_GetAmbientRate().

#define ROI_CONFIG__USER_ROI_CENTRE_SPAD 0x007F

Definition at line 106 of file vl53l1x_api.h.

Referenced by VL53L1X_GetROICenter(), VL53L1X_SetROI(), and VL53L1X_SetROICenter().

#define ROI_CONFIG__USER_ROI_REQUESTED_GLOBAL_XY_SIZE 0x0080

Definition at line 107 of file vl53l1x_api.h.

Referenced by VL53L1X_GetROI_XY(), and VL53L1X_SetROI().

#define SD_CONFIG__INITIAL_PHASE_SD0 0x007A

Definition at line 105 of file vl53l1x_api.h.

Referenced by VL53L1X_SetDistanceMode().

#define SD_CONFIG__WOI_SD0 0x0078

Definition at line 104 of file vl53l1x_api.h.

Referenced by VL53L1X_SetDistanceMode().

#define SOFT_RESET 0x0000

Definition at line 80 of file vl53l1x_api.h.

#define SYSTEM__INTERRUPT_CLEAR 0x0086

Definition at line 110 of file vl53l1x_api.h.

Referenced by VL53L1X_ClearInterrupt(), and VL53L1X_NonBlocking_ClearInterrupt().

#define SYSTEM__INTERRUPT_CONFIG_GPIO 0x0046

Definition at line 91 of file vl53l1x_api.h.

Referenced by VL53L1X_GetDistanceThresholdWindow(), and VL53L1X_SetDistanceThreshold().

#define SYSTEM__MODE_START 0x0087

Definition at line 111 of file vl53l1x_api.h.

Referenced by VL53L1X_StartRanging(), and VL53L1X_StopRanging().

#define SYSTEM__SEQUENCE_CONFIG 0x0081

Definition at line 108 of file vl53l1x_api.h.

#define SYSTEM__THRESH_HIGH 0x0072

Definition at line 102 of file vl53l1x_api.h.

Referenced by VL53L1X_GetDistanceThresholdHigh(), and VL53L1X_SetDistanceThreshold().

#define SYSTEM__THRESH_LOW 0x0074

Definition at line 103 of file vl53l1x_api.h.

Referenced by VL53L1X_GetDistanceThresholdLow(), and VL53L1X_SetDistanceThreshold().

#define VL53L1_FIRMWARE__SYSTEM_STATUS 0x00E5

Definition at line 118 of file vl53l1x_api.h.

Referenced by VL53L1X_BootState().

#define VL53L1_I2C_SLAVE__DEVICE_ADDRESS 0x0001

Definition at line 81 of file vl53l1x_api.h.

Referenced by VL53L1X_SetI2CAddress().

#define VL53L1_IDENTIFICATION__MODEL_ID 0x010F

Definition at line 119 of file vl53l1x_api.h.

Referenced by VL53L1X_GetSensorId().

#define VL53L1_RESULT__DSS_ACTUAL_EFFECTIVE_SPADS_SD0 0x008C

Definition at line 113 of file vl53l1x_api.h.

Referenced by VL53L1X_GetAmbientPerSpad(), VL53L1X_GetSignalPerSpad(), and VL53L1X_GetSpadNb().

#define VL53L1_RESULT__FINAL_CROSSTALK_CORRECTED_RANGE_MM_SD0 0x0096

Definition at line 115 of file vl53l1x_api.h.

Referenced by VL53L1X_GetDistance(), and VL53L1X_NonBlocking_GetDistance().

#define VL53L1_RESULT__OSC_CALIBRATE_VAL 0x00DE

Definition at line 117 of file vl53l1x_api.h.

Referenced by VL53L1X_GetInterMeasurementInMs(), and VL53L1X_SetInterMeasurementInMs().

#define VL53L1_RESULT__PEAK_SIGNAL_COUNT_RATE_CROSSTALK_CORRECTED_MCPS_SD0 0x0098

Definition at line 116 of file vl53l1x_api.h.

Referenced by VL53L1X_GetSignalPerSpad(), and VL53L1X_GetSignalRate().

#define VL53L1_RESULT__RANGE_STATUS 0x0089

Definition at line 112 of file vl53l1x_api.h.

Referenced by VL53L1X_GetRangeStatus(), VL53L1X_GetResult(), and VL53L1X_NonBlocking_GetRangeStatus().

#define VL53L1_ROI_CONFIG__MODE_ROI_CENTRE_SPAD 0x013E

Definition at line 120 of file vl53l1x_api.h.

Referenced by VL53L1X_SetROI().

#define VL53L1_SYSTEM__GROUPED_PARAMETER_HOLD 0x0082

Definition at line 109 of file vl53l1x_api.h.

#define VL53L1_SYSTEM__INTERMEASUREMENT_PERIOD 0x006C

Definition at line 101 of file vl53l1x_api.h.

Referenced by VL53L1X_GetInterMeasurementInMs(), and VL53L1X_SetInterMeasurementInMs().

#define VL53L1_VHV_CONFIG__TIMEOUT_MACROP_LOOP_BOUND 0x0008

Definition at line 82 of file vl53l1x_api.h.

Referenced by VL53L1X_SensorInit(), and VL53L1X_StartTemperatureUpdate().

#define VL53L1X_IMPLEMENTATION_VER_MAJOR 3

Definition at line 73 of file vl53l1x_api.h.

Referenced by VL53L1X_GetSWVersion().

#define VL53L1X_IMPLEMENTATION_VER_MINOR 3

Definition at line 74 of file vl53l1x_api.h.

Referenced by VL53L1X_GetSWVersion().

#define VL53L1X_IMPLEMENTATION_VER_REVISION 0000

Definition at line 76 of file vl53l1x_api.h.

Referenced by VL53L1X_GetSWVersion().

#define VL53L1X_IMPLEMENTATION_VER_SUB 0

Definition at line 75 of file vl53l1x_api.h.

Referenced by VL53L1X_GetSWVersion().

Typedef Documentation

typedef int8_t VL53L1X_ERROR

Definition at line 78 of file vl53l1x_api.h.

Function Documentation

void VL53L1X_BootDevice	(	VL53L1_DEV	dev,
		uint16_t	TimingBudgetInMs,
		uint16_t	DistanceMode,
		uint32_t	InterMeasurementInMs
	)

Implement boot sequence of VL53L1 device as described in documentation See VL53L1X_SetTimingBudgetInMs, VL53L1X_SetDistanceMode and VL53L1X_SetInterMeasurementInMs for params details.

Definition at line 255 of file vl53l1x_api.c.

References state, VL53L1X_BootState(), VL53L1X_SensorInit(), VL53L1X_SetDistanceMode(), VL53L1X_SetInterMeasurementInMs(), VL53L1X_SetTimingBudgetInMs(), and VL53L1X_StartRanging().

Referenced by multi_ranger_boot_device(), and sonar_vl53l1x_init().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_BootState	(	VL53L1_DEV	dev,
		uint8_t *	state
	)

This function returns the boot state of the device (1:booted, 0:not booted)

Definition at line 557 of file vl53l1x_api.c.

References status, VL53L1_FIRMWARE__SYSTEM_STATUS, and VL53L1_RdByte().

Referenced by VL53L1X_BootDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_CheckForDataReady	(	VL53L1_DEV	dev,
		uint8_t *	isDataReady
	)

This function checks if the new ranging data is available by polling the dedicated register.

Parameters

isDataReady==0 -> not ready; isDataReady==1 -> ready

Definition at line 317 of file vl53l1x_api.c.

References GPIO__TIO_HV_STATUS, status, VL53L1_RdByte(), and VL53L1X_GetInterruptPolarity().

Referenced by VL53L1X_SensorInit(), and VL53L1X_StartTemperatureUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_ClearInterrupt ( VL53L1_DEV dev )

This function clears the interrupt, to be called after a ranging data reading to arm the interrupt for the next data ready event.

Definition at line 271 of file vl53l1x_api.c.

References status, SYSTEM__INTERRUPT_CLEAR, and VL53L1_WrByte().

Referenced by VL53L1X_SensorInit(), and VL53L1X_StartTemperatureUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_GetAmbientPerSpad	(	VL53L1_DEV	dev,
		uint16_t *	amb
	)

This function returns the ambient per SPAD in kcps/SPAD.

Definition at line 601 of file vl53l1x_api.c.

References RESULT__AMBIENT_COUNT_RATE_MCPS_SD, status, VL53L1_RdWord(), and VL53L1_RESULT__DSS_ACTUAL_EFFECTIVE_SPADS_SD0.

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetAmbientRate	(	VL53L1_DEV	dev,
		uint16_t *	ambRate
	)

This function returns the ambient rate in kcps.

Definition at line 634 of file vl53l1x_api.c.

References RESULT__AMBIENT_COUNT_RATE_MCPS_SD, status, and VL53L1_RdWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetDistance	(	VL53L1_DEV	dev,
		uint16_t *	distance
	)

This function returns the distance measured by the sensor in mm.

Definition at line 577 of file vl53l1x_api.c.

References status, VL53L1_RdWord(), and VL53L1_RESULT__FINAL_CROSSTALK_CORRECTED_RANGE_MM_SD0.

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetDistanceMode	(	VL53L1_DEV	dev,
		uint16_t *	pDistanceMode
	)

This function returns the current distance mode (1=short, 2=long).

Definition at line 516 of file vl53l1x_api.c.

References PHASECAL_CONFIG__TIMEOUT_MACROP, status, and VL53L1_RdByte().

Referenced by VL53L1X_SetTimingBudgetInMs().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_GetDistanceThresholdHigh	(	VL53L1_DEV	dev,
		uint16_t *	high
	)

This function returns the high threshold in mm.

Definition at line 768 of file vl53l1x_api.c.

References status, SYSTEM__THRESH_HIGH, and VL53L1_RdWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetDistanceThresholdLow	(	VL53L1_DEV	dev,
		uint16_t *	low
	)

This function returns the low threshold in mm.

Definition at line 758 of file vl53l1x_api.c.

References status, SYSTEM__THRESH_LOW, and VL53L1_RdWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetDistanceThresholdWindow	(	VL53L1_DEV	dev,
		uint16_t *	window
	)

This function returns the window detection mode (0=below; 1=above; 2=out; 3=in)

Definition at line 749 of file vl53l1x_api.c.

References status, SYSTEM__INTERRUPT_CONFIG_GPIO, and VL53L1_RdByte().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetInterMeasurementInMs	(	VL53L1_DEV	dev,
		uint16_t *	pIM
	)

This function returns the Intermeasurement period in ms.

Definition at line 543 of file vl53l1x_api.c.

References status, VL53L1_RdDWord(), VL53L1_RdWord(), VL53L1_RESULT__OSC_CALIBRATE_VAL, and VL53L1_SYSTEM__INTERMEASUREMENT_PERIOD.

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetInterruptPolarity	(	VL53L1_DEV	dev,
		uint8_t *	pIntPol
	)

This function returns the current interrupt polarity
1=active high (default), 0=active low.

Definition at line 290 of file vl53l1x_api.c.

References GPIO_HV_MUX__CTRL, status, and VL53L1_RdByte().

Referenced by VL53L1X_CheckForDataReady().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_GetOffset	(	VL53L1_DEV	dev,
		int16_t *	Offset
	)

This function returns the programmed offset correction value in mm.

Definition at line 691 of file vl53l1x_api.c.

References ALGO__PART_TO_PART_RANGE_OFFSET_MM, status, and VL53L1_RdWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetRangeStatus	(	VL53L1_DEV	dev,
		uint8_t *	rangeStatus
	)

This function returns the ranging status error
(0:no error, 1:sigma failed, 2:signal failed, ..., 7:wrap-around)

Definition at line 644 of file vl53l1x_api.c.

References status, status_rtn, VL53L1_RdByte(), and VL53L1_RESULT__RANGE_STATUS.

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetResult	(	VL53L1_DEV	dev,
		VL53L1X_Result_t *	pResult
	)

This function returns measurements and the range status in a single read access.

Definition at line 658 of file vl53l1x_api.c.

References VL53L1X_Result_t::Ambient, VL53L1X_Result_t::Distance, VL53L1X_Result_t::NumSPADs, VL53L1X_Result_t::SigPerSPAD, status, VL53L1X_Result_t::Status, status_rtn, VL53L1_ReadMulti(), and VL53L1_RESULT__RANGE_STATUS.

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetROI_XY	(	VL53L1_DEV	dev,
		uint16_t *	ROI_X,
		uint16_t *	ROI_Y
	)

This function returns width X and height Y.

Definition at line 815 of file vl53l1x_api.c.

References ROI_CONFIG__USER_ROI_REQUESTED_GLOBAL_XY_SIZE, status, and VL53L1_RdByte().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetROICenter	(	VL53L1_DEV	dev,
		uint8_t *	ROICenter
	)

This function returns the current user ROI center.

Definition at line 785 of file vl53l1x_api.c.

References ROI_CONFIG__USER_ROI_CENTRE_SPAD, status, and VL53L1_RdByte().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetSensorId	(	VL53L1_DEV	dev,
		uint16_t *	id
	)

This function returns the sensor id, sensor Id must be 0xEEAC.

Definition at line 567 of file vl53l1x_api.c.

References status, VL53L1_IDENTIFICATION__MODEL_ID, and VL53L1_RdWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetSigmaThreshold	(	VL53L1_DEV	dev,
		uint16_t *	signal
	)

This function returns the current sigma threshold in mm.

Definition at line 857 of file vl53l1x_api.c.

References RANGE_CONFIG__SIGMA_THRESH, status, and VL53L1_RdWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetSignalPerSpad	(	VL53L1_DEV	dev,
		uint16_t *	signalPerSp
	)

This function returns the returned signal per SPAD in kcps/SPAD.

With kcps stands for Kilo Count Per Second

Definition at line 588 of file vl53l1x_api.c.

References status, VL53L1_RdWord(), VL53L1_RESULT__DSS_ACTUAL_EFFECTIVE_SPADS_SD0, and VL53L1_RESULT__PEAK_SIGNAL_COUNT_RATE_CROSSTALK_CORRECTED_MCPS_SD0.

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetSignalRate	(	VL53L1_DEV	dev,
		uint16_t *	signalRate
	)

This function returns the returned signal in kcps.

Definition at line 612 of file vl53l1x_api.c.

References status, VL53L1_RdWord(), and VL53L1_RESULT__PEAK_SIGNAL_COUNT_RATE_CROSSTALK_CORRECTED_MCPS_SD0.

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetSignalThreshold	(	VL53L1_DEV	dev,
		uint16_t *	signal
	)

This function returns the current signal threshold in kcps.

Definition at line 834 of file vl53l1x_api.c.

References RANGE_CONFIG__MIN_COUNT_RATE_RTN_LIMIT_MCPS, status, and VL53L1_RdWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetSpadNb	(	VL53L1_DEV	dev,
		uint16_t *	spNb
	)

This function returns the current number of enabled SPADs.

Definition at line 623 of file vl53l1x_api.c.

References status, VL53L1_RdWord(), and VL53L1_RESULT__DSS_ACTUAL_EFFECTIVE_SPADS_SD0.

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_GetSWVersion ( VL53L1X_Version_t * pVersion )

This function returns the SW driver version.

Definition at line 211 of file vl53l1x_api.c.

References VL53L1X_Version_t::build, VL53L1X_Version_t::major, VL53L1X_Version_t::minor, VL53L1X_Version_t::revision, VL53L1X_IMPLEMENTATION_VER_MAJOR, VL53L1X_IMPLEMENTATION_VER_MINOR, VL53L1X_IMPLEMENTATION_VER_REVISION, and VL53L1X_IMPLEMENTATION_VER_SUB.

VL53L1X_ERROR VL53L1X_GetTimingBudgetInMs	(	VL53L1_DEV	dev,
		uint16_t *	pTimingBudgetInMs
	)

This function returns the current timing budget in ms.

Definition at line 438 of file vl53l1x_api.c.

References RANGE_CONFIG__TIMEOUT_MACROP_A_HI, status, and VL53L1_RdWord().

Referenced by VL53L1X_SetDistanceMode().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_GetXtalk	(	VL53L1_DEV	dev,
		uint16_t *	Xtalk
	)

This function returns the current programmed xtalk correction value in cps.

Definition at line 718 of file vl53l1x_api.c.

References ALGO__CROSSTALK_COMPENSATION_PLANE_OFFSET_KCPS, status, and VL53L1_RdDWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_SensorInit ( VL53L1_DEV dev )

This function loads the 135 bytes default values to initialize the sensor.

Parameters

dev	Device address

Returns: 0:success, != 0:failed

Definition at line 231 of file vl53l1x_api.c.

References status, VL51L1X_DEFAULT_CONFIGURATION, VL53L1_VHV_CONFIG__TIMEOUT_MACROP_LOOP_BOUND, VL53L1_WrByte(), VL53L1X_CheckForDataReady(), VL53L1X_ClearInterrupt(), VL53L1X_SetI2CAddress(), VL53L1X_StartRanging(), and VL53L1X_StopRanging().

Referenced by VL53L1X_BootDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_SetDistanceMode	(	VL53L1_DEV	dev,
		uint16_t	DistanceMode
	)

This function programs the distance mode (1=short, 2=long(default)).

Short mode max distance is limited to 1.3 m but better ambient immunity.
Long mode can range up to 4 m in the dark with 200 ms timing budget.

Definition at line 479 of file vl53l1x_api.c.

References PHASECAL_CONFIG__TIMEOUT_MACROP, RANGE_CONFIG__VALID_PHASE_HIGH, RANGE_CONFIG__VCSEL_PERIOD_A, RANGE_CONFIG__VCSEL_PERIOD_B, SD_CONFIG__INITIAL_PHASE_SD0, SD_CONFIG__WOI_SD0, status, VL53L1_WrByte(), VL53L1_WrWord(), VL53L1X_GetTimingBudgetInMs(), and VL53L1X_SetTimingBudgetInMs().

Referenced by VL53L1X_BootDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_SetDistanceThreshold	(	VL53L1_DEV	dev,
		uint16_t	ThreshLow,
		uint16_t	ThreshHigh,
		uint8_t	Window,
		uint8_t	IntOnNoTarget
	)

This function programs the threshold detection mode
Example:
VL53L1X_SetDistanceThreshold(dev,100,300,0,1): Below 100
VL53L1X_SetDistanceThreshold(dev,100,300,1,1): Above 300
VL53L1X_SetDistanceThreshold(dev,100,300,2,1): Out of window
VL53L1X_SetDistanceThreshold(dev,100,300,3,1): In window
.

Parameters

dev	: device address
ThreshLow(in	mm) : the threshold under which one the device raises an interrupt if Window = 0
ThreshHigh(in	mm) : the threshold above which one the device raises an interrupt if Window = 1
Window	detection mode : 0=below, 1=above, 2=out, 3=in
IntOnNoTarget	= 1 (No longer used - just use 1)

Definition at line 728 of file vl53l1x_api.c.

References status, SYSTEM__INTERRUPT_CONFIG_GPIO, SYSTEM__THRESH_HIGH, SYSTEM__THRESH_LOW, VL53L1_RdByte(), VL53L1_WrByte(), and VL53L1_WrWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_SetI2CAddress	(	VL53L1_DEV	,
		uint8_t	new_address
	)

This function sets the sensor I2C address used in case multiple devices application, default address 0x52.

Definition at line 222 of file vl53l1x_api.c.

References VL53L1_Dev_t::i2c_trans, i2c_transaction::slave_addr, status, VL53L1_I2C_SLAVE__DEVICE_ADDRESS, and VL53L1_WrByte().

Referenced by VL53L1X_SensorInit().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_SetInterMeasurementInMs	(	VL53L1_DEV	dev,
		uint32_t	InterMeasurementInMs
	)

This function programs the Intermeasurement period in ms
Intermeasurement period must be >/= timing budget.

This condition is not checked by the API, the customer has the duty to check the condition. Default = 100 ms

Definition at line 530 of file vl53l1x_api.c.

References status, VL53L1_RdWord(), VL53L1_RESULT__OSC_CALIBRATE_VAL, VL53L1_SYSTEM__INTERMEASUREMENT_PERIOD, and VL53L1_WrDWord().

Referenced by VL53L1X_BootDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_SetInterruptPolarity	(	VL53L1_DEV	dev,
		uint8_t	IntPol
	)

This function programs the interrupt polarity
1=active high (default), 0=active low.

Definition at line 279 of file vl53l1x_api.c.

References GPIO_HV_MUX__CTRL, status, VL53L1_RdByte(), and VL53L1_WrByte().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_SetOffset	(	VL53L1_DEV	dev,
		int16_t	OffsetValue
	)

This function programs the offset correction in mm.

Parameters

OffsetValue:the offset correction value to program in mm

Definition at line 678 of file vl53l1x_api.c.

References ALGO__PART_TO_PART_RANGE_OFFSET_MM, MM_CONFIG__INNER_OFFSET_MM, MM_CONFIG__OUTER_OFFSET_MM, status, and VL53L1_WrWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_SetROI	(	VL53L1_DEV	dev,
		uint16_t	X,
		uint16_t	Y
	)

This function programs the ROI (Region of Interest)
The ROI position is centered, only the ROI size can be reprogrammed.

The smallest acceptable ROI size = 4

Parameters

X:ROI Width; Y=ROI Height

Definition at line 794 of file vl53l1x_api.c.

References ROI_CONFIG__USER_ROI_CENTRE_SPAD, ROI_CONFIG__USER_ROI_REQUESTED_GLOBAL_XY_SIZE, status, VL53L1_RdByte(), VL53L1_ROI_CONFIG__MODE_ROI_CENTRE_SPAD, and VL53L1_WrByte().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_SetROICenter	(	VL53L1_DEV	dev,
		uint8_t	ROICenter
	)

This function programs the new user ROI center, please to be aware that there is no check in this function.

if the ROI center vs ROI size is out of border the ranging function return error #13

Definition at line 778 of file vl53l1x_api.c.

References ROI_CONFIG__USER_ROI_CENTRE_SPAD, status, and VL53L1_WrByte().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_SetSigmaThreshold	(	VL53L1_DEV	dev,
		uint16_t	sigma
	)

This function programs a new sigma threshold in mm (default=15 mm)

Definition at line 845 of file vl53l1x_api.c.

References RANGE_CONFIG__SIGMA_THRESH, status, and VL53L1_WrWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_SetSignalThreshold	(	VL53L1_DEV	dev,
		uint16_t	signal
	)

This function programs a new signal threshold in kcps (default=1024 kcps
.

Definition at line 826 of file vl53l1x_api.c.

References RANGE_CONFIG__MIN_COUNT_RATE_RTN_LIMIT_MCPS, status, and VL53L1_WrWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_SetTimingBudgetInMs	(	VL53L1_DEV	dev,
		uint16_t	TimingBudgetInMs
	)

This function programs the timing budget in ms.

Predefined values = 15, 20, 33, 50, 100(default), 200, 500.

Definition at line 336 of file vl53l1x_api.c.

References RANGE_CONFIG__TIMEOUT_MACROP_A_HI, RANGE_CONFIG__TIMEOUT_MACROP_B_HI, status, VL53L1_WrWord(), and VL53L1X_GetDistanceMode().

Referenced by VL53L1X_BootDevice(), and VL53L1X_SetDistanceMode().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_SetXtalk	(	VL53L1_DEV	dev,
		uint16_t	XtalkValue
	)

This function programs the xtalk correction value in cps (Count Per Second).

This is the number of photons reflected back from the cover glass in cps.

Definition at line 703 of file vl53l1x_api.c.

References ALGO__CROSSTALK_COMPENSATION_PLANE_OFFSET_KCPS, ALGO__CROSSTALK_COMPENSATION_X_PLANE_GRADIENT_KCPS, ALGO__CROSSTALK_COMPENSATION_Y_PLANE_GRADIENT_KCPS, status, and VL53L1_WrWord().

Here is the call graph for this function:

VL53L1X_ERROR VL53L1X_StartRanging ( VL53L1_DEV dev )

This function starts the ranging distance operation
The ranging operation is continuous.

The clear interrupt has to be done after each get data to allow the interrupt to raise when the next data is ready
1=active high (default), 0=active low, use SetInterruptPolarity() to change the interrupt polarity if required.

Definition at line 301 of file vl53l1x_api.c.

References status, SYSTEM__MODE_START, and VL53L1_WrByte().

Referenced by VL53L1X_BootDevice(), VL53L1X_SensorInit(), and VL53L1X_StartTemperatureUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

VL53L1X_ERROR VL53L1X_StartTemperatureUpdate ( VL53L1_DEV dev )

This function performs the temperature calibration.

It is recommended to call this function any time the temperature might have changed by more than 8 deg C without sensor ranging activity for an extended period.

Definition at line 868 of file vl53l1x_api.c.

References status, VL53L1_VHV_CONFIG__TIMEOUT_MACROP_LOOP_BOUND, VL53L1_WrByte(), VL53L1X_CheckForDataReady(), VL53L1X_ClearInterrupt(), VL53L1X_StartRanging(), and VL53L1X_StopRanging().

Here is the call graph for this function: