kvDiag.h

Go to the documentation of this file.

/*
 *                   Copyright 2002-2019 by KVASER AB, SWEDEN
 *
 *                        WWW: http://www.kvaser.com
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license.
 *
 */

#ifndef _KVDIAG_H_
#define _KVDIAG_H_

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

#ifdef __cplusplus
extern "C" {
#endif

#define DIAG_ANALYZER_TYPE_DEFAULT 0 
#define DIAG_PROGRAM_TYPE_NORMAL   0
#define DIAG_PROGRAM_TYPE_AUTOBAUD 1

#define DIAG_PROGRAM_TYPE_HALT     2
#define DIAG_PROGRAM_TYPE_GENERIC  3

#define DIAG_PROGRAM_STATE_UNKNOWN      0
#define DIAG_PROGRAM_STATE_RUNNING      1
#define DIAG_PROGRAM_STATE_STOPPED      2


typedef struct {
  double bitrate;   
  int quality;      
} bitrate_t;


typedef struct {
  bitrate_t bitrate;      
  bitrate_t bitrate_brs;  
} bitrates_t;

typedef struct {
  struct {
    int version;        
    int seqno;          
    int type;           
  } header;
  struct {
    int id;             
    int64_t time;       
    char data[64];      
    int flag;           
    int dlc;            
  } msg;
  struct {
    int64_t startTime;    
    int sampleFreq;       
    int startValue;       
    int edgeCount;        
    int edgeTimes[8192];  
  } sample;
} kvDiagSample;

typedef struct {
  int analyzerNo;
  int type;
  int version_major;
  int version_minor;
} kvAnalyzerInfo_t;


canStatus CANLIBAPI kvDiagGetNumberOfAnalyzers(const canHandle canHnd,
                                               int *analyzerCount);

canStatus CANLIBAPI kvDiagGetAnalyzerInfo(const canHandle canHnd,
                                          kvAnalyzerInfo_t* info);

canStatus CANLIBAPI kvDiagAttachAnalyzer(const canHandle canHnd, int type);

canStatus CANLIBAPI kvDiagDetachAnalyzer(const canHandle canHnd);

canStatus CANLIBAPI kvDiagSetProgram(const canHandle canHnd,
                                     int programType,
                                     const char *const configBuffer);

canStatus CANLIBAPI kvDiagStart(const canHandle canHnd);

canStatus CANLIBAPI kvDiagStop(const canHandle canHnd);

canStatus CANLIBAPI kvDiagReadSample(const canHandle canHnd,
                                     kvDiagSample *sample);

canStatus CANLIBAPI kvDiagReadSampleWait(const canHandle canHnd,
                                         kvDiagSample *sample,
                                         int timeout);


canStatus CANLIBAPI kvDiagCalculateBitrate(const canHandle canHnd, bitrates_t *btr);

canStatus CANLIBAPI kvDiagResetBitrateCalculation(const canHandle canHnd);

canStatus CANLIBAPI kvDiagCalculateClockOffset(const canHandle canHnd,
                                               int id,
                                               double *fMin,
                                               double *fMax,
                                               double *fMean,
                                               double *fStd,
                                               int *n);

canStatus CANLIBAPI kvDiagResetClockOffsetCalculation(const canHandle canHnd);


#ifdef __cplusplus
}
#endif

#endif // _KVDIAG_H_