Functions used to prepare and setup the device. More...

Functions
VL53L0X_API VL53L0X_Error	VL53L0X_SetDeviceParameters (VL53L0X_DEV Dev, const VL53L0X_DeviceParameters_t *pDeviceParameters)
	Prepare device for operation. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetDeviceParameters (VL53L0X_DEV Dev, VL53L0X_DeviceParameters_t *pDeviceParameters)
	Retrieve current device parameters. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetDeviceMode (VL53L0X_DEV Dev, VL53L0X_DeviceModes DeviceMode)
	Set a new device mode. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetDeviceMode (VL53L0X_DEV Dev, VL53L0X_DeviceModes *pDeviceMode)
	Get current new device mode. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetRangeFractionEnable (VL53L0X_DEV Dev, uint8_t Enable)
	Sets the resolution of range measurements. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetFractionEnable (VL53L0X_DEV Dev, uint8_t *pEnable)
	Gets the fraction enable parameter indicating the resolution of range measurements. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetHistogramMode (VL53L0X_DEV Dev, VL53L0X_HistogramModes HistogramMode)
	Set a new Histogram mode. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetHistogramMode (VL53L0X_DEV Dev, VL53L0X_HistogramModes *pHistogramMode)
	Get current new device mode. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetMeasurementTimingBudgetMicroSeconds (VL53L0X_DEV Dev, uint32_t MeasurementTimingBudgetMicroSeconds)
	Set Ranging Timing Budget in microseconds. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetMeasurementTimingBudgetMicroSeconds (VL53L0X_DEV Dev, uint32_t *pMeasurementTimingBudgetMicroSeconds)
	Get Ranging Timing Budget in microseconds. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetVcselPulsePeriod (VL53L0X_DEV Dev, VL53L0X_VcselPeriod VcselPeriodType, uint8_t *pVCSELPulsePeriod)
	Gets the VCSEL pulse period. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetVcselPulsePeriod (VL53L0X_DEV Dev, VL53L0X_VcselPeriod VcselPeriodType, uint8_t VCSELPulsePeriod)
	Sets the VCSEL pulse period. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetSequenceStepEnable (VL53L0X_DEV Dev, VL53L0X_SequenceStepId SequenceStepId, uint8_t SequenceStepEnabled)
	Sets the (on/off) state of a requested sequence step. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetSequenceStepEnable (VL53L0X_DEV Dev, VL53L0X_SequenceStepId SequenceStepId, uint8_t *pSequenceStepEnabled)
	Gets the (on/off) state of a requested sequence step. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetSequenceStepEnables (VL53L0X_DEV Dev, VL53L0X_SchedulerSequenceSteps_t *pSchedulerSequenceSteps)
	Gets the (on/off) state of all sequence steps. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetSequenceStepTimeout (VL53L0X_DEV Dev, VL53L0X_SequenceStepId SequenceStepId, FixPoint1616_t TimeOutMilliSecs)
	Sets the timeout of a requested sequence step. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetSequenceStepTimeout (VL53L0X_DEV Dev, VL53L0X_SequenceStepId SequenceStepId, FixPoint1616_t *pTimeOutMilliSecs)
	Gets the timeout of a requested sequence step. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetNumberOfSequenceSteps (VL53L0X_DEV Dev, uint8_t *pNumberOfSequenceSteps)
	Gets number of sequence steps managed by the API. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetSequenceStepsInfo (VL53L0X_SequenceStepId SequenceStepId, char *pSequenceStepsString)
	Gets the name of a given sequence step. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetInterMeasurementPeriodMilliSeconds (VL53L0X_DEV Dev, uint32_t InterMeasurementPeriodMilliSeconds)

VL53L0X_API VL53L0X_Error	VL53L0X_GetInterMeasurementPeriodMilliSeconds (VL53L0X_DEV Dev, uint32_t *pInterMeasurementPeriodMilliSeconds)

VL53L0X_API VL53L0X_Error	VL53L0X_SetXTalkCompensationEnable (VL53L0X_DEV Dev, uint8_t XTalkCompensationEnable)
	Enable/Disable Cross talk compensation feature. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetXTalkCompensationEnable (VL53L0X_DEV Dev, uint8_t *pXTalkCompensationEnable)
	Get Cross talk compensation rate. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetXTalkCompensationRateMegaCps (VL53L0X_DEV Dev, FixPoint1616_t XTalkCompensationRateMegaCps)
	Set Cross talk compensation rate. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetXTalkCompensationRateMegaCps (VL53L0X_DEV Dev, FixPoint1616_t *pXTalkCompensationRateMegaCps)
	Get Cross talk compensation rate. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetRefCalibration (VL53L0X_DEV Dev, uint8_t VhvSettings, uint8_t PhaseCal)
	Set Reference Calibration Parameters. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetRefCalibration (VL53L0X_DEV Dev, uint8_t pVhvSettings, uint8_t pPhaseCal)
	Get Reference Calibration Parameters. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetNumberOfLimitCheck (uint16_t *pNumberOfLimitCheck)
	Get the number of the check limit managed by a given Device. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetLimitCheckInfo (VL53L0X_DEV Dev, uint16_t LimitCheckId, char *pLimitCheckString)
	Return a description string for a given limit check number. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetLimitCheckStatus (VL53L0X_DEV Dev, uint16_t LimitCheckId, uint8_t *pLimitCheckStatus)
	Return a the Status of the specified check limit. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetLimitCheckEnable (VL53L0X_DEV Dev, uint16_t LimitCheckId, uint8_t LimitCheckEnable)
	Enable/Disable a specific limit check. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetLimitCheckEnable (VL53L0X_DEV Dev, uint16_t LimitCheckId, uint8_t *pLimitCheckEnable)
	Get specific limit check enable state. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetLimitCheckValue (VL53L0X_DEV Dev, uint16_t LimitCheckId, FixPoint1616_t LimitCheckValue)
	Set a specific limit check value. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetLimitCheckValue (VL53L0X_DEV Dev, uint16_t LimitCheckId, FixPoint1616_t *pLimitCheckValue)
	Get a specific limit check value. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetLimitCheckCurrent (VL53L0X_DEV Dev, uint16_t LimitCheckId, FixPoint1616_t *pLimitCheckCurrent)
	Get the current value of the signal used for the limit check. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetWrapAroundCheckEnable (VL53L0X_DEV Dev, uint8_t WrapAroundCheckEnable)
	Enable (or disable) Wrap around Check. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetWrapAroundCheckEnable (VL53L0X_DEV Dev, uint8_t *pWrapAroundCheckEnable)
	Get setup of Wrap around Check. More...

VL53L0X_API VL53L0X_Error	VL53L0X_SetDmaxCalParameters (VL53L0X_DEV Dev, uint16_t RangeMilliMeter, FixPoint1616_t SignalRateRtnMegaCps)
	Set Dmax Calibration Parameters for a given device When one of the parameter is zero, this function will get parameter from NVM. More...

VL53L0X_API VL53L0X_Error	VL53L0X_GetDmaxCalParameters (VL53L0X_DEV Dev, uint16_t pRangeMilliMeter, FixPoint1616_t pSignalRateRtnMegaCps)
	Get Dmax Calibration Parameters for a given device. More...

Detailed Description

Functions used to prepare and setup the device.

Function Documentation

◆ VL53L0X_GetDeviceMode()

VL53L0X_API VL53L0X_Error VL53L0X_GetDeviceMode	(	VL53L0X_DEV	Dev,
		VL53L0X_DeviceModes *	pDeviceMode
	)

Get current new device mode.

Function Description: Get actual mode of the device(ranging, histogram ...)

Note: This function doesn't Access to the device

Parameters

Dev	Device Handle
pDeviceMode	Pointer to current apply mode value Valid values are: VL53L0X_DEVICEMODE_SINGLE_RANGING VL53L0X_DEVICEMODE_CONTINUOUS_RANGING VL53L0X_DEVICEMODE_CONTINUOUS_TIMED_RANGING VL53L0X_DEVICEMODE_SINGLE_HISTOGRAM VL53L0X_HISTOGRAMMODE_REFERENCE_ONLY VL53L0X_HISTOGRAMMODE_RETURN_ONLY VL53L0X_HISTOGRAMMODE_BOTH

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_MODE_NOT_SUPPORTED This error occurs when DeviceMode is not in the supported list

◆ VL53L0X_GetDeviceParameters()

VL53L0X_API VL53L0X_Error VL53L0X_GetDeviceParameters	(	VL53L0X_DEV	Dev,
		VL53L0X_DeviceParameters_t *	pDeviceParameters
	)

Retrieve current device parameters.

Function Description

Get actual parameters of the device

Then start ranging operation.

Note: This function Access to the device

Parameters

Dev	Device Handle
pDeviceParameters	Pointer to store current device parameters.

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetDmaxCalParameters()

VL53L0X_API VL53L0X_Error VL53L0X_GetDmaxCalParameters	(	VL53L0X_DEV	Dev,
		uint16_t *	pRangeMilliMeter,
		FixPoint1616_t *	pSignalRateRtnMegaCps
	)

Get Dmax Calibration Parameters for a given device.

Note: This function Access to the device

Parameters

Dev	Device Handle
pRangeMilliMeter	Pointer to Calibration Distance
pSignalRateRtnMegaCps	Pointer to Signal rate return

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetFractionEnable()

VL53L0X_API VL53L0X_Error VL53L0X_GetFractionEnable	(	VL53L0X_DEV	Dev,
		uint8_t *	pEnable
	)

Gets the fraction enable parameter indicating the resolution of range measurements.

Function Description: Gets the fraction enable state, which translates to the resolution of range measurements as follows :Enabled:=0.25mm resolution, Not Enabled:=1mm resolution.

Note: This function Accesses the device

Parameters

Dev	Device Handle
pEnable	Output Parameter reporting the fraction enable state.

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetHistogramMode()

VL53L0X_API VL53L0X_Error VL53L0X_GetHistogramMode	(	VL53L0X_DEV	Dev,
		VL53L0X_HistogramModes *	pHistogramMode
	)

Get current new device mode.

Function Description: Get current Histogram mode of a Device

Note: This function doesn't Access to the device

Parameters

Dev	Device Handle
pHistogramMode	Pointer to current Histogram Mode value Valid values are: VL53L0X_HISTOGRAMMODE_DISABLED VL53L0X_DEVICEMODE_SINGLE_HISTOGRAM VL53L0X_HISTOGRAMMODE_REFERENCE_ONLY VL53L0X_HISTOGRAMMODE_RETURN_ONLY VL53L0X_HISTOGRAMMODE_BOTH

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetInterMeasurementPeriodMilliSeconds()

VL53L0X_API VL53L0X_Error VL53L0X_GetInterMeasurementPeriodMilliSeconds	(	VL53L0X_DEV	Dev,
		uint32_t *	pInterMeasurementPeriodMilliSeconds
	)

Get continuous mode Inter-Measurement period in milliseconds

Function Description: When trying to set too short time return INVALID_PARAMS minimal value

Note: This function Access to the device

Parameters

Dev	Device Handle
pInterMeasurementPeriodMilliSeconds	Pointer to programmed Inter-Measurement Period in milliseconds.

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetLimitCheckCurrent()

VL53L0X_API VL53L0X_Error VL53L0X_GetLimitCheckCurrent	(	VL53L0X_DEV	Dev,
		uint16_t	LimitCheckId,
		FixPoint1616_t *	pLimitCheckCurrent
	)

Get the current value of the signal used for the limit check.

Function Description: This function get a the current value of the signal used for the limit check. To obtain the latest value you should run a ranging before. The value reported is linked to the limit check identified with the LimitCheckId.

Note: This function Access to the device

Parameters

Dev	Device Handle
LimitCheckId	Limit Check ID (0<= LimitCheckId < VL53L0X_GetNumberOfLimitCheck() ).
pLimitCheckCurrent	Pointer to current Value for a given LimitCheckId.

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS This error is returned when LimitCheckId value is out of range.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetLimitCheckEnable()

VL53L0X_API VL53L0X_Error VL53L0X_GetLimitCheckEnable	(	VL53L0X_DEV	Dev,
		uint16_t	LimitCheckId,
		uint8_t *	pLimitCheckEnable
	)

Get specific limit check enable state.

Function Description: This function get the enable state of a specific limit check. The limit check is identified with the LimitCheckId.

Note: This function Access to the device

Parameters

Dev	Device Handle
LimitCheckId	Limit Check ID (0<= LimitCheckId < VL53L0X_GetNumberOfLimitCheck() ).
pLimitCheckEnable	Pointer to the check limit enable value. if 1 the check limit corresponding to LimitCheckId is Enabled if 0 the check limit corresponding to LimitCheckId is disabled

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS This error is returned when LimitCheckId value is out of range.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetLimitCheckInfo()

VL53L0X_API VL53L0X_Error VL53L0X_GetLimitCheckInfo	(	VL53L0X_DEV	Dev,
		uint16_t	LimitCheckId,
		char *	pLimitCheckString
	)

Return a description string for a given limit check number.

Function Description: This function returns a description string for a given limit check number. The limit check is identified with the LimitCheckId.

Note: This function doesn't Access to the device

Parameters

Dev	Device Handle
LimitCheckId	Limit Check ID (0<= LimitCheckId < VL53L0X_GetNumberOfLimitCheck() ).
pLimitCheckString	Pointer to the description string of the given check limit.

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS This error is returned when LimitCheckId value is out of range.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetLimitCheckStatus()

VL53L0X_API VL53L0X_Error VL53L0X_GetLimitCheckStatus	(	VL53L0X_DEV	Dev,
		uint16_t	LimitCheckId,
		uint8_t *	pLimitCheckStatus
	)

Return a the Status of the specified check limit.

Function Description: This function returns the Status of the specified check limit. The value indicate if the check is fail or not. The limit check is identified with the LimitCheckId.

Note: This function doesn't Access to the device

Parameters

Dev	Device Handle
LimitCheckId	Limit Check ID (0<= LimitCheckId < VL53L0X_GetNumberOfLimitCheck() ).
pLimitCheckStatus	Pointer to the Limit Check Status of the given check limit. LimitCheckStatus : 0 the check is not fail 1 the check if fail or not enabled

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS This error is returned when LimitCheckId value is out of range.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetLimitCheckValue()

VL53L0X_API VL53L0X_Error VL53L0X_GetLimitCheckValue	(	VL53L0X_DEV	Dev,
		uint16_t	LimitCheckId,
		FixPoint1616_t *	pLimitCheckValue
	)

Get a specific limit check value.

Function Description: This function get a specific limit check value from device then it updates internal values and check enables. The limit check is identified with the LimitCheckId.

Note: This function Access to the device

Parameters

Dev	Device Handle
LimitCheckId	Limit Check ID (0<= LimitCheckId < VL53L0X_GetNumberOfLimitCheck() ).
pLimitCheckValue	Pointer to Limit check Value for a given LimitCheckId.

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS This error is returned when LimitCheckId value is out of range.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetMeasurementTimingBudgetMicroSeconds()

VL53L0X_API VL53L0X_Error VL53L0X_GetMeasurementTimingBudgetMicroSeconds	(	VL53L0X_DEV	Dev,
		uint32_t *	pMeasurementTimingBudgetMicroSeconds
	)

Get Ranging Timing Budget in microseconds.

Function Description: Returns the programmed the maximum time allowed by the user to the device to run a full ranging sequence for the current mode (ranging, histogram, ASL ...)

Note: This function Access to the device

Parameters

Dev	Device Handle
pMeasurementTimingBudgetMicroSeconds	Max measurement time in microseconds. Valid values are: >= 17000 microsecs when wraparound enabled >= 12000 microsecs when wraparound disabled

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetNumberOfLimitCheck()

VL53L0X_API VL53L0X_Error VL53L0X_GetNumberOfLimitCheck ( uint16_t * pNumberOfLimitCheck )

Get the number of the check limit managed by a given Device.

Function Description: This function give the number of the check limit managed by the Device

Note: This function doesn't Access to the device

Parameters

pNumberOfLimitCheck Pointer to the number of check limit.

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetNumberOfSequenceSteps()

VL53L0X_API VL53L0X_Error VL53L0X_GetNumberOfSequenceSteps	(	VL53L0X_DEV	Dev,
		uint8_t *	pNumberOfSequenceSteps
	)

Gets number of sequence steps managed by the API.

Function Description: This function retrieves the number of sequence steps currently managed by the API

Note: This function Accesses the device

Parameters

Dev	Device Handle
pNumberOfSequenceSteps	Out parameter reporting the number of sequence steps.

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetRefCalibration()

VL53L0X_API VL53L0X_Error VL53L0X_GetRefCalibration	(	VL53L0X_DEV	Dev,
		uint8_t *	pVhvSettings,
		uint8_t *	pPhaseCal
	)

Get Reference Calibration Parameters.

Function Description: Get Reference Calibration Parameters.

Note: This function Access to the device

Parameters

Dev	Device Handle
pVhvSettings	Pointer to VHV parameter
pPhaseCal	Pointer to PhaseCal Parameter

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetSequenceStepEnable()

VL53L0X_API VL53L0X_Error VL53L0X_GetSequenceStepEnable	(	VL53L0X_DEV	Dev,
		VL53L0X_SequenceStepId	SequenceStepId,
		uint8_t *	pSequenceStepEnabled
	)

Gets the (on/off) state of a requested sequence step.

Function Description: This function retrieves the state of a requested sequence step, i.e. on/off.

Note: This function Accesses the device

Parameters

Dev	Device Handle
SequenceStepId	Sequence step identifier.
pSequenceStepEnabled	Out parameter reporting if the sequence step is enabled {0=Off,1=On}.

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS Error SequenceStepId parameter not supported.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetSequenceStepEnables()

VL53L0X_API VL53L0X_Error VL53L0X_GetSequenceStepEnables	(	VL53L0X_DEV	Dev,
		VL53L0X_SchedulerSequenceSteps_t *	pSchedulerSequenceSteps
	)

Gets the (on/off) state of all sequence steps.

Function Description: This function retrieves the state of all sequence step in the scheduler.

Note: This function Accesses the device

Parameters

Dev	Device Handle
pSchedulerSequenceSteps	Pointer to struct containing result.

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetSequenceStepsInfo()

VL53L0X_API VL53L0X_Error VL53L0X_GetSequenceStepsInfo	(	VL53L0X_SequenceStepId	SequenceStepId,
		char *	pSequenceStepsString
	)

Gets the name of a given sequence step.

Function Description: This function retrieves the name of sequence steps corresponding to SequenceStepId.

Note: This function doesn't Accesses the device

Parameters

SequenceStepId	Sequence step identifier.
pSequenceStepsString	Pointer to Info string

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetSequenceStepTimeout()

VL53L0X_API VL53L0X_Error VL53L0X_GetSequenceStepTimeout	(	VL53L0X_DEV	Dev,
		VL53L0X_SequenceStepId	SequenceStepId,
		FixPoint1616_t *	pTimeOutMilliSecs
	)

Gets the timeout of a requested sequence step.

Function Description: This function retrieves the timeout of a requested sequence step.

Note: This function Accesses the device

Parameters

Dev	Device Handle
SequenceStepId	Sequence step identifier.
pTimeOutMilliSecs	Timeout value.

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS Error SequenceStepId parameter not supported.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetVcselPulsePeriod()

VL53L0X_API VL53L0X_Error VL53L0X_GetVcselPulsePeriod	(	VL53L0X_DEV	Dev,
		VL53L0X_VcselPeriod	VcselPeriodType,
		uint8_t *	pVCSELPulsePeriod
	)

Gets the VCSEL pulse period.

Function Description: This function retrieves the VCSEL pulse period for the given period type.

Note: This function Accesses the device

Parameters

Dev	Device Handle
VcselPeriodType	VCSEL period identifier (pre-range\|final).
pVCSELPulsePeriod	Pointer to VCSEL period value.

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS Error VcselPeriodType parameter not supported.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetWrapAroundCheckEnable()

VL53L0X_API VL53L0X_Error VL53L0X_GetWrapAroundCheckEnable	(	VL53L0X_DEV	Dev,
		uint8_t *	pWrapAroundCheckEnable
	)

Get setup of Wrap around Check.

Function Description: This function get the wrapAround check enable parameters

Note: This function Access to the device

Parameters

Dev	Device Handle
pWrapAroundCheckEnable	Pointer to the Wrap around Check state 0=disabled or 1 = enabled

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_GetXTalkCompensationEnable()

VL53L0X_API VL53L0X_Error VL53L0X_GetXTalkCompensationEnable	(	VL53L0X_DEV	Dev,
		uint8_t *	pXTalkCompensationEnable
	)

Get Cross talk compensation rate.

Note: This function is not Implemented. Enable/Disable Cross Talk by set to zero the Cross Talk value by using VL53L0X_SetXTalkCompensationRateMegaCps().

Parameters

Dev	Device Handle
pXTalkCompensationEnable	Pointer to the Cross talk compensation state 0=disabled or 1 = enabled

Returns: VL53L0X_ERROR_NOT_IMPLEMENTED Not implemented

◆ VL53L0X_GetXTalkCompensationRateMegaCps()

VL53L0X_API VL53L0X_Error VL53L0X_GetXTalkCompensationRateMegaCps	(	VL53L0X_DEV	Dev,
		FixPoint1616_t *	pXTalkCompensationRateMegaCps
	)

Get Cross talk compensation rate.

Function Description: Get Cross talk compensation rate.

Note: This function Access to the device

Parameters

Dev	Device Handle
pXTalkCompensationRateMegaCps	Pointer to Compensation rate in Mega counts per second (16.16 fix point) see datasheet for details

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetDeviceMode()

VL53L0X_API VL53L0X_Error VL53L0X_SetDeviceMode	(	VL53L0X_DEV	Dev,
		VL53L0X_DeviceModes	DeviceMode
	)

Set a new device mode.

Function Description: Set device to a new mode (ranging, histogram ...)

Note: This function doesn't Access to the device

Parameters

Dev	Device Handle
DeviceMode	New device mode to apply Valid values are: VL53L0X_DEVICEMODE_SINGLE_RANGING VL53L0X_DEVICEMODE_CONTINUOUS_RANGING VL53L0X_DEVICEMODE_CONTINUOUS_TIMED_RANGING VL53L0X_DEVICEMODE_SINGLE_HISTOGRAM VL53L0X_HISTOGRAMMODE_REFERENCE_ONLY VL53L0X_HISTOGRAMMODE_RETURN_ONLY VL53L0X_HISTOGRAMMODE_BOTH

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_MODE_NOT_SUPPORTED This error occurs when DeviceMode is not in the supported list

◆ VL53L0X_SetDeviceParameters()

VL53L0X_API VL53L0X_Error VL53L0X_SetDeviceParameters	(	VL53L0X_DEV	Dev,
		const VL53L0X_DeviceParameters_t *	pDeviceParameters
	)

Prepare device for operation.

Function Description

Update device with provided parameters

Then start ranging operation.

Note: This function Access to the device

Parameters

Dev	Device Handle
pDeviceParameters	Pointer to store current device parameters.

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetDmaxCalParameters()

VL53L0X_API VL53L0X_Error VL53L0X_SetDmaxCalParameters	(	VL53L0X_DEV	Dev,
		uint16_t	RangeMilliMeter,
		FixPoint1616_t	SignalRateRtnMegaCps
	)

Set Dmax Calibration Parameters for a given device When one of the parameter is zero, this function will get parameter from NVM.

Note: This function doesn't Access to the device

Parameters

Dev	Device Handle
RangeMilliMeter	Calibration Distance
SignalRateRtnMegaCps	Signal rate return read at CalDistance

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetHistogramMode()

VL53L0X_API VL53L0X_Error VL53L0X_SetHistogramMode	(	VL53L0X_DEV	Dev,
		VL53L0X_HistogramModes	HistogramMode
	)

Set a new Histogram mode.

Function Description: Set device to a new Histogram mode

Note: This function doesn't Access to the device

Parameters

Dev	Device Handle
HistogramMode	New device mode to apply Valid values are: VL53L0X_HISTOGRAMMODE_DISABLED VL53L0X_DEVICEMODE_SINGLE_HISTOGRAM VL53L0X_HISTOGRAMMODE_REFERENCE_ONLY VL53L0X_HISTOGRAMMODE_RETURN_ONLY VL53L0X_HISTOGRAMMODE_BOTH

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_MODE_NOT_SUPPORTED This error occurs when HistogramMode is not in the supported list; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetInterMeasurementPeriodMilliSeconds()

VL53L0X_API VL53L0X_Error VL53L0X_SetInterMeasurementPeriodMilliSeconds	(	VL53L0X_DEV	Dev,
		uint32_t	InterMeasurementPeriodMilliSeconds
	)

Program continuous mode Inter-Measurement period in milliseconds

Function Description: When trying to set too short time return INVALID_PARAMS minimal value

Note: This function Access to the device

Parameters

Dev	Device Handle
InterMeasurementPeriodMilliSeconds	Inter-Measurement Period in ms.

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetLimitCheckEnable()

VL53L0X_API VL53L0X_Error VL53L0X_SetLimitCheckEnable	(	VL53L0X_DEV	Dev,
		uint16_t	LimitCheckId,
		uint8_t	LimitCheckEnable
	)

Enable/Disable a specific limit check.

Function Description: This function Enable/Disable a specific limit check. The limit check is identified with the LimitCheckId.

Note: This function doesn't Access to the device

Parameters

Dev	Device Handle
LimitCheckId	Limit Check ID (0<= LimitCheckId < VL53L0X_GetNumberOfLimitCheck() ).
LimitCheckEnable	if 1 the check limit corresponding to LimitCheckId is Enabled if 0 the check limit corresponding to LimitCheckId is disabled

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS This error is returned when LimitCheckId value is out of range.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetLimitCheckValue()

VL53L0X_API VL53L0X_Error VL53L0X_SetLimitCheckValue	(	VL53L0X_DEV	Dev,
		uint16_t	LimitCheckId,
		FixPoint1616_t	LimitCheckValue
	)

Set a specific limit check value.

Function Description: This function set a specific limit check value. The limit check is identified with the LimitCheckId.

Note: This function Access to the device

Parameters

Dev	Device Handle
LimitCheckId	Limit Check ID (0<= LimitCheckId < VL53L0X_GetNumberOfLimitCheck() ).
LimitCheckValue	Limit check Value for a given LimitCheckId

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS This error is returned when either LimitCheckId or LimitCheckValue value is out of range.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetMeasurementTimingBudgetMicroSeconds()

VL53L0X_API VL53L0X_Error VL53L0X_SetMeasurementTimingBudgetMicroSeconds	(	VL53L0X_DEV	Dev,
		uint32_t	MeasurementTimingBudgetMicroSeconds
	)

Set Ranging Timing Budget in microseconds.

Function Description: Defines the maximum time allowed by the user to the device to run a full ranging sequence for the current mode (ranging, histogram, ASL ...)

Note: This function Access to the device

Parameters

Dev	Device Handle
MeasurementTimingBudgetMicroSeconds	Max measurement time in microseconds. Valid values are: >= 17000 microsecs when wraparound enabled >= 12000 microsecs when wraparound disabled

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS This error is returned if MeasurementTimingBudgetMicroSeconds out of range; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetRangeFractionEnable()

VL53L0X_API VL53L0X_Error VL53L0X_SetRangeFractionEnable	(	VL53L0X_DEV	Dev,
		uint8_t	Enable
	)

Sets the resolution of range measurements.

Function Description: Set resolution of range measurements to either 0.25mm if fraction enabled or 1mm if not enabled.

Note: This function Accesses the device

Parameters

Dev	Device Handle
Enable	Enable high resolution

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetRefCalibration()

VL53L0X_API VL53L0X_Error VL53L0X_SetRefCalibration	(	VL53L0X_DEV	Dev,
		uint8_t	VhvSettings,
		uint8_t	PhaseCal
	)

Set Reference Calibration Parameters.

Function Description: Set Reference Calibration Parameters.

Note: This function Access to the device

Parameters

Dev	Device Handle
VhvSettings	Parameter for VHV
PhaseCal	Parameter for PhaseCal

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetSequenceStepEnable()

VL53L0X_API VL53L0X_Error VL53L0X_SetSequenceStepEnable	(	VL53L0X_DEV	Dev,
		VL53L0X_SequenceStepId	SequenceStepId,
		uint8_t	SequenceStepEnabled
	)

Sets the (on/off) state of a requested sequence step.

Function Description: This function enables/disables a requested sequence step.

Note: This function Accesses the device

Parameters

Dev	Device Handle
SequenceStepId	Sequence step identifier.
SequenceStepEnabled	Demanded state {0=Off,1=On} is enabled.

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS Error SequenceStepId parameter not supported.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetSequenceStepTimeout()

VL53L0X_API VL53L0X_Error VL53L0X_SetSequenceStepTimeout	(	VL53L0X_DEV	Dev,
		VL53L0X_SequenceStepId	SequenceStepId,
		FixPoint1616_t	TimeOutMilliSecs
	)

Sets the timeout of a requested sequence step.

Function Description: This function sets the timeout of a requested sequence step.

Note: This function Accesses the device

Parameters

Dev	Device Handle
SequenceStepId	Sequence step identifier.
TimeOutMilliSecs	Demanded timeout

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS Error SequenceStepId parameter not supported.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetVcselPulsePeriod()

VL53L0X_API VL53L0X_Error VL53L0X_SetVcselPulsePeriod	(	VL53L0X_DEV	Dev,
		VL53L0X_VcselPeriod	VcselPeriodType,
		uint8_t	VCSELPulsePeriod
	)

Sets the VCSEL pulse period.

Function Description: This function retrieves the VCSEL pulse period for the given period type.

Note: This function Accesses the device

Parameters

Dev	Device Handle
VcselPeriodType	VCSEL period identifier (pre-range\|final).
VCSELPulsePeriod	VCSEL period value

Returns: VL53L0X_ERROR_NONE Success; VL53L0X_ERROR_INVALID_PARAMS Error VcselPeriodType parameter not supported.; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetWrapAroundCheckEnable()

VL53L0X_API VL53L0X_Error VL53L0X_SetWrapAroundCheckEnable	(	VL53L0X_DEV	Dev,
		uint8_t	WrapAroundCheckEnable
	)

Enable (or disable) Wrap around Check.

Note: This function Access to the device

Parameters

Dev	Device Handle
WrapAroundCheckEnable	Wrap around Check to be set 0=disabled, other = enabled

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error

◆ VL53L0X_SetXTalkCompensationEnable()

VL53L0X_API VL53L0X_Error VL53L0X_SetXTalkCompensationEnable	(	VL53L0X_DEV	Dev,
		uint8_t	XTalkCompensationEnable
	)

Enable/Disable Cross talk compensation feature.

Note: This function is not Implemented. Enable/Disable Cross Talk by set to zero the Cross Talk value by using VL53L0X_SetXTalkCompensationRateMegaCps().

Parameters

Dev	Device Handle
XTalkCompensationEnable	Cross talk compensation to be set 0=disabled else = enabled

Returns: VL53L0X_ERROR_NOT_IMPLEMENTED Not implemented

◆ VL53L0X_SetXTalkCompensationRateMegaCps()

VL53L0X_API VL53L0X_Error VL53L0X_SetXTalkCompensationRateMegaCps	(	VL53L0X_DEV	Dev,
		FixPoint1616_t	XTalkCompensationRateMegaCps
	)

Set Cross talk compensation rate.

Function Description: Set Cross talk compensation rate.

Note: This function Access to the device

Parameters

Dev	Device Handle
XTalkCompensationRateMegaCps	Compensation rate in Mega counts per second (16.16 fix point) see datasheet for details

Returns: VL53L0X_ERROR_NONE Success; "Other error code" See ::VL53L0X_Error