VL53L0X API Specification
1.0.2.4823VL53L0X Platform Functions
VL53L0X Platform Functions. More...
Modules | |
| PAL Register Access Functions | |
| PAL Register Access Functions. | |
| Basic type definition | |
| file vl53l0x_types.h files hold basic type definition that may requires porting | |
Data Structures | |
| struct | VL53L0X_Dev_t |
| Generic PAL device type that does link between API and platform abstraction layer. More... | |
Macros | |
| #define | PALDevDataGet(Dev, field) (Dev->Data.field) |
| Get ST private structure VL53L0X_DevData_t data access. More... | |
| #define | PALDevDataSet(Dev, field, data) (Dev->Data.field)=(data) |
| Set ST private structure VL53L0X_DevData_t data field. More... | |
Typedefs | |
| typedef VL53L0X_Dev_t * | VL53L0X_DEV |
| Declare the device Handle as a pointer of the structure VL53L0X_Dev_t. More... | |
Functions | |
| VL53L0X_Error | VL53L0X_PollingDelay (VL53L0X_DEV Dev) |
| execute delay in all polling API call More... | |
Detailed Description
VL53L0X Platform Functions.
Macro Definition Documentation
| #define PALDevDataGet | ( | Dev, | |
| field | |||
| ) | (Dev->Data.field) |
Get ST private structure VL53L0X_DevData_t data access.
- Parameters
-
Dev Device Handle field ST structure field name It maybe used and as real data "ref" not just as "get" for sub-structure item like PALDevDataGet(FilterData.field)[i] or PALDevDataGet(FilterData.MeasurementIndex)++
Definition at line 84 of file vl53l0x_platform.h.
| #define PALDevDataSet | ( | Dev, | |
| field, | |||
| data | |||
| ) | (Dev->Data.field)=(data) |
Set ST private structure VL53L0X_DevData_t data field.
- Parameters
-
Dev Device Handle field ST structure field name data Data to be set
Definition at line 93 of file vl53l0x_platform.h.
Typedef Documentation
| typedef VL53L0X_Dev_t* VL53L0X_DEV |
Declare the device Handle as a pointer of the structure VL53L0X_Dev_t.
Definition at line 73 of file vl53l0x_platform.h.
Function Documentation
| VL53L0X_Error VL53L0X_PollingDelay | ( | VL53L0X_DEV | Dev | ) |
execute delay in all polling API call
A typical multi-thread or RTOs implementation is to sleep the task for some 5ms (with 100Hz max rate faster polling is not needed) if nothing specific is need you can define it as an empty/void macro
- Parameters
-
Dev Device Handle
- Returns
- VL53L0X_ERROR_NONE Success
- "Other error code" See VL53L0X_Error