AFBR-S50 API Reference Manual  v1.6.5
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
argus_snm.h
Go to the documentation of this file.
1 /*************************************************************************/
37 #ifndef ARGUS_SNM_H
38 #define ARGUS_SNM_H
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 /*!***************************************************************************
44  * @defgroup argus_snm Shot Noise Monitor
45  * @ingroup argus_api
46  *
47  * @brief Shot Noise Monitor (SNM) parameter definitions and API functions.
48  *
49  * @details The SNM is an algorithm to monitor and react on shot noise
50  * induced by harsh environment conditions like high ambient
51  * light.
52  *
53  * The AFBR-S50 API provides three modes:
54  * - Dynamic: Automatic mode, automatically adopts to current
55  * ambient conditions.
56  * - Static (Outdoor): Static mode, optimized for outdoor applications.
57  * - Static (Indoor): Static mode, optimized for indoor applications.
58  * .
59  *
60  * @addtogroup argus_snm
61  * @{
62  *****************************************************************************/
63 
65 typedef enum argus_snm_mode_t
66 {
71  SNM_MODE_STATIC_INDOOR = 0U,
72 
76  SNM_MODE_STATIC_OUTDOOR = 1U,
77 
80  SNM_MODE_DYNAMIC = 2U,
81 
85  SNM_MODE_DYNAMIC_PLUS = 3U,
86 
87 } argus_snm_mode_t;
88 
89 
91 #ifdef __cplusplus
92 } // extern "C"
93 #endif
94 #endif /* ARGUS_SNM_H */
SNM_MODE_STATIC_OUTDOOR
@ SNM_MODE_STATIC_OUTDOOR
Definition: argus_snm.h:76
SNM_MODE_DYNAMIC
@ SNM_MODE_DYNAMIC
Definition: argus_snm.h:80
SNM_MODE_STATIC_INDOOR
@ SNM_MODE_STATIC_INDOOR
Definition: argus_snm.h:71
SNM_MODE_DYNAMIC_PLUS
@ SNM_MODE_DYNAMIC_PLUS
Definition: argus_snm.h:85
argus_snm_mode_t
argus_snm_mode_t
Definition: argus_snm.h:65