VL53L0X API Specification: vl53l0x_platform.h File Reference

VL53L0X API

vl53l0x_platform.h File Reference

Function prototype definitions for Ewok Platform layer. More...

Go to the source code of this file.

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_tVL53L0X_DEV
 Declare the device Handle as a pointer of the structure VL53L0X_Dev_t. More...
 

Functions

VL53L0X_Error VL53L0X_LockSequenceAccess (VL53L0X_DEV Dev)
 Lock comms interface to serialize all commands to a shared I2C interface for a specific device. More...
 
VL53L0X_Error VL53L0X_UnlockSequenceAccess (VL53L0X_DEV Dev)
 Unlock comms interface to serialize all commands to a shared I2C interface for a specific device. More...
 
VL53L0X_Error VL53L0X_WriteMulti (VL53L0X_DEV Dev, uint8_t index, uint8_t *pdata, uint32_t count)
 Writes the supplied byte buffer to the device. More...
 
VL53L0X_Error VL53L0X_ReadMulti (VL53L0X_DEV Dev, uint8_t index, uint8_t *pdata, uint32_t count)
 Reads the requested number of bytes from the device. More...
 
VL53L0X_Error VL53L0X_WrByte (VL53L0X_DEV Dev, uint8_t index, uint8_t data)
 Write single byte register. More...
 
VL53L0X_Error VL53L0X_WrWord (VL53L0X_DEV Dev, uint8_t index, uint16_t data)
 Write word register. More...
 
VL53L0X_Error VL53L0X_WrDWord (VL53L0X_DEV Dev, uint8_t index, uint32_t data)
 Write double word (4 byte) register. More...
 
VL53L0X_Error VL53L0X_RdByte (VL53L0X_DEV Dev, uint8_t index, uint8_t *data)
 Read single byte register. More...
 
VL53L0X_Error VL53L0X_RdWord (VL53L0X_DEV Dev, uint8_t index, uint16_t *data)
 Read word (2byte) register. More...
 
VL53L0X_Error VL53L0X_RdDWord (VL53L0X_DEV Dev, uint8_t index, uint32_t *data)
 Read dword (4byte) register. More...
 
VL53L0X_Error VL53L0X_UpdateByte (VL53L0X_DEV Dev, uint8_t index, uint8_t AndData, uint8_t OrData)
 Threat safe Update (read/modify/write) single byte register. More...
 
VL53L0X_Error VL53L0X_PollingDelay (VL53L0X_DEV Dev)
 execute delay in all polling API call More...
 

Detailed Description

Function prototype definitions for Ewok Platform layer.

All end user OS/platform/application porting.

Definition in file vl53l0x_platform.h.