CCAux  2.15.2.0
CCAux API reference
Diagnostic.h
Go to the documentation of this file.
1 /************************************************
2  *
3  * CROSSCONTROL AUX API
4  *
5  * Diagnostic.h
6  *
7  * Version 2.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
10  *
11 
12  * File description:
13  * Access to unit diagnostic data
14  *
15  * Use the function GetDiagnostic() to get a handle to pass on to the other functions.
16  * Use the method Diagnostic_release(DIAGNOSTICHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include diagnostic_example.cpp
20  *
21  ************************************************/
22 #ifndef CC_DIAGNOSTIC_H
23 #define CC_DIAGNOSTIC_H
24 
25 #include "CCAuxErrors.h"
26 #include "CCPlatform.h"
27 
28 #ifdef __cplusplus
29 namespace CrossControl {
30 #endif
31 
32  typedef void* DIAGNOSTICHANDLE;
33 
47  EXTERN_C
48  CCAUXDLL_API
49  DIAGNOSTICHANDLE
50  CCAUXDLL_CALLING_CONV
51  GetDiagnostic(void);
52 
63  EXTERN_C
64  CCAUXDLL_API
65  void
66  CCAUXDLL_CALLING_CONV
67  Diagnostic_release(DIAGNOSTICHANDLE);
68 
81  EXTERN_C
82  CCAUXDLL_API
83  eErr
84  CCAUXDLL_CALLING_CONV
85  Diagnostic_getSSTemp (DIAGNOSTICHANDLE, int16_t* temperature);
86 
96  EXTERN_C
97  CCAUXDLL_API
98  eErr
99  CCAUXDLL_CALLING_CONV
100  Diagnostic_getPCBTemp (DIAGNOSTICHANDLE, int16_t* temperature);
101 
117  EXTERN_C
118  CCAUXDLL_API
119  eErr
120  CCAUXDLL_CALLING_CONV
121  Diagnostic_getPMTemp (DIAGNOSTICHANDLE, uint8_t index, int16_t* temperature, JidaSensorType* jst);
122 
132  EXTERN_C
133  CCAUXDLL_API
134  eErr
135  CCAUXDLL_CALLING_CONV
136  Diagnostic_getStartupReason(DIAGNOSTICHANDLE, uint16_t* reason);
137 
147  EXTERN_C
148  CCAUXDLL_API
149  eErr
150  CCAUXDLL_CALLING_CONV
151  Diagnostic_getShutDownReason(DIAGNOSTICHANDLE, uint16_t* reason);
152 
163  EXTERN_C
164  CCAUXDLL_API
165  eErr
166  CCAUXDLL_CALLING_CONV
167  Diagnostic_getHwErrorStatus(DIAGNOSTICHANDLE, uint16_t* errorCode);
168 
181  EXTERN_C
182  CCAUXDLL_API
183  eErr
184  CCAUXDLL_CALLING_CONV
185  Diagnostic_getTimer(DIAGNOSTICHANDLE, TimerType* times);
186 
200  EXTERN_C
201  CCAUXDLL_API
202  eErr
203  CCAUXDLL_CALLING_CONV
204  Diagnostic_getMinMaxTemp(DIAGNOSTICHANDLE, int16_t* minTemp, int16_t* maxTemp);
205 
215  EXTERN_C
216  CCAUXDLL_API
217  eErr
218  CCAUXDLL_CALLING_CONV
219  Diagnostic_getPowerCycles(DIAGNOSTICHANDLE, uint16_t* powerCycles);
220 
228  EXTERN_C
229  CCAUXDLL_API
230  eErr
231  CCAUXDLL_CALLING_CONV
232  Diagnostic_clearHwErrorStatus(DIAGNOSTICHANDLE);
233 
234 #ifdef __cplusplus
235 } /* namespace CrossControl */
236 #endif
237 
238 #endif /* CC_DIAGNOSTIC_H */
239 
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CCPlatform.h
CrossControl::Diagnostic_getMinMaxTemp
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getMinMaxTemp(DIAGNOSTICHANDLE, int16_t *minTemp, int16_t *maxTemp)
CrossControl::Diagnostic_getSSTemp
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getSSTemp(DIAGNOSTICHANDLE, int16_t *temperature)
CrossControl::Diagnostic_getHwErrorStatus
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getHwErrorStatus(DIAGNOSTICHANDLE, uint16_t *errorCode)
CrossControl::JidaSensorType
JidaSensorType
Definition: CCAuxTypes.h:398
CrossControl::Diagnostic_getPowerCycles
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getPowerCycles(DIAGNOSTICHANDLE, uint16_t *powerCycles)
CrossControl
Definition: About.h:30
uint16_t
unsigned short uint16_t
Definition: CCAuxTypes.h:48
CrossControl::GetDiagnostic
EXTERN_C CCAUXDLL_API DIAGNOSTICHANDLE CCAUXDLL_CALLING_CONV GetDiagnostic(void)
CrossControl::Diagnostic_getStartupReason
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getStartupReason(DIAGNOSTICHANDLE, uint16_t *reason)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
CrossControl::Diagnostic_getTimer
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getTimer(DIAGNOSTICHANDLE, TimerType *times)
CrossControl::Diagnostic_getPCBTemp
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getPCBTemp(DIAGNOSTICHANDLE, int16_t *temperature)
CCAuxErrors.h
CrossControl::Diagnostic_getShutDownReason
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getShutDownReason(DIAGNOSTICHANDLE, uint16_t *reason)
CrossControl::DIAGNOSTICHANDLE
void * DIAGNOSTICHANDLE
Definition: Diagnostic.h:32
CrossControl::TimerType
Definition: CCAuxTypes.h:384
CrossControl::Diagnostic_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Diagnostic_release(DIAGNOSTICHANDLE)
int16_t
signed short int16_t
Definition: CCAuxTypes.h:45
CrossControl::Diagnostic_getPMTemp
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getPMTemp(DIAGNOSTICHANDLE, uint8_t index, int16_t *temperature, JidaSensorType *jst)
CrossControl::Diagnostic_clearHwErrorStatus
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_clearHwErrorStatus(DIAGNOSTICHANDLE)
Generated on Wed Jul 8 2020 12:44:31 for CCAux by   doxygen 1.8.14