CCAux  2.8.3.0
CCAux API reference
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator
CfgIn.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * CfgIn.h
6 *
7 * Version 2.8.3.0, 2016-04-06
8 *
9 * (c) maximatecc 2013
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, unsigned char channel, CfgInModeEnum set_mode);
88 
103  EXTERN_C
104  CCAUXDLL_API
105  eErr
106  CCAUXDLL_CALLING_CONV
107  CfgIn_getCfgInMode (CFGINHANDLE, unsigned char channel, CfgInModeEnum* get_mode);
108 
151  EXTERN_C
152  CCAUXDLL_API
153  eErr
154  CCAUXDLL_CALLING_CONV
155  CfgIn_getValue (CFGINHANDLE, unsigned char channel, unsigned short* sample_value);
156 
172  EXTERN_C
173  CCAUXDLL_API
174  eErr
175  CCAUXDLL_CALLING_CONV
176  CfgIn_getPwmValue (CFGINHANDLE, unsigned char channel, float* frequency, unsigned char* duty_cycle);
177 
208  EXTERN_C
209  CCAUXDLL_API
210  eErr
211  CCAUXDLL_CALLING_CONV
212  CfgIn_getFrequencyValue (CFGINHANDLE, unsigned char channel, float* frequency);
213 
235  EXTERN_C
236  CCAUXDLL_API
237  eErr
238  CCAUXDLL_CALLING_CONV
239  CfgIn_getMinFrequencyThreshold (CFGINHANDLE, unsigned char channel, float* frequency);
240 
263  EXTERN_C
264  CCAUXDLL_API
265  eErr
266  CCAUXDLL_CALLING_CONV
267  CfgIn_setMinFrequencyThreshold (CFGINHANDLE, unsigned char channel, float frequency);
268 
283  EXTERN_C
284  CCAUXDLL_API
285  eErr
286  CCAUXDLL_CALLING_CONV
287  CfgIn_setFrequencyFilterLevel (CFGINHANDLE, unsigned char level);
288 
289 #ifdef __cplusplus
290 } /* namespace CrossControl */
291 #endif
292 
293 #endif /* CC_CFGIN_H */
294 
Generated on Wed Apr 6 2016 19:46:22 for CCAux by   doxygen 1.8.3.1