CCAux  2.17.0.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.17.0.0", 2019-10-22
8 *
9 * (c) CrossControl 2010-2019
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 
53  EXTERN_C
54  CCAUXDLL_API
55  DIAGNOSTICHANDLE
56  CCAUXDLL_CALLING_CONV
57  GetDiagnostic(void);
58 
69  EXTERN_C
70  CCAUXDLL_API
71  void
72  CCAUXDLL_CALLING_CONV
73  Diagnostic_release(DIAGNOSTICHANDLE);
74 
87  EXTERN_C
88  CCAUXDLL_API
89  eErr
90  CCAUXDLL_CALLING_CONV
91  Diagnostic_getSSTemp (DIAGNOSTICHANDLE, int16_t* temperature);
92 
102  EXTERN_C
103  CCAUXDLL_API
104  eErr
105  CCAUXDLL_CALLING_CONV
106  Diagnostic_getPCBTemp (DIAGNOSTICHANDLE, int16_t* temperature);
107 
123  EXTERN_C
124  CCAUXDLL_API
125  eErr
126  CCAUXDLL_CALLING_CONV
127  Diagnostic_getPMTemp (DIAGNOSTICHANDLE, uint8_t index, int16_t* temperature, JidaSensorType* jst);
128 
138  EXTERN_C
139  CCAUXDLL_API
140  eErr
141  CCAUXDLL_CALLING_CONV
142  Diagnostic_getStartupReason(DIAGNOSTICHANDLE, uint16_t* reason);
143 
153  EXTERN_C
154  CCAUXDLL_API
155  eErr
156  CCAUXDLL_CALLING_CONV
157  Diagnostic_getShutDownReason(DIAGNOSTICHANDLE, uint16_t* reason);
158 
169  EXTERN_C
170  CCAUXDLL_API
171  eErr
172  CCAUXDLL_CALLING_CONV
173  Diagnostic_getHwErrorStatus(DIAGNOSTICHANDLE, uint16_t* errorCode);
174 
187  EXTERN_C
188  CCAUXDLL_API
189  eErr
190  CCAUXDLL_CALLING_CONV
191  Diagnostic_getTimer(DIAGNOSTICHANDLE, TimerType* times);
192 
206  EXTERN_C
207  CCAUXDLL_API
208  eErr
209  CCAUXDLL_CALLING_CONV
210  Diagnostic_getMinMaxTemp(DIAGNOSTICHANDLE, int16_t* minTemp, int16_t* maxTemp);
211 
221  EXTERN_C
222  CCAUXDLL_API
223  eErr
224  CCAUXDLL_CALLING_CONV
225  Diagnostic_getPowerCycles(DIAGNOSTICHANDLE, uint16_t* powerCycles);
226 
234  EXTERN_C
235  CCAUXDLL_API
236  eErr
237  CCAUXDLL_CALLING_CONV
238  Diagnostic_clearHwErrorStatus(DIAGNOSTICHANDLE);
239 
241 #ifdef __cplusplus
242 } /* namespace CrossControl */
243 #endif
244 
245 #endif /* CC_DIAGNOSTIC_H */
246 
CrossControl::Diagnostic_getPCBTemp
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getPCBTemp(DIAGNOSTICHANDLE, int16_t *temperature)
CrossControl::Diagnostic_getMinMaxTemp
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getMinMaxTemp(DIAGNOSTICHANDLE, int16_t *minTemp, int16_t *maxTemp)
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CCPlatform.h
CrossControl::Diagnostic_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Diagnostic_release(DIAGNOSTICHANDLE)
CrossControl::Diagnostic_getShutDownReason
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getShutDownReason(DIAGNOSTICHANDLE, uint16_t *reason)
CrossControl::JidaSensorType
JidaSensorType
Definition: CCAuxTypes.h:411
CrossControl
Definition: About.h:30
uint16_t
unsigned short uint16_t
Definition: CCAuxTypes.h:48
CrossControl::Diagnostic_getPowerCycles
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getPowerCycles(DIAGNOSTICHANDLE, uint16_t *powerCycles)
CrossControl::GetDiagnostic
EXTERN_C CCAUXDLL_API DIAGNOSTICHANDLE CCAUXDLL_CALLING_CONV GetDiagnostic(void)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
CrossControl::Diagnostic_getPMTemp
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getPMTemp(DIAGNOSTICHANDLE, uint8_t index, int16_t *temperature, JidaSensorType *jst)
CCAuxErrors.h
CrossControl::Diagnostic_getSSTemp
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getSSTemp(DIAGNOSTICHANDLE, int16_t *temperature)
CrossControl::DIAGNOSTICHANDLE
void * DIAGNOSTICHANDLE
Definition: Diagnostic.h:32
CrossControl::Diagnostic_getStartupReason
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getStartupReason(DIAGNOSTICHANDLE, uint16_t *reason)
CrossControl::TimerType
Definition: CCAuxTypes.h:397
CrossControl::Diagnostic_getTimer
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getTimer(DIAGNOSTICHANDLE, TimerType *times)
CrossControl::Diagnostic_getHwErrorStatus
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_getHwErrorStatus(DIAGNOSTICHANDLE, uint16_t *errorCode)
int16_t
signed short int16_t
Definition: CCAuxTypes.h:45
CrossControl::Diagnostic_clearHwErrorStatus
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Diagnostic_clearHwErrorStatus(DIAGNOSTICHANDLE)
Generated on Tue Oct 22 2019 17:00:44 for CCAux by   doxygen 1.8.14