AFBR-S50 API Reference Manual  v1.6.5
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
argus_dfm.h
Go to the documentation of this file.
1 /*************************************************************************/
37 #ifndef ARGUS_DFM_H
38 #define ARGUS_DFM_H
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 /*!***************************************************************************
44  * @defgroup argus_dfm Dual Frequency Mode
45  * @ingroup argus_api
46  *
47  * @brief Dual Frequency Mode (DFM) parameter definitions and API functions.
48  *
49  * @details The DFM is an algorithm to extend the unambiguous range of the
50  * sensor by utilizing two detuned measurement frequencies.
51  *
52  * The AFBR-S50 API provides three measurement modes:
53  * - 1X: Single Frequency Measurement
54  * - 4X: Dual Frequency Measurement w/ 4 times the unambiguous
55  * range of the Single Frequency Measurement
56  * - 8X: Dual Frequency Measurement w/ 8 times the unambiguous
57  * range of the Single Frequency Measurement
58  *
59  * @addtogroup argus_dfm
60  * @{
61  *****************************************************************************/
62 
64 #define ARGUS_DFM_FRAME_COUNT (2U)
65 
67 #define ARGUS_DFM_MODE_COUNT (2U) // except off-mode!
68 
70 typedef enum argus_dfm_mode_t
71 {
73  DFM_MODE_OFF = 0U,
74 
76  DFM_MODE_4X = 1U,
77 
79  DFM_MODE_8X = 2U,
80 
81 } argus_dfm_mode_t;
82 
83 
85 #ifdef __cplusplus
86 } // extern "C"
87 #endif
88 #endif /* ARGUS_DFM_H */
DFM_MODE_OFF
@ DFM_MODE_OFF
Definition: argus_dfm.h:73
DFM_MODE_4X
@ DFM_MODE_4X
Definition: argus_dfm.h:76
DFM_MODE_8X
@ DFM_MODE_8X
Definition: argus_dfm.h:79
argus_dfm_mode_t
argus_dfm_mode_t
Definition: argus_dfm.h:70