VL53L0X API Specification: vl53l0x_def.h File Reference

VL53L0X API

previous page next page
Data Structures | Macros | Typedefs
vl53l0x_def.h File Reference

Type definitions for VL53L0X API. More...

#include "vl53l0x_device.h" #include "vl53l0x_types.h"

Go to the source code of this file.

Data Structures

struct  VL53L0X_Version_t
 Defines the parameters of the Get Version Functions. More...
 
struct  VL53L0X_DeviceInfo_t
 Defines the parameters of the Get Device Info Functions. More...
 
struct  VL53L0X_DeviceParameters_t
 Defines all parameters for the device. More...
 
struct  VL53L0X_DMaxData_t
 Structure containing the Dmax computation parameters and data. More...
 
struct  VL53L0X_RangingMeasurementData_t
 
struct  VL53L0X_HistogramMeasurementData_t
 
struct  VL53L0X_SpadData_t
 Spad Configuration Data. More...
 
struct  VL53L0X_DeviceSpecificParameters_t
 
struct  VL53L0X_DevData_t
 VL53L0X PAL device ST private data structure
End user should never access any of these field directly. More...
 
struct  VL53L0X_SchedulerSequenceSteps_t
 

Macros

#define VL53L0X10_SPECIFICATION_VER_MAJOR   1
 PAL SPECIFICATION major version. More...
 
#define VL53L0X10_SPECIFICATION_VER_MINOR   2
 PAL SPECIFICATION minor version. More...
 
#define VL53L0X10_SPECIFICATION_VER_SUB   7
 PAL SPECIFICATION sub version. More...
 
#define VL53L0X10_SPECIFICATION_VER_REVISION   1440
 PAL SPECIFICATION sub version. More...
 
#define VL53L0X10_IMPLEMENTATION_VER_MAJOR   1
 VL53L0X PAL IMPLEMENTATION major version. More...
 
#define VL53L0X10_IMPLEMENTATION_VER_MINOR   0
 VL53L0X PAL IMPLEMENTATION minor version. More...
 
#define VL53L0X10_IMPLEMENTATION_VER_SUB   9
 VL53L0X PAL IMPLEMENTATION sub version. More...
 
#define VL53L0X10_IMPLEMENTATION_VER_REVISION   3673
 VL53L0X PAL IMPLEMENTATION sub version. More...
 
#define VL53L0X_SPECIFICATION_VER_MAJOR   1
 PAL SPECIFICATION major version. More...
 
#define VL53L0X_SPECIFICATION_VER_MINOR   2
 PAL SPECIFICATION minor version. More...
 
#define VL53L0X_SPECIFICATION_VER_SUB   7
 PAL SPECIFICATION sub version. More...
 
#define VL53L0X_SPECIFICATION_VER_REVISION   1440
 PAL SPECIFICATION sub version. More...
 
#define VL53L0X_IMPLEMENTATION_VER_MAJOR   1
 VL53L0X PAL IMPLEMENTATION major version. More...
 
#define VL53L0X_IMPLEMENTATION_VER_MINOR   0
 VL53L0X PAL IMPLEMENTATION minor version. More...
 
#define VL53L0X_IMPLEMENTATION_VER_SUB   2
 VL53L0X PAL IMPLEMENTATION sub version. More...
 
#define VL53L0X_IMPLEMENTATION_VER_REVISION   4823
 VL53L0X PAL IMPLEMENTATION sub version. More...
 
#define VL53L0X_DEFAULT_MAX_LOOP   2000
 
#define VL53L0X_MAX_STRING_LENGTH   32
 
#define VL53L0X_ERROR_NONE   ((VL53L0X_Error) 0)
 
#define VL53L0X_ERROR_CALIBRATION_WARNING   ((VL53L0X_Error) -1)
 
#define VL53L0X_ERROR_MIN_CLIPPED   ((VL53L0X_Error) -2)
 
#define VL53L0X_ERROR_UNDEFINED   ((VL53L0X_Error) -3)
 
#define VL53L0X_ERROR_INVALID_PARAMS   ((VL53L0X_Error) -4)
 
#define VL53L0X_ERROR_NOT_SUPPORTED   ((VL53L0X_Error) -5)
 
#define VL53L0X_ERROR_RANGE_ERROR   ((VL53L0X_Error) -6)
 
#define VL53L0X_ERROR_TIME_OUT   ((VL53L0X_Error) -7)
 
#define VL53L0X_ERROR_MODE_NOT_SUPPORTED   ((VL53L0X_Error) -8)
 
#define VL53L0X_ERROR_BUFFER_TOO_SMALL   ((VL53L0X_Error) -9)
 
#define VL53L0X_ERROR_GPIO_NOT_EXISTING   ((VL53L0X_Error) -10)
 
#define VL53L0X_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED   ((VL53L0X_Error) -11)
 
#define VL53L0X_ERROR_INTERRUPT_NOT_CLEARED   ((VL53L0X_Error) -12)
 
#define VL53L0X_ERROR_CONTROL_INTERFACE   ((VL53L0X_Error) -20)
 
#define VL53L0X_ERROR_INVALID_COMMAND   ((VL53L0X_Error) -30)
 
#define VL53L0X_ERROR_DIVISION_BY_ZERO   ((VL53L0X_Error) -40)
 
#define VL53L0X_ERROR_REF_SPAD_INIT   ((VL53L0X_Error) -50)
 
#define VL53L0X_ERROR_NOT_IMPLEMENTED   ((VL53L0X_Error) -99)
 
#define VL53L0X_DEVICEMODE_SINGLE_RANGING   ((VL53L0X_DeviceModes) 0)
 
#define VL53L0X_DEVICEMODE_CONTINUOUS_RANGING   ((VL53L0X_DeviceModes) 1)
 
#define VL53L0X_DEVICEMODE_SINGLE_HISTOGRAM   ((VL53L0X_DeviceModes) 2)
 
#define VL53L0X_DEVICEMODE_CONTINUOUS_TIMED_RANGING   ((VL53L0X_DeviceModes) 3)
 
#define VL53L0X_DEVICEMODE_SINGLE_ALS   ((VL53L0X_DeviceModes) 10)
 
#define VL53L0X_DEVICEMODE_GPIO_DRIVE   ((VL53L0X_DeviceModes) 20)
 
#define VL53L0X_DEVICEMODE_GPIO_OSC   ((VL53L0X_DeviceModes) 21)
 
#define VL53L0X_HISTOGRAMMODE_DISABLED   ((VL53L0X_HistogramModes) 0)
 
#define VL53L0X_HISTOGRAMMODE_REFERENCE_ONLY   ((VL53L0X_HistogramModes) 1)
 
#define VL53L0X_HISTOGRAMMODE_RETURN_ONLY   ((VL53L0X_HistogramModes) 2)
 
#define VL53L0X_HISTOGRAMMODE_BOTH   ((VL53L0X_HistogramModes) 3)
 
#define VL53L0X_POWERMODE_STANDBY_LEVEL1   ((VL53L0X_PowerModes) 0)
 
#define VL53L0X_POWERMODE_STANDBY_LEVEL2   ((VL53L0X_PowerModes) 1)
 
#define VL53L0X_POWERMODE_IDLE_LEVEL1   ((VL53L0X_PowerModes) 2)
 
#define VL53L0X_POWERMODE_IDLE_LEVEL2   ((VL53L0X_PowerModes) 3)
 
#define VL53L0X_STATE_POWERDOWN   ((VL53L0X_State) 0)
 
#define VL53L0X_STATE_WAIT_STATICINIT   ((VL53L0X_State) 1)
 
#define VL53L0X_STATE_STANDBY   ((VL53L0X_State) 2)
 
#define VL53L0X_STATE_IDLE   ((VL53L0X_State) 3)
 
#define VL53L0X_STATE_RUNNING   ((VL53L0X_State) 4)
 
#define VL53L0X_STATE_UNKNOWN   ((VL53L0X_State) 98)
 
#define VL53L0X_STATE_ERROR   ((VL53L0X_State) 99)
 
#define VL53L0X_HISTOGRAM_BUFFER_SIZE   24
 
#define VL53L0X_REF_SPAD_BUFFER_SIZE   6
 
#define VL53L0X_INTERRUPTPOLARITY_LOW   ((VL53L0X_InterruptPolarity) 0)
 
#define VL53L0X_INTERRUPTPOLARITY_HIGH   ((VL53L0X_InterruptPolarity) 1)
 
#define VL53L0X_VCSEL_PERIOD_PRE_RANGE   ((VL53L0X_VcselPeriod) 0)
 
#define VL53L0X_VCSEL_PERIOD_FINAL_RANGE   ((VL53L0X_VcselPeriod) 1)
 
#define VL53L0X_SEQUENCESTEP_TCC   ((VL53L0X_VcselPeriod) 0)
 
#define VL53L0X_SEQUENCESTEP_DSS   ((VL53L0X_VcselPeriod) 1)
 
#define VL53L0X_SEQUENCESTEP_MSRC   ((VL53L0X_VcselPeriod) 2)
 
#define VL53L0X_SEQUENCESTEP_PRE_RANGE   ((VL53L0X_VcselPeriod) 3)
 
#define VL53L0X_SEQUENCESTEP_FINAL_RANGE   ((VL53L0X_VcselPeriod) 4)
 
#define VL53L0X_SEQUENCESTEP_NUMBER_OF_CHECKS   5
 
#define VL53L0X_SETPARAMETERFIELD(Dev, field, value)   PALDevDataSet(Dev, CurrentParameters.field, value)
 
#define VL53L0X_GETPARAMETERFIELD(Dev, field, variable)   variable = PALDevDataGet(Dev, CurrentParameters).field
 
#define VL53L0X_SETARRAYPARAMETERFIELD(Dev, field, index, value)   PALDevDataSet(Dev, CurrentParameters.field[index], value)
 
#define VL53L0X_GETARRAYPARAMETERFIELD(Dev, field, index, variable)   variable = PALDevDataGet(Dev, CurrentParameters).field[index]
 
#define VL53L0X_SETDEVICESPECIFICPARAMETER(Dev, field, value)   PALDevDataSet(Dev, DeviceSpecificParameters.field, value)
 
#define VL53L0X_GETDEVICESPECIFICPARAMETER(Dev, field)   PALDevDataGet(Dev, DeviceSpecificParameters).field
 
#define VL53L0X_FIXPOINT1616TOFIXPOINT97(Value)   (uint16_t)((Value>>9)&0xFFFF)
 
#define VL53L0X_FIXPOINT97TOFIXPOINT1616(Value)   (FixPoint1616_t)(Value<<9)
 
#define VL53L0X_FIXPOINT1616TOFIXPOINT88(Value)   (uint16_t)((Value>>8)&0xFFFF)
 
#define VL53L0X_FIXPOINT88TOFIXPOINT1616(Value)   (FixPoint1616_t)(Value<<8)
 
#define VL53L0X_FIXPOINT1616TOFIXPOINT412(Value)   (uint16_t)((Value>>4)&0xFFFF)
 
#define VL53L0X_FIXPOINT412TOFIXPOINT1616(Value)   (FixPoint1616_t)(Value<<4)
 
#define VL53L0X_FIXPOINT1616TOFIXPOINT313(Value)   (uint16_t)((Value>>3)&0xFFFF)
 
#define VL53L0X_FIXPOINT313TOFIXPOINT1616(Value)   (FixPoint1616_t)(Value<<3)
 
#define VL53L0X_FIXPOINT1616TOFIXPOINT08(Value)   (uint8_t)((Value>>8)&0x00FF)
 
#define VL53L0X_FIXPOINT08TOFIXPOINT1616(Value)   (FixPoint1616_t)(Value<<8)
 
#define VL53L0X_FIXPOINT1616TOFIXPOINT53(Value)   (uint8_t)((Value>>13)&0x00FF)
 
#define VL53L0X_FIXPOINT53TOFIXPOINT1616(Value)   (FixPoint1616_t)(Value<<13)
 
#define VL53L0X_FIXPOINT1616TOFIXPOINT102(Value)   (uint16_t)((Value>>14)&0x0FFF)
 
#define VL53L0X_FIXPOINT102TOFIXPOINT1616(Value)   (FixPoint1616_t)(Value<<12)
 
#define VL53L0X_MAKEUINT16(lsb, msb)
 

Typedefs

typedef int8_t VL53L0X_Error
 
typedef uint8_t VL53L0X_DeviceModes
 
typedef uint8_t VL53L0X_HistogramModes
 
typedef uint8_t VL53L0X_PowerModes
 
typedef uint8_t VL53L0X_State
 
typedef uint8_t VL53L0X_InterruptPolarity
 
typedef uint8_t VL53L0X_VcselPeriod
 
typedef uint8_t VL53L0X_SequenceStepId
 

Detailed Description

Type definitions for VL53L0X API.

Definition in file vl53l0x_def.h.

Generated by DoxyGen (1.8.9.1)
previous page start next page