Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: X_NUCLEO_COMMON ST_INTERFACES
Dependents: VL53L3CX_NoShield_1Sensor_poll_Mb06x VL53L3_NoShield_1Sensor_polling_Mb63 X_NUCLEO_53L3A2 53L3A2_Ranging
VL53LX Parameters Functions
[VL53LX Function Definition]
Functions used to prepare and setup the device. More...
Functions | |
| VL53LX_Error | VL53LX_SetDistanceMode (VL53LX_DEV Dev, VL53LX_DistanceModes DistanceMode) |
| Set the distance mode. | |
| VL53LX_Error | VL53LX_GetDistanceMode (VL53LX_DEV Dev, VL53LX_DistanceModes *pDistanceMode) |
| Get the distance mode. | |
| VL53LX_Error | VL53LX_SetMeasurementTimingBudgetMicroSeconds (VL53LX_DEV Dev, uint32_t MeasurementTimingBudgetMicroSeconds) |
| Set Ranging Timing Budget in microseconds. | |
| VL53LX_Error | VL53LX_GetMeasurementTimingBudgetMicroSeconds (VL53LX_DEV Dev, uint32_t *pMeasurementTimingBudgetMicroSeconds) |
| Get Ranging Timing Budget in microseconds. | |
Detailed Description
Functions used to prepare and setup the device.
Function Documentation
| VL53LX_Error VL53LX_GetDistanceMode | ( | VL53LX_DEV | Dev, |
| VL53LX_DistanceModes * | pDistanceMode | ||
| ) |
Get the distance mode.
- Function Description
- Get the distance mode used for the next ranging.
- Parameters:
-
Dev Device Handle *pDistanceMode Pointer to Distance mode
- Returns:
- VL53LX_ERROR_NONE Success
- "Other error code" See VL53LX_Error
Definition at line 430 of file vl53lx_api.c.
| VL53LX_Error VL53LX_GetMeasurementTimingBudgetMicroSeconds | ( | VL53LX_DEV | Dev, |
| uint32_t * | pMeasurementTimingBudgetMicroSeconds | ||
| ) |
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, ...)
- Parameters:
-
Dev Device Handle pMeasurementTimingBudgetMicroSeconds Max measurement time in microseconds.
- Returns:
- VL53LX_ERROR_NONE Success
- "Other error code" See VL53LX_Error
Definition at line 509 of file vl53lx_api.c.
| VL53LX_Error VL53LX_SetDistanceMode | ( | VL53LX_DEV | Dev, |
| VL53LX_DistanceModes | DistanceMode | ||
| ) |
Set the distance mode.
- Function Description
- Set the distance mode to be used for the next ranging.
The modes Short, Medium and Long are used to optimize the ranging accuracy in a specific range of distance.
The user select one of these modes to select the distance range.
- Note:
- This function doesn't Access to the device
- Warning:
- This function should be called after VL53LX_DataInit().
- Parameters:
-
Dev Device Handle DistanceMode Distance mode to apply, valid values are: - VL53LX_DISTANCEMODE_SHORT
- VL53LX_DISTANCEMODE_MEDIUM
- VL53LX_DISTANCEMODE_LONG
- Returns:
- VL53LX_ERROR_NONE Success
- VL53LX_ERROR_MODE_NOT_SUPPORTED This error occurs when DistanceMode is not in the supported list
- "Other error code" See VL53LX_Error
Definition at line 379 of file vl53lx_api.c.
| VL53LX_Error VL53LX_SetMeasurementTimingBudgetMicroSeconds | ( | VL53LX_DEV | Dev, |
| uint32_t | MeasurementTimingBudgetMicroSeconds | ||
| ) |
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 ...)
- Parameters:
-
Dev Device Handle MeasurementTimingBudgetMicroSeconds Max measurement time in microseconds.
- Returns:
- VL53LX_ERROR_NONE Success
- VL53LX_ERROR_INVALID_PARAMS Error timing parameter not supported. The maximum accepted value for the computed timing budget is 10 seconds the minimum value depends on the preset mode selected.
- "Other error code" See VL53LX_Error
Definition at line 444 of file vl53lx_api.c.
Generated on Mon Jul 18 2022 15:35:58 by
1.7.2