vl53l1_api_strings.c File Reference

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

#include "vl53l1_api_core.h"
#include "vl53l1_api_strings.h"
#include "vl53l1_error_codes.h"
#include "vl53l1_error_strings.h"

Include dependency graph for vl53l1_api_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__)

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_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 functions for decoding error codes to a text string.

Definition in file vl53l1_api_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 76 of file vl53l1_api_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 78 of file vl53l1_api_strings.c.

LOG_FUNCTION_START

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

Definition at line 74 of file vl53l1_api_strings.c.

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_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.