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.
Dependents: BigBot_v1 PololuDistanceSensorTest Lidar Ares test ... more
VL53L0X SPAD Functions
[VL53L0X cut1.1 Function Definition]
Functions used for SPAD managements. More...
Functions | |
| VL53L0X_API VL53L0X_Error | VL53L0X_SetSpadAmbientDamperThreshold (VL53L0X_DEV Dev, uint16_t SpadAmbientDamperThreshold) |
| Set the SPAD Ambient Damper Threshold value. | |
| VL53L0X_API VL53L0X_Error | VL53L0X_GetSpadAmbientDamperThreshold (VL53L0X_DEV Dev, uint16_t *pSpadAmbientDamperThreshold) |
| Get the current SPAD Ambient Damper Threshold value. | |
| VL53L0X_API VL53L0X_Error | VL53L0X_SetSpadAmbientDamperFactor (VL53L0X_DEV Dev, uint16_t SpadAmbientDamperFactor) |
| Set the SPAD Ambient Damper Factor value. | |
| VL53L0X_API VL53L0X_Error | VL53L0X_GetSpadAmbientDamperFactor (VL53L0X_DEV Dev, uint16_t *pSpadAmbientDamperFactor) |
| Get the current SPAD Ambient Damper Factor value. | |
| VL53L0X_API VL53L0X_Error | VL53L0X_PerformRefSpadManagement (VL53L0X_DEV Dev, uint32_t *refSpadCount, uint8_t *isApertureSpads) |
| Performs Reference Spad Management. | |
| VL53L0X_API VL53L0X_Error | VL53L0X_SetReferenceSpads (VL53L0X_DEV Dev, uint32_t refSpadCount, uint8_t isApertureSpads) |
| Applies Reference SPAD configuration. | |
| VL53L0X_API VL53L0X_Error | VL53L0X_GetReferenceSpads (VL53L0X_DEV Dev, uint32_t *refSpadCount, uint8_t *isApertureSpads) |
| Retrieves SPAD configuration. | |
Detailed Description
Functions used for SPAD managements.
Function Documentation
| VL53L0X_API VL53L0X_Error VL53L0X_GetReferenceSpads | ( | VL53L0X_DEV | Dev, |
| uint32_t * | refSpadCount, | ||
| uint8_t * | isApertureSpads | ||
| ) |
Retrieves SPAD configuration.
- Function Description
- This function retrieves the current number of applied reference spads and also their type : Aperture or Non-Aperture.
- Note:
- This function Access to the device
- Parameters:
-
Dev Device Handle refSpadCount Number ref Spad Count isApertureSpads Reports if spads are of type aperture or non-aperture. 1:=aperture, 0:=Non-Aperture
- Returns:
- VL53L0X_ERROR_NONE Success
- VL53L0X_ERROR_REF_SPAD_INIT Error in the in the reference spad configuration.
- "Other error code" See VL53L0X_Error
Definition at line 2799 of file vl53l0x_api.cpp.
| VL53L0X_API VL53L0X_Error VL53L0X_GetSpadAmbientDamperFactor | ( | VL53L0X_DEV | Dev, |
| uint16_t * | pSpadAmbientDamperFactor | ||
| ) |
Get the current SPAD Ambient Damper Factor value.
- Function Description
- This function get the SPAD Ambient Damper Factor value
- Note:
- This function Access to the device
- Parameters:
-
Dev Device Handle pSpadAmbientDamperFactor Pointer to programmed SPAD Ambient Damper Factor value
- Returns:
- VL53L0X_ERROR_NONE Success
- "Other error code" See VL53L0X_Error
Definition at line 2768 of file vl53l0x_api.cpp.
| VL53L0X_API VL53L0X_Error VL53L0X_GetSpadAmbientDamperThreshold | ( | VL53L0X_DEV | Dev, |
| uint16_t * | pSpadAmbientDamperThreshold | ||
| ) |
Get the current SPAD Ambient Damper Threshold value.
- Function Description
- This function get the SPAD Ambient Damper Threshold value
- Note:
- This function Access to the device
- Parameters:
-
Dev Device Handle pSpadAmbientDamperThreshold Pointer to programmed SPAD Ambient Damper Threshold value
- Returns:
- VL53L0X_ERROR_NONE Success
- "Other error code" See VL53L0X_Error
Definition at line 2741 of file vl53l0x_api.cpp.
| VL53L0X_API VL53L0X_Error VL53L0X_PerformRefSpadManagement | ( | VL53L0X_DEV | Dev, |
| uint32_t * | refSpadCount, | ||
| uint8_t * | isApertureSpads | ||
| ) |
Performs Reference Spad Management.
- Function Description
- The reference SPAD initialization procedure determines the minimum amount of reference spads to be enables to achieve a target reference signal rate and should be performed once during initialization.
- Note:
- This function Access to the device
- This function change the device mode to VL53L0X_DEVICEMODE_SINGLE_RANGING
- Parameters:
-
Dev Device Handle refSpadCount Reports ref Spad Count isApertureSpads Reports if spads are of type aperture or non-aperture. 1:=aperture, 0:=Non-Aperture
- Returns:
- VL53L0X_ERROR_NONE Success
- VL53L0X_ERROR_REF_SPAD_INIT Error in the Ref Spad procedure.
- "Other error code" See VL53L0X_Error
Definition at line 2810 of file vl53l0x_api.cpp.
| VL53L0X_API VL53L0X_Error VL53L0X_SetReferenceSpads | ( | VL53L0X_DEV | Dev, |
| uint32_t | refSpadCount, | ||
| uint8_t | isApertureSpads | ||
| ) |
Applies Reference SPAD configuration.
- Function Description
- This function applies a given number of reference spads, identified as either Aperture or Non-Aperture. The requested spad count and type are stored within the device specific parameters data for access by the host.
- Note:
- This function Access to the device
- Parameters:
-
Dev Device Handle refSpadCount Number of ref spads. isApertureSpads Defines if spads are of type aperture or non-aperture. 1:=aperture, 0:=Non-Aperture
- Returns:
- VL53L0X_ERROR_NONE Success
- VL53L0X_ERROR_REF_SPAD_INIT Error in the in the reference spad configuration.
- "Other error code" See VL53L0X_Error
Definition at line 2788 of file vl53l0x_api.cpp.
| VL53L0X_API VL53L0X_Error VL53L0X_SetSpadAmbientDamperFactor | ( | VL53L0X_DEV | Dev, |
| uint16_t | SpadAmbientDamperFactor | ||
| ) |
Set the SPAD Ambient Damper Factor value.
- Function Description
- This function set the SPAD Ambient Damper Factor value
- Note:
- This function Access to the device
- Parameters:
-
Dev Device Handle SpadAmbientDamperFactor SPAD Ambient Damper Factor value
- Returns:
- VL53L0X_ERROR_NONE Success
- "Other error code" See VL53L0X_Error
Definition at line 2753 of file vl53l0x_api.cpp.
| VL53L0X_API VL53L0X_Error VL53L0X_SetSpadAmbientDamperThreshold | ( | VL53L0X_DEV | Dev, |
| uint16_t | SpadAmbientDamperThreshold | ||
| ) |
Set the SPAD Ambient Damper Threshold value.
- Function Description
- This function set the SPAD Ambient Damper Threshold value
- Note:
- This function Access to the device
- Parameters:
-
Dev Device Handle SpadAmbientDamperThreshold SPAD Ambient Damper Threshold value
- Returns:
- VL53L0X_ERROR_NONE Success
- "Other error code" See VL53L0X_Error
Definition at line 2729 of file vl53l0x_api.cpp.
Generated on Wed Jul 13 2022 23:40:16 by
1.7.2