npm - @kvaser/canking-api - Versions diffs - 7.3.0 → 7.4.0 - Mend

@kvaser/canking-api 7.3.0 → 7.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (713) hide show

package/doc_md/models/interfaces/Frames.md ADDED Viewed

@@ -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 CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/IWorkspaceComponentPaneData.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/IWorkspaceContainerPaneData.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/IWorkspacePaneData.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/InterpreterSettings.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/J1939InterpreterSettings.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/LinChannelConfiguration.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/LinFrameFlags.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -8,3 +8,11 @@
 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 CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/LogMessages.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/LogReplaySettings.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/LogReplayStatus.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,11 @@
 # Interface: LogReplayStatus
 A message holding special log replay status information.
+## Properties
+### state
+> **state**: [`LogReplayState`](../enumerations/LogReplayState.md)
+The current state of the log replay.

package/doc_md/models/interfaces/LoggerStatus.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,11 @@
 # Interface: LoggerStatus
 A message holding special message or signal logger status information.
+## Properties
+### state
+> **state**: [`LoggerState`](../enumerations/LoggerState.md)
+The current state of the logger.

package/doc_md/models/interfaces/MeasurementSetup.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,35 @@
 # Interface: MeasurementSetup
 A message for defining a measurement setup.
+## Properties
+### dataProcessors
+> **dataProcessors**: [`DataProcessorNodeProperties`](DataProcessorNodeProperties.md)[]
+A list of data processor nodes.
+***
+### language
+> **language**: `string`
+The measurement's display language.
+***
+### sources
+> **sources**: [`SourceNodeProperties`](SourceNodeProperties.md)[]
+A list of source nodes.
+***
+### targets
+> **targets**: [`TargetNodeProperties`](TargetNodeProperties.md)[]
+A list of target nodes.

package/doc_md/models/interfaces/MessageLoggerSettings.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -28,7 +28,7 @@ Any filter
 ### colSeparator?
-> `optional` **colSeparator**: `Separator`
+> `optional` **colSeparator**: [`Separator`](../enumerations/Separator.md)
 The column separator to be used. Default value is a comma (,)
@@ -44,7 +44,7 @@ Number of data bytes to max write to the log file (1-64). Default value is 8
 ### decimalSeparator?
-> `optional` **decimalSeparator**: `DecimalChar`
+> `optional` **decimalSeparator**: [`DecimalChar`](../enumerations/DecimalChar.md)
 The decimal separator to be used. Default value is a dot (.)
@@ -132,7 +132,7 @@ Max number of seconds between first and last event before writing to a new file
 ### timeReference?
-> `optional` **timeReference**: `TimeReference`
+> `optional` **timeReference**: [`TimeReference`](../enumerations/TimeReference.md)
 Use the specified time reference. Default value is FIRST_TRIGGER

package/doc_md/models/interfaces/NodeStatus.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/NodeStatuses.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,11 @@
 # Interface: NodeStatuses
 A collection of node status items.
+## Properties
+### items
+> **items**: [`NodeStatus`](NodeStatus.md)[]
+A list of node status items.

package/doc_md/models/interfaces/OnlineStatus.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,19 @@
 # Interface: OnlineStatus
 A message for streaming online status information.
+## Properties
+### isOnline
+> **isOnline**: `boolean`
+Indicates if the measurement is online.
+***
+### onlineCounter
+> **onlineCounter**: `number`
+Counter that is increased every time the measurement goes online. This can be used to detect when the measurement goes offline and then online again.

package/doc_md/models/interfaces/PeriodicTransmissionSettings.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/models/interfaces/ServiceExtensionSettings.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,19 @@
 # Interface: ServiceExtensionSettings
 A message for defining service extension settings.
+## Properties
+### configuration?
+> `optional` **configuration**: `string`
+The configuration string for the service extension.
+***
+### extensionName
+> **extensionName**: `string`
+The name of the service extension.

package/doc_md/models/interfaces/SignalDefinition.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,135 @@
 # Interface: SignalDefinition
 A message that holds information about a signal.
+## Properties
+### comment
+> **comment**: `string`
+A comment for the signal.
+***
+### dataType
+> **dataType**: [`SignalType`](../enumerations/SignalType.md)
+The data type of the signal.
+***
+### encoding
+> **encoding**: [`SignalEncoding`](../enumerations/SignalEncoding.md)
+The encoding of the signal.
+***
+### enumValues
+> **enumValues**: `object`
+The enumeration values for the signal, if it is an enumerated type.
+#### Index Signature
+\[`key`: `number`\]: `string`
+***
+### factor
+> **factor**: `number`
+The scaling factor for the signal.
+***
+### isMultiplexed
+> **isMultiplexed**: `boolean`
+Whether the signal is multiplexed within a message.
+***
+### isMultiplexer
+> **isMultiplexer**: `boolean`
+Whether the signal is the multiplexer signal within a message.
+***
+### length
+> **length**: `number`
+The length of the signal in bits.
+***
+### maxValue
+> **maxValue**: `number`
+The maximum value of the signal.
+***
+### minValue
+> **minValue**: `number`
+The minimum value of the signal.
+***
+### multiplexValue?
+> `optional` **multiplexValue**: `number`
+The multiplex value for the signal, if it is multiplexed.
+***
+### name
+> **name**: `string`
+The name of the signal.
+***
+### offset
+> **offset**: `number`
+The offset for the signal.
+***
+### qualifiedName
+> **qualifiedName**: `string`
+The qualified name of the signal. This includes the database name and the message name as a prefix and it can be used to uniquely identify the signal.
+***
+### startbit
+> **startbit**: `number`
+The start bit of the signal within the message.
+***
+### unit
+> **unit**: `string`
+The unit of the signal.

package/doc_md/models/interfaces/SignalDefinitions.md ADDED Viewed

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

package/doc_md/models/interfaces/SignalFilterSettings.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -14,4 +14,12 @@ A message for defining a signal filter's settings.
 > **selectedSignals**: `string`[]
-A comma separated list containing the qualified names of the signals to log
+A collection with the qualified names of the signals to log
+***
+### sourceIdentifiers
+> **sourceIdentifiers**: `string`[]
+A collection with identifiers of the sources to be used for each signal, should be in the same order with the same length as selected_signals

package/doc_md/models/interfaces/SignalLoggerSettings.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -20,7 +20,7 @@ A flag indicating if the logger should auto-restart after stop. Default value is
 ### colSeparator?
-> `optional` **colSeparator**: `Separator`
+> `optional` **colSeparator**: [`Separator`](../enumerations/Separator.md)
 The column separator to be used. Default value is a comma (,)
@@ -36,7 +36,7 @@ Number of data bytes a converter will max write to the log file (1-64). Default
 ### decimalSeparator?
-> `optional` **decimalSeparator**: `DecimalChar`
+> `optional` **decimalSeparator**: [`DecimalChar`](../enumerations/DecimalChar.md)
 The decimal separator to be used. Default value is a dot (.)
@@ -140,7 +140,7 @@ Max number of seconds between first and last event before writing to a new file
 ### timeReference?
-> `optional` **timeReference**: `TimeReference`
+> `optional` **timeReference**: [`TimeReference`](../enumerations/TimeReference.md)
 Use the specified time reference. Default value is FIRST_TRIGGER

package/doc_md/models/interfaces/SignalValue.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,43 @@
 # Interface: SignalValue
 A message that holds a signal's value.
+## Properties
+### doubleValue
+> **doubleValue**: `number`
+Numeric representation of the signal value.
+***
+### name
+> **name**: `string`
+Name of the signal.
+***
+### qualifiedName
+> **qualifiedName**: `string`
+Qualified name of the signal.
+***
+### stringValue?
+> `optional` **stringValue**: `string`
+Text representation of the signal value if this is an enumeration signal.
+***
+### unit
+> **unit**: `string`
+Unit of the signal.

package/doc_md/models/interfaces/SignalValueTrigger.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -63,3 +63,11 @@ The name of the signal.
 > **signalValue**: `number`
 The value to look for, if a single value is used.
+***
+### 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/SourceNodeProperties.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,43 @@
 # Interface: SourceNodeProperties
 A message for defining a source node properties.
+## Properties
+### baseNode
+> **baseNode**: [`BaseNodeProperties`](BaseNodeProperties.md)
+Base properties of the node
+***
+### channelSettings?
+> `optional` **channelSettings**: [`ChannelSettings`](ChannelSettings.md)
+Channel settings
+***
+### isDataGenerator
+> **isDataGenerator**: `boolean`
+True if this is a data generator node, otherwise false
+***
+### logReplaySettings?
+> `optional` **logReplaySettings**: [`LogReplaySettings`](LogReplaySettings.md)
+Log replay settings
+***
+### trafficGeneratorSettings?
+> `optional` **trafficGeneratorSettings**: [`PeriodicTransmissionSettings`](PeriodicTransmissionSettings.md)
+Traffic generator settings

package/doc_md/models/interfaces/TargetNodeProperties.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,43 @@
 # Interface: TargetNodeProperties
 A message for defining a target node properties.
+## Properties
+### baseNode
+> **baseNode**: [`BaseNodeProperties`](BaseNodeProperties.md)
+Base properties of the node
+***
+### connectedNodes
+> **connectedNodes**: `string`[]
+Identifiers of connected nodes
+***
+### extensionSettings?
+> `optional` **extensionSettings**: [`ServiceExtensionSettings`](ServiceExtensionSettings.md)
+Service extension settings
+***
+### messageLoggerSettings?
+> `optional` **messageLoggerSettings**: [`MessageLoggerSettings`](MessageLoggerSettings.md)
+Message logger settings
+***
+### signalLoggerSettings?
+> `optional` **signalLoggerSettings**: [`SignalLoggerSettings`](SignalLoggerSettings.md)
+Signal logger settings