@kvaser/canking-api 7.2.1 → 7.4.0

package/doc_md/models/interfaces/CanBusParams.md

@@ -0,0 +1,78 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanBusParams
+
+# Interface: CanBusParams
+
+CanBusParams is used for getting the channels bus params capacity and it can be used for
+setting up a correct bus speed configuration for a specific CAN channel.
+
+Constraints that must be fulfilled when opening channel in classic CAN Mode:
+
+  tq         = 1 + prop + phase1 + phase2
+  tq        >= 3
+  sjw       <= min(phase1, phase2)
+  prescaler >= 1
+
+Constraints that must be fulfilled when opening channel in CAN FD Mode:
+
+  arbitration.tq         = 1 + arbitration.prop + arbitration.phase1 + arbitration.phase2
+  arbitration.tq        >= 3
+  arbitration.sjw       <= min(arbitration.phase1, arbitration.phase2)
+  arbitration.prescaler >= 1  (<=2 will enable Transmitter Delay Compensation Mechanism)
+
+  data.tq         = 1 + data.phase1 + data.phase2
+  data.tq        >= 3
+  data.sjw       <= min(data.phase1, data.phase2)
+  data.prop       = 0
+  data.prescaler  = arbitration.prescaler
+
+## Properties
+
+### phase1
+
+> **phase1**: `number`
+
+The number of time quantas in phase 1.
+
+***
+
+### phase2
+
+> **phase2**: `number`
+
+The number of time quantas in phase 2.
+
+***
+
+### prescaler
+
+> **prescaler**: `number`
+
+The prescaler value.
+
+***
+
+### prop
+
+> **prop**: `number`
+
+The propagation segment in time quantas.
+
+***
+
+### sjw
+
+> **sjw**: `number`
+
+The synchronization jump width in time quantas.
+
+***
+
+### tq
+
+> **tq**: `number`
+
+The total number of time quantas (TQ).

package/doc_md/models/interfaces/CanChannelCapacity.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) / CanChannelCapacity
+
+# Interface: CanChannelCapacity
+
+CAN channel capacity.
+
+## Properties
+
+### busParamLimits
+
+> **busParamLimits**: [`CanBusParamLimits`](CanBusParamLimits.md)
+
+Bus parameter limits for the channel.
+
+***
+
+### channelCaps
+
+> **channelCaps**: [`CanChannelCap`](../enumerations/CanChannelCap.md)[]
+
+Supported channel capabilities.
+
+***
+
+### clockFrequency
+
+> **clockFrequency**: `number`
+
+Clock frequency of the channel in Hz.
+
+***
+
+### maxBitRate
+
+> **maxBitRate**: `number`
+
+Maximum bitrate of the channel. Zero means no limit on bitrate.

package/doc_md/models/interfaces/CanChannelConfiguration.md

@@ -0,0 +1,164 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.
+
+## Remarks
+
+When using CAN FD or CAN XL, both arbitration and data phase bus parameters
+must be specified. For CAN XL, both CAN FD and CAN XL data phase parameters
+must be specified.
+Specify either only the bit rate or both the bit rate and the sample point
+or only the bus parameters for each phase. If the bus parameters are specified,
+the bit rate and sample point values are ignored (will be calculated automatically).
+If only the bit rate is specified, the sample point will be set to a default
+value of 75% for classic CAN and 80% for CAN FD and CAN XL
+
+## 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/CAN XL.
+
+***
+
+### 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/CAN XL.
+
+***
+
+### busParamsBitRateFd?
+
+> `optional` **busParamsBitRateFd**: `number`
+
+Bit rate of the selected bus params for the data phase in CAN FD.
+
+***
+
+### busParamsBitRateXl?
+
+> `optional` **busParamsBitRateXl**: `number`
+
+Bit rate of the selected bus params for the data phase in CAN XL.
+
+***
+
+### busParamsFd?
+
+> `optional` **busParamsFd**: [`CanBusParams`](CanBusParams.md)
+
+The selected bus params for the data phase in CAN FD.
+
+***
+
+### busParamsSamplePoint?
+
+> `optional` **busParamsSamplePoint**: `number`
+
+Sample point in percentage of the selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD/CAN XL.
+
+***
+
+### busParamsSamplePointFd?
+
+> `optional` **busParamsSamplePointFd**: `number`
+
+Sample point in percentage of the selected bus params for the data phase in CAN FD.
+
+***
+
+### busParamsSamplePointXl?
+
+> `optional` **busParamsSamplePointXl**: `number`
+
+Sample point in percentage of the selected bus params for the data phase in CAN XL.
+
+***
+
+### busParamsXl?
+
+> `optional` **busParamsXl**: [`CanBusParams`](CanBusParams.md)
+
+The selected bus params for the data phase in CAN XL.
+
+***
+
+### canConfigModes
+
+> **canConfigModes**: [`CanConfigMode`](../enumerations/CanConfigMode.md)[]
+
+The CAN configuration mode to use.
+
+***
+
+### canMode
+
+> **canMode**: [`CanMode`](../enumerations/CanMode.md)
+
+The CAN mode to use.
+
+***
+
+### fdTdc?
+
+> `optional` **fdTdc**: [`TdcConfiguration`](TdcConfiguration.md)
+
+CAN FD Transmitter-Delay Compensation (TDC).
+
+***
+
+### pwml?
+
+> `optional` **pwml**: `number`
+
+PWM long phase (mtq).
+
+***
+
+### pwmo?
+
+> `optional` **pwmo**: `number`
+
+PWM time offset (mtq).
+
+***
+
+### pwms?
+
+> `optional` **pwms**: `number`
+
+PWM short phase (mtq).
+
+***
+
+### silentMode
+
+> **silentMode**: `boolean`
+
+Set to true to enable silent mode, otherwise the channel will be setup as normal.
+
+***
+
+### xlTdc?
+
+> `optional` **xlTdc**: [`TdcConfiguration`](TdcConfiguration.md)
+
+CAN XL Transmitter-Delay Compensation (TDC).

package/doc_md/models/interfaces/CanFrameFlags.md

@@ -0,0 +1,18 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.
+
+## Properties
+
+### flags
+
+> **flags**: [`CanFrameFlag`](../enumerations/CanFrameFlag.md)[]
+
+A list of CAN frame flags.

package/doc_md/models/interfaces/CanMessageFilterSettings.md

@@ -0,0 +1,33 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.
+
+## Properties
+
+### extCanIds
+
+> **extCanIds**: `string`
+
+A comma separated list containing the extended CAN IDs to filter
+
+***
+
+### filterType
+
+> **filterType**: [`CanMessageFilterType`](../enumerations/CanMessageFilterType.md)
+
+The filter type to be used
+
+***
+
+### stdCanIds
+
+> **stdCanIds**: `string`
+
+A comma separated list containing the standard CAN IDs to filter

package/doc_md/models/interfaces/Channel.md

@@ -0,0 +1,49 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.
+
+## Properties
+
+### canChannelCapacity?
+
+> `optional` **canChannelCapacity**: [`CanChannelCapacity`](CanChannelCapacity.md)
+
+The channel capacity.
+
+***
+
+### channelNumber
+
+> **channelNumber**: `number`
+
+The channel number.
+
+***
+
+### channelNumberOnDevice
+
+> **channelNumberOnDevice**: `number`
+
+The channel number on the device.
+
+***
+
+### name
+
+> **name**: `string`
+
+The channel name.
+
+***
+
+### protocols
+
+> **protocols**: `string`[]
+
+Supported protocols by the channel.

package/doc_md/models/interfaces/ChannelSettings.md

@@ -0,0 +1,89 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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
+
+***
+
+### protocols
+
+> **protocols**: `string`[]
+
+Supported protocols by the channel

package/doc_md/models/interfaces/DataProcessingStatus.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) / DataProcessingStatus
+
+# Interface: DataProcessingStatus
+
+A message holding special data processing status information.
+
+## Properties
+
+### errorCounter
+
+> **errorCounter**: `number`
+
+Number of errors encountered during data processing.
+
+***
+
+### lastExecutionTime
+
+> **lastExecutionTime**: `Long`
+
+The last execution time of the data processing.
+
+***
+
+### maxExecutionTime
+
+> **maxExecutionTime**: `Long`
+
+The maximum execution time of the data processing.
+
+***
+
+### minExecutionTime
+
+> **minExecutionTime**: `Long`
+
+The minimum execution time of the data processing.

package/doc_md/models/interfaces/DataProcessorNodeProperties.md

@@ -0,0 +1,57 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.
+
+## Properties
+
+### baseNode
+
+> **baseNode**: [`BaseNodeProperties`](BaseNodeProperties.md)
+
+Base properties of the node
+
+***
+
+### canMessageFilterSettings?
+
+> `optional` **canMessageFilterSettings**: [`CanMessageFilterSettings`](CanMessageFilterSettings.md)
+
+CAN message filter settings
+
+***
+
+### connectedNodes
+
+> **connectedNodes**: `string`[]
+
+Identifiers of connected nodes
+
+***
+
+### databasesSettings?
+
+> `optional` **databasesSettings**: [`DatabasesSettings`](DatabasesSettings.md)
+
+Signal filter settings
+
+***
+
+### extensionSettings?
+
+> `optional` **extensionSettings**: [`ServiceExtensionSettings`](ServiceExtensionSettings.md)
+
+Service extension settings
+
+***
+
+### interpreterSettings?
+
+> `optional` **interpreterSettings**: [`InterpreterSettings`](InterpreterSettings.md)
+
+Interpreter settings

package/doc_md/models/interfaces/DatabasesSettings.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) / DatabasesSettings
+
+# Interface: DatabasesSettings
+
+A message for defining a database's settings.
+
+## Properties
+
+### databaseFiles
+
+> **databaseFiles**: `string`[]
+
+A list of database files to be used

package/doc_md/models/interfaces/Device.md

@@ -0,0 +1,65 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Device
+
+# Interface: Device
+
+A hardware device.
+
+## Properties
+
+### cardNumber
+
+> **cardNumber**: `number`
+
+The device card number.
+
+***
+
+### cardType
+
+> **cardType**: `number`
+
+The device type/card type.
+
+***
+
+### channels
+
+> **channels**: [`Channel`](Channel.md)[]
+
+The device channels.
+
+***
+
+### name
+
+> **name**: `string`
+
+The device name.
+
+***
+
+### productCode
+
+> **productCode**: `string`
+
+The device product code.
+
+***
+
+### protocols
+
+> **protocols**: `string`[]
+
+Supported protocols by the device.
+
+***
+
+### serialNumber
+
+> **serialNumber**: `string`
+
+The device serial number.

package/doc_md/models/interfaces/Devices.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) / Devices
+
+# Interface: Devices
+
+A collection of devices.
+
+## Properties
+
+### items
+
+> **items**: [`Device`](Device.md)[]
+
+The device items.

package/doc_md/models/interfaces/Empty.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) / 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.4.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.