@kvaser/canking-api 7.2.1 → 7.4.0

package/doc_md/models/interfaces/FixedPosFrameIdentifier.md

@@ -0,0 +1,57 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FixedPosFrameIdentifier
+
+# Interface: FixedPosFrameIdentifier
+
+A message describing a fixed position frame identifier.
+
+## Properties
+
+### canFrameFlags?
+
+> `optional` **canFrameFlags**: [`CanFrameFlags`](CanFrameFlags.md)
+
+Special CAN flags
+
+***
+
+### id
+
+> **id**: `number`
+
+Frame identifier
+
+***
+
+### linFrameFlags?
+
+> `optional` **linFrameFlags**: [`LinFrameFlags`](LinFrameFlags.md)
+
+Special LIN flags
+
+***
+
+### mux?
+
+> `optional` **mux**: `number`
+
+Multiplexing value of the frame, used in multiplexed CAN frames
+
+***
+
+### sourceId?
+
+> `optional` **sourceId**: `string`
+
+Identifier of the source node, accepts any source if not set
+
+***
+
+### tx?
+
+> `optional` **tx**: `boolean`
+
+True if the frame is transmitted, false if received, undefined if both

package/doc_md/models/interfaces/Frame.md

@@ -0,0 +1,169 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Frame
+
+# Interface: Frame
+
+A message describing a frame.
+
+## Properties
+
+### canFrameFlags?
+
+> `optional` **canFrameFlags**: [`CanFrameFlags`](CanFrameFlags.md)
+
+Special CAN flags
+
+***
+
+### data
+
+> **data**: `number`[]
+
+Frame data
+
+***
+
+### deltaTimeUs?
+
+> `optional` **deltaTimeUs**: `Long`
+
+Delta time in microseconds since the previous frame with the same fixed pos identifier
+
+***
+
+### dlc
+
+> **dlc**: `number`
+
+Frame DLC
+
+***
+
+### fixedPosIdentifier?
+
+> `optional` **fixedPosIdentifier**: `string`
+
+Fixed position frame identifier
+
+***
+
+### hashCode
+
+> **hashCode**: `number`
+
+Frame hash code, a unique key that identifies the frame
+
+***
+
+### id
+
+> **id**: `number`
+
+Frame identifier
+
+***
+
+### linFrameFlags?
+
+> `optional` **linFrameFlags**: [`LinFrameFlags`](LinFrameFlags.md)
+
+Special LIN flags
+
+***
+
+### messageName
+
+> **messageName**: `string`
+
+Frame identifier
+
+***
+
+### muxValue?
+
+> `optional` **muxValue**: `number`
+
+Multiplexing value of the frame, used in multiplexed CAN frames
+
+***
+
+### properties
+
+> **properties**: `object`
+
+Extra properties
+
+#### Index Signature
+
+\[`key`: `string`\]: [`FramePropertyValue`](FramePropertyValue.md)
+
+***
+
+### protocol?
+
+> `optional` **protocol**: `string`
+
+Protocol used for this frame
+
+***
+
+### signalValues
+
+> **signalValues**: [`SignalValue`](SignalValue.md)[]
+
+Signal values
+
+***
+
+### sourceId
+
+> **sourceId**: `string`
+
+Identifier of the source node
+
+***
+
+### sourceName
+
+> **sourceName**: `string`
+
+Name of the source node
+
+***
+
+### streamId
+
+> **streamId**: `string`
+
+Identifier of the stream node
+
+***
+
+### ~~time~~
+
+> **time**: `number`
+
+Timestamp in seconds when the frame was recieved or transmitted
+
+#### Deprecated
+
+Use time_us instead, which has microsecond precision. This field will be removed in future releases.
+
+***
+
+### timeUs
+
+> **timeUs**: `Long`
+
+Timestamp in microseconds when the frame was recieved or transmitted
+
+***
+
+### tx
+
+> **tx**: `boolean`
+
+Flag indicating if this message was transmitted or recieved

package/doc_md/models/interfaces/FrameDefinition.md

@@ -0,0 +1,65 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FrameDefinition
+
+# Interface: FrameDefinition
+
+A message describing a frame definition.
+
+## Properties
+
+### canFrameFlags?
+
+> `optional` **canFrameFlags**: [`CanFrameFlags`](CanFrameFlags.md)
+
+Special CAN flags
+
+***
+
+### dataLength
+
+> **dataLength**: `number`
+
+The frame data length
+
+***
+
+### id
+
+> **id**: `number`
+
+Frame identifier
+
+***
+
+### messageName
+
+> **messageName**: `string`
+
+Message name
+
+***
+
+### messageQualifiedName
+
+> **messageQualifiedName**: `string`
+
+Message qualified name
+
+***
+
+### signals
+
+> **signals**: [`SignalDefinition`](SignalDefinition.md)[]
+
+Signal definitions
+
+***
+
+### sourceIdentifiers
+
+> **sourceIdentifiers**: `string`[]
+
+Identifiers of all possible source nodes

package/doc_md/models/interfaces/FrameDefinitions.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FrameDefinitions
+
+# Interface: FrameDefinitions
+
+A collection of frame definitions.
+
+## Properties
+
+### items
+
+> **items**: [`FrameDefinition`](FrameDefinition.md)[]
+
+A list of frame definitions.

package/doc_md/models/interfaces/FramePropertyValue.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FramePropertyValue
+
+# Interface: FramePropertyValue
+
+A message that holds an extra frame property.
+
+## Properties
+
+### doubleValue?
+
+> `optional` **doubleValue**: `number`
+
+Double value.
+
+***
+
+### stringValue?
+
+> `optional` **stringValue**: `string`
+
+String value.

package/doc_md/models/interfaces/FrameReceivedTrigger.md

@@ -0,0 +1,33 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FrameReceivedTrigger
+
+# Interface: FrameReceivedTrigger
+
+A message for defining an On Frame Received trigger.
+
+## Properties
+
+### frameId
+
+> **frameId**: `string`
+
+The identifier of the frame to look for. Prefix with 0x to indicate hex-format.
+
+***
+
+### frameIdType
+
+> **frameIdType**: `string`
+
+The type of identifier used, 'extended' or 'standard'
+
+***
+
+### sourceId?
+
+> `optional` **sourceId**: `string`
+
+The source identifier of the frame to look for. If not specified, all sources are considered.

package/doc_md/models/interfaces/Frames.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Frames
+
+# Interface: Frames
+
+A collection of frames.
+
+## Properties
+
+### items
+
+> **items**: [`Frame`](Frame.md)[]
+
+A list of frames.

package/doc_md/models/interfaces/IUserSettings.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / IUserSettings
+
+# Interface: IUserSettings
+
+Interface describing the contents of the settings file.

package/doc_md/models/interfaces/IWorkspaceComponentPaneData.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / IWorkspaceComponentPaneData
+
+# Interface: IWorkspaceComponentPaneData
+
+Data stored by a Workspace view.

package/doc_md/models/interfaces/IWorkspaceContainerPaneData.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / IWorkspaceContainerPaneData
+
+# Interface: IWorkspaceContainerPaneData
+
+Data stored by a Workspace view container.

package/doc_md/models/interfaces/IWorkspacePaneData.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / IWorkspacePaneData
+
+# Interface: IWorkspacePaneData
+
+Data stored by a Workspace pane.

package/doc_md/models/interfaces/InterpreterSettings.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / InterpreterSettings
+
+# Interface: InterpreterSettings
+
+A message for defining interpreter settings
+
+## Properties
+
+### j1939Settings?
+
+> `optional` **j1939Settings**: [`J1939InterpreterSettings`](J1939InterpreterSettings.md)
+
+J1939

package/doc_md/models/interfaces/J1939InterpreterSettings.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / J1939InterpreterSettings
+
+# Interface: J1939InterpreterSettings
+
+A message for defining a J1939 interpreter's specific settings

package/doc_md/models/interfaces/LinChannelConfiguration.md

@@ -0,0 +1,57 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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,18 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.
+
+## Properties
+
+### flags
+
+> **flags**: [`LinFrameFlag`](../enumerations/LinFrameFlag.md)[]
+
+A list of LIN frame flags.

package/doc_md/models/interfaces/LogMessage.md

@@ -0,0 +1,49 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.4.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.4.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).