AFBR-S50 API Reference Manual v1.5.6
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
Loading...
Searching...
No Matches
argus_xtalk_cal_cli.h
Go to the documentation of this file.
1/*************************************************************************/
37#ifndef ARGUS_XTALK_CAL_CLI_H
38#define ARGUS_XTALK_CAL_CLI_H
39
40/*!***************************************************************************
41 * @defgroup argus_xtk_cli Crosstalk Calibration CLI
42 * @ingroup argus
43 *
44 * @brief A CLI module to interactively run crosstalk calibration.
45 *
46 * @details This interactive procedure guides through the steps needed to
47 * compensate the application specific crosstalk (xtalk) using
48 * the AFBR-S50 API.
49 *
50 * Please read application note
51 * [AFBR-S50-XTK-Crosstalk-Guide](https://docs.broadcom.com/docs/AFBR-S50-XTK-Crosstalk-Guide)
52 * to get more information.
53 *
54 * @addtogroup argus_xtk_cli
55 * @{
56 *****************************************************************************/
57
58#include "argus.h"
59
60/*!***************************************************************************
61 * @brief Version number of the xtalk calibration CLI.
62 *
63 * @details Changes:
64 * * v1.0:
65 * - Initial release.
66 *
67 *****************************************************************************/
68#define ARGUS_XTALK_CAL_CLI_VERSION "v1.0"
69
70/*!***************************************************************************
71 * @brief The xtalk measurement amplitude limits in LSB for the electrical part.
72 *
73 * @note These values can but should not be increased to meet target sensor
74 * performance.
75 ******************************************************************************/
76#define ELEC_XTK_AMPL_LMT (25U)
77
78/*!***************************************************************************
79 * @brief The xtalk measurement amplitude limits in LSB for the optical part.
80 *
81 * @note These values can but should not be increased to meet target sensor
82 * performance.
83 ******************************************************************************/
84#define OPT_ELEC_XTK_AMPL_LMT (200U)
85
86/*!***************************************************************************
87 * @brief Wavelength dependent transmission of a cover glass.
88 *
89 * @details Wavelength dependent transmission or transmittance factor of the
90 * specific cover glass.
91 *
92 * Example: Gorilla glass has 92% transmittance @ 850nm which is
93 * translated as UQ0.8 by `0.92 * 2^8 = 236`
94 *
95 * @note * AFBR-S5xxx85x devises use 850nm,
96 * * AFBR-S5xxx68x use 680nm
97 *
98 ******************************************************************************/
99#define T_GLASS (236U)
100
101/*!***************************************************************************
102 * @brief Interactive Xtalk Calibration Procedure CLI
103 *
104 * @details This interactive procedure guides through the steps needed to
105 * compensate the application specific crosstalk (xtalk) using the
106 * AFBR-S50 API.
107 *
108 * Please read application note
109 * [AFBR-S50-XTK-Crosstalk-Guide](https://docs.broadcom.com/docs/AFBR-S50-XTK-Crosstalk-Guide)
110 * to get more information.
111 ******************************************************************************/
112void Argus_XtalkCalibration_CLI(argus_hnd_t * hnd);
113
115#endif /* ARGUS_XTALK_CAL_CLI */
argus.h
This file is part of the AFBR-S50 API.
argus_hnd_t
struct argus_hnd_t argus_hnd_t
Definition argus_def.h:284
Argus_XtalkCalibration_CLI
void Argus_XtalkCalibration_CLI(argus_hnd_t *hnd)
Interactive Xtalk Calibration Procedure CLI.
Definition argus_xtalk_cal_cli.c:162
hnd
argus_hnd_t * hnd
Definition main.c:100