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 ROI Functions
[VL53LX Function Definition]
Functions used to select ROIs. More...
Functions | |
| VL53LX_Error | VL53LX_SetUserROI (VL53LX_DEV Dev, VL53LX_UserRoi_t *pUserROi) |
| Set the ROI to be used for ranging. | |
| VL53LX_Error | VL53LX_GetUserROI (VL53LX_DEV Dev, VL53LX_UserRoi_t *pUserROi) |
| Get the ROI managed by the Device. | |
Detailed Description
Functions used to select ROIs.
Function Documentation
| VL53LX_Error VL53LX_GetUserROI | ( | VL53LX_DEV | Dev, |
| VL53LX_UserRoi_t * | pUserROi | ||
| ) |
Get the ROI managed by the Device.
- Function Description
- Get the ROI managed by the Device
- Parameters:
-
Dev Device Handle pUserROi Pointer to the Structure definining the ROI
- Returns:
- VL53LX_ERROR_NONE Success
- "Other error code" See VL53LX_Error
Definition at line 608 of file vl53lx_api.c.
| VL53LX_Error VL53LX_SetUserROI | ( | VL53LX_DEV | Dev, |
| VL53LX_UserRoi_t * | pUserROi | ||
| ) |
Set the ROI to be used for ranging.
- Function Description
- The user defined ROI is a rectangle described as per the following system from the Top Left corner to the Bottom Right corner.
Minimal ROI size is 4x4 spads
- Parameters:
-
Dev Device Handle pUserROi Pointer to the Structure definining the ROI
- Returns:
- VL53LX_ERROR_NONE Success
- "Other error code" See VL53LX_Error
Definition at line 578 of file vl53lx_api.c.
Generated on Mon Jul 18 2022 15:35:58 by
1.7.2