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.
VL53L1 General Functions
[VL53L1 cut1.1 Function Definition]
General functions and definitions. More...
Functions | |
| VL53L1_Error | VL53L1_GetVersion (VL53L1_Version_t *pVersion) |
| Return the VL53L1 driver Version. | |
| VL53L1_Error | VL53L1_GetProductRevision (VL53L1_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. | |
| VL53L1_Error | VL53L1_GetDeviceInfo (VL53L1_DEV Dev, VL53L1_DeviceInfo_t *pVL53L1_DeviceInfo) |
| Reads the Device information for given Device. | |
| VL53L1_Error | VL53L1_GetUID (VL53L1_DEV Dev, uint64_t *pUid) |
| Reads the Device unique identifier. | |
| VL53L1_Error | VL53L1_GetRangeStatusString (uint8_t RangeStatus, char *pRangeStatusString) |
| Human readable Range Status string for a given RangeStatus. | |
| VL53L1_Error | VL53L1_GetPalErrorString (VL53L1_Error PalErrorCode, char *pPalErrorString) |
| Human readable error string for driver error status. | |
| VL53L1_Error | VL53L1_GetPalStateString (VL53L1_State PalStateCode, char *pPalStateString) |
| Human readable driver State string. | |
| VL53L1_Error | VL53L1_GetPalState (VL53L1_DEV Dev, VL53L1_State *pPalState) |
| Reads the internal state of the driver for a given Device. | |
Detailed Description
General functions and definitions.
Function Documentation
| VL53L1_Error VL53L1_GetDeviceInfo | ( | VL53L1_DEV | Dev, |
| VL53L1_DeviceInfo_t * | pVL53L1_DeviceInfo | ||
| ) |
Reads the Device information for given Device.
- Note:
- This function Access to the device
- Parameters:
-
Dev Device Handle pVL53L1_DeviceInfo Pointer to current device info for a given Device
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 375 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetPalErrorString | ( | VL53L1_Error | PalErrorCode, |
| char * | pPalErrorString | ||
| ) |
Human readable error string for driver error status.
- Note:
- This function doesn't access to the device
- Parameters:
-
PalErrorCode The error code as stored on VL53L1_Error pPalErrorString The error string corresponding to the PalErrorCode. Shall be defined as char buf[VL53L1_MAX_STRING_LENGTH]
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 452 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetPalState | ( | VL53L1_DEV | Dev, |
| VL53L1_State * | pPalState | ||
| ) |
Reads the internal state of the driver for a given Device.
- Note:
- This function doesn't access to the device
- Parameters:
-
Dev Device Handle pPalState Pointer to current state of the PAL for a given Device
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 478 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetPalStateString | ( | VL53L1_State | PalStateCode, |
| char * | pPalStateString | ||
| ) |
Human readable driver State string.
- Note:
- This function doesn't access to the device
- Parameters:
-
PalStateCode The State code as stored on VL53L1_State pPalStateString The State string corresponding to the PalStateCode. Shall be defined as char buf[VL53L1_MAX_STRING_LENGTH]
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 465 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetProductRevision | ( | VL53L1_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:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 356 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetRangeStatusString | ( | uint8_t | RangeStatus, |
| char * | pRangeStatusString | ||
| ) |
Human readable Range Status string for a given RangeStatus.
- Note:
- This function doesn't access to the device
- Parameters:
-
RangeStatus The RangeStatus code as stored on VL53L1_RangingMeasurementData_t pRangeStatusString The returned RangeStatus string. Shall be defined as char buf[VL53L1_MAX_STRING_LENGTH]
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 438 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetUID | ( | VL53L1_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:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 421 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetVersion | ( | VL53L1_Version_t * | pVersion ) |
Return the VL53L1 driver Version.
- Note:
- This function doesn't access to the device
- Parameters:
-
pVersion Rer to current driver Version
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 340 of file vl53l1_api.c.
Generated on Tue Jul 12 2022 20:07:15 by
1.7.2