@kvaser/canking-api 7.2.1 → 7.4.0

package/doc_md/models/interfaces/LogReplayStatus.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) / LogReplayStatus
+
+# 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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.
+
+## Properties
+
+### state
+
+> **state**: [`LoggerState`](../enumerations/LoggerState.md)
+
+The current state of the logger.

package/doc_md/models/interfaces/MeasurementSetup.md

@@ -0,0 +1,41 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / MeasurementSetup
+
+# 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

@@ -0,0 +1,177 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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`](../enumerations/Separator.md)
+
+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`](../enumerations/DecimalChar.md)
+
+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`](../enumerations/TimeReference.md)
+
+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.4.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,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / NodeStatuses
+
+# 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

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / OnlineStatus
+
+# 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

@@ -0,0 +1,145 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / PeriodicTransmissionSettings
+
+# Interface: PeriodicTransmissionSettings
+
+A message defining a periodic transmission setup.
+
+## Properties
+
+### channelIdentifier
+
+> **channelIdentifier**: `string`
+
+The channel to be used
+
+***
+
+### constantBurstSize
+
+> **constantBurstSize**: `number`
+
+Constant burst size that is used if random_burst_size is false
+
+***
+
+### constantIntervalMs
+
+> **constantIntervalMs**: `number`
+
+Constant interval in milliseconds that is used if random_interval is false
+
+***
+
+### frame
+
+> **frame**: [`WriteFrame`](WriteFrame.md)
+
+The message frame to be sent out
+
+***
+
+### identifierMax
+
+> **identifierMax**: `number`
+
+Random/Scan max identifier
+
+***
+
+### identifierMin
+
+> **identifierMin**: `number`
+
+Random/Scan min identifier
+
+***
+
+### numberOfMessages
+
+> **numberOfMessages**: `number`
+
+Number of messages to send out, if set to 0 then messages will be sent out continuously until stop is called
+
+***
+
+### randomBurstSize
+
+> **randomBurstSize**: `boolean`
+
+Send out with random or constant burst size
+
+***
+
+### randomBurstSizeMax
+
+> **randomBurstSizeMax**: `number`
+
+Random max burst size that is used if random_burst_size is true
+
+***
+
+### randomBurstSizeMin
+
+> **randomBurstSizeMin**: `number`
+
+Random min burst size that is used if random_burst_size is true
+
+***
+
+### randomDataLength
+
+> **randomDataLength**: `boolean`
+
+Randomize the messages' data length
+
+***
+
+### randomIdentifier
+
+> **randomIdentifier**: `boolean`
+
+Send out with random identifier, ignored if scan_identifier is set
+
+***
+
+### randomInterval
+
+> **randomInterval**: `boolean`
+
+Send out with random or constant interval
+
+***
+
+### randomIntervalMaxMs
+
+> **randomIntervalMaxMs**: `number`
+
+Random max interval in milliseconds that is used if random_interval is true
+
+***
+
+### randomIntervalMinMs
+
+> **randomIntervalMinMs**: `number`
+
+Random min interval in milliseconds that is used if random_interval is true
+
+***
+
+### randomMessageData
+
+> **randomMessageData**: `boolean`
+
+Randomize the messages' data
+
+***
+
+### scanIdentifier
+
+> **scanIdentifier**: `boolean`
+
+Send out with identifier set from min to max

package/doc_md/models/interfaces/ServiceExtensionSettings.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) / ServiceExtensionSettings
+
+# 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

@@ -0,0 +1,141 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SignalDefinition
+
+# 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

@@ -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.