argus_dfm.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef ARGUS_DFM_H
#define ARGUS_DFM_H
#ifdef __cplusplus
extern "C" {
#endif
 
/*!***************************************************************************
 * @defgroup    argus_dfm Dual Frequency Mode
 * @ingroup     argus_api
 *
 * @brief       Dual Frequency Mode (DFM) parameter definitions and API functions.
 *
 * @details     The DFM is an algorithm to extend the unambiguous range of the
 *              sensor by utilizing two detuned measurement frequencies.
 *
 *              The AFBR-S50 API provides three measurement modes:
 *              - 1X: Single Frequency Measurement
 *              - 4X: Dual Frequency Measurement w/ 4 times the unambiguous
 *                    range of the Single Frequency Measurement
 *              - 8X: Dual Frequency Measurement w/ 8 times the unambiguous
 *                    range of the Single Frequency Measurement
 *
 * @addtogroup  argus_dfm
 * @{
 *****************************************************************************/
 
#define ARGUS_DFM_FRAME_COUNT (2U)
 
#define ARGUS_DFM_MODE_COUNT (2U) // except off-mode!
 
typedef enum argus_dfm_mode_t
{
    DFM_MODE_OFF = 0U,
 
    DFM_MODE_4X = 1U,
 
    DFM_MODE_8X = 2U,
 
} argus_dfm_mode_t;
 
 
#ifdef __cplusplus
} // extern "C"
#endif
#endif /* ARGUS_DFM_H */