To Next Page

To Previous Page

7.8 StopRanging

VL53L1X_ERROR VL53L1X_StopRanging(VL53L1_Dev_t dev);

This function stops the ranging.

7.9 CheckForDataReady

VL53L1X_ERROR VL53L1X_CheckForDataReady(VL53L1_Dev_t dev,

uint8_t *isDataReady);

This function checks if the new ranging data are available by polling the dedicated register. Data are not ready

when "isDataReady == 0". Data are ready when "isDataReady==1".

7.10 SetTimingBudgetInMs

VL53L1X_ERROR VL53L1X_SetTimingBudgetInMs(VL53L1_Dev_t dev,

uint16_t TimingBudgetInMs);

This function programs the timing budget in ms. The predefined values are 15, 20, 50, 100, 200, and 500. This

function must be called after the VL53L1X_SetDistanceMode.

7.11 GetTimingBudgetInMs

VL53L1X_ERROR VL53L1X_GetTimingBudgetInMs(VL53L1_Dev_t dev,

uint16_t *pTimingBudgetInMs);

This function returns the current timing budget in ms.

7.12 SetDistanceMode

VL53L1X_ERROR VL53L1X_SetDistanceMode(VL53L1_Dev_t dev,

uint16_t DistanceMode);

This function programs the distance mode (1 = Short, 2 = Long). Short mode maximum distance is limited to 1.3

m but results in a better ambient immunity. Long mode can range up to 4 m in the dark with a timing budget of

200 ms.

7.13 GetDistanceMode

VL53L1X_ERROR VL53L1X_GetDistanceMode(VL53L1_Dev_t dev,

uint16_t *pDistanceMode);

This function returns the current distance mode (1 = Short, 2 = Long).

7.14 SetInterMeasurementInMs

VL53L1X_ERROR VL53L1X_SetInterMeasurementInMs(VL53L1_Dev_t dev,

uint16_t InterMeasurementInMs);

This function programs the intermeasurement period (IMP) in ms. The IMP must be greater than or equal to the

timing budget. This condition is not checked by the API, so the customer must check this condition.

7.15 GetInterMeasurementInMs

VL53L1X_ERROR VL53L1X_GetInterMeasurementInMs(VL53L1_Dev_t dev,

uint16_t * pIM);

This function returns the intermeasurement period in ms.

UM2510

StopRanging

UM2510 - Rev 1

page 16/26

ST VL53L1X API User Manual

Questions and Answers: