Initial release. Mbed library for VL53L1CB
vl53l1_api_strings.h File Reference
VL53L1 API function declarations for decoding error codes to a text strings. More...
Go to the source code of this file.
Functions | |
VL53L1_Error | VL53L1_get_range_status_string (uint8_t RangeStatus, char *pRangeStatusString) |
Generates a string for the input device range status code. | |
VL53L1_Error | VL53L1_get_pal_error_string (VL53L1_Error PalErrorCode, char *pPalErrorString) |
Generates an error string for the input PAL error code. | |
VL53L1_Error | VL53L1_get_pal_state_string (VL53L1_State PalStateCode, char *pPalStateString) |
Generates a string for the input PAL State code. | |
VL53L1_Error | VL53L1_get_sequence_steps_info (VL53L1_SequenceStepId SequenceStepId, char *pSequenceStepsString) |
Generates a string for the sequence step Id. | |
VL53L1_Error | VL53L1_get_limit_check_info (uint16_t LimitCheckId, char *pLimitCheckString) |
Generates a string for the limit check Id. |
Detailed Description
VL53L1 API function declarations for decoding error codes to a text strings.
Definition in file vl53l1_api_strings.h.
Function Documentation
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 243 of file vl53l1_api_strings.c.
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 82 of file vl53l1_error_strings.c.
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 132 of file vl53l1_api_strings.c.
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_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 188 of file vl53l1_api_strings.c.
Generated on Tue Jul 12 2022 20:07:15 by 1.7.2