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/GetScheduleTablesFromDatabaseFilesResponse.md DELETED Viewed

@@ -1,17 +0,0 @@
-[**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 DELETED Viewed

@@ -1,27 +0,0 @@
-[**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 DELETED Viewed

@@ -1,65 +0,0 @@
-[**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 DELETED Viewed

@@ -1,25 +0,0 @@
-[**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 DELETED Viewed

@@ -1,17 +0,0 @@
-[**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 DELETED Viewed

@@ -1,9 +0,0 @@
-[**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 DELETED Viewed

@@ -1,9 +0,0 @@
-[**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 DELETED Viewed

@@ -1,9 +0,0 @@
-[**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 DELETED Viewed

@@ -1,9 +0,0 @@
-[**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/IWorkspaceData.md DELETED Viewed

@@ -1,9 +0,0 @@
-[**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/IdentifierRequest.md DELETED Viewed

@@ -1,10 +0,0 @@
-[**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 DELETED Viewed

@@ -1,10 +0,0 @@
-[**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 DELETED Viewed

@@ -1,33 +0,0 @@
-[**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/LicenseInformation.md DELETED Viewed

@@ -1,73 +0,0 @@
-[**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 DELETED Viewed

@@ -1,17 +0,0 @@
-[**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/MeasurementEventArgs.md DELETED Viewed

@@ -1,9 +0,0 @@
-[**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/RequestLinMessageRequest.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / RequestLinMessageRequest
-# Interface: RequestLinMessageRequest
-A request message for writing a LIN message header to the LIN bus.
-## Properties
-### channelIdentifier
-> **channelIdentifier**: `string`
-Identifier of the LIN channel to clear the message buffer on.
-***
-### frameId
-> **frameId**: `number`
-The LIN message id to write to the LIN bus.

package/doc_md/models/interfaces/ScheduleTable.md DELETED Viewed

@@ -1,33 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / ScheduleTable
-# Interface: ScheduleTable
-A message describing a schedule table.
-## Properties
-### entries
-> **entries**: [`ScheduleTableEntry`](ScheduleTableEntry.md)[]
-Schedule table entries
-***
-### name
-> **name**: `string`
-Name of the schedule table
-***
-### qualifiedName
-> **qualifiedName**: `string`
-Qualified name of the schedule table

package/doc_md/models/interfaces/ScheduleTableEntry.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / ScheduleTableEntry
-# Interface: ScheduleTableEntry
-A message describing an entry in a schedule table.
-## Properties
-### delay
-> **delay**: `number`
-Delay in milliseconds
-***
-### messageQualifiedName
-> **messageQualifiedName**: `string`
-Message qualified name

package/doc_md/models/interfaces/SendLinWakeupFrameRequest.md DELETED Viewed

@@ -1,33 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SendLinWakeupFrameRequest
-# Interface: SendLinWakeupFrameRequest
-A request message for sending out one LIN wakeup frame.
-## Properties
-### channelIdentifier
-> **channelIdentifier**: `string`
-Identifier of the LIN channel to send the wakeup frame on.
-***
-### count
-> **count**: `number`
-The number of wakeup frames to send. Maximum value of count is 255 (0xFF).
-***
-### interval
-> **interval**: `number`
-The time, in bit times, between the wakeup frames. Maximum value of interval is either 255 (0xFF) or 65535 (0xFFFF) depending on device.

package/doc_md/models/interfaces/SendMessageRequest.md DELETED Viewed

@@ -1,9 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SendMessageRequest
-# Interface: SendMessageRequest
-A request message for sending out one message frame.

package/doc_md/models/interfaces/SetLogLevelRequest.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SetLogLevelRequest
-# Interface: SetLogLevelRequest
-A request message for setting log level.
-## Properties
-### logLevel
-> **logLevel**: [`LogLevel`](../enumerations/LogLevel.md)
-The new log level.
-***
-### preferences
-> **preferences**: [`ApiPreferences`](ApiPreferences.md)
-API preferences.

package/doc_md/models/interfaces/SetMeasurementSetupRequest.md DELETED Viewed

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

package/doc_md/models/interfaces/SetSignalDataToMessageDataRequest.md DELETED Viewed

@@ -1,33 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SetSignalDataToMessageDataRequest
-# Interface: SetSignalDataToMessageDataRequest
-A request message to set all signal values for a message.
-## Properties
-### data
-> **data**: `number`[]
-The current message data.
-***
-### messageQualifiedName
-> **messageQualifiedName**: `string`
-Message qualified name.
-***
-### signalValues
-> **signalValues**: [`SignalValue`](SignalValue.md)[]
-New signal values. One or more signals to be updated.

package/doc_md/models/interfaces/SetSignalDataToMessageDataResponse.md DELETED Viewed

@@ -1,26 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SetSignalDataToMessageDataResponse
-# Interface: SetSignalDataToMessageDataResponse
-A response message for SetSignalDataToMessageData request.
-## Properties
-### data
-> **data**: `number`[]
-Updated message data.
-***
-### signalValues
-> **signalValues**: [`SignalValue`](SignalValue.md)[]
-Updated signal values. Might be different from the once passed in the request if the
-specified signal value couldn't be exactly represented in raw data.

package/doc_md/models/interfaces/StartPeriodicTransmissionRequest.md DELETED Viewed

@@ -1,17 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / StartPeriodicTransmissionRequest
-# Interface: StartPeriodicTransmissionRequest
-A request message for start sending out message frames periodically.
-## Properties
-### settings
-> **settings**: [`PeriodicTransmissionSettings`](PeriodicTransmissionSettings.md)
-Periodic transmission settings

package/doc_md/models/interfaces/StartPeriodicTransmissionResponse.md DELETED Viewed

@@ -1,9 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / StartPeriodicTransmissionResponse
-# Interface: StartPeriodicTransmissionResponse
-A response message for start sending out message frames periodically.

package/doc_md/models/interfaces/SubscribeForDataRequest.md DELETED Viewed

@@ -1,17 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SubscribeForDataRequest
-# Interface: SubscribeForDataRequest
-A request message to subscribe for data frames.
-## Properties
-### frameIds
-> **frameIds**: [`FixedPosFrameIdentifier`](FixedPosFrameIdentifier.md)[]
-Subscribed frame identifiers, for frames specified here all data will be streamed.

package/doc_md/models/interfaces/UninstallServiceExtensionRequest.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / UninstallServiceExtensionRequest
-# Interface: UninstallServiceExtensionRequest
-Request message for uninstalling a service extension.
-## Properties
-### name
-> **name**: `string`
-Name of the extension.
-***
-### preferences
-> **preferences**: [`ApiPreferences`](ApiPreferences.md)
-API preferences.