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

@kvaser/canking-api 7.2.1 → 7.3.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 (861) hide show

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

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetCanChannelBusSpeedsResponse
+# Interface: GetCanChannelBusSpeedsResponse
+A response on GetCanChannelBusSpeeds request.
+## Properties
+### availableBusSpeeds
+> **availableBusSpeeds**: [`CanBusSpeedInfo`](CanBusSpeedInfo.md)[]
+Available bus speeds on classic CAN.
+***
+### availableBusSpeedsFd
+> **availableBusSpeedsFd**: [`CanFDBusSpeedCombination`](CanFDBusSpeedCombination.md)[]
+Available bus speeds on CAN FD.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetCanFdBusSpeedsRequest
+# Interface: GetCanFdBusSpeedsRequest
+A request message to get a CAN channel's CAN FD bus speeds for a given bit rate.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetCanFdBusSpeedsResponse
+# Interface: GetCanFdBusSpeedsResponse
+A response on GetCanFdBusSpeeds request request.
+## Properties
+### availableBusSpeedsFd
+> **availableBusSpeedsFd**: [`CanFDBusSpeedCombination`](CanFDBusSpeedCombination.md)[]
+Available bus speeds on CAN FD.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetChannelsFromLogFileRequest
+# Interface: GetChannelsFromLogFileRequest
+A request message to get all channels listed in a log file.
+## Properties
+### logFile
+> **logFile**: `string`
+Log file to retrieve channels from.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetChannelsFromLogFileResponse
+# Interface: GetChannelsFromLogFileResponse
+A response message for GetChannelsFromLogFile request.
+## Properties
+### channels
+> **channels**: `number`[]
+Channels listed in the log file.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetClassicCanBusSpeedsRequest
+# Interface: GetClassicCanBusSpeedsRequest
+A request message to get a CAN channel's classic CAN bus speeds for the specified bit rates.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetClassicCanBusSpeedsResponse
+# Interface: GetClassicCanBusSpeedsResponse
+A response on GetClassicCanBusSpeeds request request.
+## Properties
+### availableBusSpeeds
+> **availableBusSpeeds**: [`CanBusSpeedInfo`](CanBusSpeedInfo.md)[]
+Available bus speeds on classic CAN.

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

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetDataFramesBeforeTimestampRequest
+# Interface: GetDataFramesBeforeTimestampRequest
+A request message to get data frames before a specified timestamp.
+## Properties
+### maxCount?
+> `optional` **maxCount**: `number`
+Maximum number of frames to retrieve.
+***
+### timestamp
+> **timestamp**: `number`
+Timestamp in seconds to retrieve frames before.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetDataProcessorResponse
+# Interface: GetDataProcessorResponse
+A response message for getting a data processor node.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetDevicesRequest
+# Interface: GetDevicesRequest
+A request message to get all connected devices.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetDevicesResponse
+# Interface: GetDevicesResponse
+A response on the GetDevices request.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetFrameDefinitionsFromDatabaseFilesRequest
+# Interface: GetFrameDefinitionsFromDatabaseFilesRequest
+A request message to get all frame definitions listed in the specified database files.
+## Properties
+### files
+> **files**: `string`[]
+Database files to retrieve frame definitions from.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetLicensesResponse
+# Interface: GetLicensesResponse
+Response message for getting licenses.
+## Properties
+### licenses
+> **licenses**: [`LicenseInformation`](LicenseInformation.md)[]
+A collection of registered licenses.

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

@@ -0,0 +1,33 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetLogFileFormatsRequest
+# Interface: GetLogFileFormatsRequest
+A request message to get supported log file formats.
+## Properties
+### messageLog
+> **messageLog**: `boolean`
+Set to true to include message log formats.
+***
+### readSupport
+> **readSupport**: `boolean`
+Set to true to only include formats with read support.
+***
+### signalLog
+> **signalLog**: `boolean`
+Set to true to include signal value log formats.

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

@@ -0,0 +1,41 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetLogFileFormatsResponse
+# Interface: GetLogFileFormatsResponse
+A response message for GetLogFileFormats request.
+## Properties
+### descriptions
+> **descriptions**: `string`[]
+Description of each supported format.
+***
+### extensions
+> **extensions**: `string`[]
+File extensions for each supported format.
+***
+### formats
+> **formats**: [`LogFileFormat`](../enumerations/LogFileFormat.md)[]
+All supported formats.
+***
+### names
+> **names**: `string`[]
+Name of each supported format.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetLogLevelResponse
+# Interface: GetLogLevelResponse
+A response message for receiving the current log level.
+## Properties
+### logLevel
+> **logLevel**: [`LogLevel`](../enumerations/LogLevel.md)
+The current log level.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetScheduleTablesFromDatabaseFilesRequest
+# Interface: GetScheduleTablesFromDatabaseFilesRequest
+A request message to get all schedule tables listed in the specified database files.
+## Properties
+### files
+> **files**: `string`[]
+Database files to retrieve schedule tables from.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetScheduleTablesFromDatabaseFilesResponse
+# Interface: GetScheduleTablesFromDatabaseFilesResponse
+A response message for GetScheduleTablesFromDatabaseFiles request.
+## Properties
+### tables
+> **tables**: [`ScheduleTable`](ScheduleTable.md)[]
+Tables listed in the database file.

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

@@ -0,0 +1,27 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetServiceExtensionInfoRequest
+# Interface: GetServiceExtensionInfoRequest
+Request message for getting information about a service extension, either from a
+WebAssembly file or from an installed extension.
+## Properties
+### filePathOrName
+> **filePathOrName**: `string`
+Full path to the extension WebAssembly file (.wasm file), or the extension name if it is
+already installed.
+***
+### preferences
+> **preferences**: [`ApiPreferences`](ApiPreferences.md)
+API preferences.

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

@@ -0,0 +1,65 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetServiceExtensionInfoResponse
+# Interface: GetServiceExtensionInfoResponse
+Response message for getting service extension information.
+## Properties
+### author
+> **author**: `string`
+Extension author.
+***
+### defaultConfig
+> **defaultConfig**: `string`
+Extension default configuration.
+***
+### description
+> **description**: `string`
+Extension description.
+***
+### displayName
+> **displayName**: `string`
+Extension display name.
+***
+### extensionType
+> **extensionType**: [`ServiceExtensionType`](../enumerations/ServiceExtensionType.md)
+Extension type.
+***
+### name
+> **name**: `string`
+Extension name.
+***
+### version
+> **version**: `string`
+Extension version.

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

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetSignalDataFromMessageDataRequest
+# Interface: GetSignalDataFromMessageDataRequest
+A request message to get all signal values for a message.
+## Properties
+### data
+> **data**: `number`[]
+Message data.
+***
+### messageQualifiedName
+> **messageQualifiedName**: `string`
+Message qualified name.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetSignalDataFromMessageDataResponse
+# Interface: GetSignalDataFromMessageDataResponse
+A response message for GetSignalDataFromMessageData request.
+## Properties
+### signalValues
+> **signalValues**: [`SignalValue`](SignalValue.md)[]
+Signal values.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetSourceResponse
+# Interface: GetSourceResponse
+A response message for getting a source node.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / GetTargetResponse
+# Interface: GetTargetResponse
+A response message for getting a target node.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / ILogFileFormat
+# Interface: ILogFileFormat
+Holds data about a log file format.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / IProject
+# Interface: IProject
+Data stored by the CanKing project.

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.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 ADDED Viewed

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.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 ADDED Viewed

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.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/IWorkspaceData.md ADDED Viewed

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

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.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/IdentifierRequest.md ADDED Viewed

@@ -0,0 +1,10 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / IdentifierRequest
+# Interface: IdentifierRequest
+A request message for any service method that needs to know one identifier of a node
+in the measurement setup.

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

@@ -0,0 +1,10 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / IdentifiersRequest
+# Interface: IdentifiersRequest
+A request message for any service method that needs to know identifiers of a nodes
+in the measurement setup.

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

@@ -0,0 +1,33 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / InstallServiceExtensionRequest
+# Interface: InstallServiceExtensionRequest
+Request message for installing a service extension.
+## Properties
+### filePath
+> **filePath**: `string`
+Full path to the extension WebAssembly file (.wasm file).
+***
+### preferences
+> **preferences**: [`ApiPreferences`](ApiPreferences.md)
+API preferences.
+***
+### replaceExisting?
+> `optional` **replaceExisting**: `boolean`
+An optional flag that can be used if an extension should be replace/updated with a new WebAssembly file.

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.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 ADDED Viewed

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