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

@@ -1,35 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / AddOrUpdateDataProcessorRequest
-# Interface: AddOrUpdateDataProcessorRequest
-A request message for adding or updating a data processor node.
-## Properties
-### nextNode
-> **nextNode**: `string`
-If adding a new data processor before another node then set next_node to the id of the subsequent node
-***
-### previousNode
-> **previousNode**: `string`
-If adding a new data processor after another node then set previous_node to the id of the preceding node
-***
-### replaceAllProperties
-> **replaceAllProperties**: `boolean`
-If true then all properties will be replaced with values from data_processor.
-If false then only properties with values in data_processor will be updated.
-This field is ignored when adding a new node.

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

@@ -1,19 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / AddOrUpdateSourceRequest
-# Interface: AddOrUpdateSourceRequest
-A request message for adding or updating a source node.
-## Properties
-### replaceAllProperties
-> **replaceAllProperties**: `boolean`
-If true then all properties will be replaced with values from source.
-If false then only properties with values in source will be updated.
-This field is ignored when adding a new node.

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

@@ -1,19 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / AddOrUpdateTargetRequest
-# Interface: AddOrUpdateTargetRequest
-A request message for adding or updating a target node.
-## Properties
-### replaceAllProperties
-> **replaceAllProperties**: `boolean`
-If true then all properties will be replaced with values from target.
-If false then only properties with values in target will be updated.
-This field is ignored when adding a new node.

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

@@ -1,41 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / ApiPreferences
-# Interface: ApiPreferences
-A message to be included in all request messages to control the responses.
-## Properties
-### language
-> **language**: `string`
-The preferred UI language.
-***
-### useHexNumericBase
-> **useHexNumericBase**: `boolean`
-The preferred numeric base for message identifiers and message data
-***
-### username
-> **username**: `string`
-The current user.
-***
-### version
-> **version**: `string`
-The API version used by the client.

package/doc_md/models/interfaces/AppEventArgs.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) / AppEventArgs
-# Interface: AppEventArgs
-Event arguments.
-## Properties
-### eventType
-> **eventType**: [`AppEvent`](../enumerations/AppEvent.md)
-The application event type.
-***
-### licenses?
-> `optional` **licenses**: [`Licenses`](Licenses.md)
-A collection of registered licenses.

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

@@ -1,57 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanBusSpeedInfo
-# Interface: CanBusSpeedInfo
-Bus speed information, used for listing available bus speed settings for CAN.
-## Properties
-### actualBitRate
-> **actualBitRate**: `number`
-The actual bit rate (measured in bits per second).
-***
-### bitRate
-> **bitRate**: `number`
-The target bit rate (measured in bits per second).
-***
-### bitRateError
-> **bitRateError**: `number`
-The bit rate error with these settings.
-***
-### busParams
-> **busParams**: [`CanBusParams`](CanBusParams.md)
-Bus parameters for this bus speed.
-***
-### description
-> **description**: `string`
-A text description of the bus speed.
-***
-### samplePoint
-> **samplePoint**: `number`
-The sample point in percentage.

package/doc_md/models/interfaces/CanFDBusSpeedCombination.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) / CanFDBusSpeedCombination
-# Interface: CanFDBusSpeedCombination
-CAN FD bus speed combination, holds one arbitration phase speed together with available data phase speeds.

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

@@ -1,41 +0,0 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
-***
-[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanFDBusSpeedInfo
-# Interface: CanFDBusSpeedInfo
-Bus speed information, used for listing available bus speed settings for CAN FD.
-## Properties
-### bitRate
-> **bitRate**: `number`
-The target bit rate (measured in bits per second).
-***
-### busParams
-> **busParams**: [`CanBusParams`](CanBusParams.md)
-Bus parameters for this bus speed.
-***
-### description
-> **description**: `string`
-A text description of the bus speed.
-***
-### samplePoint
-> **samplePoint**: `number`
-The sample point in percentage.

package/doc_md/models/interfaces/ClearLinMessageRequest.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) / ClearLinMessageRequest
-# Interface: ClearLinMessageRequest
-A request message for clearing a message buffer for a LIN slave. The slave will not answer next time it is polled.
-## Properties
-### channelIdentifier
-> **channelIdentifier**: `string`
-Identifier of the LIN channel to clear the message buffer on.
-***
-### frameId
-> **frameId**: `number`
-The LIN message id for which the corresponding buffer will be cleared.

package/doc_md/models/interfaces/ConnectNodesRequest.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) / ConnectNodesRequest
-# Interface: ConnectNodesRequest
-A request message for connecting two nodes.

package/doc_md/models/interfaces/DatabaseFiles.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) / DatabaseFiles
-# Interface: DatabaseFiles
-A message describing database files for both database nodes and LIN channels.
-## Properties
-### dbcFiles
-> **dbcFiles**: `string`[]
-Database files for CAN channels
-***
-### ldfFiles
-> **ldfFiles**: `string`[]
-Database files for LIN channels

package/doc_md/models/interfaces/DeviceEventArgs.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) / DeviceEventArgs
-# Interface: DeviceEventArgs
-Event arguments

package/doc_md/models/interfaces/DisconnectNodesRequest.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) / DisconnectNodesRequest
-# Interface: DisconnectNodesRequest
-A request message for disconnecting two nodes.

package/doc_md/models/interfaces/GetCanChannelBusSpeedsRequest.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) / GetCanChannelBusSpeedsRequest
-# Interface: GetCanChannelBusSpeedsRequest
-A request message to get a CAN channel's available bus speeds.

package/doc_md/models/interfaces/GetCanChannelBusSpeedsResponse.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) / 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 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) / 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 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) / 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 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) / 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 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) / 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 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) / 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 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) / 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 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) / 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 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) / GetDataProcessorResponse
-# Interface: GetDataProcessorResponse
-A response message for getting a data processor node.

package/doc_md/models/interfaces/GetDevicesRequest.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) / GetDevicesRequest
-# Interface: GetDevicesRequest
-A request message to get all connected devices.

package/doc_md/models/interfaces/GetDevicesResponse.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) / GetDevicesResponse
-# Interface: GetDevicesResponse
-A response on the GetDevices request.

package/doc_md/models/interfaces/GetFrameDefinitionsFromDatabaseFilesRequest.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) / 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 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) / 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 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) / 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 DELETED Viewed

@@ -1,41 +0,0 @@
-[**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 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) / 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 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) / 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.