argus_snm.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef ARGUS_SNM_H
#define ARGUS_SNM_H
#ifdef __cplusplus
extern "C" {
#endif
 
/*!***************************************************************************
 * @defgroup    argus_snm Shot Noise Monitor
 * @ingroup     argus_api
 *
 * @brief       Shot Noise Monitor (SNM) parameter definitions and API functions.
 *
 * @details     The SNM is an algorithm to monitor and react on shot noise
 *              induced by harsh environment conditions like high ambient
 *              light.
 *
 *              The AFBR-S50 API provides three modes:
 *              - Dynamic: Automatic mode, automatically adopts to current
 *                         ambient conditions.
 *              - Static (Outdoor): Static mode, optimized for outdoor applications.
 *              - Static (Indoor): Static mode, optimized for indoor applications.
 *              .
 *
 * @addtogroup  argus_snm
 * @{
 *****************************************************************************/
 
typedef enum argus_snm_mode_t
{
    SNM_MODE_STATIC_INDOOR = 0U,
 
    SNM_MODE_STATIC_OUTDOOR = 1U,
 
    SNM_MODE_DYNAMIC = 2U,
 
} argus_snm_mode_t;
 
 
#ifdef __cplusplus
} // extern "C"
#endif
#endif /* ARGUS_SNM_H */