CCAux  2.7.2.0
CCAux API reference
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator
Diagnostic.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * Diagnostic.h
6 *
7 * Version 2.7.2.0, 2014-08-25
8 *
9 * (c) maximatecc 2013
10 *
11 * File description:
12 * Access to unit diagnostic data
13 *
14 * Use the function GetDiagnostic() to get a handle to pass on to the other functions.
15 * Use the method Diagnostic_release(DIAGNOSTICHANDLE) to return the handle.
16 *
17 * Example Usage:
18 * @include diagnostic_example.cpp
19 *
20 ************************************************/
21 #ifndef CC_DIAGNOSTIC_H
22 #define CC_DIAGNOSTIC_H
23 
24 #include "CCAuxErrors.h"
25 #include "CCPlatform.h"
26 
27 #ifdef __cplusplus
28 namespace CrossControl {
29 #endif
30 
31  typedef void* DIAGNOSTICHANDLE;
32 
46  EXTERN_C
47  CCAUXDLL_API
48  DIAGNOSTICHANDLE
49  CCAUXDLL_CALLING_CONV
50  GetDiagnostic(void);
51 
62  EXTERN_C
63  CCAUXDLL_API
64  void
65  CCAUXDLL_CALLING_CONV
66  Diagnostic_release(DIAGNOSTICHANDLE);
67 
80  EXTERN_C
81  CCAUXDLL_API
82  eErr
83  CCAUXDLL_CALLING_CONV
84  Diagnostic_getSSTemp (DIAGNOSTICHANDLE, signed short* temperature);
85 
95  EXTERN_C
96  CCAUXDLL_API
97  eErr
98  CCAUXDLL_CALLING_CONV
99  Diagnostic_getPCBTemp (DIAGNOSTICHANDLE, signed short* temperature);
100 
116  EXTERN_C
117  CCAUXDLL_API
118  eErr
119  CCAUXDLL_CALLING_CONV
120  Diagnostic_getPMTemp (DIAGNOSTICHANDLE, unsigned char index, signed short* temperature, JidaSensorType* jst);
121 
131  EXTERN_C
132  CCAUXDLL_API
133  eErr
134  CCAUXDLL_CALLING_CONV
135  Diagnostic_getStartupReason(DIAGNOSTICHANDLE, unsigned short* reason);
136 
146  EXTERN_C
147  CCAUXDLL_API
148  eErr
149  CCAUXDLL_CALLING_CONV
150  Diagnostic_getShutDownReason(DIAGNOSTICHANDLE, unsigned short* reason);
151 
162  EXTERN_C
163  CCAUXDLL_API
164  eErr
165  CCAUXDLL_CALLING_CONV
166  Diagnostic_getHwErrorStatus(DIAGNOSTICHANDLE, unsigned short* errorCode);
167 
180  EXTERN_C
181  CCAUXDLL_API
182  eErr
183  CCAUXDLL_CALLING_CONV
184  Diagnostic_getTimer(DIAGNOSTICHANDLE, TimerType* times);
185 
199  EXTERN_C
200  CCAUXDLL_API
201  eErr
202  CCAUXDLL_CALLING_CONV
203  Diagnostic_getMinMaxTemp(DIAGNOSTICHANDLE, signed short* minTemp, signed short* maxTemp);
204 
214  EXTERN_C
215  CCAUXDLL_API
216  eErr
217  CCAUXDLL_CALLING_CONV
218  Diagnostic_getPowerCycles(DIAGNOSTICHANDLE, unsigned short* powerCycles);
219 
227  EXTERN_C
228  CCAUXDLL_API
229  eErr
230  CCAUXDLL_CALLING_CONV
231  Diagnostic_clearHwErrorStatus(DIAGNOSTICHANDLE);
232 
233 #ifdef __cplusplus
234 } /* namespace CrossControl */
235 #endif
236 
237 #endif /* CC_DIAGNOSTIC_H */
238 
Generated on Mon Aug 25 2014 17:48:49 for CCAux by   doxygen 1.8.3.1