CCAux  2.12.0.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.12.0.0, 2017-12-21
8 *
9 * (c) CrossControl 2010-2017
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 
154  EXTERN_C
155  CCAUXDLL_API
156  eErr
157  CCAUXDLL_CALLING_CONV
158  CfgIn_getValue (CFGINHANDLE, uint8_t channel, uint16_t* sample_value);
159 
175  EXTERN_C
176  CCAUXDLL_API
177  eErr
178  CCAUXDLL_CALLING_CONV
179  CfgIn_getPwmValue (CFGINHANDLE, uint8_t channel, float32_t* frequency, uint8_t* duty_cycle);
180 
212  EXTERN_C
213  CCAUXDLL_API
214  eErr
215  CCAUXDLL_CALLING_CONV
216  CfgIn_getFrequencyValue (CFGINHANDLE, uint8_t channel, float32_t* frequency);
217 
240  EXTERN_C
241  CCAUXDLL_API
242  eErr
243  CCAUXDLL_CALLING_CONV
244  CfgIn_getMinFrequencyThreshold (CFGINHANDLE, uint8_t channel, float32_t* frequency);
245 
269  EXTERN_C
270  CCAUXDLL_API
271  eErr
272  CCAUXDLL_CALLING_CONV
273  CfgIn_setMinFrequencyThreshold (CFGINHANDLE, uint8_t channel, float32_t frequency);
274 
288  EXTERN_C
289  CCAUXDLL_API
290  eErr
291  CCAUXDLL_CALLING_CONV
292  CfgIn_setFrequencyFilterLevel (CFGINHANDLE, uint8_t level);
293 
294 #ifdef __cplusplus
295 } /* namespace CrossControl */
296 #endif
297 
298 #endif /* CC_CFGIN_H */
299 
eErr
Definition: CCAuxTypes.h:154
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getValue(CFGINHANDLE, uint8_t channel, uint16_t *sample_value)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getCfgInMode(CFGINHANDLE, uint8_t channel, CfgInModeEnum *get_mode)
void * CFGINHANDLE
Definition: CfgIn.h:32
float float32_t
Definition: CCAuxTypes.h:25
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getPwmValue(CFGINHANDLE, uint8_t channel, float32_t *frequency, uint8_t *duty_cycle)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_setCfgInMode(CFGINHANDLE, uint8_t channel, CfgInModeEnum set_mode)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getFrequencyValue(CFGINHANDLE, uint8_t channel, float32_t *frequency)
EXTERN_C CCAUXDLL_API CFGINHANDLE CCAUXDLL_CALLING_CONV GetCfgIn(void)
Definition: About.h:30
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CfgIn_release(CFGINHANDLE)
unsigned short uint16_t
Definition: CCAuxTypes.h:48
unsigned char uint8_t
Definition: CCAuxTypes.h:47
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_setMinFrequencyThreshold(CFGINHANDLE, uint8_t channel, float32_t frequency)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_setFrequencyFilterLevel(CFGINHANDLE, uint8_t level)
CfgInModeEnum
Definition: CCAuxTypes.h:455
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CfgIn_getMinFrequencyThreshold(CFGINHANDLE, uint8_t channel, float32_t *frequency)