@kvaser/canking-api 7.3.0 → 7.4.0

package/doc_md/models/interfaces/CanChannelConfiguration.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -8,6 +8,17 @@
 
 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
@@ -22,7 +33,7 @@ The access mode to use.
 
 > **busParams**: [`CanBusParams`](CanBusParams.md)
 
-The selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD.
+The selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD/CAN XL.
 
 ***
 
@@ -30,23 +41,71 @@ The selected bus params for classic CAN or the selected bus params for the arbit
 
 > **busParamsBitRate**: `number`
 
-Bit rate of the selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD.
+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.
 
 ***
 
-### busParamsDataPhase?
+### busParamsBitRateXl?
 
-> `optional` **busParamsDataPhase**: [`CanBusParams`](CanBusParams.md)
+> `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.
 
 ***
 
-### busParamsDataPhaseBitRate?
+### busParamsSamplePoint?
 
-> `optional` **busParamsDataPhaseBitRate**: `number`
+> `optional` **busParamsSamplePoint**: `number`
 
-Bit rate of the selected bus params for the data phase in CAN FD.
+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.
 
 ***
 
@@ -58,8 +117,48 @@ 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

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -8,3 +8,11 @@
 
 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

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -7,3 +7,27 @@
 # 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

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -7,3 +7,43 @@
 # 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

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -79,3 +79,11 @@ The LIN channel configuration
 > **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

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -7,3 +7,35 @@
 # 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

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -7,3 +7,51 @@
 # 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

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -7,3 +7,11 @@
 # 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

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -7,3 +7,59 @@
 # 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

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 

package/doc_md/models/interfaces/ErrorStatus.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 

package/doc_md/models/interfaces/FixedPosFrameIdentifier.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -38,20 +38,20 @@ Special LIN flags
 
 > `optional` **mux**: `number`
 
-Mux value for the frame, used in multiplexed CAN frames
+Multiplexing value of the frame, used in multiplexed CAN frames
 
 ***
 
-### sourceName?
+### sourceId?
 
-> `optional` **sourceName**: `string`
+> `optional` **sourceId**: `string`
 
-Name of the source node, accept any source if not set
+Identifier of the source node, accepts any source if not set
 
 ***
 
-### tx
+### tx?
 
-> **tx**: `boolean`
+> `optional` **tx**: `boolean`
 
-True if the frame is transmitted, false if received
+True if the frame is transmitted, false if received, undefined if both

package/doc_md/models/interfaces/Frame.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -26,6 +26,14 @@ Frame data
 
 ***
 
+### deltaTimeUs?
+
+> `optional` **deltaTimeUs**: `Long`
+
+Delta time in microseconds since the previous frame with the same fixed pos identifier
+
+***
+
 ### dlc
 
 > **dlc**: `number`
@@ -34,6 +42,14 @@ Frame DLC
 
 ***
 
+### fixedPosIdentifier?
+
+> `optional` **fixedPosIdentifier**: `string`
+
+Fixed position frame identifier
+
+***
+
 ### hashCode
 
 > **hashCode**: `number`
@@ -66,6 +82,14 @@ Frame identifier
 
 ***
 
+### muxValue?
+
+> `optional` **muxValue**: `number`
+
+Multiplexing value of the frame, used in multiplexed CAN frames
+
+***
+
 ### properties
 
 > **properties**: `object`
@@ -78,6 +102,14 @@ Extra properties
 
 ***
 
+### protocol?
+
+> `optional` **protocol**: `string`
+
+Protocol used for this frame
+
+***
+
 ### signalValues
 
 > **signalValues**: [`SignalValue`](SignalValue.md)[]
@@ -110,12 +142,24 @@ Identifier of the stream node
 
 ***
 
-### time
+### ~~time~~
 
 > **time**: `number`
 
 Timestamp in seconds when the frame was recieved or transmitted
 
+#### Deprecated
+
+Use time_us instead, which has microsecond precision. This field will be removed in future releases.
+
+***
+
+### timeUs
+
+> **timeUs**: `Long`
+
+Timestamp in microseconds when the frame was recieved or transmitted
+
 ***
 
 ### tx

package/doc_md/models/interfaces/FrameDefinition.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -55,3 +55,11 @@ Message qualified name
 > **signals**: [`SignalDefinition`](SignalDefinition.md)[]
 
 Signal definitions
+
+***
+
+### sourceIdentifiers
+
+> **sourceIdentifiers**: `string`[]
+
+Identifiers of all possible source nodes

package/doc_md/models/interfaces/FrameDefinitions.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) / FrameDefinitions
+
+# Interface: FrameDefinitions
+
+A collection of frame definitions.
+
+## Properties
+
+### items
+
+> **items**: [`FrameDefinition`](FrameDefinition.md)[]
+
+A list of frame definitions.

package/doc_md/models/interfaces/FramePropertyValue.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -7,3 +7,19 @@
 # Interface: FramePropertyValue
 
 A message that holds an extra frame property.
+
+## Properties
+
+### doubleValue?
+
+> `optional` **doubleValue**: `number`
+
+Double value.
+
+***
+
+### stringValue?
+
+> `optional` **stringValue**: `string`
+
+String value.

package/doc_md/models/interfaces/FrameReceivedTrigger.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -23,3 +23,11 @@ The identifier of the frame to look for. Prefix with 0x to indicate hex-format.
 > **frameIdType**: `string`
 
 The type of identifier used, 'extended' or 'standard'
+
+***
+
+### sourceId?
+
+> `optional` **sourceId**: `string`
+
+The source identifier of the frame to look for. If not specified, all sources are considered.