@kvaser/canking-api 7.2.1 → 7.4.0

package/doc_md/models/enumerations/CanMode.md

@@ -0,0 +1,53 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanMode
+
+# Enumeration: CanMode
+
+Possible CAN modes.
+
+## Enumeration Members
+
+### CAN\_MODE\_CAN
+
+> **CAN\_MODE\_CAN**: `1`
+
+CAN_MODE_CAN - Classic CAN mode.
+
+***
+
+### CAN\_MODE\_CAN\_FD
+
+> **CAN\_MODE\_CAN\_FD**: `2`
+
+CAN_MODE_CAN_FD - CAN FD mode.
+
+***
+
+### CAN\_MODE\_CAN\_FD\_NONISO
+
+> **CAN\_MODE\_CAN\_FD\_NONISO**: `3`
+
+CAN_MODE_CAN_FD_NONISO - CAN FD non-ISO mode.
+
+***
+
+### CAN\_MODE\_CAN\_XL
+
+> **CAN\_MODE\_CAN\_XL**: `4`
+
+CAN_MODE_CAN_XL - CAN XL mode.
+
+***
+
+### CAN\_MODE\_UNSPECIFIED
+
+> **CAN\_MODE\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/DecimalChar.md

@@ -0,0 +1,37 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / DecimalChar
+
+# Enumeration: DecimalChar
+
+Possible decimal separators for loggers.
+
+## Enumeration Members
+
+### DECIMAL\_CHAR\_DEC\_COMMA
+
+> **DECIMAL\_CHAR\_DEC\_COMMA**: `2`
+
+DECIMAL_CHAR_DEC_COMMA - Comma (,) separator
+
+***
+
+### DECIMAL\_CHAR\_DEC\_DOT
+
+> **DECIMAL\_CHAR\_DEC\_DOT**: `1`
+
+DECIMAL_CHAR_DEC_DOT - Dot (.) separator
+
+***
+
+### DECIMAL\_CHAR\_UNSPECIFIED
+
+> **DECIMAL\_CHAR\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/FileConflictAction.md

@@ -0,0 +1,45 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FileConflictAction
+
+# Enumeration: FileConflictAction
+
+Possible actions to use if a log file already exists with the same name.
+
+## Enumeration Members
+
+### FILE\_CONFLICT\_ACTION\_APPEND\_INDEX
+
+> **FILE\_CONFLICT\_ACTION\_APPEND\_INDEX**: `2`
+
+FILE_CONFLICT_ACTION_APPEND_INDEX - Append an index to the file name.
+
+***
+
+### FILE\_CONFLICT\_ACTION\_APPEND\_TIMESTAMP
+
+> **FILE\_CONFLICT\_ACTION\_APPEND\_TIMESTAMP**: `3`
+
+FILE_CONFLICT_ACTION_APPEND_TIMESTAMP - Append a timestamp to the file name.
+
+***
+
+### FILE\_CONFLICT\_ACTION\_OVERWRITE
+
+> **FILE\_CONFLICT\_ACTION\_OVERWRITE**: `1`
+
+FILE_CONFLICT_ACTION_OVERWRITE - Overwrite the existing file.
+
+***
+
+### FILE\_CONFLICT\_ACTION\_UNSPECIFIED
+
+> **FILE\_CONFLICT\_ACTION\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/LinFrameFlag.md

@@ -0,0 +1,87 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LinFrameFlag
+
+# Enumeration: LinFrameFlag
+
+Possible LIN frame flags. The flag value must match the linlib flag value.
+
+## Enumeration Members
+
+### LIN\_FRAME\_FLAG\_BIT\_ERROR
+
+> **LIN\_FRAME\_FLAG\_BIT\_ERROR**: `128`
+
+LIN_FRAME_FLAG_BIT_ERROR - Bit error when transmitting.
+
+***
+
+### LIN\_FRAME\_FLAG\_CSUM\_ERROR
+
+> **LIN\_FRAME\_FLAG\_CSUM\_ERROR**: `16`
+
+LIN_FRAME_FLAG_CSUM_ERROR - Checksum error.
+
+***
+
+### LIN\_FRAME\_FLAG\_NODATA
+
+> **LIN\_FRAME\_FLAG\_NODATA**: `8`
+
+LIN_FRAME_FLAG_NODATA - No data, only a header.
+
+***
+
+### LIN\_FRAME\_FLAG\_PARITY\_ERROR
+
+> **LIN\_FRAME\_FLAG\_PARITY\_ERROR**: `32`
+
+LIN_FRAME_FLAG_PARITY_ERROR - ID parity error.
+
+***
+
+### LIN\_FRAME\_FLAG\_RX
+
+> **LIN\_FRAME\_FLAG\_RX**: `2`
+
+LIN_FRAME_FLAG_RX - The message was something we received from the bus.
+
+***
+
+### LIN\_FRAME\_FLAG\_SYNCH\_ERROR
+
+> **LIN\_FRAME\_FLAG\_SYNCH\_ERROR**: `64`
+
+LIN_FRAME_FLAG_SYNCH_ERROR - A synch error.
+
+***
+
+### LIN\_FRAME\_FLAG\_TX
+
+> **LIN\_FRAME\_FLAG\_TX**: `1`
+
+LIN_FRAME_FLAG_TX - The message was something we transmitted to the bus.
+
+***
+
+### LIN\_FRAME\_FLAG\_UNSPECIFIED
+
+> **LIN\_FRAME\_FLAG\_UNSPECIFIED**: `0`
+
+LIN_FRAME_FLAG_UNSPECIFIED - No flag has been set.
+
+***
+
+### LIN\_FRAME\_FLAG\_WAKEUP\_FRAME
+
+> **LIN\_FRAME\_FLAG\_WAKEUP\_FRAME**: `4`
+
+LIN_FRAME_FLAG_WAKEUP_FRAME - A wake up frame was received. Id/msg/dlc are undefined.
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/LogFileFormat.md

@@ -0,0 +1,199 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LogFileFormat
+
+# Enumeration: LogFileFormat
+
+Possible log file formats. The values must match the kvlclib FILE_FORMAT values.
+
+## Enumeration Members
+
+### LOG\_FILE\_FORMAT\_CSV
+
+> **LOG\_FILE\_FORMAT\_CSV**: `4`
+
+LOG_FILE_FORMAT_CSV - Output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_CSV\_SIGNAL
+
+> **LOG\_FILE\_FORMAT\_CSV\_SIGNAL**: `100`
+
+LOG_FILE_FORMAT_CSV_SIGNAL - Output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_DEBUG
+
+> **LOG\_FILE\_FORMAT\_DEBUG**: `1000`
+
+LOG_FILE_FORMAT_DEBUG - Reserved for debug.
+
+***
+
+### LOG\_FILE\_FORMAT\_FAMOS
+
+> **LOG\_FILE\_FORMAT\_FAMOS**: `105`
+
+LOG_FILE_FORMAT_FAMOS - Output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_FAMOS\_XCP
+
+> **LOG\_FILE\_FORMAT\_FAMOS\_XCP**: `201`
+
+LOG_FILE_FORMAT_FAMOS_XCP - Not supported.
+
+***
+
+### LOG\_FILE\_FORMAT\_J1587\_ALT
+
+> **LOG\_FILE\_FORMAT\_J1587\_ALT**: `104`
+
+LOG_FILE_FORMAT_J1587_ALT - Output file format. Currently not supported.
+LOG_FILE_FORMAT_J1587 = 103;
+Obsolete.
+
+***
+
+### LOG\_FILE\_FORMAT\_KME24
+
+> **LOG\_FILE\_FORMAT\_KME24**: `1`
+
+LOG_FILE_FORMAT_KME24 - Input and output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_KME25
+
+> **LOG\_FILE\_FORMAT\_KME25**: `2`
+
+LOG_FILE_FORMAT_KME25 - Input and output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_KME40
+
+> **LOG\_FILE\_FORMAT\_KME40**: `7`
+
+LOG_FILE_FORMAT_KME40 - Input and output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_KME50
+
+> **LOG\_FILE\_FORMAT\_KME50**: `9`
+
+LOG_FILE_FORMAT_KME50 - Input and output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_KME60
+
+> **LOG\_FILE\_FORMAT\_KME60**: `10`
+
+LOG_FILE_FORMAT_KME60 - Input and output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_MATLAB
+
+> **LOG\_FILE\_FORMAT\_MATLAB**: `102`
+
+LOG_FILE_FORMAT_MATLAB - Output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_MDF
+
+> **LOG\_FILE\_FORMAT\_MDF**: `101`
+
+LOG_FILE_FORMAT_MDF - Input and output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_MDF\_4X
+
+> **LOG\_FILE\_FORMAT\_MDF\_4X**: `107`
+
+LOG_FILE_FORMAT_MDF_4X - Output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_MDF\_4X\_SIGNAL
+
+> **LOG\_FILE\_FORMAT\_MDF\_4X\_SIGNAL**: `108`
+
+LOG_FILE_FORMAT_MDF_4X_SIGNAL - Output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_MDF\_SIGNAL
+
+> **LOG\_FILE\_FORMAT\_MDF\_SIGNAL**: `106`
+
+LOG_FILE_FORMAT_MDF_SIGNAL - Output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_MEMO\_LOG
+
+> **LOG\_FILE\_FORMAT\_MEMO\_LOG**: `6`
+
+LOG_FILE_FORMAT_MEMO_LOG - Input (internal device logfile format).
+
+***
+
+### LOG\_FILE\_FORMAT\_PLAIN\_ASC
+
+> **LOG\_FILE\_FORMAT\_PLAIN\_ASC**: `5`
+
+LOG_FILE_FORMAT_PLAIN_ASC - Input and output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_UNSPECIFIED
+
+> **LOG\_FILE\_FORMAT\_UNSPECIFIED**: `0`
+
+***
+
+### LOG\_FILE\_FORMAT\_VECTOR\_ASC
+
+> **LOG\_FILE\_FORMAT\_VECTOR\_ASC**: `3`
+
+LOG_FILE_FORMAT_VECTOR_ASC - Input and output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_VECTOR\_BLF
+
+> **LOG\_FILE\_FORMAT\_VECTOR\_BLF**: `8`
+
+LOG_FILE_FORMAT_VECTOR_BLF - Output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_VECTOR\_BLF\_FD
+
+> **LOG\_FILE\_FORMAT\_VECTOR\_BLF\_FD**: `109`
+
+LOG_FILE_FORMAT_VECTOR_BLF_FD - Input and output file format.
+
+***
+
+### LOG\_FILE\_FORMAT\_XCP
+
+> **LOG\_FILE\_FORMAT\_XCP**: `200`
+
+LOG_FILE_FORMAT_XCP - Not supported.
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/LogLevel.md

@@ -0,0 +1,76 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LogLevel
+
+# Enumeration: LogLevel
+
+Possible log levels.
+
+## Enumeration Members
+
+### LOG\_LEVEL\_CRITICAL
+
+> **LOG\_LEVEL\_CRITICAL**: `5`
+
+LOG_LEVEL_CRITICAL - Logs that describe an unrecoverable application or system crash, or a catastrophic failure that
+requires immediate attention.
+
+***
+
+### LOG\_LEVEL\_DEBUG
+
+> **LOG\_LEVEL\_DEBUG**: `1`
+
+LOG_LEVEL_DEBUG - Logs that are used for interactive investigation during development. These logs should primarily
+contain information useful for debugging and have no long-term value.
+
+***
+
+### LOG\_LEVEL\_ERROR
+
+> **LOG\_LEVEL\_ERROR**: `4`
+
+LOG_LEVEL_ERROR - Logs that highlight when the current flow of execution is stopped due to a failure. These should
+indicate a failure in the current activity, not an application-wide failure.
+
+***
+
+### LOG\_LEVEL\_INFORMATION
+
+> **LOG\_LEVEL\_INFORMATION**: `2`
+
+LOG_LEVEL_INFORMATION - Logs that track the general flow of the application. These logs should have long-term value.
+
+***
+
+### LOG\_LEVEL\_NONE
+
+> **LOG\_LEVEL\_NONE**: `6`
+
+LOG_LEVEL_NONE - Not used for writing log messages. Specifies that a logging category should not write any messages.
+
+***
+
+### LOG\_LEVEL\_TRACE
+
+> **LOG\_LEVEL\_TRACE**: `0`
+
+LOG_LEVEL_TRACE - Logs that contain the most detailed messages. These messages may contain sensitive application data.
+These messages are disabled by default and should never be enabled in a production environment.
+
+***
+
+### LOG\_LEVEL\_WARNING
+
+> **LOG\_LEVEL\_WARNING**: `3`
+
+LOG_LEVEL_WARNING - Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise
+cause the application execution to stop.
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/LogReplayState.md

@@ -0,0 +1,37 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LogReplayState
+
+# Enumeration: LogReplayState
+
+Possible log replay states.
+
+## Enumeration Members
+
+### LOG\_REPLAY\_STATE\_STARTED
+
+> **LOG\_REPLAY\_STATE\_STARTED**: `1`
+
+LOG_REPLAY_STATE_STARTED - The log replay is in started state.
+
+***
+
+### LOG\_REPLAY\_STATE\_STOPPED
+
+> **LOG\_REPLAY\_STATE\_STOPPED**: `2`
+
+LOG_REPLAY_STATE_STOPPED - The log replay is in stopped state.
+
+***
+
+### LOG\_REPLAY\_STATE\_UNSPECIFIED
+
+> **LOG\_REPLAY\_STATE\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/LoggerState.md

@@ -0,0 +1,45 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LoggerState
+
+# Enumeration: LoggerState
+
+Possible message or signal logger states.
+
+## Enumeration Members
+
+### MESSAGE\_LOGGER\_STATE\_PRESTART
+
+> **MESSAGE\_LOGGER\_STATE\_PRESTART**: `1`
+
+MESSAGE_LOGGER_STATE_PRESTART - The logger is in the pre-start state.
+
+***
+
+### MESSAGE\_LOGGER\_STATE\_STARTED
+
+> **MESSAGE\_LOGGER\_STATE\_STARTED**: `2`
+
+MESSAGE_LOGGER_STATE_STARTED - The logger is currently started.
+
+***
+
+### MESSAGE\_LOGGER\_STATE\_STOPPED
+
+> **MESSAGE\_LOGGER\_STATE\_STOPPED**: `3`
+
+MESSAGE_LOGGER_STATE_STOPPED - The logger is currently stopped.
+
+***
+
+### MESSAGE\_LOGGER\_STATE\_UNSPECIFIED
+
+> **MESSAGE\_LOGGER\_STATE\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/Separator.md

@@ -0,0 +1,37 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Separator
+
+# Enumeration: Separator
+
+Possible column separators for loggers.
+
+## Enumeration Members
+
+### SEPARATOR\_COMMA
+
+> **SEPARATOR\_COMMA**: `1`
+
+SEPARATOR_COMMA - Comma (,) separator
+
+***
+
+### SEPARATOR\_SEMICOLON
+
+> **SEPARATOR\_SEMICOLON**: `2`
+
+SEPARATOR_SEMICOLON - Semicolon (;) separator
+
+***
+
+### SEPARATOR\_UNSPECIFIED
+
+> **SEPARATOR\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/SignalEncoding.md

@@ -0,0 +1,31 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SignalEncoding
+
+# Enumeration: SignalEncoding
+
+Possible signal encodings. The value must match the kvadblib value.
+
+## Enumeration Members
+
+### SIGNAL\_ENCODING\_INTEL
+
+> **SIGNAL\_ENCODING\_INTEL**: `0`
+
+SIGNAL_ENCODING_INTEL - Intel / little endian encoding
+
+***
+
+### SIGNAL\_ENCODING\_MOTOROLA
+
+> **SIGNAL\_ENCODING\_MOTOROLA**: `1`
+
+SIGNAL_ENCODING_MOTOROLA - Motorola / big endian encoding
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/SignalType.md

@@ -0,0 +1,53 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SignalType
+
+# Enumeration: SignalType
+
+Possible signal types. The value must match the kvadblib value.
+
+## Enumeration Members
+
+### SIGNAL\_TYPE\_DOUBLE
+
+> **SIGNAL\_TYPE\_DOUBLE**: `4`
+
+SIGNAL_TYPE_DOUBLE - Double, strictly 64 bit long
+
+***
+
+### SIGNAL\_TYPE\_FLOAT
+
+> **SIGNAL\_TYPE\_FLOAT**: `3`
+
+SIGNAL_TYPE_FLOAT - Float, strictly 32 bit long
+
+***
+
+### SIGNAL\_TYPE\_INVALID
+
+> **SIGNAL\_TYPE\_INVALID**: `0`
+
+***
+
+### SIGNAL\_TYPE\_SIGNED
+
+> **SIGNAL\_TYPE\_SIGNED**: `1`
+
+SIGNAL_TYPE_SIGNED - Signed integer
+
+***
+
+### SIGNAL\_TYPE\_UNSIGNED
+
+> **SIGNAL\_TYPE\_UNSIGNED**: `2`
+
+SIGNAL_TYPE_UNSIGNED - Unsigned integer
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`