@kvaser/canking-api 7.3.0 → 7.4.0

package/doc_md/models/enumerations/TimeReference.md

@@ -0,0 +1,37 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / TimeReference
+
+# Enumeration: TimeReference
+
+Possible time references for loggers.
+
+## Enumeration Members
+
+### TIME\_REFERENCE\_FIRST\_TRIGGER
+
+> **TIME\_REFERENCE\_FIRST\_TRIGGER**: `1`
+
+TIME_REFERENCE_FIRST_TRIGGER - Time is relative to the first trigger.
+
+***
+
+### TIME\_REFERENCE\_START\_OF\_MEASUREMENT
+
+> **TIME\_REFERENCE\_START\_OF\_MEASUREMENT**: `2`
+
+TIME_REFERENCE_START_OF_MEASUREMENT - Time is relative to the start of the measurement.
+
+***
+
+### TIME\_REFERENCE\_UNSPECIFIED
+
+> **TIME\_REFERENCE\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/TriggerOperator.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)
 
 ***
 
@@ -14,12 +14,16 @@ Possible trigger operators.
 
 > **TRIGGER\_OPERATOR\_AND**: `1`
 
+TRIGGER_OPERATOR_AND - Logical AND between triggers.
+
 ***
 
 ### TRIGGER\_OPERATOR\_OR
 
 > **TRIGGER\_OPERATOR\_OR**: `2`
 
+TRIGGER_OPERATOR_OR - Logical OR between triggers.
+
 ***
 
 ### TRIGGER\_OPERATOR\_UNSPECIFIED

package/doc_md/models/functions/decimalToFixed.md

@@ -0,0 +1,31 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / decimalToFixed
+
+# Function: decimalToFixed()
+
+> **decimalToFixed**(`d`, `padding`): `string`
+
+Converts a decimal number to a fixed length string.
+
+## Parameters
+
+### d
+
+`number`
+
+The number to convert.
+
+### padding
+
+`number` = `3`
+
+Number of digits in the returned value, the result will be padded with zeroes.
+
+## Returns
+
+`string`
+
+The fixed length formatted value.

package/doc_md/models/functions/decimalToHex.md

@@ -0,0 +1,37 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / decimalToHex
+
+# Function: decimalToHex()
+
+> **decimalToHex**(`d`, `padding`, `prefix`): `string`
+
+Converts a decimal number to a hexadecimal string.
+
+## Parameters
+
+### d
+
+`number`
+
+The number to convert.
+
+### padding
+
+`number` = `2`
+
+Number of hexadecimal digits in the returned value, the result will be padded with zeroes.
+
+### prefix
+
+`boolean` = `false`
+
+True if a 0x prefix should be added.
+
+## Returns
+
+`string`
+
+The hexadecimal formatted value.

package/doc_md/models/functions/deep_equal.md

@@ -0,0 +1,37 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / deep\_equal
+
+# Function: deep\_equal()
+
+> **deep\_equal**\<`T`\>(`a`, `b`): `boolean`
+
+Deep equality check between two values.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### a
+
+`T`
+
+First value to compare.
+
+### b
+
+`T`
+
+Second value to compare.
+
+## Returns
+
+`boolean`
+
+True if the values are deeply equal, false otherwise.

package/doc_md/models/functions/deserializeFrame.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / deserializeFrame
+
+# Function: deserializeFrame()
+
+> **deserializeFrame**(`serializableFrame`): [`Frame`](../interfaces/Frame.md)
+
+Converts a SerializableFrame object back into a Frame object after receiving it through IPC.
+
+## Parameters
+
+### serializableFrame
+
+[`SerializableFrame`](../type-aliases/SerializableFrame.md)
+
+The SerializableFrame object to be deserialized.
+
+## Returns
+
+[`Frame`](../interfaces/Frame.md)
+
+A Frame object reconstructed from the SerializableFrame.

package/doc_md/models/functions/jsonReplacer.md

@@ -0,0 +1,32 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / jsonReplacer
+
+# Function: jsonReplacer()
+
+> **jsonReplacer**(`key`, `value`): `any`
+
+Custom JSON replacer function.
+Supports serialization of complex data types like Map and Set.
+
+## Parameters
+
+### key
+
+`string`
+
+The key being processed.
+
+### value
+
+`any`
+
+The value associated with the key.
+
+## Returns
+
+`any`
+
+The value to be serialized.

package/doc_md/models/functions/jsonReviver.md

@@ -0,0 +1,32 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / jsonReviver
+
+# Function: jsonReviver()
+
+> **jsonReviver**(`key`, `value`): `any`
+
+Custom JSON reviver function.
+Supports deserialization of complex data types like Map and Set.
+
+## Parameters
+
+### key
+
+`string`
+
+The key being processed.
+
+### value
+
+`any`
+
+The value associated with the key.
+
+## Returns
+
+`any`
+
+The value to be deserialized.

package/doc_md/models/functions/longToNumber.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / longToNumber
+
+# Function: longToNumber()
+
+> **longToNumber**(`value`): `number`
+
+Converts a Long value to a number.
+
+## Parameters
+
+### value
+
+`Long`
+
+The Long value to convert.
+
+## Returns
+
+`number`
+
+The value as a number.

package/doc_md/models/functions/serializeFrame.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / serializeFrame
+
+# Function: serializeFrame()
+
+> **serializeFrame**(`frame`): [`SerializableFrame`](../type-aliases/SerializableFrame.md)
+
+Converts a Frame object into a SerializableFrame object for IPC.
+
+## Parameters
+
+### frame
+
+[`Frame`](../interfaces/Frame.md)
+
+The Frame object to be serialized.
+
+## Returns
+
+[`SerializableFrame`](../type-aliases/SerializableFrame.md)
+
+A SerializableFrame object that can be sent through IPC.

package/doc_md/models/interfaces/BaseNodeProperties.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: BaseNodeProperties
 
 A message for defining base node properties.
+
+## Properties
+
+### description
+
+> **description**: `string`[]
+
+Description lines for the node
+
+***
+
+### disabled
+
+> **disabled**: `boolean`
+
+True if the node is disabled, otherwise false
+
+***
+
+### identifier
+
+> **identifier**: `string`
+
+The unique identifier of the node
+
+***
+
+### name
+
+> **name**: `string`
+
+The name of the node
+
+***
+
+### readOnlyConnections
+
+> **readOnlyConnections**: `boolean`
+
+True if the node's connections are read-only, otherwise false
+
+***
+
+### readOnlyProperties
+
+> **readOnlyProperties**: `boolean`
+
+True if the node's properties are read-only, otherwise false

package/doc_md/models/interfaces/BusStatus.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,123 @@
 # Interface: BusStatus
 
 A message holding bus status information.
+
+## Properties
+
+### busLoad
+
+> **busLoad**: `number`
+
+The bus load.
+
+***
+
+### busOnStatus
+
+> **busOnStatus**: [`StatusLevel`](../enumerations/StatusLevel.md)
+
+The bus on status level.
+
+***
+
+### errorFrameCounter
+
+> **errorFrameCounter**: `number`
+
+The number of error frames.
+
+***
+
+### errorFramesPerSecond
+
+> **errorFramesPerSecond**: `number`
+
+The number of error frames per second.
+
+***
+
+### errorStatus
+
+> **errorStatus**: [`StatusLevel`](../enumerations/StatusLevel.md)
+
+The error status level.
+
+***
+
+### overrunCounter
+
+> **overrunCounter**: `number`
+
+The number of overruns.
+
+***
+
+### overrunErrorCounter
+
+> **overrunErrorCounter**: `number`
+
+The number of overrun errors.
+
+***
+
+### overrunsPerSecond
+
+> **overrunsPerSecond**: `number`
+
+The number of overruns per second.
+
+***
+
+### overrunStatus
+
+> **overrunStatus**: [`StatusLevel`](../enumerations/StatusLevel.md)
+
+The overrun status level.
+
+***
+
+### rxErrorCounter
+
+> **rxErrorCounter**: `number`
+
+The number of received errors.
+
+***
+
+### rxMessageCounter
+
+> **rxMessageCounter**: `number`
+
+The number of received messages.
+
+***
+
+### rxMessagesPerSecond
+
+> **rxMessagesPerSecond**: `number`
+
+The number of received messages per second.
+
+***
+
+### txErrorCounter
+
+> **txErrorCounter**: `number`
+
+The number of transmitted errors.
+
+***
+
+### txMessageCounter
+
+> **txMessageCounter**: `number`
+
+The number of transmitted messages.
+
+***
+
+### txMessagesPerSecond
+
+> **txMessagesPerSecond**: `number`
+
+The number of transmitted messages per second.

package/doc_md/models/interfaces/CanBusParamLimits.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: CanBusParamLimits
 
 CAN channel bus parameter limits.
+
+## Properties
+
+### arbitrationMax
+
+> **arbitrationMax**: [`CanBusParams`](CanBusParams.md)
+
+Maximum bus parameters for arbitration phase.
+
+***
+
+### arbitrationMin
+
+> **arbitrationMin**: [`CanBusParams`](CanBusParams.md)
+
+Minimum bus parameters for arbitration phase.
+
+***
+
+### dataMax
+
+> **dataMax**: [`CanBusParams`](CanBusParams.md)
+
+Maximum bus parameters for data phase.
+
+***
+
+### dataMin
+
+> **dataMin**: [`CanBusParams`](CanBusParams.md)
+
+Minimum bus parameters for data phase.
+
+***
+
+### isValid
+
+> **isValid**: `boolean`
+
+Indicates if the limits are valid.

package/doc_md/models/interfaces/CanBusParams.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)
 
 ***
 
@@ -28,3 +28,51 @@ Constraints that must be fulfilled when opening channel in CAN FD Mode:
   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

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