VL53L0X API Specification
Table of contents
- Documentation
- Platform
- RangeStatus
- Strings
- Disclaimer
-
Modules
- VL53L0X Platform Functions
-
VL53L0X cut1.1 Function Definition
-
VL53L0X General Functions
- VL53L0X_GetVersion
- VL53L0X_GetPalSpecVersion
- VL53L0X_GetProductRevision
- VL53L0X_GetDeviceInfo
- VL53L0X_GetDeviceErrorStatus
- VL53L0X_GetRangeStatusString
- VL53L0X_GetDeviceErrorString
- VL53L0X_GetPalErrorString
- VL53L0X_GetPalStateString
- VL53L0X_GetPalState
- VL53L0X_SetPowerMode
- VL53L0X_GetPowerMode
- VL53L0X_SetOffsetCalibrationDataMicroMeter
- VL53L0X_GetOffsetCalibrationDataMicroMeter
- VL53L0X_SetLinearityCorrectiveGain
- VL53L0X_GetLinearityCorrectiveGain
- VL53L0X_SetGroupParamHold
- VL53L0X_GetUpperLimitMilliMeter
- VL53L0X_GetTotalSignalRate
- VL53L0X Init Functions
-
VL53L0X Parameters Functions
- VL53L0X_SetDeviceParameters
- VL53L0X_GetDeviceParameters
- VL53L0X_SetDeviceMode
- VL53L0X_GetDeviceMode
- VL53L0X_SetRangeFractionEnable
- VL53L0X_GetFractionEnable
- VL53L0X_SetHistogramMode
- VL53L0X_GetHistogramMode
- VL53L0X_SetMeasurementTimingBudgetMicroSeconds
- VL53L0X_GetMeasurementTimingBudgetMicroSeconds
- VL53L0X_GetVcselPulsePeriod
- VL53L0X_SetVcselPulsePeriod
- VL53L0X_SetSequenceStepEnable
- VL53L0X_GetSequenceStepEnable
- VL53L0X_GetSequenceStepEnables
- VL53L0X_SetSequenceStepTimeout
- VL53L0X_GetSequenceStepTimeout
- VL53L0X_GetNumberOfSequenceSteps
- VL53L0X_GetSequenceStepsInfo
- VL53L0X_SetInterMeasurementPeriodMilliSeconds
- VL53L0X_GetInterMeasurementPeriodMilliSeconds
- VL53L0X_SetXTalkCompensationEnable
- VL53L0X_GetXTalkCompensationEnable
- VL53L0X_SetXTalkCompensationRateMegaCps
- VL53L0X_GetXTalkCompensationRateMegaCps
- VL53L0X_SetRefCalibration
- VL53L0X_GetRefCalibration
- VL53L0X_GetNumberOfLimitCheck
- VL53L0X_GetLimitCheckInfo
- VL53L0X_GetLimitCheckStatus
- VL53L0X_SetLimitCheckEnable
- VL53L0X_GetLimitCheckEnable
- VL53L0X_SetLimitCheckValue
- VL53L0X_GetLimitCheckValue
- VL53L0X_GetLimitCheckCurrent
- VL53L0X_SetWrapAroundCheckEnable
- VL53L0X_GetWrapAroundCheckEnable
- VL53L0X_SetDmaxCalParameters
- VL53L0X_GetDmaxCalParameters
-
VL53L0X Measurement Functions
- VL53L0X_PerformSingleMeasurement
- VL53L0X_PerformRefCalibration
- VL53L0X_PerformXTalkMeasurement
- VL53L0X_PerformXTalkCalibration
- VL53L0X_PerformOffsetCalibration
- VL53L0X_StartMeasurement
- VL53L0X_StopMeasurement
- VL53L0X_GetMeasurementDataReady
- VL53L0X_WaitDeviceReadyForNewMeasurement
- VL53L0X_GetMeasurementRefSignal
- VL53L0X_GetRangingMeasurementData
- VL53L0X_GetHistogramMeasurementData
- VL53L0X_PerformSingleRangingMeasurement
- VL53L0X_PerformSingleHistogramMeasurement
- VL53L0X_SetNumberOfROIZones
- VL53L0X_GetNumberOfROIZones
- VL53L0X_GetMaxNumberOfROIZones
- VL53L0X Interrupt Functions
- VL53L0X SPAD Functions
-
VL53L0X General Functions
-
VL53L0X Defines
-
Error and Warning code returned by API
- VL53L0X_ERROR_NONE
- VL53L0X_ERROR_CALIBRATION_WARNING
- VL53L0X_ERROR_MIN_CLIPPED
- VL53L0X_ERROR_UNDEFINED
- VL53L0X_ERROR_INVALID_PARAMS
- VL53L0X_ERROR_NOT_SUPPORTED
- VL53L0X_ERROR_RANGE_ERROR
- VL53L0X_ERROR_TIME_OUT
- VL53L0X_ERROR_MODE_NOT_SUPPORTED
- VL53L0X_ERROR_BUFFER_TOO_SMALL
- VL53L0X_ERROR_GPIO_NOT_EXISTING
- VL53L0X_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED
- VL53L0X_ERROR_INTERRUPT_NOT_CLEARED
- VL53L0X_ERROR_CONTROL_INTERFACE
- VL53L0X_ERROR_INVALID_COMMAND
- VL53L0X_ERROR_DIVISION_BY_ZERO
- VL53L0X_ERROR_REF_SPAD_INIT
- VL53L0X_ERROR_NOT_IMPLEMENTED
- VL53L0X_Error
- Defines Device modes
- Defines Histogram modes
- List of available Power Modes
- Defines the current status of the device
- Defines the Polarity
- Vcsel Period Defines
- Defines the steps
- Defines the Polarity
-
General Macro Defines
- VL53L0X_SETPARAMETERFIELD
- VL53L0X_GETPARAMETERFIELD
- VL53L0X_SETARRAYPARAMETERFIELD
- VL53L0X_GETARRAYPARAMETERFIELD
- VL53L0X_SETDEVICESPECIFICPARAMETER
- VL53L0X_GETDEVICESPECIFICPARAMETER
- VL53L0X_FIXPOINT1616TOFIXPOINT97
- VL53L0X_FIXPOINT97TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT88
- VL53L0X_FIXPOINT88TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT412
- VL53L0X_FIXPOINT412TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT313
- VL53L0X_FIXPOINT313TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT08
- VL53L0X_FIXPOINT08TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT53
- VL53L0X_FIXPOINT53TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT102
- VL53L0X_FIXPOINT102TOFIXPOINT1616
- VL53L0X_MAKEUINT16
- VL53L0X_Version_t
- VL53L0X_DeviceInfo_t
- VL53L0X_DeviceParameters_t
- VL53L0X_DMaxData_t
- VL53L0X_RangingMeasurementData_t
- VL53L0X_HistogramMeasurementData_t
- VL53L0X_SpadData_t
-
VL53L0X_DeviceSpecificParameters_t
- OscFrequencyMHz
- LastEncodedTimeout
- Pin0GpioFunctionality
- FinalRangeTimeoutMicroSecs
- FinalRangeVcselPulsePeriod
- PreRangeTimeoutMicroSecs
- PreRangeVcselPulsePeriod
- SigmaEstRefArray
- SigmaEstEffPulseWidth
- SigmaEstEffAmbWidth
- ReadDataFromDeviceDone
- ModuleId
- Revision
- ProductId
- ReferenceSpadCount
- ReferenceSpadType
- RefSpadsInitialised
- PartUIDUpper
- PartUIDLower
- SignalRateMeasFixed400mm
-
VL53L0X_DevData_t
- DMaxData
- Part2PartOffsetNVMMicroMeter
- Part2PartOffsetAdjustmentNVMMicroMeter
- CurrentParameters
- LastRangeMeasure
- LastHistogramMeasure
- DeviceSpecificParameters
- SpadData
- SequenceConfig
- RangeFractionalEnable
- PalState
- PowerMode
- SigmaEstRefArray
- SigmaEstEffPulseWidth
- SigmaEstEffAmbWidth
- StopVariable
- targetRefRate
- SigmaEstimate
- SignalEstimate
- LastSignalRefMcps
- pTuningSettingsPointer
- UseInternalTuningSettings
- LinearityCorrectiveGain
- DmaxCalRangeMilliMeter
- DmaxCalSignalRateRtnMegaCps
- VL53L0X_RangeData_t
- VL53L0X_HistogramData_t
- VL53L0X10_SPECIFICATION_VER_MAJOR
- VL53L0X10_SPECIFICATION_VER_MINOR
- VL53L0X10_SPECIFICATION_VER_SUB
- VL53L0X10_SPECIFICATION_VER_REVISION
- VL53L0X10_IMPLEMENTATION_VER_MAJOR
- VL53L0X10_IMPLEMENTATION_VER_MINOR
- VL53L0X10_IMPLEMENTATION_VER_SUB
- VL53L0X10_IMPLEMENTATION_VER_REVISION
- VL53L0X_SPECIFICATION_VER_MAJOR
- VL53L0X_SPECIFICATION_VER_MINOR
- VL53L0X_SPECIFICATION_VER_SUB
- VL53L0X_SPECIFICATION_VER_REVISION
- VL53L0X_IMPLEMENTATION_VER_MAJOR
- VL53L0X_IMPLEMENTATION_VER_MINOR
- VL53L0X_IMPLEMENTATION_VER_SUB
- VL53L0X_IMPLEMENTATION_VER_REVISION
- VL53L0X_DEFAULT_MAX_LOOP
- VL53L0X_MAX_STRING_LENGTH
- VL53L0X_HISTOGRAM_BUFFER_SIZE
- VL53L0X_REF_SPAD_BUFFER_SIZE
-
Error and Warning code returned by API
-
VL53L0X cut1.1 Device Specific Defines
-
Device Error
- VL53L0X_DEVICEERROR_NONE
- VL53L0X_DEVICEERROR_VCSELCONTINUITYTESTFAILURE
- VL53L0X_DEVICEERROR_VCSELWATCHDOGTESTFAILURE
- VL53L0X_DEVICEERROR_NOVHVVALUEFOUND
- VL53L0X_DEVICEERROR_MSRCNOTARGET
- VL53L0X_DEVICEERROR_SNRCHECK
- VL53L0X_DEVICEERROR_RANGEPHASECHECK
- VL53L0X_DEVICEERROR_SIGMATHRESHOLDCHECK
- VL53L0X_DEVICEERROR_TCC
- VL53L0X_DEVICEERROR_PHASECONSISTENCY
- VL53L0X_DEVICEERROR_MINCLIP
- VL53L0X_DEVICEERROR_RANGECOMPLETE
- VL53L0X_DEVICEERROR_ALGOUNDERFLOW
- VL53L0X_DEVICEERROR_ALGOOVERFLOW
- VL53L0X_DEVICEERROR_RANGEIGNORETHRESHOLD
- VL53L0X_DeviceError
- Check Enable list
- Gpio Functionality
-
Define Registers
- VL53L0X_REG_SYSRANGE_START
- VL53L0X_REG_SYSRANGE_MODE_MASK
- VL53L0X_REG_SYSRANGE_MODE_START_STOP
- VL53L0X_REG_SYSRANGE_MODE_SINGLESHOT
- VL53L0X_REG_SYSRANGE_MODE_BACKTOBACK
- VL53L0X_REG_SYSRANGE_MODE_TIMED
- VL53L0X_REG_SYSRANGE_MODE_HISTOGRAM
- VL53L0X_REG_SYSTEM_THRESH_HIGH
- VL53L0X_REG_SYSTEM_THRESH_LOW
- VL53L0X_REG_SYSTEM_SEQUENCE_CONFIG
- VL53L0X_REG_SYSTEM_RANGE_CONFIG
- VL53L0X_REG_SYSTEM_INTERMEASUREMENT_PERIOD
- VL53L0X_REG_SYSTEM_INTERRUPT_CONFIG_GPIO
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_DISABLED
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_LEVEL_LOW
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_LEVEL_HIGH
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_OUT_OF_WINDOW
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_NEW_SAMPLE_READY
- VL53L0X_REG_GPIO_HV_MUX_ACTIVE_HIGH
- VL53L0X_REG_SYSTEM_INTERRUPT_CLEAR
- VL53L0X_REG_RESULT_INTERRUPT_STATUS
- VL53L0X_REG_RESULT_RANGE_STATUS
- VL53L0X_REG_RESULT_CORE_PAGE
- VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_RTN
- VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_RTN
- VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_REF
- VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_REF
- VL53L0X_REG_RESULT_PEAK_SIGNAL_RATE_REF
- VL53L0X_REG_ALGO_PART_TO_PART_RANGE_OFFSET_MM
- VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS
- VL53L0X_REG_MSRC_CONFIG_CONTROL
- VL53L0X_REG_PRE_RANGE_CONFIG_MIN_SNR
- VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_LOW
- VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_HIGH
- VL53L0X_REG_PRE_RANGE_MIN_COUNT_RATE_RTN_LIMIT
- VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_SNR
- VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_LOW
- VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_HIGH
- VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_COUNT_RATE_RTN_LIMIT
- VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_HI
- VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_LO
- VL53L0X_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD
- VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_HI
- VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_LO
- VL53L0X_REG_SYSTEM_HISTOGRAM_BIN
- VL53L0X_REG_HISTOGRAM_CONFIG_INITIAL_PHASE_SELECT
- VL53L0X_REG_HISTOGRAM_CONFIG_READOUT_CTRL
- VL53L0X_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD
- VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_HI
- VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_LO
- VL53L0X_REG_CROSSTALK_COMPENSATION_PEAK_RATE_MCPS
- VL53L0X_REG_MSRC_CONFIG_TIMEOUT_MACROP
- VL53L0X_REG_SOFT_RESET_GO2_SOFT_RESET_N
- VL53L0X_REG_IDENTIFICATION_MODEL_ID
- VL53L0X_REG_IDENTIFICATION_REVISION_ID
- VL53L0X_REG_OSC_CALIBRATE_VAL
- VL53L0X_SIGMA_ESTIMATE_MAX_VALUE
- VL53L0X_REG_GLOBAL_CONFIG_VCSEL_WIDTH
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_0
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_1
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_2
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_3
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_4
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_5
- VL53L0X_REG_GLOBAL_CONFIG_REF_EN_START_SELECT
- VL53L0X_REG_DYNAMIC_SPAD_NUM_REQUESTED_REF_SPAD
- VL53L0X_REG_DYNAMIC_SPAD_REF_EN_START_OFFSET
- VL53L0X_REG_POWER_MANAGEMENT_GO1_POWER_FORCE
- VL53L0X_SPEED_OF_LIGHT_IN_AIR
- VL53L0X_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV
- VL53L0X_REG_ALGO_PHASECAL_LIM
- VL53L0X_REG_ALGO_PHASECAL_CONFIG_TIMEOUT
-
Device Error
-
Data Structures
-
Data Structures
- VL53L0X_Dev_t
-
VL53L0X_DevData_t
- DMaxData
- Part2PartOffsetNVMMicroMeter
- Part2PartOffsetAdjustmentNVMMicroMeter
- CurrentParameters
- LastRangeMeasure
- LastHistogramMeasure
- DeviceSpecificParameters
- SpadData
- SequenceConfig
- RangeFractionalEnable
- PalState
- PowerMode
- SigmaEstRefArray
- SigmaEstEffPulseWidth
- SigmaEstEffAmbWidth
- StopVariable
- targetRefRate
- SigmaEstimate
- SignalEstimate
- LastSignalRefMcps
- pTuningSettingsPointer
- UseInternalTuningSettings
- LinearityCorrectiveGain
- DmaxCalRangeMilliMeter
- DmaxCalSignalRateRtnMegaCps
- VL53L0X_DeviceInfo_t
- VL53L0X_DeviceParameters_t
-
VL53L0X_DeviceSpecificParameters_t
- OscFrequencyMHz
- LastEncodedTimeout
- Pin0GpioFunctionality
- FinalRangeTimeoutMicroSecs
- FinalRangeVcselPulsePeriod
- PreRangeTimeoutMicroSecs
- PreRangeVcselPulsePeriod
- SigmaEstRefArray
- SigmaEstEffPulseWidth
- SigmaEstEffAmbWidth
- ReadDataFromDeviceDone
- ModuleId
- Revision
- ProductId
- ReferenceSpadCount
- ReferenceSpadType
- RefSpadsInitialised
- PartUIDUpper
- PartUIDLower
- SignalRateMeasFixed400mm
- VL53L0X_DMaxData_t
- VL53L0X_HistogramData_t
- VL53L0X_HistogramMeasurementData_t
- VL53L0X_RangeData_t
- VL53L0X_RangingMeasurementData_t
- VL53L0X_SchedulerSequenceSteps_t
- VL53L0X_SpadData_t
- VL53L0X_Version_t
- Data Structure Index
- Data Fields
-
Data Structures
-
Files
-
File List
- PAL_disclaimer.c
-
vl53l0x_api.h
- VL53L0X_API
- VL53L0X_GetVersion
- VL53L0X_GetPalSpecVersion
- VL53L0X_GetProductRevision
- VL53L0X_GetDeviceInfo
- VL53L0X_GetDeviceErrorStatus
- VL53L0X_GetRangeStatusString
- VL53L0X_GetDeviceErrorString
- VL53L0X_GetPalErrorString
- VL53L0X_GetPalStateString
- VL53L0X_GetPalState
- VL53L0X_SetPowerMode
- VL53L0X_GetPowerMode
- VL53L0X_SetOffsetCalibrationDataMicroMeter
- VL53L0X_GetOffsetCalibrationDataMicroMeter
- VL53L0X_SetLinearityCorrectiveGain
- VL53L0X_GetLinearityCorrectiveGain
- VL53L0X_SetGroupParamHold
- VL53L0X_GetUpperLimitMilliMeter
- VL53L0X_GetTotalSignalRate
- VL53L0X_SetDeviceAddress
- VL53L0X_DataInit
- VL53L0X_SetTuningSettingBuffer
- VL53L0X_GetTuningSettingBuffer
- VL53L0X_StaticInit
- VL53L0X_WaitDeviceBooted
- VL53L0X_ResetDevice
- VL53L0X_SetDeviceParameters
- VL53L0X_GetDeviceParameters
- VL53L0X_SetDeviceMode
- VL53L0X_GetDeviceMode
- VL53L0X_SetRangeFractionEnable
- VL53L0X_GetFractionEnable
- VL53L0X_SetHistogramMode
- VL53L0X_GetHistogramMode
- VL53L0X_SetMeasurementTimingBudgetMicroSeconds
- VL53L0X_GetMeasurementTimingBudgetMicroSeconds
- VL53L0X_GetVcselPulsePeriod
- VL53L0X_SetVcselPulsePeriod
- VL53L0X_SetSequenceStepEnable
- VL53L0X_GetSequenceStepEnable
- VL53L0X_GetSequenceStepEnables
- VL53L0X_SetSequenceStepTimeout
- VL53L0X_GetSequenceStepTimeout
- VL53L0X_GetNumberOfSequenceSteps
- VL53L0X_GetSequenceStepsInfo
- VL53L0X_SetInterMeasurementPeriodMilliSeconds
- VL53L0X_GetInterMeasurementPeriodMilliSeconds
- VL53L0X_SetXTalkCompensationEnable
- VL53L0X_GetXTalkCompensationEnable
- VL53L0X_SetXTalkCompensationRateMegaCps
- VL53L0X_GetXTalkCompensationRateMegaCps
- VL53L0X_SetRefCalibration
- VL53L0X_GetRefCalibration
- VL53L0X_GetNumberOfLimitCheck
- VL53L0X_GetLimitCheckInfo
- VL53L0X_GetLimitCheckStatus
- VL53L0X_SetLimitCheckEnable
- VL53L0X_GetLimitCheckEnable
- VL53L0X_SetLimitCheckValue
- VL53L0X_GetLimitCheckValue
- VL53L0X_GetLimitCheckCurrent
- VL53L0X_SetWrapAroundCheckEnable
- VL53L0X_GetWrapAroundCheckEnable
- VL53L0X_SetDmaxCalParameters
- VL53L0X_GetDmaxCalParameters
- VL53L0X_PerformSingleMeasurement
- VL53L0X_PerformRefCalibration
- VL53L0X_PerformXTalkMeasurement
- VL53L0X_PerformXTalkCalibration
- VL53L0X_PerformOffsetCalibration
- VL53L0X_StartMeasurement
- VL53L0X_StopMeasurement
- VL53L0X_GetMeasurementDataReady
- VL53L0X_WaitDeviceReadyForNewMeasurement
- VL53L0X_GetMeasurementRefSignal
- VL53L0X_GetRangingMeasurementData
- VL53L0X_GetHistogramMeasurementData
- VL53L0X_PerformSingleRangingMeasurement
- VL53L0X_PerformSingleHistogramMeasurement
- VL53L0X_SetNumberOfROIZones
- VL53L0X_GetNumberOfROIZones
- VL53L0X_GetMaxNumberOfROIZones
- VL53L0X_SetGpioConfig
- VL53L0X_GetGpioConfig
- VL53L0X_SetInterruptThresholds
- VL53L0X_GetInterruptThresholds
- VL53L0X_GetStopCompletedStatus
- VL53L0X_ClearInterruptMask
- VL53L0X_GetInterruptMaskStatus
- VL53L0X_EnableInterruptMask
- VL53L0X_SetSpadAmbientDamperThreshold
- VL53L0X_GetSpadAmbientDamperThreshold
- VL53L0X_SetSpadAmbientDamperFactor
- VL53L0X_GetSpadAmbientDamperFactor
- VL53L0X_PerformRefSpadManagement
- VL53L0X_SetReferenceSpads
- VL53L0X_GetReferenceSpads
-
vl53l0x_api_calibration.h
- VL53L0X_perform_xtalk_calibration
- VL53L0X_perform_offset_calibration
- VL53L0X_set_offset_calibration_data_micro_meter
- VL53L0X_get_offset_calibration_data_micro_meter
- VL53L0X_apply_offset_adjustment
- VL53L0X_perform_ref_spad_management
- VL53L0X_set_reference_spads
- VL53L0X_get_reference_spads
- VL53L0X_perform_phase_calibration
- VL53L0X_perform_ref_calibration
- VL53L0X_set_ref_calibration
- VL53L0X_get_ref_calibration
-
vl53l0x_api_core.h
- VL53L0X_reverse_bytes
- VL53L0X_measurement_poll_for_completion
- VL53L0X_encode_vcsel_period
- VL53L0X_decode_vcsel_period
- VL53L0X_isqrt
- VL53L0X_quadrature_sum
- VL53L0X_get_info_from_device
- VL53L0X_set_vcsel_pulse_period
- VL53L0X_get_vcsel_pulse_period
- VL53L0X_decode_timeout
- get_sequence_step_timeout
- set_sequence_step_timeout
- VL53L0X_set_measurement_timing_budget_micro_seconds
- VL53L0X_get_measurement_timing_budget_micro_seconds
- VL53L0X_load_tuning_settings
- VL53L0X_calc_sigma_estimate
- VL53L0X_get_total_xtalk_rate
- VL53L0X_get_total_signal_rate
- VL53L0X_get_pal_range_status
- VL53L0X_calc_timeout_mclks
- VL53L0X_encode_timeout
- vl53l0x_api_ranging.h
-
vl53l0x_api_strings.h
- VL53L0X_STRING_DEVICE_INFO_NAME
- VL53L0X_STRING_DEVICE_INFO_NAME_TS0
- VL53L0X_STRING_DEVICE_INFO_NAME_TS1
- VL53L0X_STRING_DEVICE_INFO_NAME_TS2
- VL53L0X_STRING_DEVICE_INFO_NAME_ES1
- VL53L0X_STRING_DEVICE_INFO_TYPE
- VL53L0X_STRING_ERROR_NONE
- VL53L0X_STRING_ERROR_CALIBRATION_WARNING
- VL53L0X_STRING_ERROR_MIN_CLIPPED
- VL53L0X_STRING_ERROR_UNDEFINED
- VL53L0X_STRING_ERROR_INVALID_PARAMS
- VL53L0X_STRING_ERROR_NOT_SUPPORTED
- VL53L0X_STRING_ERROR_RANGE_ERROR
- VL53L0X_STRING_ERROR_TIME_OUT
- VL53L0X_STRING_ERROR_MODE_NOT_SUPPORTED
- VL53L0X_STRING_ERROR_BUFFER_TOO_SMALL
- VL53L0X_STRING_ERROR_GPIO_NOT_EXISTING
- VL53L0X_STRING_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED
- VL53L0X_STRING_ERROR_INTERRUPT_NOT_CLEARED
- VL53L0X_STRING_ERROR_CONTROL_INTERFACE
- VL53L0X_STRING_ERROR_INVALID_COMMAND
- VL53L0X_STRING_ERROR_DIVISION_BY_ZERO
- VL53L0X_STRING_ERROR_REF_SPAD_INIT
- VL53L0X_STRING_ERROR_NOT_IMPLEMENTED
- VL53L0X_STRING_UNKNOW_ERROR_CODE
- VL53L0X_STRING_RANGESTATUS_NONE
- VL53L0X_STRING_RANGESTATUS_RANGEVALID
- VL53L0X_STRING_RANGESTATUS_SIGMA
- VL53L0X_STRING_RANGESTATUS_SIGNAL
- VL53L0X_STRING_RANGESTATUS_MINRANGE
- VL53L0X_STRING_RANGESTATUS_PHASE
- VL53L0X_STRING_RANGESTATUS_HW
- VL53L0X_STRING_STATE_POWERDOWN
- VL53L0X_STRING_STATE_WAIT_STATICINIT
- VL53L0X_STRING_STATE_STANDBY
- VL53L0X_STRING_STATE_IDLE
- VL53L0X_STRING_STATE_RUNNING
- VL53L0X_STRING_STATE_UNKNOWN
- VL53L0X_STRING_STATE_ERROR
- VL53L0X_STRING_DEVICEERROR_NONE
- VL53L0X_STRING_DEVICEERROR_VCSELCONTINUITYTESTFAILURE
- VL53L0X_STRING_DEVICEERROR_VCSELWATCHDOGTESTFAILURE
- VL53L0X_STRING_DEVICEERROR_NOVHVVALUEFOUND
- VL53L0X_STRING_DEVICEERROR_MSRCNOTARGET
- VL53L0X_STRING_DEVICEERROR_SNRCHECK
- VL53L0X_STRING_DEVICEERROR_RANGEPHASECHECK
- VL53L0X_STRING_DEVICEERROR_SIGMATHRESHOLDCHECK
- VL53L0X_STRING_DEVICEERROR_TCC
- VL53L0X_STRING_DEVICEERROR_PHASECONSISTENCY
- VL53L0X_STRING_DEVICEERROR_MINCLIP
- VL53L0X_STRING_DEVICEERROR_RANGECOMPLETE
- VL53L0X_STRING_DEVICEERROR_ALGOUNDERFLOW
- VL53L0X_STRING_DEVICEERROR_ALGOOVERFLOW
- VL53L0X_STRING_DEVICEERROR_RANGEIGNORETHRESHOLD
- VL53L0X_STRING_DEVICEERROR_UNKNOWN
- VL53L0X_STRING_CHECKENABLE_SIGMA_FINAL_RANGE
- VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE
- VL53L0X_STRING_CHECKENABLE_SIGNAL_REF_CLIP
- VL53L0X_STRING_CHECKENABLE_RANGE_IGNORE_THRESHOLD
- VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_MSRC
- VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_PRE_RANGE
- VL53L0X_STRING_SEQUENCESTEP_TCC
- VL53L0X_STRING_SEQUENCESTEP_DSS
- VL53L0X_STRING_SEQUENCESTEP_MSRC
- VL53L0X_STRING_SEQUENCESTEP_PRE_RANGE
- VL53L0X_STRING_SEQUENCESTEP_FINAL_RANGE
- VL53L0X_get_device_info
- VL53L0X_get_device_error_string
- VL53L0X_get_range_status_string
- VL53L0X_get_pal_error_string
- VL53L0X_get_pal_state_string
- VL53L0X_get_sequence_steps_info
- VL53L0X_get_limit_check_info
-
vl53l0x_def.h
- VL53L0X10_SPECIFICATION_VER_MAJOR
- VL53L0X10_SPECIFICATION_VER_MINOR
- VL53L0X10_SPECIFICATION_VER_SUB
- VL53L0X10_SPECIFICATION_VER_REVISION
- VL53L0X10_IMPLEMENTATION_VER_MAJOR
- VL53L0X10_IMPLEMENTATION_VER_MINOR
- VL53L0X10_IMPLEMENTATION_VER_SUB
- VL53L0X10_IMPLEMENTATION_VER_REVISION
- VL53L0X_SPECIFICATION_VER_MAJOR
- VL53L0X_SPECIFICATION_VER_MINOR
- VL53L0X_SPECIFICATION_VER_SUB
- VL53L0X_SPECIFICATION_VER_REVISION
- VL53L0X_IMPLEMENTATION_VER_MAJOR
- VL53L0X_IMPLEMENTATION_VER_MINOR
- VL53L0X_IMPLEMENTATION_VER_SUB
- VL53L0X_IMPLEMENTATION_VER_REVISION
- VL53L0X_DEFAULT_MAX_LOOP
- VL53L0X_MAX_STRING_LENGTH
- VL53L0X_ERROR_NONE
- VL53L0X_ERROR_CALIBRATION_WARNING
- VL53L0X_ERROR_MIN_CLIPPED
- VL53L0X_ERROR_UNDEFINED
- VL53L0X_ERROR_INVALID_PARAMS
- VL53L0X_ERROR_NOT_SUPPORTED
- VL53L0X_ERROR_RANGE_ERROR
- VL53L0X_ERROR_TIME_OUT
- VL53L0X_ERROR_MODE_NOT_SUPPORTED
- VL53L0X_ERROR_BUFFER_TOO_SMALL
- VL53L0X_ERROR_GPIO_NOT_EXISTING
- VL53L0X_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED
- VL53L0X_ERROR_INTERRUPT_NOT_CLEARED
- VL53L0X_ERROR_CONTROL_INTERFACE
- VL53L0X_ERROR_INVALID_COMMAND
- VL53L0X_ERROR_DIVISION_BY_ZERO
- VL53L0X_ERROR_REF_SPAD_INIT
- VL53L0X_ERROR_NOT_IMPLEMENTED
- VL53L0X_DEVICEMODE_SINGLE_RANGING
- VL53L0X_DEVICEMODE_CONTINUOUS_RANGING
- VL53L0X_DEVICEMODE_SINGLE_HISTOGRAM
- VL53L0X_DEVICEMODE_CONTINUOUS_TIMED_RANGING
- VL53L0X_DEVICEMODE_SINGLE_ALS
- VL53L0X_DEVICEMODE_GPIO_DRIVE
- VL53L0X_DEVICEMODE_GPIO_OSC
- VL53L0X_HISTOGRAMMODE_DISABLED
- VL53L0X_HISTOGRAMMODE_REFERENCE_ONLY
- VL53L0X_HISTOGRAMMODE_RETURN_ONLY
- VL53L0X_HISTOGRAMMODE_BOTH
- VL53L0X_POWERMODE_STANDBY_LEVEL1
- VL53L0X_POWERMODE_STANDBY_LEVEL2
- VL53L0X_POWERMODE_IDLE_LEVEL1
- VL53L0X_POWERMODE_IDLE_LEVEL2
- VL53L0X_STATE_POWERDOWN
- VL53L0X_STATE_WAIT_STATICINIT
- VL53L0X_STATE_STANDBY
- VL53L0X_STATE_IDLE
- VL53L0X_STATE_RUNNING
- VL53L0X_STATE_UNKNOWN
- VL53L0X_STATE_ERROR
- VL53L0X_HISTOGRAM_BUFFER_SIZE
- VL53L0X_REF_SPAD_BUFFER_SIZE
- VL53L0X_INTERRUPTPOLARITY_LOW
- VL53L0X_INTERRUPTPOLARITY_HIGH
- VL53L0X_VCSEL_PERIOD_PRE_RANGE
- VL53L0X_VCSEL_PERIOD_FINAL_RANGE
- VL53L0X_SEQUENCESTEP_TCC
- VL53L0X_SEQUENCESTEP_DSS
- VL53L0X_SEQUENCESTEP_MSRC
- VL53L0X_SEQUENCESTEP_PRE_RANGE
- VL53L0X_SEQUENCESTEP_FINAL_RANGE
- VL53L0X_SEQUENCESTEP_NUMBER_OF_CHECKS
- VL53L0X_SETPARAMETERFIELD
- VL53L0X_GETPARAMETERFIELD
- VL53L0X_SETARRAYPARAMETERFIELD
- VL53L0X_GETARRAYPARAMETERFIELD
- VL53L0X_SETDEVICESPECIFICPARAMETER
- VL53L0X_GETDEVICESPECIFICPARAMETER
- VL53L0X_FIXPOINT1616TOFIXPOINT97
- VL53L0X_FIXPOINT97TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT88
- VL53L0X_FIXPOINT88TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT412
- VL53L0X_FIXPOINT412TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT313
- VL53L0X_FIXPOINT313TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT08
- VL53L0X_FIXPOINT08TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT53
- VL53L0X_FIXPOINT53TOFIXPOINT1616
- VL53L0X_FIXPOINT1616TOFIXPOINT102
- VL53L0X_FIXPOINT102TOFIXPOINT1616
- VL53L0X_MAKEUINT16
- VL53L0X_Error
- VL53L0X_DeviceModes
- VL53L0X_HistogramModes
- VL53L0X_PowerModes
- VL53L0X_State
- VL53L0X_InterruptPolarity
- VL53L0X_VcselPeriod
- VL53L0X_SequenceStepId
-
vl53l0x_device.h
- VL53L0X_DEVICEERROR_NONE
- VL53L0X_DEVICEERROR_VCSELCONTINUITYTESTFAILURE
- VL53L0X_DEVICEERROR_VCSELWATCHDOGTESTFAILURE
- VL53L0X_DEVICEERROR_NOVHVVALUEFOUND
- VL53L0X_DEVICEERROR_MSRCNOTARGET
- VL53L0X_DEVICEERROR_SNRCHECK
- VL53L0X_DEVICEERROR_RANGEPHASECHECK
- VL53L0X_DEVICEERROR_SIGMATHRESHOLDCHECK
- VL53L0X_DEVICEERROR_TCC
- VL53L0X_DEVICEERROR_PHASECONSISTENCY
- VL53L0X_DEVICEERROR_MINCLIP
- VL53L0X_DEVICEERROR_RANGECOMPLETE
- VL53L0X_DEVICEERROR_ALGOUNDERFLOW
- VL53L0X_DEVICEERROR_ALGOOVERFLOW
- VL53L0X_DEVICEERROR_RANGEIGNORETHRESHOLD
- VL53L0X_CHECKENABLE_SIGMA_FINAL_RANGE
- VL53L0X_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE
- VL53L0X_CHECKENABLE_SIGNAL_REF_CLIP
- VL53L0X_CHECKENABLE_RANGE_IGNORE_THRESHOLD
- VL53L0X_CHECKENABLE_SIGNAL_RATE_MSRC
- VL53L0X_CHECKENABLE_SIGNAL_RATE_PRE_RANGE
- VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS
- VL53L0X_GPIOFUNCTIONALITY_OFF
- VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_LOW
- VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_HIGH
- VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_OUT
- VL53L0X_GPIOFUNCTIONALITY_NEW_MEASURE_READY
- VL53L0X_REG_SYSRANGE_START
- VL53L0X_REG_SYSRANGE_MODE_MASK
- VL53L0X_REG_SYSRANGE_MODE_START_STOP
- VL53L0X_REG_SYSRANGE_MODE_SINGLESHOT
- VL53L0X_REG_SYSRANGE_MODE_BACKTOBACK
- VL53L0X_REG_SYSRANGE_MODE_TIMED
- VL53L0X_REG_SYSRANGE_MODE_HISTOGRAM
- VL53L0X_REG_SYSTEM_THRESH_HIGH
- VL53L0X_REG_SYSTEM_THRESH_LOW
- VL53L0X_REG_SYSTEM_SEQUENCE_CONFIG
- VL53L0X_REG_SYSTEM_RANGE_CONFIG
- VL53L0X_REG_SYSTEM_INTERMEASUREMENT_PERIOD
- VL53L0X_REG_SYSTEM_INTERRUPT_CONFIG_GPIO
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_DISABLED
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_LEVEL_LOW
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_LEVEL_HIGH
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_OUT_OF_WINDOW
- VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_NEW_SAMPLE_READY
- VL53L0X_REG_GPIO_HV_MUX_ACTIVE_HIGH
- VL53L0X_REG_SYSTEM_INTERRUPT_CLEAR
- VL53L0X_REG_RESULT_INTERRUPT_STATUS
- VL53L0X_REG_RESULT_RANGE_STATUS
- VL53L0X_REG_RESULT_CORE_PAGE
- VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_RTN
- VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_RTN
- VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_REF
- VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_REF
- VL53L0X_REG_RESULT_PEAK_SIGNAL_RATE_REF
- VL53L0X_REG_ALGO_PART_TO_PART_RANGE_OFFSET_MM
- VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS
- VL53L0X_REG_MSRC_CONFIG_CONTROL
- VL53L0X_REG_PRE_RANGE_CONFIG_MIN_SNR
- VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_LOW
- VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_HIGH
- VL53L0X_REG_PRE_RANGE_MIN_COUNT_RATE_RTN_LIMIT
- VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_SNR
- VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_LOW
- VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_HIGH
- VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_COUNT_RATE_RTN_LIMIT
- VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_HI
- VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_LO
- VL53L0X_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD
- VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_HI
- VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_LO
- VL53L0X_REG_SYSTEM_HISTOGRAM_BIN
- VL53L0X_REG_HISTOGRAM_CONFIG_INITIAL_PHASE_SELECT
- VL53L0X_REG_HISTOGRAM_CONFIG_READOUT_CTRL
- VL53L0X_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD
- VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_HI
- VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_LO
- VL53L0X_REG_CROSSTALK_COMPENSATION_PEAK_RATE_MCPS
- VL53L0X_REG_MSRC_CONFIG_TIMEOUT_MACROP
- VL53L0X_REG_SOFT_RESET_GO2_SOFT_RESET_N
- VL53L0X_REG_IDENTIFICATION_MODEL_ID
- VL53L0X_REG_IDENTIFICATION_REVISION_ID
- VL53L0X_REG_OSC_CALIBRATE_VAL
- VL53L0X_SIGMA_ESTIMATE_MAX_VALUE
- VL53L0X_REG_GLOBAL_CONFIG_VCSEL_WIDTH
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_0
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_1
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_2
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_3
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_4
- VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_5
- VL53L0X_REG_GLOBAL_CONFIG_REF_EN_START_SELECT
- VL53L0X_REG_DYNAMIC_SPAD_NUM_REQUESTED_REF_SPAD
- VL53L0X_REG_DYNAMIC_SPAD_REF_EN_START_OFFSET
- VL53L0X_REG_POWER_MANAGEMENT_GO1_POWER_FORCE
- VL53L0X_SPEED_OF_LIGHT_IN_AIR
- VL53L0X_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV
- VL53L0X_REG_ALGO_PHASECAL_LIM
- VL53L0X_REG_ALGO_PHASECAL_CONFIG_TIMEOUT
- VL53L0X_DeviceError
- VL53L0X_GpioFunctionality
- vl53l0x_doxydoc.c
-
vl53l0x_i2c_platform.h
- I2C
- SPI
- COMMS_BUFFER_SIZE
- BYTES_PER_WORD
- BYTES_PER_DWORD
- VL53L0X_MAX_STRING_LENGTH_PLT
- bool_t
- VL53L0X_comms_initialise
- VL53L0X_comms_close
- VL53L0X_cycle_power
- VL53L0X_write_multi
- VL53L0X_read_multi
- VL53L0X_write_byte
- VL53L0X_write_word
- VL53L0X_write_dword
- VL53L0X_read_byte
- VL53L0X_read_word
- VL53L0X_read_dword
- VL53L0X_platform_wait_us
- VL53L0X_wait_ms
- VL53L0X_set_gpio
- VL53L0X_get_gpio
- VL53L0X_release_gpio
- VL53L0X_get_timer_frequency
- VL53L0X_get_timer_value
- vl53l0x_interrupt_threshold_settings.h
- vl53l0x_platform.h
-
vl53l0x_platform_log.h
- VL53L0X_ErrLog
- _LOG_FUNCTION_START
- _LOG_FUNCTION_END
- _LOG_FUNCTION_END_FMT
- VL53L0X_COPYSTRING
- TRACE_LEVEL_NONE
- TRACE_LEVEL_ERRORS
- TRACE_LEVEL_WARNING
- TRACE_LEVEL_INFO
- TRACE_LEVEL_DEBUG
- TRACE_LEVEL_ALL
- TRACE_LEVEL_IGNORE
- TRACE_FUNCTION_NONE
- TRACE_FUNCTION_I2C
- TRACE_FUNCTION_ALL
- TRACE_MODULE_NONE
- TRACE_MODULE_API
- TRACE_MODULE_PLATFORM
- TRACE_MODULE_ALL
- vl53l0x_tuning.h
- vl53l0x_types.h
- Globals
-
File List