vl53l1_error_strings.c File Reference

VL53L1 API functions for decoding error codes to a text string. More...

#include "vl53l1_error_codes.h"
#include "vl53l1_error_strings.h"
#include "vl53l1_platform_log.h"
#include "vl53l1_ll_def.h"

Include dependency graph for vl53l1_error_strings.c:

Go to the source code of this file.

Macros
#define	LOG_FUNCTION_END(status, ...)   _LOG_FUNCTION_END(VL53L1_TRACE_MODULE_API, status, ##__VA_ARGS__)
#define	LOG_FUNCTION_END_FMT(status, fmt, ...)
#define	LOG_FUNCTION_START(fmt, ...)   _LOG_FUNCTION_START(VL53L1_TRACE_MODULE_API, fmt, ##__VA_ARGS__)
#define	VL53L1_USE_EMPTY_STRING

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

Detailed Description

VL53L1 API functions for decoding error codes to a text string.

Definition in file vl53l1_error_strings.c.

Macro Definition Documentation

LOG_FUNCTION_END

#define LOG_FUNCTION_END	(		status,
			...
	)		_LOG_FUNCTION_END(VL53L1_TRACE_MODULE_API, status, ##__VA_ARGS__)

Definition at line 75 of file vl53l1_error_strings.c.

LOG_FUNCTION_END_FMT

#define LOG_FUNCTION_END_FMT	(		status,
			fmt,
			...
	)

Value:

        _LOG_FUNCTION_END_FMT(VL53L1_TRACE_MODULE_API, \
                status, fmt, ##__VA_ARGS__)

Definition at line 77 of file vl53l1_error_strings.c.

LOG_FUNCTION_START

#define LOG_FUNCTION_START	(		fmt,
			...
	)		_LOG_FUNCTION_START(VL53L1_TRACE_MODULE_API, fmt, ##__VA_ARGS__)

Definition at line 73 of file vl53l1_error_strings.c.

VL53L1_USE_EMPTY_STRING

#define VL53L1_USE_EMPTY_STRING

Definition at line 83 of file vl53l1_error_strings.c.

Function Documentation

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.