kvlclib.h

Go to the documentation of this file.

/*
 *             Copyright 2017 by Kvaser AB, Molndal, Sweden
 *                         http://www.kvaser.com
 *
 * This software is dual licensed under the following two licenses:
 * BSD-new and GPLv2.You may use either one. See the included
 * COPYING file for details.
 *
 * License: BSD-new
 * ==============================================================================
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * License: GPLv2
 * ==============================================================================
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 *
 *
 * IMPORTANT NOTICE:
 * ==============================================================================
 * This source code is made available for free, as an open license, by Kvaser AB,
 * for use with its applications. Kvaser AB does not accept any liability
 * whatsoever for any third party patent or other immaterial property rights
 * violations that may result from any usage of this source code, regardless of
 * the combination of source code and various applications that it can be used
 * in, or with.
 *
 * -----------------------------------------------------------------------------
 */

#ifndef KVLCLIB_H
#define KVLCLIB_H

#include <stdint.h>
#include <stddef.h>
#define WINAPI

#include "kvaDbLib.h"

#ifdef __cplusplus
extern "C"
{
#endif // __cplusplus

  typedef int KvlcStatus;
  typedef void *KvlcHandle;
typedef uint64_t time_uint64;
typedef int64_t time_int64;
typedef int64_t int64;
typedef uint64_t uint64;
#pragma pack(push, 1)

  typedef struct
  {
    int64 fileSize;                
    int64 eventCount;              
    time_int64 startOfMeasurement; 
    unsigned int channelMask;      
    unsigned int canChannelMask;   
    unsigned int linChannelMask;   
    unsigned int directionMask;    
  } kvlcReaderInfo;

  typedef struct
  {
    unsigned int id;        
    time_int64 timeStamp;   
    unsigned int channel;   
    unsigned int dlc;       
    unsigned int flags;     
    unsigned char data[64]; 
  } kvlcLogMsgEx;

  typedef struct
  {
    unsigned int calendarTime; 
    time_int64 timeStamp;      
  } kvlcLogRtcClockEx;

  typedef struct
  {
    int type;              
    int preTrigger;        
    int postTrigger;       
    unsigned int trigMask; 
    time_int64 timeStamp;  
  } kvlcLogTriggerEx;

  typedef struct
  {
    unsigned int lioMajor;     // Lio major version
    unsigned int lioMinor;     // Lio minor version
    unsigned int fwMajor;      // Firmware major version
    unsigned int fwMinor;      // Firmware major version
    unsigned int fwBuild;      // Firmware build version
    unsigned int serialNumber; // Serial number
    unsigned int eanHi;        // EAN high bytes
    unsigned int eanLo;        // EAN low bytes
  } kvlcLogVersionEx;

  typedef struct
  {
    unsigned int type; 
    union
    {
      kvlcLogMsgEx msg;       
      kvlcLogRtcClockEx rtc;  
      kvlcLogTriggerEx trig;  
      kvlcLogVersionEx ver;   
      unsigned char raw[128]; 
    } eventUnion;
  } kvlcLogEventEx;

#pragma pack(pop)

#define KVLC_LOG_TYPE_INVALID 0 
#define KVLC_LOG_TYPE_CLOCK 1   
#define KVLC_LOG_TYPE_MSG 2     
#define KVLC_LOG_TYPE_TRIGGER 3 
#define KVLC_LOG_TYPE_VERSION 4 
#define KVLC_LOG_TYPE_LINMSG 5  

#define KVLC_DIR_RX 0x01 
#define KVLC_DIR_TX 0x02 

#define KVLC_DEFAULT_SCAN_EVENT_COUNT 10000u

#define kvlcOK ((KvlcStatus)0)                        
#define kvlcFail ((KvlcStatus) - 1)                   
#define kvlcERR_PARAM ((KvlcStatus) - 2)              
#define kvlcEOF ((KvlcStatus) - 3)                    
#define kvlcERR_NOT_IMPLEMENTED ((KvlcStatus) - 4)    
#define kvlcERR_FILE_ERROR ((KvlcStatus) - 5)         
#define kvlcERR_FILE_EXISTS ((KvlcStatus) - 6)        
#define kvlcERR_INTERNAL_ERROR ((KvlcStatus) - 7)     
#define kvlcERR_NULL_POINTER ((KvlcStatus) - 8)       
#define kvlcERR_FILE_TOO_LARGE ((KvlcStatus) - 10)    
#define kvlcERR_TYPE_MISMATCH ((KvlcStatus) - 11)     
#define kvlcERR_NO_FREE_HANDLES ((KvlcStatus) - 12)   
#define kvlcERR_NO_INPUT_SELECTED ((KvlcStatus) - 13) 
#define kvlcERR_CONVERTING ((KvlcStatus) - 14)        
#define kvlcERR_BUFFER_SIZE ((KvlcStatus) - 15)       

#define kvlcERR_INVALID_LOG_EVENT ((KvlcStatus) - 30)   
#define kvlcERR_NO_TIME_REFERENCE ((KvlcStatus) - 31)   
#define kvlcERR_TIME_DECREASING ((KvlcStatus) - 32)     
#define kvlcERR_MIXED_ENDIANNESS ((KvlcStatus) - 33)    
#define kvlcERR_RESULT_TOO_BIG ((KvlcStatus) - 34)      
#define kvlcERR_UNSUPPORTED_VERSION ((KvlcStatus) - 35) 


#define KVLC_FILE_FORMAT_KME24 1      
#define KVLC_FILE_FORMAT_KME25 2      
#define KVLC_FILE_FORMAT_VECTOR_ASC 3 
#define KVLC_FILE_FORMAT_CSV 4        
#define KVLC_FILE_FORMAT_PLAIN_ASC 5  
#define KVLC_FILE_FORMAT_MEMO_LOG 6   
#define KVLC_FILE_FORMAT_KME40 7      
#define KVLC_FILE_FORMAT_VECTOR_BLF 8 
#define KVLC_FILE_FORMAT_KME50 9      
#define KVLC_FILE_FORMAT_KME60 10     

#define KVLC_FILE_FORMAT_CSV_SIGNAL 100    
#define KVLC_FILE_FORMAT_MDF 101           
#define KVLC_FILE_FORMAT_MATLAB 102        
#define KVLC_FILE_FORMAT_J1587 103         
#define KVLC_FILE_FORMAT_J1587_ALT 104     
#define KVLC_FILE_FORMAT_FAMOS 105         
#define KVLC_FILE_FORMAT_MDF_SIGNAL 106    
#define KVLC_FILE_FORMAT_MDF_4X 107        
#define KVLC_FILE_FORMAT_MDF_4X_SIGNAL 108 
#define KVLC_FILE_FORMAT_VECTOR_BLF_FD 109 
#define KVLC_FILE_FORMAT_DIADEM 110        
#define KVLC_FILE_FORMAT_RPCIII 111        

#define KVLC_FILE_FORMAT_XCP 200       
#define KVLC_FILE_FORMAT_FAMOS_XCP 201 

#define KVLC_FILE_FORMAT_DEBUG 1000 

#define KVLC_PROPERTY_START_OF_MEASUREMENT 1

#define KVLC_PROPERTY_FIRST_TRIGGER 2

#define KVLC_PROPERTY_USE_OFFSET 3

#define KVLC_PROPERTY_OFFSET 4

#define KVLC_PROPERTY_CHANNEL_MASK 5

#define KVLC_PROPERTY_HLP_J1939 6            
#define KVLC_PROPERTY_CALENDAR_TIME_STAMPS 7 
#define KVLC_PROPERTY_WRITE_HEADER 8         
#define KVLC_PROPERTY_SEPARATOR_CHAR 9       
#define KVLC_PROPERTY_DECIMAL_CHAR 10        

#define KVLC_PROPERTY_ID_IN_HEX 11               
#define KVLC_PROPERTY_DATA_IN_HEX 12             
#define KVLC_PROPERTY_NUMBER_OF_TIME_DECIMALS 13 
#define KVLC_PROPERTY_NAME_MANGLING 14           
#define KVLC_PROPERTY_FILL_BLANKS 15             

#define KVLC_PROPERTY_SHOW_UNITS 16       
#define KVLC_PROPERTY_ISO8601_DECIMALS 17 
#define KVLC_PROPERTY_MERGE_LINES 18      
#define KVLC_PROPERTY_RESAMPLE_COLUMN 19  
#define KVLC_PROPERTY_VERSION 20          

#define KVLC_PROPERTY_SHOW_COUNTER 21 

#define KVLC_PROPERTY_CROP_PRETRIGGER 22
#define KVLC_PROPERTY_ENUM_VALUES 23 
#define KVLC_PROPERTY_SIZE_LIMIT 24  


#define KVLC_PROPERTY_TIME_LIMIT 25

#define KVLC_PROPERTY_LIMIT_DATA_BYTES 26
#define KVLC_PROPERTY_CREATION_DATE 27 


#define KVLC_PROPERTY_OVERWRITE 28
#define KVLC_PROPERTY_TIMEZONE 29 


#define KVLC_PROPERTY_FULLY_QUALIFIED_NAMES 30

#define KVLC_PROPERTY_NUMBER_OF_DATA_DECIMALS 31 


#define KVLC_PROPERTY_COMPRESSION_LEVEL 32

#define KVLC_PROPERTY_SAMPLE_AND_HOLD_TIMESTEP 33

#define KVLC_PROPERTY_SIGNAL_BASED 1001

#define KVLC_PROPERTY_SHOW_SIGNAL_SELECT 1002

#define KVLC_PROPERTY_ATTACHMENTS 1003

#define KVLC_PROPERTY_LIN_FRAMES 1004

  KvlcStatus WINAPI kvlcGetErrorText(KvlcStatus error, char *buffer, unsigned int buffer_size);

  KvlcStatus WINAPI kvlcGetVersion(unsigned int *major, unsigned int *minor, unsigned int *build);

  KvlcStatus WINAPI kvlcCreateConverter(KvlcHandle *handle, const char *filename, int format);

  KvlcStatus WINAPI kvlcDeleteConverter(KvlcHandle handle);

  KvlcStatus WINAPI kvlcCreateReader(KvlcHandle *handle, const char *filename, int format);

  KvlcStatus WINAPI kvlcDeleteReader(KvlcHandle handle);

  KvlcStatus WINAPI kvlcReadInfo(KvlcHandle handle, kvlcReaderInfo *info,
                                 unsigned int maxEvents);

  KvlcStatus WINAPI kvlcReadNextEvent(KvlcHandle handle, kvlcLogEventEx *e);

  KvlcStatus WINAPI kvlcReadFirstEventAtOrAfter(KvlcHandle handle, time_int64 timestamp, kvlcLogEventEx *e);

  KvlcStatus WINAPI kvlcEventCount(KvlcHandle handle, unsigned int *count);

  KvlcStatus WINAPI kvlcEventCountEx(KvlcHandle handle, int64 *count);

  KvlcStatus WINAPI kvlcConvertEvent(KvlcHandle handle);

  KvlcStatus WINAPI kvlcSetInputFile(KvlcHandle handle, const char *filename, int format);

  KvlcStatus WINAPI kvlcNextInputFile(KvlcHandle handle, const char *filename);

  KvlcStatus WINAPI kvlcFeedSelectFormat(KvlcHandle handle, int format);

  KvlcStatus WINAPI kvlcFeedLogEvent(KvlcHandle handle, void *event);

  KvlcStatus WINAPI kvlcFeedNextFile(KvlcHandle handle);

  KvlcStatus WINAPI kvlcIsOutputFilenameNew(KvlcHandle handle, int *updated);

  KvlcStatus WINAPI kvlcGetOutputFilename(KvlcHandle handle, char *filename, int len);

  KvlcStatus WINAPI kvlcGetWriterPropertyDefault(int format, unsigned int property, void *buf, unsigned int len);

  KvlcStatus WINAPI kvlcSetProperty(KvlcHandle handle, unsigned int property, void *buf, unsigned int len);

  KvlcStatus WINAPI kvlcGetProperty(KvlcHandle handle, unsigned int property, void *buf, unsigned int len);

  KvlcStatus WINAPI kvlcIsOverrunActive(KvlcHandle handle, int *overrun);

  KvlcStatus WINAPI kvlcResetOverrunActive(KvlcHandle handle);

  KvlcStatus WINAPI kvlcIsDataTruncated(KvlcHandle handle, int *truncated);

  KvlcStatus WINAPI kvlcResetDataTruncated(KvlcHandle handle);

  KvlcStatus WINAPI kvlcAttachFile(KvlcHandle handle, const char *filename);

  KvlcStatus WINAPI kvlcGetFirstWriterFormat(int *format);

  KvlcStatus WINAPI kvlcGetNextWriterFormat(int currentFormat, int *nextFormat);

  KvlcStatus WINAPI kvlcGetFirstReaderFormat(int *format);

  KvlcStatus WINAPI kvlcGetNextReaderFormat(int currentFormat, int *nextFormat);

  KvlcStatus WINAPI kvlcGetReaderName(int format, char *str, unsigned int len);

  KvlcStatus WINAPI kvlcGetReaderExtension(int format, char *str, unsigned int len);

  KvlcStatus WINAPI kvlcGetReaderDescription(int format, char *str, unsigned int len);

  KvlcStatus WINAPI kvlcGetReaderPropertyDefault(int format, unsigned int property, void *buf, unsigned int len);

  KvlcStatus WINAPI kvlcGetWriterName(int format, char *str, unsigned int len);

  KvlcStatus WINAPI kvlcGetWriterExtension(int format, char *str, unsigned int len);

  KvlcStatus WINAPI kvlcGetWriterDescription(int format, char *str, unsigned int len);

  KvlcStatus WINAPI kvlcIsPropertySupported(int format, unsigned int property, int *supported);

  KvlcStatus WINAPI kvlcAddDatabaseFile(KvlcHandle handle, const char *filename, unsigned int channelMask);

  KvlcStatus WINAPI kvlcAddDatabase(KvlcHandle handle, KvaDbHnd dbHandle, unsigned int channelMask);

  KvlcStatus WINAPI kvlcIsDlcMismatch(KvlcHandle handle, int *mismatch);

  KvlcStatus WINAPI kvlcResetDlcMismatch(KvlcHandle handle);

  KvlcStatus WINAPI kvlcGetDlcMismatchList(KvlcHandle handle, unsigned int *MsgIds, unsigned int *MsgDlc, unsigned int *MsgOccurance, unsigned int *length);

#ifdef __cplusplus
};
#endif

#endif // KVLCLIB_H