CCAux  2.8.3.0
CCAux API reference
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator
Adc.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * Adc.h
6 *
7 * Version 2.8.3.0, 2016-04-06
8 *
9 * (c) maximatecc 2013
10 *
11 
12  * File description:
13  * Get current voltages from the built-in ADC
14  *
15  * Use the function GetAdc() to get a handle to pass on to the other functions.
16  * Use the method Adc_release(ADCHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include adc_example.cpp
20  *
21  ************************************************/
22 
23 #ifndef CC_ADC_H_
24 #define CC_ADC_H_
25 
26 #include "CCAuxErrors.h"
27 #include "CCPlatform.h"
28 #include "CCAuxTypes.h"
29 
30 #ifdef __cplusplus
31 namespace CrossControl {
32 #endif
33 
34  typedef void* ADCHANDLE;
35 
50  EXTERN_C
51  CCAUXDLL_API
52  ADCHANDLE
53  CCAUXDLL_CALLING_CONV
54  GetAdc(void);
55 
66  EXTERN_C
67  CCAUXDLL_API
68  void
69  CCAUXDLL_CALLING_CONV
70  Adc_release(ADCHANDLE);
71 
85  EXTERN_C
86  CCAUXDLL_API
87  eErr
88  CCAUXDLL_CALLING_CONV
89  Adc_getVoltage(ADCHANDLE, VoltageEnum selection, double* value);
90 
91 #ifdef __cplusplus
92 } /* namespace CrossControl */
93 #endif
94 
95 #endif /* CC_ADC_H_ */
96 
Generated on Wed Apr 6 2016 19:46:22 for CCAux by   doxygen 1.8.3.1