AFBR-S50 API Reference Manual  v1.6.5
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
core_cal.h
Go to the documentation of this file.
1 /*************************************************************************/
37 #ifndef CORE_CALIB_H
38 #define CORE_CALIB_H
39 
40 /*!***************************************************************************
41  * @defgroup core_calib AFBR-S50 Explorer - Explorer calibration functions
42  * @ingroup explorer_app
43  * @brief AFBR-S50 Explorer - Explorer calibration functions
44  * @details Util functions for handling the calibration of Explorer devices
45  * @addtogroup core_calib
46  * @{
47  *****************************************************************************/
48 
49 #include "explorer_types.h"
50 
51 #if EXPLORER_API_PRO
52 /*!***************************************************************************
53  * @brief Triggers a substrate voltage calibration measurement sequence.
54  * @param argus The Argus device handler.
55  * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
56  *****************************************************************************/
57 status_t ExplorerApp_ExecuteVsubCalibrationSequence(argus_hnd_t * argus);
58 #endif
59 
60 /*!***************************************************************************
61  * @brief Triggers a crosstalk calibration measurement sequence.
62  * @param argus The Argus device handler.
63  * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
64  *****************************************************************************/
65 status_t ExplorerApp_ExecuteXtalkCalibrationSequence(argus_hnd_t * argus);
66 
67 /*!***************************************************************************
68  * @brief Triggers a crosstalk calibration measurement sequence.
69  * @param argus The Argus device handler.
70  * @param targetRange The calibration target distance in meter and Q9.22
71  * format. Pass non-positive (0) value to execute
72  * relative calibration sequence only.
73  * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
74  *****************************************************************************/
75 status_t ExplorerApp_ExecuteOffsetsCalibrationSequence(argus_hnd_t * argus, q9_22_t targetRange);
76 
77 #if EXPLORER_API_PRO
78 /*!***************************************************************************
79  * @brief Resets the device calibration to the factory default values.
80  * @param explorer The AFBR-Explorer control block.
81  * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
82  *****************************************************************************/
83 status_t ExplorerApp_ResetDeviceCalibration(explorer_t * explorer);
84 #endif
85 
86 
88 #endif /* CORE_CALIB_H */
ExplorerApp_ExecuteOffsetsCalibrationSequence
status_t ExplorerApp_ExecuteOffsetsCalibrationSequence(argus_hnd_t *argus, q9_22_t targetRange)
Triggers a crosstalk calibration measurement sequence.
Definition: core_cal.c:111
explorer_t
Definition: explorer_types.h:282
q9_22_t
int32_t q9_22_t
Signed fixed point number: Q9.22.
Definition: fp_def.h:538
explorer_types.h
This file is part of the AFBR-S50 Explorer Demo Application.
argus_hnd_t
struct argus_hnd_t argus_hnd_t
Definition: argus_def.h:320
ExplorerApp_ExecuteXtalkCalibrationSequence
status_t ExplorerApp_ExecuteXtalkCalibrationSequence(argus_hnd_t *argus)
Triggers a crosstalk calibration measurement sequence.
Definition: core_cal.c:92
status_t
int32_t status_t
Type used for all status and error return values.
Definition: argus_status.h:70