Include dependency graph for vl53l1_api.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Macros | |
| #define | VL53L1DevDataGet(Dev, field) (Dev->Data.field) |
| #define | VL53L1DevDataSet(Dev, field, data) ((Dev->Data.field) = (data)) |
Functions | |
| VL53L1_Error | VL53L1_ClearInterruptAndStartMeasurement (VL53L1_DEV Dev) |
| Clear the Interrupt flag and start new measurement *. More... | |
| VL53L1_Error | VL53L1_DataInit (VL53L1_DEV Dev) |
| One time device initialization. More... | |
| VL53L1_Error | VL53L1_GetCalibrationData (VL53L1_DEV Dev, VL53L1_CalibrationData_t *pCalibrationData) |
| Gets the Calibration Data. More... | |
| VL53L1_Error | VL53L1_GetDeviceInfo (VL53L1_DEV Dev, VL53L1_DeviceInfo_t *pVL53L1_DeviceInfo) |
| Reads the Device information for given Device. More... | |
| VL53L1_Error | VL53L1_GetDistanceMode (VL53L1_DEV Dev, VL53L1_DistanceModes *pDistanceMode) |
| Get the distance mode. More... | |
| VL53L1_Error | VL53L1_GetInterMeasurementPeriodMilliSeconds (VL53L1_DEV Dev, uint32_t *pInterMeasurementPeriodMilliSeconds) |
| VL53L1_Error | VL53L1_GetLimitCheckCurrent (VL53L1_DEV Dev, uint16_t LimitCheckId, FixPoint1616_t *pLimitCheckCurrent) |
| Get the current value of the signal used for the limit check. More... | |
| VL53L1_Error | VL53L1_GetLimitCheckEnable (VL53L1_DEV Dev, uint16_t LimitCheckId, uint8_t *pLimitCheckEnable) |
| Get specific limit check enable state. More... | |
| VL53L1_Error | VL53L1_GetLimitCheckInfo (uint16_t LimitCheckId, char *pLimitCheckString) |
| Return a description string for a given limit check number. More... | |
| VL53L1_Error | VL53L1_GetLimitCheckStatus (VL53L1_DEV Dev, uint16_t LimitCheckId, uint8_t *pLimitCheckStatus) |
| Return a the Status of the specified check limit. More... | |
| VL53L1_Error | VL53L1_GetLimitCheckValue (VL53L1_DEV Dev, uint16_t LimitCheckId, FixPoint1616_t *pLimitCheckValue) |
| Get a specific limit check value. More... | |
| VL53L1_Error | VL53L1_GetMeasurementDataReady (VL53L1_DEV Dev, uint8_t *pMeasurementDataReady) |
| Return Measurement Data Ready. More... | |
| VL53L1_Error | VL53L1_GetMeasurementTimingBudgetMicroSeconds (VL53L1_DEV Dev, uint32_t *pMeasurementTimingBudgetMicroSeconds) |
| Get Ranging Timing Budget in microseconds. More... | |
| VL53L1_Error | VL53L1_GetNumberOfLimitCheck (uint16_t *pNumberOfLimitCheck) |
| Get the number of the check limit managed by a given Device. More... | |
| VL53L1_Error | VL53L1_GetNumberOfSequenceSteps (VL53L1_DEV Dev, uint8_t *pNumberOfSequenceSteps) |
| Gets number of sequence steps managed by the API. More... | |
| VL53L1_Error | VL53L1_GetOpticalCenter (VL53L1_DEV Dev, FixPoint1616_t *pOpticalCenterX, FixPoint1616_t *pOpticalCenterY) |
| Gets the optical center. More... | |
| VL53L1_Error | VL53L1_GetPalErrorString (VL53L1_Error PalErrorCode, char *pPalErrorString) |
| Human readable error string for driver error status. More... | |
| VL53L1_Error | VL53L1_GetPalState (VL53L1_DEV Dev, VL53L1_State *pPalState) |
| Reads the internal state of the driver for a given Device. More... | |
| VL53L1_Error | VL53L1_GetPalStateString (VL53L1_State PalStateCode, char *pPalStateString) |
| Human readable driver State string. More... | |
| VL53L1_Error | VL53L1_GetPresetMode (VL53L1_DEV Dev, VL53L1_PresetModes *pPresetMode) |
| Get current Preset Mode. More... | |
| VL53L1_Error | VL53L1_GetProductRevision (VL53L1_DEV Dev, uint8_t *pProductRevisionMajor, uint8_t *pProductRevisionMinor) |
| Reads the Product Revision for a for given Device This function can be used to distinguish cut1.0 from cut1.1. More... | |
| VL53L1_Error | VL53L1_GetRangeStatusString (uint8_t RangeStatus, char *pRangeStatusString) |
| Human readable Range Status string for a given RangeStatus. More... | |
| VL53L1_Error | VL53L1_GetRangingMeasurementData (VL53L1_DEV Dev, VL53L1_RangingMeasurementData_t *pRangingMeasurementData) |
| Retrieve the measurements from device for a given setup. More... | |
| VL53L1_Error | VL53L1_GetSequenceStepEnable (VL53L1_DEV Dev, VL53L1_SequenceStepId SequenceStepId, uint8_t *pSequenceStepEnabled) |
| Gets the (on/off) state of a requested sequence step. More... | |
| VL53L1_Error | VL53L1_GetSequenceStepsInfo (VL53L1_SequenceStepId SequenceStepId, char *pSequenceStepsString) |
| Gets the name of a given sequence step. More... | |
| VL53L1_Error | VL53L1_GetThresholdConfig (VL53L1_DEV Dev, VL53L1_DetectionConfig_t *pConfig) |
| Retrieves the interrupt config structure currently programmed into the API. More... | |
| VL53L1_Error | VL53L1_GetTuningParameter (VL53L1_DEV Dev, uint16_t TuningParameterId, int32_t *pTuningParameterValue) |
| Get Tuning Parameter value for a given parameter ID. More... | |
| VL53L1_Error | VL53L1_GetUserROI (VL53L1_DEV Dev, VL53L1_UserRoi_t *pUserROi) |
| Get the ROI managed by the Device. More... | |
| VL53L1_Error | VL53L1_GetVersion (VL53L1_Version_t *pVersion) |
| Return the VL53L1 driver Version. More... | |
| VL53L1_Error | VL53L1_GetXTalkCompensationEnable (VL53L1_DEV Dev, uint8_t *pXTalkCompensationEnable) |
| Get Cross talk compensation rate enable. More... | |
| VL53L1_Error | VL53L1_PerformOffsetCalibration (VL53L1_DEV Dev, int32_t CalDistanceMilliMeter) |
| Perform Offset Calibration. More... | |
| VL53L1_Error | VL53L1_PerformOffsetSimpleCalibration (VL53L1_DEV Dev, int32_t CalDistanceMilliMeter) |
| Perform Offset simple Calibration. More... | |
| VL53L1_Error | VL53L1_PerformRefSpadManagement (VL53L1_DEV Dev) |
| Performs Reference Spad Management. More... | |
| VL53L1_Error | VL53L1_PerformSingleTargetXTalkCalibration (VL53L1_DEV Dev, int32_t CalDistanceMilliMeter) |
| Perform XTalk Calibration. More... | |
| VL53L1_Error | VL53L1_SetCalibrationData (VL53L1_DEV Dev, VL53L1_CalibrationData_t *pCalibrationData) |
| Sets the Calibration Data. More... | |
| VL53L1_Error | VL53L1_SetDeviceAddress (VL53L1_DEV Dev, uint8_t DeviceAddress) |
| Set new device address. More... | |
| VL53L1_Error | VL53L1_SetDistanceMode (VL53L1_DEV Dev, VL53L1_DistanceModes DistanceMode) |
| Set the distance mode. More... | |
| VL53L1_Error | VL53L1_SetInterMeasurementPeriodMilliSeconds (VL53L1_DEV Dev, uint32_t InterMeasurementPeriodMilliSeconds) |
| VL53L1_Error | VL53L1_SetLimitCheckEnable (VL53L1_DEV Dev, uint16_t LimitCheckId, uint8_t LimitCheckEnable) |
| Enable/Disable a specific limit check. More... | |
| VL53L1_Error | VL53L1_SetLimitCheckValue (VL53L1_DEV Dev, uint16_t LimitCheckId, FixPoint1616_t LimitCheckValue) |
| Set a specific limit check value. More... | |
| VL53L1_Error | VL53L1_SetMeasurementTimingBudgetMicroSeconds (VL53L1_DEV Dev, uint32_t MeasurementTimingBudgetMicroSeconds) |
| Set Ranging Timing Budget in microseconds. More... | |
| VL53L1_Error | VL53L1_SetOffsetCalibrationMode (VL53L1_DEV Dev, VL53L1_OffsetCalibrationModes OffsetCalibrationMode) |
| Define the mode to be used for the offset calibration. More... | |
| VL53L1_Error | VL53L1_SetPresetMode (VL53L1_DEV Dev, VL53L1_PresetModes PresetMode) |
| Set a new Preset Mode. More... | |
| VL53L1_Error | VL53L1_SetSequenceStepEnable (VL53L1_DEV Dev, VL53L1_SequenceStepId SequenceStepId, uint8_t SequenceStepEnabled) |
| Sets the (on/off) state of a requested sequence step. More... | |
| VL53L1_Error | VL53L1_SetThresholdConfig (VL53L1_DEV Dev, VL53L1_DetectionConfig_t *pConfig) |
| Configure the interrupt config, from the given structure. More... | |
| VL53L1_Error | VL53L1_SetTuningParameter (VL53L1_DEV Dev, uint16_t TuningParameterId, int32_t TuningParameterValue) |
| Set Tuning Parameter value for a given parameter ID. More... | |
| VL53L1_Error | VL53L1_SetUserROI (VL53L1_DEV Dev, VL53L1_UserRoi_t *pUserROi) |
| Set the ROI to be used for ranging. More... | |
| VL53L1_Error | VL53L1_SetXTalkCompensationEnable (VL53L1_DEV Dev, uint8_t XTalkCompensationEnable) |
| Enable/Disable Cross talk compensation feature. More... | |
| VL53L1_Error | VL53L1_StartMeasurement (VL53L1_DEV Dev) |
| Start device measurement. More... | |
| VL53L1_Error | VL53L1_StaticInit (VL53L1_DEV Dev) |
| Do basic device init (and eventually patch loading) This function will change the VL53L1_State from VL53L1_STATE_WAIT_STATICINIT to VL53L1_STATE_IDLE. In this stage all default setting will be applied. More... | |
| VL53L1_Error | VL53L1_StopMeasurement (VL53L1_DEV Dev) |
| Stop device measurement. More... | |
| VL53L1_Error | VL53L1_WaitDeviceBooted (VL53L1_DEV Dev) |
| Wait for device booted after chip enable (hardware standby) This function can be run only when VL53L1_State is VL53L1_STATE_POWERDOWN. More... | |
| VL53L1_Error | VL53L1_WaitMeasurementDataReady (VL53L1_DEV Dev) |
| Wait for measurement data ready. Blocking function. Note that the timeout is given by: VL53L1_RANGE_COMPLETION_POLLING_TIMEOUT_MS defined in def.h. More... | |
Macro Definition Documentation
◆ VL53L1DevDataGet
| #define VL53L1DevDataGet | ( | Dev, | |
| field | |||
| ) | (Dev->Data.field) |
Definition at line 78 of file vl53l1_api.h.
◆ VL53L1DevDataSet
| #define VL53L1DevDataSet | ( | Dev, | |
| field, | |||
| data | |||
| ) | ((Dev->Data.field) = (data)) |
Definition at line 84 of file vl53l1_api.h.