VL53L1 API function declarations for decoding error codes to a text strings. More...

#include "vl53l1_def.h"

Include dependency graph for vl53l1_api_strings.h:

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

Macros
#define	VL53L1_STRING_CHECKENABLE_RANGE_IGNORE_THRESHOLD "RANGE IGNORE THRESHOLD"

#define	VL53L1_STRING_CHECKENABLE_RANGE_PHASE_CONSISTENCY "RANGE PHASE CONSISTENCY"

#define	VL53L1_STRING_CHECKENABLE_RANGE_PHASE_HIGH "RANGE PHASE HIGH"

#define	VL53L1_STRING_CHECKENABLE_RANGE_PHASE_LOW "RANGE PHASE LOW"

#define	VL53L1_STRING_CHECKENABLE_SIGMA_FINAL_RANGE "SIGMA FINAL RANGE"

#define	VL53L1_STRING_CHECKENABLE_SIGNAL_MIN_CLIP "SIGNAL MIN CLIP"

#define	VL53L1_STRING_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE "SIGNAL RATE FINAL RANGE"

#define	VL53L1_STRING_DEVICE_INFO_NAME0 "VL53L1 cut1.0"

#define	VL53L1_STRING_DEVICE_INFO_NAME1 "VL53L1 cut1.1"

#define	VL53L1_STRING_DEVICE_INFO_TYPE "VL53L1"

#define	VL53L1_STRING_RANGESTATUS_HW "Hardware Fail"

#define	VL53L1_STRING_RANGESTATUS_MINRANGE "Min Range Fail"

#define	VL53L1_STRING_RANGESTATUS_NONE "No Update"

#define	VL53L1_STRING_RANGESTATUS_PHASE "Phase Fail"

#define	VL53L1_STRING_RANGESTATUS_RANGEVALID "Range Valid"

#define	VL53L1_STRING_RANGESTATUS_SIGMA "Sigma Fail"

#define	VL53L1_STRING_RANGESTATUS_SIGNAL "Signal Fail"

#define	VL53L1_STRING_SEQUENCESTEP_DSS1 "DSS1"

#define	VL53L1_STRING_SEQUENCESTEP_DSS2 "DSS2"

#define	VL53L1_STRING_SEQUENCESTEP_MM1 "MM1"

#define	VL53L1_STRING_SEQUENCESTEP_MM2 "MM2"

#define	VL53L1_STRING_SEQUENCESTEP_PHASECAL "PHASE CAL"

#define	VL53L1_STRING_SEQUENCESTEP_RANGE "RANGE"

#define	VL53L1_STRING_SEQUENCESTEP_REFPHASE "REF PHASE"

#define	VL53L1_STRING_SEQUENCESTEP_VHV "VHV"

#define	VL53L1_STRING_STATE_ERROR "ERROR State"

#define	VL53L1_STRING_STATE_IDLE "IDLE State"

#define	VL53L1_STRING_STATE_POWERDOWN "POWERDOWN State"

#define	VL53L1_STRING_STATE_RESET "RESET State"

#define	VL53L1_STRING_STATE_RUNNING "RUNNING State"

#define	VL53L1_STRING_STATE_STANDBY "STANDBY State"

#define	VL53L1_STRING_STATE_UNKNOWN "UNKNOWN State"

#define	VL53L1_STRING_STATE_WAIT_STATICINIT "Wait for staticinit State"

Functions
VL53L1_Error	VL53L1_get_limit_check_info (uint16_t LimitCheckId, char *pLimitCheckString)
	Generates a string for the limit check Id. More...

VL53L1_Error	VL53L1_get_pal_error_string (VL53L1_Error PalErrorCode, char *pPalErrorString)
	Generates an error string for the input PAL error code. More...

VL53L1_Error	VL53L1_get_pal_state_string (VL53L1_State PalStateCode, char *pPalStateString)
	Generates a string for the input PAL State code. More...

VL53L1_Error	VL53L1_get_range_status_string (uint8_t RangeStatus, char *pRangeStatusString)
	Generates a string for the input device range status code. More...

VL53L1_Error	VL53L1_get_sequence_steps_info (VL53L1_SequenceStepId SequenceStepId, char *pSequenceStepsString)
	Generates a string for the sequence step Id. More...

Detailed Description

VL53L1 API function declarations for decoding error codes to a text strings.

Definition in file vl53l1_api_strings.h.

Macro Definition Documentation

◆ VL53L1_STRING_CHECKENABLE_RANGE_IGNORE_THRESHOLD

#define VL53L1_STRING_CHECKENABLE_RANGE_IGNORE_THRESHOLD "RANGE IGNORE THRESHOLD"

Definition at line 185 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_CHECKENABLE_RANGE_PHASE_CONSISTENCY

#define VL53L1_STRING_CHECKENABLE_RANGE_PHASE_CONSISTENCY "RANGE PHASE CONSISTENCY"

Definition at line 191 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_CHECKENABLE_RANGE_PHASE_HIGH

#define VL53L1_STRING_CHECKENABLE_RANGE_PHASE_HIGH "RANGE PHASE HIGH"

Definition at line 187 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_CHECKENABLE_RANGE_PHASE_LOW

#define VL53L1_STRING_CHECKENABLE_RANGE_PHASE_LOW "RANGE PHASE LOW"

Definition at line 189 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_CHECKENABLE_SIGMA_FINAL_RANGE

#define VL53L1_STRING_CHECKENABLE_SIGMA_FINAL_RANGE "SIGMA FINAL RANGE"

Definition at line 179 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_CHECKENABLE_SIGNAL_MIN_CLIP

#define VL53L1_STRING_CHECKENABLE_SIGNAL_MIN_CLIP "SIGNAL MIN CLIP"

Definition at line 183 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE

#define VL53L1_STRING_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE "SIGNAL RATE FINAL RANGE"

Definition at line 181 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_DEVICE_INFO_NAME0

#define VL53L1_STRING_DEVICE_INFO_NAME0 "VL53L1 cut1.0"

Definition at line 151 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_DEVICE_INFO_NAME1

#define VL53L1_STRING_DEVICE_INFO_NAME1 "VL53L1 cut1.1"

Definition at line 152 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_DEVICE_INFO_TYPE

#define VL53L1_STRING_DEVICE_INFO_TYPE "VL53L1"

Definition at line 153 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_RANGESTATUS_HW

#define VL53L1_STRING_RANGESTATUS_HW "Hardware Fail"

Definition at line 162 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_RANGESTATUS_MINRANGE

#define VL53L1_STRING_RANGESTATUS_MINRANGE "Min Range Fail"

Definition at line 160 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_RANGESTATUS_NONE

#define VL53L1_STRING_RANGESTATUS_NONE "No Update"

Definition at line 156 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_RANGESTATUS_PHASE

#define VL53L1_STRING_RANGESTATUS_PHASE "Phase Fail"

Definition at line 161 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_RANGESTATUS_RANGEVALID

#define VL53L1_STRING_RANGESTATUS_RANGEVALID "Range Valid"

Definition at line 157 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_RANGESTATUS_SIGMA

#define VL53L1_STRING_RANGESTATUS_SIGMA "Sigma Fail"

Definition at line 158 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_RANGESTATUS_SIGNAL

#define VL53L1_STRING_RANGESTATUS_SIGNAL "Signal Fail"

Definition at line 159 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_SEQUENCESTEP_DSS1

#define VL53L1_STRING_SEQUENCESTEP_DSS1 "DSS1"

Definition at line 198 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_SEQUENCESTEP_DSS2

#define VL53L1_STRING_SEQUENCESTEP_DSS2 "DSS2"

Definition at line 199 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_SEQUENCESTEP_MM1

#define VL53L1_STRING_SEQUENCESTEP_MM1 "MM1"

Definition at line 200 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_SEQUENCESTEP_MM2

#define VL53L1_STRING_SEQUENCESTEP_MM2 "MM2"

Definition at line 201 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_SEQUENCESTEP_PHASECAL

#define VL53L1_STRING_SEQUENCESTEP_PHASECAL "PHASE CAL"

Definition at line 196 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_SEQUENCESTEP_RANGE

#define VL53L1_STRING_SEQUENCESTEP_RANGE "RANGE"

Definition at line 202 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_SEQUENCESTEP_REFPHASE

#define VL53L1_STRING_SEQUENCESTEP_REFPHASE "REF PHASE"

Definition at line 197 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_SEQUENCESTEP_VHV

#define VL53L1_STRING_SEQUENCESTEP_VHV "VHV"

Definition at line 195 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_STATE_ERROR

#define VL53L1_STRING_STATE_ERROR "ERROR State"

Definition at line 174 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_STATE_IDLE

#define VL53L1_STRING_STATE_IDLE "IDLE State"

Definition at line 170 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_STATE_POWERDOWN

#define VL53L1_STRING_STATE_POWERDOWN "POWERDOWN State"

Definition at line 166 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_STATE_RESET

#define VL53L1_STRING_STATE_RESET "RESET State"

Definition at line 172 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_STATE_RUNNING

#define VL53L1_STRING_STATE_RUNNING "RUNNING State"

Definition at line 171 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_STATE_STANDBY

#define VL53L1_STRING_STATE_STANDBY "STANDBY State"

Definition at line 169 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_STATE_UNKNOWN

#define VL53L1_STRING_STATE_UNKNOWN "UNKNOWN State"

Definition at line 173 of file vl53l1_api_strings.h.

◆ VL53L1_STRING_STATE_WAIT_STATICINIT

#define VL53L1_STRING_STATE_WAIT_STATICINIT "Wait for staticinit State"

Definition at line 167 of file vl53l1_api_strings.h.

Function Documentation

◆ VL53L1_get_limit_check_info()

VL53L1_Error VL53L1_get_limit_check_info	(	uint16_t	LimitCheckId,
		char *	pLimitCheckString
	)

Generates a string for the limit check Id.

Parameters

[in]	LimitCheckId	: Limit check Id
[out]	pLimitCheckString	: pointer to character buffer

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Definition at line 240 of file vl53l1_api_strings.c.

◆ VL53L1_get_pal_error_string()

VL53L1_Error VL53L1_get_pal_error_string	(	VL53L1_Error	PalErrorCode,
		char *	pPalErrorString
	)

Generates an error string for the input PAL error code.

Parameters

[in]	PalErrorCode	: PAL Error Code
[out]	pPalErrorString	: pointer to character buffer

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Definition at line 86 of file vl53l1_error_strings.c.

◆ VL53L1_get_pal_state_string()

VL53L1_Error VL53L1_get_pal_state_string	(	VL53L1_State	PalStateCode,
		char *	pPalStateString
	)

Generates a string for the input PAL State code.

Parameters

[in]	PalStateCode	: PAL State Code
[out]	pPalStateString	: pointer to character buffer

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Definition at line 131 of file vl53l1_api_strings.c.

◆ VL53L1_get_range_status_string()

VL53L1_Error VL53L1_get_range_status_string	(	uint8_t	RangeStatus,
		char *	pRangeStatusString
	)

Generates a string for the input device range status code.

Parameters

[in]	RangeStatus	: Device Range AStatus Code
[out]	pRangeStatusString	: pointer to character buffer

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Definition at line 83 of file vl53l1_api_strings.c.

◆ VL53L1_get_sequence_steps_info()

VL53L1_Error VL53L1_get_sequence_steps_info	(	VL53L1_SequenceStepId	SequenceStepId,
		char *	pSequenceStepsString
	)

Generates a string for the sequence step Id.

Parameters

[in]	SequenceStepId	: Sequence Step Id
[out]	pSequenceStepsString	: pointer to character buffer

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Definition at line 186 of file vl53l1_api_strings.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ VL53L1_STRING_CHECKENABLE_RANGE_IGNORE_THRESHOLD

◆ VL53L1_STRING_CHECKENABLE_RANGE_PHASE_CONSISTENCY

◆ VL53L1_STRING_CHECKENABLE_RANGE_PHASE_HIGH

◆ VL53L1_STRING_CHECKENABLE_RANGE_PHASE_LOW

◆ VL53L1_STRING_CHECKENABLE_SIGMA_FINAL_RANGE

◆ VL53L1_STRING_CHECKENABLE_SIGNAL_MIN_CLIP

◆ VL53L1_STRING_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE

◆ VL53L1_STRING_DEVICE_INFO_NAME0

◆ VL53L1_STRING_DEVICE_INFO_NAME1

◆ VL53L1_STRING_DEVICE_INFO_TYPE

◆ VL53L1_STRING_RANGESTATUS_HW

◆ VL53L1_STRING_RANGESTATUS_MINRANGE

◆ VL53L1_STRING_RANGESTATUS_NONE

◆ VL53L1_STRING_RANGESTATUS_PHASE

◆ VL53L1_STRING_RANGESTATUS_RANGEVALID

◆ VL53L1_STRING_RANGESTATUS_SIGMA

◆ VL53L1_STRING_RANGESTATUS_SIGNAL

◆ VL53L1_STRING_SEQUENCESTEP_DSS1

◆ VL53L1_STRING_SEQUENCESTEP_DSS2

◆ VL53L1_STRING_SEQUENCESTEP_MM1

◆ VL53L1_STRING_SEQUENCESTEP_MM2

◆ VL53L1_STRING_SEQUENCESTEP_PHASECAL

◆ VL53L1_STRING_SEQUENCESTEP_RANGE

◆ VL53L1_STRING_SEQUENCESTEP_REFPHASE

◆ VL53L1_STRING_SEQUENCESTEP_VHV

◆ VL53L1_STRING_STATE_ERROR

◆ VL53L1_STRING_STATE_IDLE

◆ VL53L1_STRING_STATE_POWERDOWN

◆ VL53L1_STRING_STATE_RESET

◆ VL53L1_STRING_STATE_RUNNING

◆ VL53L1_STRING_STATE_STANDBY

◆ VL53L1_STRING_STATE_UNKNOWN

◆ VL53L1_STRING_STATE_WAIT_STATICINIT

Function Documentation

◆ VL53L1_get_limit_check_info()

◆ VL53L1_get_pal_error_string()

◆ VL53L1_get_pal_state_string()

◆ VL53L1_get_range_status_string()

◆ VL53L1_get_sequence_steps_info()