vl53l1_ll_def.h File Reference

Type definitions for VL53L1 LL Driver. More...

#include "vl53l1_ll_device.h"
#include "vl53l1_error_codes.h"
#include "vl53l1_register_structs.h"
#include "vl53l1_platform_user_config.h"
#include "vl53l1_platform_user_defines.h"
#include "vl53l1_error_exceptions.h"

Include dependency graph for vl53l1_ll_def.h:

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

Go to the source code of this file.

Classes
struct	VL53L1_additional_data_t
	Additional debug data. More...
struct	VL53L1_additional_offset_cal_data_t
	Additional Offset Calibration Data. More...
struct	VL53L1_cal_peak_rate_map_t
	Structure for storing the calibration peak rate map Used by DMAX to understand the spatial roll off in the signal rate map towards the corner of the SPAD array. More...
struct	VL53L1_calibration_data_t
	Per Part calibration data. More...
struct	VL53L1_gain_calibration_data_t
	Gain calibration data. More...
struct	VL53L1_GPIO_interrupt_config_t
	Structure to configure conditions when GPIO interrupt is trigerred. More...
struct	VL53L1_ll_driver_state_t
	Contains the driver state information. More...
struct	VL53L1_ll_version_t
	Defines the parameters of the LL driver Get Version Functions. More...
struct	VL53L1_LLDriverData_t
	VL53L1 LL Driver ST private data structure . More...
struct	VL53L1_LLDriverResults_t
	VL53L1 LL Driver ST private results structure. More...
struct	VL53L1_low_power_auto_data_t
	Structure to hold state, tuning and output variables for the low power auto mode (Presence) More...
struct	VL53L1_offset_range_data_t
	Structure for storing the set of range results required for the mm1 and mm2 offset calibration functions. More...
struct	VL53L1_offset_range_results_t
	Structure for storing the set of range results required for the offset calibration functions. More...
struct	VL53L1_offsetcal_config_t
	Run Offset Cal Function (offsetcal) Config. More...
struct	VL53L1_optical_centre_t
	Optical Centre data. More...
struct	VL53L1_range_data_t
	Internal data structure for storing post processed ranges. More...
struct	VL53L1_range_results_t
	Structure for storing the set of range results. More...
struct	VL53L1_refspadchar_config_t
	Reference SPAD Characterization (RefSpadChar) Config. More...
struct	VL53L1_spad_rate_data_t
	SPAD Rate Data output by SSC. More...
struct	VL53L1_ssc_config_t
	SPAD Self Check (SSC) Config data structure. More...
struct	VL53L1_tuning_parameters_t
	Tuning Parameters Debug data. More...
struct	VL53L1_tuning_parm_storage_t
	TuningParameter Storage. More...
struct	VL53L1_user_zone_t
	Defines User Zone(ROI) parameters. More...
struct	VL53L1_xtalk_config_t
	Xtalk Extraction and Paramter Config. More...

Macros
#define	IGNORE_STATUS(__FUNCTION_ID__, __ERROR_STATUS_CHECK__, __STATUS__)
#define	SUPPRESS_UNUSED_WARNING(x)   ((void) (x))
#define	VL53L1_COPYSTRING(str, ...)   (strncpy(str, ##__VA_ARGS__, VL53L1_MAX_STRING_LENGTH-1))
#define	VL53L1_ERROR_DEVICE_FIRMWARE_TOO_NEW   ((VL53L1_Error) - 85)
#define	VL53L1_ERROR_DEVICE_FIRMWARE_TOO_OLD   ((VL53L1_Error) - 80)
#define	VL53L1_ERROR_FILE_READ_FAIL   ((VL53L1_Error) - 95)
#define	VL53L1_ERROR_FILE_WRITE_FAIL   ((VL53L1_Error) - 96)
#define	VL53L1_ERROR_UNIT_TEST_FAIL   ((VL53L1_Error) - 90)
#define	VL53L1_FIRMWARE_VER_MAXIMUM   400
#define	VL53L1_FIRMWARE_VER_MINIMUM   398
#define	VL53L1_LL_API_IMPLEMENTATION_VER_MAJOR   1
#define	VL53L1_LL_API_IMPLEMENTATION_VER_MINOR   2
#define	VL53L1_LL_API_IMPLEMENTATION_VER_REVISION   1840
#define	VL53L1_LL_API_IMPLEMENTATION_VER_STRING   "1.2.11.1840"
#define	VL53L1_LL_API_IMPLEMENTATION_VER_SUB   10
#define	VL53L1_LL_CALIBRATION_DATA_STRUCT_VERSION   0xECAB0102
#define	VL53L1_LL_ZONE_CALIBRATION_DATA_STRUCT_VERSION   0xECAE0101
#define	VL53L1_MAX_OFFSET_RANGE_RESULTS   3
#define	VL53L1_NVM_MAX_FMT_RANGE_DATA   4
#define	VL53L1_NVM_PEAK_RATE_MAP_HEIGHT   5
#define	VL53L1_NVM_PEAK_RATE_MAP_SAMPLES   25
#define	VL53L1_NVM_PEAK_RATE_MAP_WIDTH   5

Detailed Description

Type definitions for VL53L1 LL Driver.

Definition in file vl53l1_ll_def.h.

Macro Definition Documentation

IGNORE_STATUS

#define IGNORE_STATUS	(		__FUNCTION_ID__,
			__ERROR_STATUS_CHECK__,
			__STATUS__
	)

Value:

        do { \
                DISABLE_WARNINGS(); \
                if (__FUNCTION_ID__) { \
                        if (__STATUS__ == __ERROR_STATUS_CHECK__) { \
                                __STATUS__ = VL53L1_ERROR_NONE; \
                                WARN_OVERRIDE_STATUS(__FUNCTION_ID__); \
                        } \
                } \
                ENABLE_WARNINGS(); \
        } \
        while (0)

Definition at line 1076 of file vl53l1_ll_def.h.

SUPPRESS_UNUSED_WARNING

#define SUPPRESS_UNUSED_WARNING

(

x

)

((void) (x))

Definition at line 1072 of file vl53l1_ll_def.h.

VL53L1_COPYSTRING

#define VL53L1_COPYSTRING	(		str,
			...
	)		(strncpy(str, ##__VA_ARGS__, VL53L1_MAX_STRING_LENGTH-1))

Definition at line 1089 of file vl53l1_ll_def.h.