canlib.kvmlib¶
Wrapper for the Kvaser kvmlib library
The kvmlib is used to interact with Kvaser Memorator devices that can record CAN messages (E.g. Kvaser Memorator Professional 5xHS). You can download configuration data (e.g. triggers, filters, scripts) allowing you to disconnect the device from your computer, connect the device to a CAN bus and let it record the traffic autonomously. When done, you can reconnect the device with your computer and use kvmlib to get the recorded data.
-
class
canlib.kvmlib.Device[source]¶ Bases:
canlib.cenum.CEnumkvmDEVICE_xxx
Device type, used to connect to a Memorator device.
-
MHYDRA= 0¶
-
MHYDRA_EXT= 1¶
-
-
class
canlib.kvmlib.Error[source]¶ Bases:
canlib.cenum.CEnum-
CONFIG_ERROR= -41¶
-
CRC_ERROR= -21¶
-
DEVICE_COMM_ERROR= -37¶
-
DISKFULL_DATA= -26¶
-
DISKFULL_DIR= -25¶
-
DISK_ERROR= -24¶
-
EOF= -12¶
-
FAIL= -1¶
-
FATAL_ERROR= -31¶
-
FILE_ERROR= -23¶
-
FILE_NOT_FOUND= -33¶
-
FILE_SYSTEM_CORRUPT= -28¶
-
FIRMWARE= -40¶
-
ILLEGAL_REQUEST= -32¶
-
LOGFILEOPEN= -8¶
-
LOGFILEREAD= -14¶
-
LOGFILEWRITE= -11¶
-
NOLOGMSG= -10¶
-
NOSTARTTIME= -9¶
-
NOT_FORMATTED= -34¶
-
NOT_IMPLEMENTED= -30¶
-
NO_DISK= -13¶
-
OCCUPIED= -38¶
-
PARAM= -3¶
-
QUEUE_FULL= -20¶
-
SECTOR_ERASED= -22¶
-
SEQ_ERROR= -27¶
-
TIMEOUT= -36¶
-
UNSUPPORTED_VERSION= -29¶
-
USER_CANCEL= -39¶
-
WRITE_PROT= -42¶
-
WRONG_DISK_TYPE= -35¶
-
-
class
canlib.kvmlib.FileType[source]¶ Bases:
canlib.cenum.CEnumkvmFILE_xxx
KME file type, a binary file format representing log data.
-
KME24= 0¶
-
KME25= 1¶
-
KME40= 2¶
-
KME50= 3¶
-
-
exception
canlib.kvmlib.KvmDiskError[source]¶ Bases:
canlib.kvmlib.exceptions.KvmError-
status= -24¶
-
-
exception
canlib.kvmlib.KvmDiskNotFormated[source]¶ Bases:
canlib.kvmlib.exceptions.KvmDiskError-
status= -34¶
-
-
class
canlib.kvmlib.KvmLib[source]¶ Bases:
objectWrapper class for the Kvaser kvmlib.
This class wraps the Kvaser kvmlib dll. For more info, see the kvmlib help files which are availible in the CANlib SDK. https://www.kvaser.com/developer/canlib-sdk/
-
deviceMountKmf()[source]¶ Mount device log files (kmf)
Mount the log area on the SD card on a connected Kvaser Memorator and return the logger data format (LDF) version.
Returns: ldfVersion (str) – The logger data format (e.g. ‘5.0’)
-
dll= <canlib.kvmlib.dll.KvmlibDll object>¶
-
formatDisk[source]¶ Deprecated function
Deprecated since version 1.5: Use
deviceFormatDiskinstead.
-
getDiskSize[source]¶ Deprecated function
Deprecated since version 1.5: Use
deviceGetDiskSizeinstead.
-
getFileSystemUsage[source]¶ Deprecated function
Deprecated since version 1.5: Use
kmfGetUsageinstead.
-
getLogFileCount[source]¶ Deprecated function
Deprecated since version 1.5: Use
logFileGetCountinstead.
-
getRTC[source]¶ Deprecated function
Deprecated since version 1.5: Use
deviceGetRTCinstead.
-
getSerialNumber[source]¶ Deprecated function
Deprecated since version 1.5: Use
deviceGetSerialNumberinstead.
-
getVersion()[source]¶ Get the kvmlib version number.
Returns the kvmlib version number from the kvmlib DLL currently in use.
Deprecated since version 1.5: Use
dllversioninstead.Parameters: None Returns: version (kvmVersion) – Major and minor version number
-
isDiskPresent[source]¶ Deprecated function
Deprecated since version 1.5: Use
deviceGetDiskStatusinstead.
-
kmeScanFileType(filename)[source]¶ Scan KME file and report version
Open and read the file filename and try to decode what version of KME it contains. Returns type as kvmFILE_xxx.
-
logCloseFile[source]¶ Deprecated function
Deprecated since version 1.5: Use
logFileDismountinstead.
-
logOpenFile[source]¶ Deprecated function
Deprecated since version 1.5: Use
logFileMountinstead.
-
logReadEventEx[source]¶ Deprecated function
Deprecated since version 1.5: Use
logFileReadEventinstead.
-
logReadEvents[source]¶ Deprecated function
Deprecated since version 1.5: Use
logFileReadEventsinstead.
-
openDeviceEx[source]¶ Deprecated function
Deprecated since version 1.5: Use
deviceOpeninstead.
-
openLog[source]¶ Deprecated function
Deprecated since version 1.5: Use
deviceMountKmfinstead.
-
readConfig[source]¶ Deprecated function
Deprecated since version 1.5: Use
kmfReadConfiginstead.
-
readEvents[source]¶ Deprecated function
Deprecated since version 1.5: Use
logFileReadEventsinstead.
-
setRTC[source]¶ Deprecated function
Deprecated since version 1.5: Use
deviceSetRTCinstead.
-
validateDisk[source]¶ Deprecated function
Deprecated since version 1.5: Use
kmfValidateinstead.
-
writeConfigLif[source]¶ writeConfig
Deprecated since version 1.5: Use
kmfWriteConfiginstead.
-
-
exception
canlib.kvmlib.KvmNoDisk[source]¶ Bases:
canlib.kvmlib.exceptions.KvmDiskError-
status= -13¶
-
-
class
canlib.kvmlib.LoggerDataFormat[source]¶ Bases:
canlib.cenum.CEnumkvmLDF_MAJOR_xxx
Logged data format (LDF) version.
-
MAJOR_CAN= 3¶
-
MAJOR_CAN64= 5¶
-
-
class
canlib.kvmlib.MessageEvent(id=None, channel=None, dlc=None, flags=None, data=None, timestamp=None)[source]¶ Bases:
canlib.kvmlib.events.LogEvent
-
class
canlib.kvmlib.RTCEvent(calendartime=None, timestamp=None)[source]¶ Bases:
canlib.kvmlib.events.LogEvent
-
class
canlib.kvmlib.TriggerEvent(type=None, timestamp=None, pretrigger=None, posttrigger=None, trigno=None)[source]¶ Bases:
canlib.kvmlib.events.LogEvent
-
class
canlib.kvmlib.VersionEvent(lioMajor, lioMinor, fwMajor, fwMinor, fwBuild, serialNumber, eanHi, eanLo)[source]¶ Bases:
canlib.kvmlib.events.LogEvent
-
canlib.kvmlib.kvmDiskError¶ alias of
canlib.kvmlib.exceptions.KvmDiskError
-
canlib.kvmlib.kvmDiskNotFormated¶ alias of
canlib.kvmlib.exceptions.KvmDiskNotFormated
-
canlib.kvmlib.kvmError¶ alias of
canlib.kvmlib.exceptions.KvmError
-
canlib.kvmlib.kvmNoDisk¶ alias of
canlib.kvmlib.exceptions.KvmNoDisk
-
canlib.kvmlib.kvmNoLogMsg¶ alias of
canlib.kvmlib.exceptions.KvmNoLogMsg
-
canlib.kvmlib.kvmlib¶ alias of
canlib.kvmlib.wrapper.KvmLib
-
class
canlib.kvmlib.logMsg(*args, **kwargs)¶ Bases:
canlib.kvmlib.events.MessageEvent,objectDeprecated name for
MessageEventlogMsghas been renamedMessageEvent, using the old name (logMsg) is deprecated.
-
class
canlib.kvmlib.memoLogEventEx[source]¶ Bases:
_ctypes.Structure-
MEMOLOG_TYPE_CLOCK= 1¶
-
MEMOLOG_TYPE_INVALID= 0¶
-
MEMOLOG_TYPE_MSG= 2¶
-
MEMOLOG_TYPE_TRIGGER= 3¶
-
MEMOLOG_TYPE_VERSION= 4¶
-
event¶ Structure/Union member
-
-
class
canlib.kvmlib.memoLogMrtEx[source]¶ Bases:
_ctypes.Union-
msg¶ Structure/Union member
-
raw¶ Structure/Union member
-
rtc¶ Structure/Union member
-
trig¶ Structure/Union member
-
ver¶ Structure/Union member
-
-
class
canlib.kvmlib.memoLogMsgEx[source]¶ Bases:
_ctypes.Structure-
channel¶ Structure/Union member
-
data¶ Structure/Union member
-
dlc¶ Structure/Union member
-
evType¶ Structure/Union member
-
flags¶ Structure/Union member
-
id¶ Structure/Union member
-
timeStamp¶ Structure/Union member
-
-
class
canlib.kvmlib.memoLogRaw[source]¶ Bases:
_ctypes.Structure-
data¶ Structure/Union member
-
evType¶ Structure/Union member
-
-
class
canlib.kvmlib.memoLogRtcClockEx[source]¶ Bases:
_ctypes.Structure-
calendarTime¶ Structure/Union member
-
evType¶ Structure/Union member
-
padding¶ Structure/Union member
-
timeStamp¶ Structure/Union member
-
-
class
canlib.kvmlib.memoLogTriggerEx[source]¶ Bases:
_ctypes.Structure-
evType¶ Structure/Union member
-
padding¶ Structure/Union member
-
postTrigger¶ Structure/Union member
-
preTrigger¶ Structure/Union member
-
timeStampHi¶ Structure/Union member
-
timeStampLo¶ Structure/Union member
-
trigNo¶ Structure/Union member
-
type¶ Structure/Union member
-
-
class
canlib.kvmlib.memoLogVersionEx[source]¶ Bases:
_ctypes.Structure-
eanHi¶ Structure/Union member
-
eanLo¶ Structure/Union member
-
evType¶ Structure/Union member
-
fwBuild¶ Structure/Union member
-
fwMajor¶ Structure/Union member
-
fwMinor¶ Structure/Union member
-
lioMajor¶ Structure/Union member
-
lioMinor¶ Structure/Union member
-
serialNumber¶ Structure/Union member
-
-
class
canlib.kvmlib.memoMsg(*args, **kwargs)¶ Bases:
canlib.kvmlib.events.LogEvent,objectDeprecated name for
LogEventmemoMsghas been renamedLogEvent, using the old name (memoMsg) is deprecated.
-
class
canlib.kvmlib.rtcMsg(*args, **kwargs)¶ Bases:
canlib.kvmlib.events.RTCEvent,objectDeprecated name for
RTCEventrtcMsghas been renamedRTCEvent, using the old name (rtcMsg) is deprecated.
-
class
canlib.kvmlib.trigMsg(*args, **kwargs)¶ Bases:
canlib.kvmlib.events.TriggerEvent,objectDeprecated name for
TriggerEventtrigMsghas been renamedTriggerEvent, using the old name (trigMsg) is deprecated.
-
class
canlib.kvmlib.verMsg(*args, **kwargs)¶ Bases:
canlib.kvmlib.events.VersionEvent,objectDeprecated name for
VersionEventverMsghas been renamedVersionEvent, using the old name (verMsg) is deprecated.