VL53L0 Platform Functions

VL53L0 Platform Functions. More...

Modules
	PAL Register Access Functions
	PAL Register Access Functions.
	Basic type definition
	file vl53l0_types.h files hold basic type definition that may requires porting

Classes
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.

Functions
VL53L0X_Error	VL53L0X_PollingDelay (VL53L0X_DEV Dev)
	execute delay in all polling API call More...

Detailed Description

VL53L0 Platform Functions.

Macro Definition Documentation

PALDevDataGet

#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)++

PALDevDataSet

#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

Function Documentation

VL53L0X_PollingDelay()

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

#define VL53L0X_PollingDelay(...) (void)0

Parameters

Dev	Device Handle

Returns

VL53L0X_ERROR_NONE Success

"Other error code" See ::VL53L0X_Error