EwokPlus25 API Preset Modes definitions. More...
#include "vl53l1_ll_def.h"#include "vl53l1_platform_log.h"#include "vl53l1_register_structs.h"#include "vl53l1_register_settings.h"#include "vl53l1_core.h"#include "vl53l1_api_preset_modes.h"#include "vl53l1_tuning_parm_defaults.h"
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, ...) _LOG_FUNCTION_END_FMT(VL53L1_TRACE_MODULE_API, status, fmt, ##__VA_ARGS__) |
| #define | LOG_FUNCTION_START(fmt, ...) _LOG_FUNCTION_START(VL53L1_TRACE_MODULE_API, fmt, ##__VA_ARGS__) |
Detailed Description
EwokPlus25 API Preset Modes definitions.
Definition in file vl53l1_api_preset_modes.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 80 of file vl53l1_api_preset_modes.c.
◆ LOG_FUNCTION_END_FMT
| #define LOG_FUNCTION_END_FMT | ( | status, | |
| fmt, | |||
| ... | |||
| ) | _LOG_FUNCTION_END_FMT(VL53L1_TRACE_MODULE_API, status, fmt, ##__VA_ARGS__) |
Definition at line 82 of file vl53l1_api_preset_modes.c.
◆ LOG_FUNCTION_START
| #define LOG_FUNCTION_START | ( | fmt, | |
| ... | |||
| ) | _LOG_FUNCTION_START(VL53L1_TRACE_MODULE_API, fmt, ##__VA_ARGS__) |
Definition at line 78 of file vl53l1_api_preset_modes.c.
Function Documentation
◆ VL53L1_init_offset_cal_config_struct()
| VL53L1_Error VL53L1_init_offset_cal_config_struct | ( | VL53L1_offsetcal_config_t * | pdata | ) |
Initializes Offset Calibration Configuration Parameters.
- Parameters
-
[out] pdata : pointer to VL53L1_offsetcal_config_t data structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 249 of file vl53l1_api_preset_modes.c.
◆ VL53L1_init_refspadchar_config_struct()
| VL53L1_Error VL53L1_init_refspadchar_config_struct | ( | VL53L1_refspadchar_config_t * | pdata | ) |
Initializes Ref SPAD Char Configuration Parameters.
- Parameters
-
[out] pdata : pointer to VL53L1_refspadchar_config_t data structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 87 of file vl53l1_api_preset_modes.c.
◆ VL53L1_init_ssc_config_struct()
| VL53L1_Error VL53L1_init_ssc_config_struct | ( | VL53L1_ssc_config_t * | pdata | ) |
Initializes SPAD Self Check (SSC) Configuration Parameters.
- Parameters
-
[out] pdata : pointer to VL53L1_ssc_config_t data structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 128 of file vl53l1_api_preset_modes.c.
◆ VL53L1_init_tuning_parm_storage_struct()
| VL53L1_Error VL53L1_init_tuning_parm_storage_struct | ( | VL53L1_tuning_parm_storage_t * | pdata | ) |
Initializes Tuning Parameter Storage Values.
- Parameters
-
[out] pdata : pointer to VL53L1_tuning_parm_storage_t data structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 291 of file vl53l1_api_preset_modes.c.
◆ VL53L1_init_xtalk_config_struct()
| VL53L1_Error VL53L1_init_xtalk_config_struct | ( | VL53L1_customer_nvm_managed_t * | pnvm, |
| VL53L1_xtalk_config_t * | pdata | ||
| ) |
Initializes Xtalk Configuration Parameters.
- Parameters
-
[in] pnvm : pointer to VL53L1_customer_nvm_managed_t data structure [out] pdata : pointer to VL53L1_xtalk_config_t data structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 174 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_low_power_auto_long_ranging()
| VL53L1_Error VL53L1_preset_mode_low_power_auto_long_ranging | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms, | ||
| VL53L1_low_power_auto_data_t * | plpadata | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_LOWPOWERAUTO_LONG_RANGE.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure [out] plpadata : pointer to VL53L1_low_power_auto_data_t data structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1242 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_low_power_auto_ranging()
| VL53L1_Error VL53L1_preset_mode_low_power_auto_ranging | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms, | ||
| VL53L1_low_power_auto_data_t * | plpadata | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_LOWPOWERAUTO_MEDIUM_RANGE.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure [out] plpadata : pointer to VL53L1_low_power_auto_data_t data structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1136 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_low_power_auto_short_ranging()
| VL53L1_Error VL53L1_preset_mode_low_power_auto_short_ranging | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms, | ||
| VL53L1_low_power_auto_data_t * | plpadata | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_LOWPOWERAUTO_SHORT_RANGE.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure [out] plpadata : pointer to VL53L1_low_power_auto_data_t data structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1189 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_olt()
| VL53L1_Error VL53L1_preset_mode_olt | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_OLT.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Initializes static and dynamic data structures for device preset mode VL53L1_DEVICEPRESETMODE_OLT
PLEASE NOTE THE SETTINGS BELOW AT PROVISIONAL AND WILL CHANGE!
Definition at line 1367 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_singleshot_ranging()
| VL53L1_Error VL53L1_preset_mode_singleshot_ranging | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_SINGLESHOT_RANGING.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1297 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_standard_ranging()
| VL53L1_Error VL53L1_preset_mode_standard_ranging | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDARD_RANGING.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 395 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_standard_ranging_long_range()
| VL53L1_Error VL53L1_preset_mode_standard_ranging_long_range | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDARD_RANGING_LONG_RANGE.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 731 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_standard_ranging_mm1_cal()
| VL53L1_Error VL53L1_preset_mode_standard_ranging_mm1_cal | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDARD_RANGING_MM1_CAL.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 808 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_standard_ranging_mm2_cal()
| VL53L1_Error VL53L1_preset_mode_standard_ranging_mm2_cal | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDARD_RANGING_MM2_CAL.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 862 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_standard_ranging_short_range()
| VL53L1_Error VL53L1_preset_mode_standard_ranging_short_range | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDARD_RANGING_SHORT_RANGE.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 655 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_timed_ranging()
| VL53L1_Error VL53L1_preset_mode_timed_ranging | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_TIMED_RANGING.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 917 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_timed_ranging_long_range()
| VL53L1_Error VL53L1_preset_mode_timed_ranging_long_range | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_TIMED_RANGING_LONG_RANGE.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1062 of file vl53l1_api_preset_modes.c.
◆ VL53L1_preset_mode_timed_ranging_short_range()
| VL53L1_Error VL53L1_preset_mode_timed_ranging_short_range | ( | VL53L1_static_config_t * | pstatic, |
| VL53L1_general_config_t * | pgeneral, | ||
| VL53L1_timing_config_t * | ptiming, | ||
| VL53L1_dynamic_config_t * | pdynamic, | ||
| VL53L1_system_control_t * | psystem, | ||
| VL53L1_tuning_parm_storage_t * | ptuning_parms | ||
| ) |
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_TIMED_RANGING_SHORT_RANGE.
- Parameters
-
[out] pstatic : pointer to VL53L1_static_config_t data structure [out] pgeneral : pointer to VL53L1_general_config_t data structure [out] ptiming : pointer to VL53L1_timing_config_t data structure [out] pdynamic : pointer to VL53L1_dynamic_config_t data structure [out] psystem : pointer to VL53L1_system_control_t data structure [out] ptuning_parms : pointer to VL53L1_tuning_parms_storage_t structure
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 989 of file vl53l1_api_preset_modes.c.