@kvaser/canking-api 7.2.1 → 7.3.0

package/doc_md/models/interfaces/CanChannelConfiguration.md

@@ -0,0 +1,65 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanChannelConfiguration
+
+# Interface: CanChannelConfiguration
+
+A message for defining a CAN channel's configuration.
+
+## Properties
+
+### accessMode
+
+> **accessMode**: [`AccessMode`](../enumerations/AccessMode.md)
+
+The access mode to use.
+
+***
+
+### busParams
+
+> **busParams**: [`CanBusParams`](CanBusParams.md)
+
+The selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD.
+
+***
+
+### busParamsBitRate
+
+> **busParamsBitRate**: `number`
+
+Bit rate of the selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD.
+
+***
+
+### busParamsDataPhase?
+
+> `optional` **busParamsDataPhase**: [`CanBusParams`](CanBusParams.md)
+
+The selected bus params for the data phase in CAN FD.
+
+***
+
+### busParamsDataPhaseBitRate?
+
+> `optional` **busParamsDataPhaseBitRate**: `number`
+
+Bit rate of the selected bus params for the data phase in CAN FD.
+
+***
+
+### canMode
+
+> **canMode**: [`CanMode`](../enumerations/CanMode.md)
+
+The CAN mode to use.
+
+***
+
+### silentMode
+
+> **silentMode**: `boolean`
+
+Set to true to enable silent mode, otherwise the channel will be setup as normal.

package/doc_md/models/interfaces/CanFDBusSpeedCombination.md

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

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

@@ -0,0 +1,10 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanFrameFlags
+
+# Interface: CanFrameFlags
+
+A message holding a combination of CanFrameFlag enums.
+This is a work-around since it's not possible to use repeated fields as oneof fields.

package/doc_md/models/interfaces/CanMessageFilterSettings.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanMessageFilterSettings
+
+# Interface: CanMessageFilterSettings
+
+A message for defining a CAN message filter's settings.

package/doc_md/models/interfaces/Channel.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Channel
+
+# Interface: Channel
+
+A channel of any type, could be CAN and/or LIN.

package/doc_md/models/interfaces/ChannelSettings.md

@@ -0,0 +1,81 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / ChannelSettings
+
+# Interface: ChannelSettings
+
+A message for defining a channel's settings.
+
+## Properties
+
+### canConfiguration?
+
+> `optional` **canConfiguration**: [`CanChannelConfiguration`](CanChannelConfiguration.md)
+
+The CAN channel configuration
+
+***
+
+### channelNumber
+
+> **channelNumber**: `number`
+
+The canlib channel number
+
+***
+
+### channelNumberOnDevice
+
+> **channelNumberOnDevice**: `number`
+
+The channel number on the device
+
+***
+
+### deviceCardNumber
+
+> **deviceCardNumber**: `number`
+
+The device card number
+
+***
+
+### deviceCardType
+
+> **deviceCardType**: `number`
+
+The device card type
+
+***
+
+### deviceProductCode
+
+> **deviceProductCode**: `string`
+
+The device product code
+
+***
+
+### deviceSerialNumber
+
+> **deviceSerialNumber**: `string`
+
+The device serial number
+
+***
+
+### linConfiguration?
+
+> `optional` **linConfiguration**: [`LinChannelConfiguration`](LinChannelConfiguration.md)
+
+The LIN channel configuration
+
+***
+
+### lockedToSerialNumber
+
+> **lockedToSerialNumber**: `boolean`
+
+Lock the channel to a specific serial number

package/doc_md/models/interfaces/ClearLinMessageRequest.md

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

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

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / DataProcessingStatus
+
+# Interface: DataProcessingStatus
+
+A message holding special data processing status information.

package/doc_md/models/interfaces/DataProcessorNodeProperties.md

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

package/doc_md/models/interfaces/DatabaseFiles.md

@@ -0,0 +1,25 @@
+[**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/DatabasesSettings.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / DatabasesSettings
+
+# Interface: DatabasesSettings
+
+A message for defining a database's settings.

package/doc_md/models/interfaces/Device.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Device
+
+# Interface: Device
+
+A hardware device.

package/doc_md/models/interfaces/DeviceEventArgs.md

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

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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Empty
+
+# Interface: Empty
+
+A generic empty message that you can re-use to avoid defining duplicated
+empty messages in your APIs. A typical example is to use it as the request
+or the response type of an API method. For instance:
+
+    service Foo {
+      rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    }
+
+The JSON representation for `Empty` is empty JSON object `{}`.

package/doc_md/models/interfaces/ErrorStatus.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / ErrorStatus
+
+# Interface: ErrorStatus
+
+A message holding any errors associated with a node.
+
+## Properties
+
+### errors
+
+> **errors**: `string`
+
+The errors, set to an empty string when any errors have been cleared.

package/doc_md/models/interfaces/FixedPosFrameIdentifier.md

@@ -0,0 +1,57 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FixedPosFrameIdentifier
+
+# Interface: FixedPosFrameIdentifier
+
+A message describing a fixed position frame identifier.
+
+## Properties
+
+### canFrameFlags?
+
+> `optional` **canFrameFlags**: [`CanFrameFlags`](CanFrameFlags.md)
+
+Special CAN flags
+
+***
+
+### id
+
+> **id**: `number`
+
+Frame identifier
+
+***
+
+### linFrameFlags?
+
+> `optional` **linFrameFlags**: [`LinFrameFlags`](LinFrameFlags.md)
+
+Special LIN flags
+
+***
+
+### mux?
+
+> `optional` **mux**: `number`
+
+Mux value for the frame, used in multiplexed CAN frames
+
+***
+
+### sourceName?
+
+> `optional` **sourceName**: `string`
+
+Name of the source node, accept any source if not set
+
+***
+
+### tx
+
+> **tx**: `boolean`
+
+True if the frame is transmitted, false if received

package/doc_md/models/interfaces/Frame.md

@@ -0,0 +1,125 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Frame
+
+# Interface: Frame
+
+A message describing a frame.
+
+## Properties
+
+### canFrameFlags?
+
+> `optional` **canFrameFlags**: [`CanFrameFlags`](CanFrameFlags.md)
+
+Special CAN flags
+
+***
+
+### data
+
+> **data**: `number`[]
+
+Frame data
+
+***
+
+### dlc
+
+> **dlc**: `number`
+
+Frame DLC
+
+***
+
+### hashCode
+
+> **hashCode**: `number`
+
+Frame hash code, a unique key that identifies the frame
+
+***
+
+### id
+
+> **id**: `number`
+
+Frame identifier
+
+***
+
+### linFrameFlags?
+
+> `optional` **linFrameFlags**: [`LinFrameFlags`](LinFrameFlags.md)
+
+Special LIN flags
+
+***
+
+### messageName
+
+> **messageName**: `string`
+
+Frame identifier
+
+***
+
+### properties
+
+> **properties**: `object`
+
+Extra properties
+
+#### Index Signature
+
+\[`key`: `string`\]: [`FramePropertyValue`](FramePropertyValue.md)
+
+***
+
+### signalValues
+
+> **signalValues**: [`SignalValue`](SignalValue.md)[]
+
+Signal values
+
+***
+
+### sourceId
+
+> **sourceId**: `string`
+
+Identifier of the source node
+
+***
+
+### sourceName
+
+> **sourceName**: `string`
+
+Name of the source node
+
+***
+
+### streamId
+
+> **streamId**: `string`
+
+Identifier of the stream node
+
+***
+
+### time
+
+> **time**: `number`
+
+Timestamp in seconds when the frame was recieved or transmitted
+
+***
+
+### tx
+
+> **tx**: `boolean`
+
+Flag indicating if this message was transmitted or recieved

package/doc_md/models/interfaces/FrameDefinition.md

@@ -0,0 +1,57 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FrameDefinition
+
+# Interface: FrameDefinition
+
+A message describing a frame definition.
+
+## Properties
+
+### canFrameFlags?
+
+> `optional` **canFrameFlags**: [`CanFrameFlags`](CanFrameFlags.md)
+
+Special CAN flags
+
+***
+
+### dataLength
+
+> **dataLength**: `number`
+
+The frame data length
+
+***
+
+### id
+
+> **id**: `number`
+
+Frame identifier
+
+***
+
+### messageName
+
+> **messageName**: `string`
+
+Message name
+
+***
+
+### messageQualifiedName
+
+> **messageQualifiedName**: `string`
+
+Message qualified name
+
+***
+
+### signals
+
+> **signals**: [`SignalDefinition`](SignalDefinition.md)[]
+
+Signal definitions

package/doc_md/models/interfaces/FramePropertyValue.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FramePropertyValue
+
+# Interface: FramePropertyValue
+
+A message that holds an extra frame property.

package/doc_md/models/interfaces/FrameReceivedTrigger.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / FrameReceivedTrigger
+
+# Interface: FrameReceivedTrigger
+
+A message for defining an On Frame Received trigger.
+
+## Properties
+
+### frameId
+
+> **frameId**: `string`
+
+The identifier of the frame to look for. Prefix with 0x to indicate hex-format.
+
+***
+
+### frameIdType
+
+> **frameIdType**: `string`
+
+The type of identifier used, 'extended' or 'standard'

package/doc_md/models/interfaces/GetCanChannelBusSpeedsRequest.md

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