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 General Functions
[VL53LX Function Definition]
General functions and definitions. More...
Functions | |
| VL53LX_Error | VL53LX_GetVersion (VL53LX_Version_t *pVersion) |
| Return the VL53LX driver Version. | |
| VL53LX_Error | VL53LX_GetProductRevision (VL53LX_DEV Dev, uint8_t *pProductRevisionMajor, uint8_t *pProductRevisionMinor) |
| Reads the Product Revision for a for given Device This function can be used to distinguish cut1.0 from cut1.1. | |
| VL53LX_Error | VL53LX_GetDeviceInfo (VL53LX_DEV Dev, VL53LX_DeviceInfo_t *pVL53LX_DeviceInfo) |
| Reads the Device information for given Device. | |
| VL53LX_Error | VL53LX_GetUID (VL53LX_DEV Dev, uint64_t *pUid) |
| Reads the Device unique identifier. | |
Detailed Description
General functions and definitions.
Function Documentation
| VL53LX_Error VL53LX_GetDeviceInfo | ( | VL53LX_DEV | Dev, |
| VL53LX_DeviceInfo_t * | pVL53LX_DeviceInfo | ||
| ) |
Reads the Device information for given Device.
- Note:
- This function Access to the device
- Parameters:
-
Dev Device Handle pVL53LX_DeviceInfo Pointer to current device info for a given Device
- Returns:
- VL53LX_ERROR_NONE Success
- "Other error code" See VL53LX_Error
Definition at line 136 of file vl53lx_api.c.
| VL53LX_Error VL53LX_GetProductRevision | ( | VL53LX_DEV | Dev, |
| uint8_t * | pProductRevisionMajor, | ||
| uint8_t * | pProductRevisionMinor | ||
| ) |
Reads the Product Revision for a for given Device This function can be used to distinguish cut1.0 from cut1.1.
- Parameters:
-
Dev Device Handle pProductRevisionMajor Pointer to Product Revision Major for a given Device pProductRevisionMinor Pointer to Product Revision Minor for a given Device
- Returns:
- VL53LX_ERROR_NONE Success
- "Other error code" See VL53LX_Error
Definition at line 117 of file vl53lx_api.c.
| VL53LX_Error VL53LX_GetUID | ( | VL53LX_DEV | Dev, |
| uint64_t * | pUid | ||
| ) |
Reads the Device unique identifier.
- Note:
- This function Access to the device
- Parameters:
-
Dev Device Handle pUid Pointer to current device unique ID
- Returns:
- VL53LX_ERROR_NONE Success
- "Other error code" See VL53LX_Error
Definition at line 158 of file vl53lx_api.c.
| VL53LX_Error VL53LX_GetVersion | ( | VL53LX_Version_t * | pVersion ) |
Return the VL53LX driver Version.
- Note:
- This function doesn't access to the device
- Parameters:
-
pVersion Rer to current driver Version
- Returns:
- VL53LX_ERROR_NONE Success
- "Other error code" See VL53LX_Error
Definition at line 101 of file vl53lx_api.c.
Generated on Mon Jul 18 2022 15:35:58 by
1.7.2