vl53l1x: vl53l1_def.h File Reference

Type definitions for VL53L1 API. More...

#include "vl53l1_ll_def.h"

Include dependency graph for vl53l1_def.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	VL53L1_CalibrationData_t
	Structure for storing the Calibration Data. More...

struct	VL53L1_CustomerNvmManaged_t
	Defines ROI configuration parameters. More...

struct	VL53L1_DetectionConfig_t
	Defines parameters for User/object Detection configuration. More...

struct	VL53L1_DevData_t
	Contains the Internal data of the Bare Driver. More...

struct	VL53L1_DeviceInfo_t
	Defines the parameters of the Get Device Info Functions. More...

struct	VL53L1_DeviceParameters_t
	Defines all parameters for the device. More...

struct	VL53L1_DistanceThreshold_t
	Defines parameters for Distance detection Thresholds configuration. More...

struct	VL53L1_RangingMeasurementData_t
	Single Range measurement data. More...

struct	VL53L1_RateThreshold_t
	Defines parameters for Signal rate detection Thresholds configuration. More...

struct	VL53L1_UserRoi_t
	Defines User Zone(ROI) parameters. More...

struct	VL53L1_Version_t
	Defines the parameters of the Get Version Functions. More...

Macros
#define	CHECK_ERROR_GO_ENDFUNC

#define	VL53L1_ADDITIONAL_CALIBRATION_DATA_STRUCT_VERSION 0x10

#define	VL53L1_CALIBRATION_DATA_STRUCT_VERSION

#define	VL53L1_CHECKENABLE_NUMBER_OF_CHECKS 2

#define	VL53L1_CHECKENABLE_SIGMA_FINAL_RANGE 0

#define	VL53L1_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE 1

#define	VL53L1_DETECTION_DISTANCE_AND_RATE ((VL53L1_DetectionMode) 3)

#define	VL53L1_DETECTION_DISTANCE_ONLY ((VL53L1_DetectionMode) 1)

#define	VL53L1_DETECTION_DISTANCE_OR_RATE ((VL53L1_DetectionMode) 4)

#define	VL53L1_DETECTION_NORMAL_RUN ((VL53L1_DetectionMode) 0)

#define	VL53L1_DETECTION_RATE_ONLY ((VL53L1_DetectionMode) 2)

#define	VL53L1_DEVINFO_STRLEN 32

#define	VL53L1_DISTANCEMODE_LONG ((VL53L1_DistanceModes) 3)

#define	VL53L1_DISTANCEMODE_MEDIUM ((VL53L1_DistanceModes) 2)

#define	VL53L1_DISTANCEMODE_SHORT ((VL53L1_DistanceModes) 1)

#define	VL53L1_FIXPOINT08TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<8)

#define	VL53L1_FIXPOINT102TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<14)

#define	VL53L1_FIXPOINT142TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<14)

#define	VL53L1_FIXPOINT160TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<16)

#define	VL53L1_FIXPOINT1616TOFIXPOINT08(Value) (uint8_t)((Value>>8)&0x00FF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT102(Value) (uint16_t)((Value>>14)&0x0FFF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT142(Value) (uint16_t)((Value>>14)&0xFFFF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT160(Value) (uint16_t)((Value>>16)&0xFFFF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT313(Value) (uint16_t)((Value>>3)&0xFFFF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT412(Value) (uint16_t)((Value>>4)&0xFFFF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT44(Value) (uint16_t)((Value>>12)&0xFFFF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT53(Value) (uint8_t)((Value>>13)&0x00FF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT72(Value) (uint16_t)((Value>>14)&0xFFFF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT88(Value) (uint16_t)((Value>>8)&0xFFFF)

#define	VL53L1_FIXPOINT1616TOFIXPOINT97(Value) (uint16_t)((Value>>9)&0xFFFF)

#define	VL53L1_FIXPOINT313TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<3)

#define	VL53L1_FIXPOINT412TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<4)

#define	VL53L1_FIXPOINT44TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<12)

#define	VL53L1_FIXPOINT53TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<13)

#define	VL53L1_FIXPOINT72TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<14)

#define	VL53L1_FIXPOINT88TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<8)

#define	VL53L1_FIXPOINT97TOFIXPOINT1616(Value) (FixPoint1616_t)((uint32_t)Value<<9)

#define	VL53L1_GETARRAYPARAMETERFIELD(Dev, field, index, variable) (variable = VL53L1DevDataGet(Dev, CurrentParameters).field[index])

#define	VL53L1_GETDEVICESPECIFICPARAMETER(Dev, field) (VL53L1DevDataGet(Dev, DeviceSpecificParameters).field)

#define	VL53L1_GETPARAMETERFIELD(Dev, field, variable) (variable = VL53L1DevDataGet(Dev, CurrentParameters).field)

#define	VL53L1_IMPLEMENTATION_VER_MAJOR 2

#define	VL53L1_IMPLEMENTATION_VER_MINOR 3

#define	VL53L1_IMPLEMENTATION_VER_REVISION 1885

#define	VL53L1_IMPLEMENTATION_VER_SUB 3

#define	VL53L1_MAKEUINT16(lsb, msb)

#define	VL53L1_OFFSETCALIBRATIONMODE_PRERANGE_ONLY ((VL53L1_OffsetCalibrationModes) 2)

#define	VL53L1_OFFSETCALIBRATIONMODE_STANDARD ((VL53L1_OffsetCalibrationModes) 1)

#define	VL53L1_PRESETMODE_AUTONOMOUS ((VL53L1_PresetModes) 3)

#define	VL53L1_PRESETMODE_LITE_RANGING ((VL53L1_PresetModes) 4)

#define	VL53L1_PRESETMODE_LOWPOWER_AUTONOMOUS ((VL53L1_PresetModes) 8)

#define	VL53L1_RANGESTATUS_HARDWARE_FAIL 5

#define	VL53L1_RANGESTATUS_MIN_RANGE_FAIL 13

#define	VL53L1_RANGESTATUS_NONE 255

#define	VL53L1_RANGESTATUS_OUTOFBOUNDS_FAIL 4

#define	VL53L1_RANGESTATUS_PROCESSING_FAIL 8

#define	VL53L1_RANGESTATUS_RANGE_INVALID 14

#define	VL53L1_RANGESTATUS_RANGE_VALID 0

#define	VL53L1_RANGESTATUS_RANGE_VALID_MERGED_PULSE 11

#define	VL53L1_RANGESTATUS_RANGE_VALID_MIN_RANGE_CLIPPED 3

#define	VL53L1_RANGESTATUS_RANGE_VALID_NO_WRAP_CHECK_FAIL 6

#define	VL53L1_RANGESTATUS_SIGMA_FAIL 1

#define	VL53L1_RANGESTATUS_SIGNAL_FAIL 2

#define	VL53L1_RANGESTATUS_SYNCRONISATION_INT 10

#define	VL53L1_RANGESTATUS_TARGET_PRESENT_LACK_OF_SIGNAL 12

#define	VL53L1_RANGESTATUS_WRAP_TARGET_FAIL 7

#define	VL53L1_RANGESTATUS_XTALK_SIGNAL_FAIL 9

#define	VL53L1_SEQUENCESTEP_DSS1 ((VL53L1_SequenceStepId) 3)

#define	VL53L1_SEQUENCESTEP_DSS2 ((VL53L1_SequenceStepId) 4)

#define	VL53L1_SEQUENCESTEP_MM1 ((VL53L1_SequenceStepId) 5)

#define	VL53L1_SEQUENCESTEP_MM2 ((VL53L1_SequenceStepId) 6)

#define	VL53L1_SEQUENCESTEP_NUMBER_OF_ITEMS 8

#define	VL53L1_SEQUENCESTEP_PHASECAL ((VL53L1_SequenceStepId) 1)

#define	VL53L1_SEQUENCESTEP_RANGE ((VL53L1_SequenceStepId) 7)

#define	VL53L1_SEQUENCESTEP_REFPHASE ((VL53L1_SequenceStepId) 2)

#define	VL53L1_SEQUENCESTEP_VHV ((VL53L1_SequenceStepId) 0)

#define	VL53L1_SETARRAYPARAMETERFIELD(Dev, field, index, value) (VL53L1DevDataSet(Dev, CurrentParameters.field[index], value))

#define	VL53L1_SETDEVICESPECIFICPARAMETER(Dev, field, value) (VL53L1DevDataSet(Dev, DeviceSpecificParameters.field, value))

#define	VL53L1_SETPARAMETERFIELD(Dev, field, value) (VL53L1DevDataSet(Dev, CurrentParameters.field, value))

#define	VL53L1_STATE_ERROR ((VL53L1_State) 99)

#define	VL53L1_STATE_IDLE ((VL53L1_State) 3)

#define	VL53L1_STATE_POWERDOWN ((VL53L1_State) 0)

#define	VL53L1_STATE_RESET ((VL53L1_State) 5)

#define	VL53L1_STATE_RUNNING ((VL53L1_State) 4)

#define	VL53L1_STATE_STANDBY ((VL53L1_State) 2)

#define	VL53L1_STATE_UNKNOWN ((VL53L1_State) 98)

#define	VL53L1_STATE_WAIT_STATICINIT ((VL53L1_State) 1)

#define	VL53L1_THRESHOLD_CROSSED_HIGH ((VL53L1_ThresholdMode) 1)

#define	VL53L1_THRESHOLD_CROSSED_LOW ((VL53L1_ThresholdMode) 0)

#define	VL53L1_THRESHOLD_IN_WINDOW ((VL53L1_ThresholdMode) 3)

#define	VL53L1_THRESHOLD_OUT_OF_WINDOW ((VL53L1_ThresholdMode) 2)

#define	VL53L1_XTALKCALIBRATIONMODE_FULL_ROI ((VL53L1_OffsetCalibrationModes) 2)

#define	VL53L1_XTALKCALIBRATIONMODE_NO_TARGET ((VL53L1_OffsetCalibrationModes) 0)

#define	VL53L1_XTALKCALIBRATIONMODE_SINGLE_TARGET ((VL53L1_OffsetCalibrationModes) 1)

Typedefs
typedef VL53L1_additional_data_t	VL53L1_AdditionalData_t

typedef uint8_t	VL53L1_DetectionMode

typedef uint8_t	VL53L1_DistanceModes

typedef uint8_t	VL53L1_OffsetCalibrationModes

typedef uint8_t	VL53L1_PresetModes

typedef uint8_t	VL53L1_SequenceStepId

typedef uint8_t	VL53L1_State

typedef uint8_t	VL53L1_ThresholdMode

typedef uint8_t	VL53L1_XtalkCalibrationModes

Detailed Description

Type definitions for VL53L1 API.

Definition in file vl53l1_def.h.

Classes

Macros

Typedefs

Detailed Description