CCAux  2.15.2.0
CCAux API reference
CfgIn.h
Go to the documentation of this file.
1 /************************************************
2  *
3  * CROSSCONTROL AUX API
4  *
5  * CfgIn.h
6  *
7  * Version 2.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
10  *
11 
12  * File description:
13  * Configurable inputs
14  *
15  * Use the function GetCfgIn() to get a handle to pass on to the other functions.
16  * Use the method CfgIn_release(CFGINHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include cfgin_example.cpp
20  *
21  ************************************************/
22 #ifndef CC_CFGIN_H
23 #define CC_CFGIN_H
24 
25 #include "CCAuxErrors.h"
26 #include "CCPlatform.h"
27 
28 #ifdef __cplusplus
29 namespace CrossControl {
30 #endif
31 
32  typedef void* CFGINHANDLE;
33 
47  EXTERN_C
48  CCAUXDLL_API
49  CFGINHANDLE
50  CCAUXDLL_CALLING_CONV
51  GetCfgIn(void);
52 
63  EXTERN_C
64  CCAUXDLL_API
65  void
66  CCAUXDLL_CALLING_CONV
67  CfgIn_release(CFGINHANDLE);
68 
83  EXTERN_C
84  CCAUXDLL_API
85  eErr
86  CCAUXDLL_CALLING_CONV
87  CfgIn_setCfgInMode (CFGINHANDLE, uint8_t channel, CfgInModeEnum set_mode);
88 
103  EXTERN_C
104  CCAUXDLL_API
105  eErr
106  CCAUXDLL_CALLING_CONV
107  CfgIn_getCfgInMode (CFGINHANDLE, uint8_t channel, CfgInModeEnum* get_mode);
108 
159  EXTERN_C
160  CCAUXDLL_API
161  eErr
162  CCAUXDLL_CALLING_CONV
163  CfgIn_getValue (CFGINHANDLE, uint8_t channel, uint16_t* sample_value);
164 
180  EXTERN_C
181  CCAUXDLL_API
182  eErr
183  CCAUXDLL_CALLING_CONV
184  CfgIn_getPwmValue (CFGINHANDLE, uint8_t channel, float32_t* frequency, uint8_t* duty_cycle);
185 
217  EXTERN_C
218  CCAUXDLL_API
219  eErr
220  CCAUXDLL_CALLING_CONV
221  CfgIn_getFrequencyValue (CFGINHANDLE, uint8_t channel, float32_t* frequency);
222 
245  EXTERN_C
246  CCAUXDLL_API
247  eErr
248  CCAUXDLL_CALLING_CONV
249  CfgIn_getMinFrequencyThreshold (CFGINHANDLE, uint8_t channel, float32_t* frequency);
250 
274  EXTERN_C
275  CCAUXDLL_API
276  eErr
277  CCAUXDLL_CALLING_CONV
278  CfgIn_setMinFrequencyThreshold (CFGINHANDLE, uint8_t channel, float32_t frequency);
279 
293  EXTERN_C
294  CCAUXDLL_API
295  eErr
296  CCAUXDLL_CALLING_CONV
297  CfgIn_setFrequencyFilterLevel (CFGINHANDLE, uint8_t level);
298 
299 #ifdef __cplusplus
300 } /* namespace CrossControl */
301 #endif
302 
303 #endif /* CC_CFGIN_H */
304 
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CrossControl::CfgIn_getValue
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getValue(CFGINHANDLE, uint8_t channel, uint16_t *sample_value)
CCPlatform.h
CrossControl::CfgIn_getCfgInMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getCfgInMode(CFGINHANDLE, uint8_t channel, CfgInModeEnum *get_mode)
CrossControl::CFGINHANDLE
void * CFGINHANDLE
Definition: CfgIn.h:32
float32_t
float float32_t
Definition: CCAuxTypes.h:25
CrossControl::CfgIn_getPwmValue
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getPwmValue(CFGINHANDLE, uint8_t channel, float32_t *frequency, uint8_t *duty_cycle)
CrossControl::CfgIn_setCfgInMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_setCfgInMode(CFGINHANDLE, uint8_t channel, CfgInModeEnum set_mode)
CrossControl::CfgIn_getFrequencyValue
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getFrequencyValue(CFGINHANDLE, uint8_t channel, float32_t *frequency)
CrossControl::GetCfgIn
EXTERN_C CCAUXDLL_API CFGINHANDLE CCAUXDLL_CALLING_CONV GetCfgIn(void)
CrossControl
Definition: About.h:30
CrossControl::CfgIn_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CfgIn_release(CFGINHANDLE)
uint16_t
unsigned short uint16_t
Definition: CCAuxTypes.h:48
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
CCAuxErrors.h
CrossControl::CfgIn_setMinFrequencyThreshold
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_setMinFrequencyThreshold(CFGINHANDLE, uint8_t channel, float32_t frequency)
CrossControl::CfgIn_setFrequencyFilterLevel
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_setFrequencyFilterLevel(CFGINHANDLE, uint8_t level)
CrossControl::CfgInModeEnum
CfgInModeEnum
Definition: CCAuxTypes.h:463
CrossControl::CfgIn_getMinFrequencyThreshold
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getMinFrequencyThreshold(CFGINHANDLE, uint8_t channel, float32_t *frequency)
Generated on Wed Jul 8 2020 12:44:31 for CCAux by   doxygen 1.8.14