Diagnostic.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Access to unit diagnostic data
 *
 *  Use the function GetDiagnostic() to get a handle to pass on to the other functions.
 *  Use the method Diagnostic_release(DIAGNOSTICHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include diagnostic_example.cpp
 *
 ************************************************/
#ifndef CC_DIAGNOSTIC_H
#define CC_DIAGNOSTIC_H
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *DIAGNOSTICHANDLE;
 
EXTERN_C
CCAUXDLL_API
DIAGNOSTICHANDLE
CCAUXDLL_CALLING_CONV
GetDiagnostic(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV Diagnostic_release(DIAGNOSTICHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getSSTemp(DIAGNOSTICHANDLE, int16_t *temperature);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getPCBTemp(DIAGNOSTICHANDLE, int16_t *temperature);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getPMTemp(DIAGNOSTICHANDLE, uint8_t index, int16_t *temperature,
                                                JidaSensorType *jst);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getStartupReason(DIAGNOSTICHANDLE, uint16_t *reason);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getShutDownReason(DIAGNOSTICHANDLE, uint16_t *reason);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getHardShutDowns(DIAGNOSTICHANDLE, uint16_t *button, uint16_t *powerloss);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getHwErrorStatus(DIAGNOSTICHANDLE, uint16_t *errorCode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getTimer(DIAGNOSTICHANDLE, TimerType *times);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getTimerExt(DIAGNOSTICHANDLE, TimerTypeExt *times);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getMinMaxTemp(DIAGNOSTICHANDLE, int16_t *minTemp, int16_t *maxTemp);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_getPowerCycles(DIAGNOSTICHANDLE, uint16_t *powerCycles);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Diagnostic_clearHwErrorStatus(DIAGNOSTICHANDLE);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_DIAGNOSTIC_H */