charles macneill
/
VL53L1CB
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.
Embed:
(wiki syntax)
VL53L1 ROI Functions
[VL53L1 cut1.1 Function Definition]
Functions used to select ROIs. More...
Functions | |
| VL53L1_Error | VL53L1_GetMaxNumberOfROI (VL53L1_DEV Dev, uint8_t *pMaxNumberOfROI) |
| Get the Maximum number of ROI Zones managed by the Device. | |
| VL53L1_Error | VL53L1_SetROI (VL53L1_DEV Dev, VL53L1_RoiConfig_t *pRoiConfig) |
| Set the ROI to be used for ranging. | |
| VL53L1_Error | VL53L1_GetROI (VL53L1_DEV Dev, VL53L1_RoiConfig_t *pRoiConfig) |
| Get the ROI managed by the Device. | |
Detailed Description
Functions used to select ROIs.
Function Documentation
| VL53L1_Error VL53L1_GetMaxNumberOfROI | ( | VL53L1_DEV | Dev, |
| uint8_t * | pMaxNumberOfROI | ||
| ) |
Get the Maximum number of ROI Zones managed by the Device.
- Function Description
- Get Maximum number of ROI Zones managed by the Device.
- Note:
- The number of Zone depends on the preset mode used so to have the right number this function should be call after VL53L1_SetPresetMode()
- This function doesn't Access to the device
- Parameters:
-
Dev Device Handle pMaxNumberOfROI Pointer to the Maximum Number of ROI Zones value.
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1506 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetROI | ( | VL53L1_DEV | Dev, |
| VL53L1_RoiConfig_t * | pRoiConfig | ||
| ) |
Get the ROI managed by the Device.
- Function Description
- Get the ROI managed by the Device
- Parameters:
-
Dev Device Handle pRoiConfig Pointer to the Structure containing all the ROI to be used.
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1589 of file vl53l1_api.c.
| VL53L1_Error VL53L1_SetROI | ( | VL53L1_DEV | Dev, |
| VL53L1_RoiConfig_t * | pRoiConfig | ||
| ) |
Set the ROI to be used for ranging.
- Function Description
- The user defined ROIs are rectangles 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 pRoiConfig Pointer to the Structure containing all the ROI to be used.
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1526 of file vl53l1_api.c.
Generated on Tue Jul 12 2022 20:07:15 by
1.7.2