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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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