kvDiag.h File Reference

Definitions for the Diagnostics API. More...

#include <canlib.h>
#include <stdint.h>

Go to the source code of this file.

Macros

DIAG_ANALYZER_TYPE_xxx

Analyzer type.

#define DIAG_ANALYZER_TYPE_DEFAULT   0
 
KDI_MAX_SAMPLE_SIZE

The maximum size of sample from a default analyzer. Used with kvDiagReadSampleRaw.

#define KDI_DEFAULT_MAX_SAMPLE_SIZE   8196
 

Typedefs

DiagDataPtr

Pointer to diagnostic data buffer.

typedef void * DiagDataPtr
 

Functions

canStatus kvDiagAttach (const CanHandle hnd, uint32_t type)
 
canStatus kvDiagDetach (const CanHandle hnd)
 
canStatus kvDiagAlloc (DiagDataPtr *diagData)
 
canStatus kvDiagDealloc (DiagDataPtr *diagData)
 
canStatus kvDiagConfigure (const CanHandle hnd, const char *configBuffer, DiagDataPtr diagData)
 
canStatus kvDiagStart (const CanHandle hnd)
 
canStatus kvDiagStop (const CanHandle hnd)
 
canStatus kvDiagReadSampleRaw (DiagDataPtr diagData, uint8_t *buffer, uint32_t bufferLength, int *sampleLength)
 
canStatus kvDiagGetNumberOfAnalyzers (const CanHandle hnd, uint8_t *analyzerCount)
 
canStatus kvDiagGetAnalyzerInfo (const CanHandle hnd, uint8_t analyzerNo, uint32_t *type, uint32_t *version)
 

Detailed Description

Definitions for the Diagnostics API.

Note
The kvDiag API is preliminary and will change!

Macro Definition Documentation

◆ DIAG_ANALYZER_TYPE_DEFAULT

#define DIAG_ANALYZER_TYPE_DEFAULT   0

Default.

◆ KDI_DEFAULT_MAX_SAMPLE_SIZE

#define KDI_DEFAULT_MAX_SAMPLE_SIZE   8196

Typedef Documentation

◆ DiagDataPtr

typedef void* DiagDataPtr