@kvaser/canking-api 7.2.1 → 7.3.0

package/doc_md/models/interfaces/LicenseInformation.md

@@ -0,0 +1,73 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LicenseInformation
+
+# Interface: LicenseInformation
+
+License information.
+
+## Properties
+
+### expirationDate
+
+> **expirationDate**: `Long`
+
+Expiration date as unix time is in seconds.
+
+***
+
+### instanceId
+
+> **instanceId**: `string`
+
+The instance identifier.
+
+***
+
+### instanceName
+
+> **instanceName**: `string`
+
+The instance name.
+
+***
+
+### isValid
+
+> **isValid**: `boolean`
+
+A flag indicating if the license is valid.
+
+***
+
+### licenseKey
+
+> **licenseKey**: `string`
+
+The license key.
+
+***
+
+### productId
+
+> **productId**: `string`
+
+The product identifier.
+
+***
+
+### productName
+
+> **productName**: `string`
+
+The product name.
+
+***
+
+### productVersion
+
+> **productVersion**: `string`
+
+The product version.

package/doc_md/models/interfaces/Licenses.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Licenses
+
+# Interface: Licenses
+
+A collection of licenses.
+
+## Properties
+
+### items
+
+> **items**: [`LicenseInformation`](LicenseInformation.md)[]
+
+The license information items.

package/doc_md/models/interfaces/LinChannelConfiguration.md

@@ -0,0 +1,57 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LinChannelConfiguration
+
+# Interface: LinChannelConfiguration
+
+A message for defining a LIN channel's configuration.
+
+## Properties
+
+### bitRate
+
+> **bitRate**: `number`
+
+Bit rate in bits per second, possible values are 1000-20000 bps.
+
+***
+
+### databaseFile?
+
+> `optional` **databaseFile**: `string`
+
+If master mode is set to true, this is the LIN configuration file to use.
+
+***
+
+### masterMode
+
+> **masterMode**: `boolean`
+
+Set to true to act as master, otherwise the channel will be setup as slave.
+
+***
+
+### protocolVersion
+
+> **protocolVersion**: `string`
+
+The LIN protocol version, possible values 1.3, 2.0, 2.1 or 2.2.
+
+***
+
+### saveMessageInfo
+
+> **saveMessageInfo**: `boolean`
+
+Set to true if LIN message info should be saved.
+
+***
+
+### scheduleTable?
+
+> `optional` **scheduleTable**: `string`
+
+If master mode is set to true, this is the schedule table to use.

package/doc_md/models/interfaces/LinFrameFlags.md

@@ -0,0 +1,10 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LinFrameFlags
+
+# Interface: LinFrameFlags
+
+A message holding a combination of LinFrameFlag enums.
+This is a work-around since it's not possible to use repeated fields as oneof fields.

package/doc_md/models/interfaces/LogMessage.md

@@ -0,0 +1,49 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LogMessage
+
+# Interface: LogMessage
+
+A log message.
+
+## Properties
+
+### categoryName
+
+> **categoryName**: `string`
+
+The category name.
+
+***
+
+### eventId
+
+> **eventId**: `number`
+
+The event identifier.
+
+***
+
+### logLevel
+
+> **logLevel**: [`LogLevel`](../enumerations/LogLevel.md)
+
+The log level.
+
+***
+
+### message
+
+> **message**: `string`
+
+The message.
+
+***
+
+### time
+
+> **time**: `Long`
+
+Time of the message.

package/doc_md/models/interfaces/LogMessages.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LogMessages
+
+# Interface: LogMessages
+
+A collection of log messages.
+
+## Properties
+
+### items
+
+> **items**: [`LogMessage`](LogMessage.md)[]
+
+The log message items.

package/doc_md/models/interfaces/LogReplaySettings.md

@@ -0,0 +1,109 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LogReplaySettings
+
+# Interface: LogReplaySettings
+
+A message for defining a log replay's settings.
+
+## Properties
+
+### channelIdentifiers
+
+> **channelIdentifiers**: `object`
+
+A dictionary consisting of the channels found in the log file mapped to the channel identifiers to be used when replaying the file.
+
+#### Index Signature
+
+\[`key`: `string`\]: `string`
+
+***
+
+### higherVariance?
+
+> `optional` **higherVariance**: `number`
+
+Maximum waiting time variance (0-1) for how long to wait before sending the next message. The resulting range will be between the time factor and the time factor plus the higher variance.
+
+***
+
+### includeErrorFrames
+
+> **includeErrorFrames**: `boolean`
+
+Replay error frames as well. Default value is false.
+
+***
+
+### increaseSpeed?
+
+> `optional` **increaseSpeed**: `boolean`
+
+Increase the speed by the time factor. Default value is true.
+
+***
+
+### iterations
+
+> **iterations**: `number`
+
+Number of iterations to loop the log file. Set to -1 to iterate forever. Default value is 1.
+
+***
+
+### logFile
+
+> **logFile**: `string`
+
+Full path to the log file to read CAN frames from.
+
+***
+
+### lowerVariance?
+
+> `optional` **lowerVariance**: `number`
+
+Minimum waiting time variance (0-1) for how long to wait before sending the next message. The resulting range will be between the time factor and the time factor minus the lower variance.
+
+***
+
+### sampleRateMs
+
+> **sampleRateMs**: `number`
+
+Static sample rate in milliseconds to send the CAN frames at. If zero, timestamps from the log file will be used. Default value is 0.
+
+***
+
+### sendFirstMessageMode
+
+> **sendFirstMessageMode**: `number`
+
+Send the first message straight away (1), after the time specified in the log file (2) or after an offset (3). Default value is 1 (send directly).
+
+***
+
+### timeFactor?
+
+> `optional` **timeFactor**: `number`
+
+Factor in percentage for speeding up or down the waiting time until sending the next message.
+
+***
+
+### timeOffsetMs?
+
+> `optional` **timeOffsetMs**: `number`
+
+Time offset in milliseconds until sending the first message. Default value is 0. This parameter shall be used together with the mode for sending the first message after an offset (3).
+
+***
+
+### transceiverMode
+
+> **transceiverMode**: `number`
+
+If only Rx (1), Tx (2), or both (3) messages shall be replayed. Default value is 1 (Rx).

package/doc_md/models/interfaces/LogReplayStatus.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LogReplayStatus
+
+# Interface: LogReplayStatus
+
+A message holding special log replay status information.

package/doc_md/models/interfaces/LoggerStatus.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / LoggerStatus
+
+# Interface: LoggerStatus
+
+A message holding special message or signal logger status information.

package/doc_md/models/interfaces/MeasurementEventArgs.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / MeasurementEventArgs
+
+# Interface: MeasurementEventArgs
+
+Event arguments

package/doc_md/models/interfaces/MeasurementSetup.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / MeasurementSetup
+
+# Interface: MeasurementSetup
+
+A message for defining a measurement setup.

package/doc_md/models/interfaces/MessageLoggerSettings.md

@@ -0,0 +1,177 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / MessageLoggerSettings
+
+# Interface: MessageLoggerSettings
+
+A message for defining a message logger's settings.
+
+## Properties
+
+### autoRestartAfterStop
+
+> **autoRestartAfterStop**: `boolean`
+
+A flag indicating if the logger should auto-restart after stop. Default value is false
+
+***
+
+### canMessageFilter
+
+> **canMessageFilter**: [`CanMessageFilterSettings`](CanMessageFilterSettings.md)
+
+Any filter
+
+***
+
+### colSeparator?
+
+> `optional` **colSeparator**: `Separator`
+
+The column separator to be used. Default value is a comma (,)
+
+***
+
+### dataBytesConverterLimit?
+
+> `optional` **dataBytesConverterLimit**: `number`
+
+Number of data bytes to max write to the log file (1-64). Default value is 8
+
+***
+
+### decimalSeparator?
+
+> `optional` **decimalSeparator**: `DecimalChar`
+
+The decimal separator to be used. Default value is a dot (.)
+
+***
+
+### fileConflictAction
+
+> **fileConflictAction**: [`FileConflictAction`](../enumerations/FileConflictAction.md)
+
+Name conflict action
+
+***
+
+### fileFormat
+
+> **fileFormat**: [`LogFileFormat`](../enumerations/LogFileFormat.md)
+
+The file format to be used
+
+***
+
+### fileName
+
+> **fileName**: `string`
+
+Name of the file to log messages to
+
+***
+
+### numberOfTimeDecimals?
+
+> `optional` **numberOfTimeDecimals**: `number`
+
+Number of time decimals (0-9). Default value is 9
+
+***
+
+### sizeLimit?
+
+> `optional` **sizeLimit**: `number`
+
+Max file size in megabytes before writing to a new file
+
+***
+
+### startTriggerSettings
+
+> **startTriggerSettings**: [`TriggerSettings`](TriggerSettings.md)[]
+
+Any start triggers
+
+***
+
+### startTriggersOperator
+
+> **startTriggersOperator**: [`TriggerOperator`](../enumerations/TriggerOperator.md)
+
+The trigger operator to be used between start triggers
+
+***
+
+### stopTriggerSettings
+
+> **stopTriggerSettings**: [`TriggerSettings`](TriggerSettings.md)[]
+
+Any stop triggers
+
+***
+
+### stopTriggersOperator
+
+> **stopTriggersOperator**: [`TriggerOperator`](../enumerations/TriggerOperator.md)
+
+The trigger operator to be used between stop triggers
+
+***
+
+### timeLimit?
+
+> `optional` **timeLimit**: `number`
+
+Max number of seconds between first and last event before writing to a new file
+
+***
+
+### timeReference?
+
+> `optional` **timeReference**: `TimeReference`
+
+Use the specified time reference. Default value is FIRST_TRIGGER
+
+***
+
+### useCalendarTime?
+
+> `optional` **useCalendarTime**: `boolean`
+
+Write timestamps in calendar time instead of seconds. Default value is false
+
+***
+
+### useUtcTime?
+
+> `optional` **useUtcTime**: `boolean`
+
+Use UTC instead of local time for absolute timestamps. Default value is true
+
+***
+
+### writeDataInHex?
+
+> `optional` **writeDataInHex**: `boolean`
+
+Write data in hexadecimal format. Default value is true
+
+***
+
+### writeFileHeader?
+
+> `optional` **writeFileHeader**: `boolean`
+
+Write file header. Default value is true
+
+***
+
+### writeIdInHex?
+
+> `optional` **writeIdInHex**: `boolean`
+
+Write ID in hexadecimal format. Default value is true

package/doc_md/models/interfaces/NodeStatus.md

@@ -0,0 +1,73 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / NodeStatus
+
+# Interface: NodeStatus
+
+A message for sending node status.
+
+## Properties
+
+### busStatus
+
+> **busStatus**: [`BusStatus`](BusStatus.md)
+
+Special bus status
+
+***
+
+### dataProcessingStatus
+
+> **dataProcessingStatus**: [`DataProcessingStatus`](DataProcessingStatus.md)
+
+Special data processing status
+
+***
+
+### errorStatus
+
+> **errorStatus**: [`ErrorStatus`](ErrorStatus.md)
+
+Error status
+
+***
+
+### loggerStatus
+
+> **loggerStatus**: [`LoggerStatus`](LoggerStatus.md)
+
+Special message logger status
+
+***
+
+### logReplayStatus
+
+> **logReplayStatus**: [`LogReplayStatus`](LogReplayStatus.md)
+
+Special log replay status
+
+***
+
+### nodeId
+
+> **nodeId**: `string`
+
+Identifier of the node
+
+***
+
+### nodeName
+
+> **nodeName**: `string`
+
+Name of the node
+
+***
+
+### streamId
+
+> **streamId**: `string`
+
+Identifier of the stream node

package/doc_md/models/interfaces/NodeStatuses.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / NodeStatuses
+
+# Interface: NodeStatuses
+
+A collection of node status items.

package/doc_md/models/interfaces/OnlineStatus.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / OnlineStatus
+
+# Interface: OnlineStatus
+
+A message for streaming online status information.