Return the VL53L0X PAL Implementation Version.

Note

This function doesn't access to the device

Parameters

pVersion

Pointer to current PAL Implementation Version

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Return the PAL Specification Version used for the current implementation.

Note

This function doesn't access to the device

Parameters

pPalSpecVersion

Pointer to current PAL Specification Version

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Reads the Product Revision for a for given Device This function can be used to distinguish cut1.0 from cut1.1.

Note

This function Access to the device

Parameters

Dev	Device Handle
pProductRevisionMajor	Pointer to Product Revision Major for a given Device
pProductRevisionMinor	Pointer to Product Revision Minor for a given Device

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Reads the Device information for given Device.

Note

This function Access to the device

Parameters

Dev	Device Handle
pVL53L0X_DeviceInfo	Pointer to current device info for a given Device

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Read current status of the error register for the selected device.

Note

This function Access to the device

Parameters

Dev	Device Handle
pDeviceErrorStatus	Pointer to current error code of the device

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Human readable Range Status string for a given RangeStatus.

Note

This function doesn't access to the device

Parameters

RangeStatus	The RangeStatus code as stored on VL53L0X_RangingMeasurementData_t
pRangeStatusString	The returned RangeStatus string.

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Human readable error string for a given Error Code.

Note

This function doesn't access to the device

Parameters

ErrorCode	The error code as stored on VL53L0X_DeviceError
pDeviceErrorString	The error string corresponding to the ErrorCode

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Human readable error string for current PAL error status.

Note

This function doesn't access to the device

Parameters

PalErrorCode	The error code as stored on VL53L0X_Error
pPalErrorString	The error string corresponding to the PalErrorCode

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Human readable PAL State string.

Note

This function doesn't access to the device

Parameters

PalStateCode	The State code as stored on VL53L0X_State
pPalStateString	The State string corresponding to the PalStateCode

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Reads the internal state of the PAL for a given Device.

Note

This function doesn't access to the device

Parameters

Dev	Device Handle
pPalState	Pointer to current state of the PAL for a given Device

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Set the power mode for a given Device The power mode can be Standby or Idle.

Different level of both Standby and Idle can exists. This function should not be used when device is in Ranging state.

Note

This function Access to the device

Parameters

Dev	Device Handle
PowerMode	The value of the power mode to set. see VL53L0X_PowerModes Valid values are: VL53L0X_POWERMODE_STANDBY_LEVEL1, VL53L0X_POWERMODE_IDLE_LEVEL1

Returns

VL53L0X_ERROR_NONE Success

VL53L0X_ERROR_MODE_NOT_SUPPORTED This error occurs when PowerMode is not in the supported list

"Other error code" See VL53L0X_Error

Get the power mode for a given Device.

Note

This function Access to the device

Parameters

Dev	Device Handle
pPowerMode	Pointer to the current value of the power mode. see VL53L0X_PowerModes Valid values are: VL53L0X_POWERMODE_STANDBY_LEVEL1, VL53L0X_POWERMODE_IDLE_LEVEL1

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Set or over-hide part to part calibration offset.

See also

VL53L0X_DataInit() VL53L0X_GetOffsetCalibrationDataMicroMeter()

Note

This function Access to the device

Parameters

Dev	Device Handle
OffsetCalibrationDataMicroMeter	Offset (microns)

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Get part to part calibration offset.

Function Description

Should only be used after a successful call to VL53L0X_DataInit to backup device NVM value

Note

This function Access to the device

Parameters

Dev	Device Handle
pOffsetCalibrationDataMicroMeter	Return part to part calibration offset from device (microns)

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Set the linearity corrective gain.

Note

This function Access to the device

Parameters

Dev	Device Handle
LinearityCorrectiveGain	Linearity corrective gain in x1000 if value is 1000 then no modification is applied.

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Get the linearity corrective gain.

Function Description

Should only be used after a successful call to VL53L0X_DataInit to backup device NVM value

Note

This function Access to the device

Parameters

Dev	Device Handle
pLinearityCorrectiveGain	Pointer to the linearity corrective gain in x1000 if value is 1000 then no modification is applied.

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Set Group parameter Hold state.

Function Description

Set or remove device internal group parameter hold

Note

This function is not Implemented

Parameters

Dev	Device Handle
GroupParamHold	Group parameter Hold state to be set (on/off)

Returns

VL53L0X_ERROR_NOT_IMPLEMENTED Not implemented

Get the maximal distance for actual setup.

Function Description

Device must be initialized through VL53L0X_SetParameters() prior calling this function.

Any range value more than the value returned is to be considered as "no target detected" or "no target in detectable range"

Warning

The maximal distance depends on the setup

Note

This function is not Implemented

Parameters

Dev	Device Handle
pUpperLimitMilliMeter	The maximal range limit for actual setup (in millimeter)

Returns

VL53L0X_ERROR_NOT_IMPLEMENTED Not implemented

Get the Total Signal Rate.

Function Description

This function will return the Total Signal Rate after a good ranging is done.

Note

This function access to Device

Parameters

Dev	Device Handle
pTotalSignalRate	Total Signal Rate value in Mega count per second

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error