@kvaser/canking-api 7.2.0 → 7.3.0

package/doc_md/models/enumerations/ServiceExtensionType.md

@@ -0,0 +1,37 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / ServiceExtensionType
+
+# Enumeration: ServiceExtensionType
+
+Possible service extension types.
+
+## Enumeration Members
+
+### SERVICE\_EXTENSION\_TYPE\_DATA\_PROCESSOR
+
+> **SERVICE\_EXTENSION\_TYPE\_DATA\_PROCESSOR**: `1`
+
+SERVICE_EXTENSION_TYPE_DATA_PROCESSOR - Data processing extension.
+
+***
+
+### SERVICE\_EXTENSION\_TYPE\_DATA\_TARGET
+
+> **SERVICE\_EXTENSION\_TYPE\_DATA\_TARGET**: `2`
+
+SERVICE_EXTENSION_TYPE_DATA_TARGET - Data target extension.
+
+***
+
+### SERVICE\_EXTENSION\_TYPE\_UNSPECIFIED
+
+> **SERVICE\_EXTENSION\_TYPE\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/SignalEncoding.md

@@ -0,0 +1,27 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SignalEncoding
+
+# Enumeration: SignalEncoding
+
+Possible signal encodings. The value must match the kvadblib value.
+
+## Enumeration Members
+
+### SIGNAL\_ENCODING\_INTEL
+
+> **SIGNAL\_ENCODING\_INTEL**: `0`
+
+***
+
+### SIGNAL\_ENCODING\_MOTOROLA
+
+> **SIGNAL\_ENCODING\_MOTOROLA**: `1`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/SignalType.md

@@ -0,0 +1,53 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SignalType
+
+# Enumeration: SignalType
+
+Possible signal types. The value must match the kvadblib value.
+
+## Enumeration Members
+
+### SIGNAL\_TYPE\_DOUBLE
+
+> **SIGNAL\_TYPE\_DOUBLE**: `4`
+
+SIGNAL_TYPE_DOUBLE - Double, strictly 64 bit long
+
+***
+
+### SIGNAL\_TYPE\_FLOAT
+
+> **SIGNAL\_TYPE\_FLOAT**: `3`
+
+SIGNAL_TYPE_FLOAT - Float, strictly 32 bit long
+
+***
+
+### SIGNAL\_TYPE\_INVALID
+
+> **SIGNAL\_TYPE\_INVALID**: `0`
+
+***
+
+### SIGNAL\_TYPE\_SIGNED
+
+> **SIGNAL\_TYPE\_SIGNED**: `1`
+
+SIGNAL_TYPE_SIGNED - Signed integer
+
+***
+
+### SIGNAL\_TYPE\_UNSIGNED
+
+> **SIGNAL\_TYPE\_UNSIGNED**: `2`
+
+SIGNAL_TYPE_UNSIGNED - Unsigned integer
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/SignalValueTriggerOperator.md

@@ -0,0 +1,75 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SignalValueTriggerOperator
+
+# Enumeration: SignalValueTriggerOperator
+
+Possible signal value trigger operators.
+
+## Enumeration Members
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_CHANGE\_FROM
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_CHANGE\_FROM**: `8`
+
+***
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_CHANGE\_TO
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_CHANGE\_TO**: `7`
+
+***
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_EQUAL\_TO
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_EQUAL\_TO**: `1`
+
+***
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_GREATER\_THAN
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_GREATER\_THAN**: `6`
+
+***
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_GREATER\_THAN\_OR\_EQUAL
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_GREATER\_THAN\_OR\_EQUAL**: `5`
+
+***
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_LESS\_THAN
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_LESS\_THAN**: `3`
+
+***
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_LESS\_THAN\_OR\_EQUAL
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_LESS\_THAN\_OR\_EQUAL**: `4`
+
+***
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_NOT\_EQUAL\_TO
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_NOT\_EQUAL\_TO**: `2`
+
+***
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_ON\_CHANGE
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_ON\_CHANGE**: `9`
+
+***
+
+### SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_UNSPECIFIED
+
+> **SIGNAL\_VALUE\_TRIGGER\_OPERATOR\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/StatusLevel.md

@@ -0,0 +1,39 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / StatusLevel
+
+# Enumeration: StatusLevel
+
+Possible CAN frame flags. The flag value must match the canlib flag value.
+
+## Enumeration Members
+
+### STATUS\_LEVEL\_ERROR
+
+> **STATUS\_LEVEL\_ERROR**: `3`
+
+***
+
+### STATUS\_LEVEL\_NONE
+
+> **STATUS\_LEVEL\_NONE**: `0`
+
+***
+
+### STATUS\_LEVEL\_OK
+
+> **STATUS\_LEVEL\_OK**: `1`
+
+***
+
+### STATUS\_LEVEL\_WARNING
+
+> **STATUS\_LEVEL\_WARNING**: `2`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/enumerations/TriggerOperator.md

@@ -0,0 +1,33 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / TriggerOperator
+
+# Enumeration: TriggerOperator
+
+Possible trigger operators.
+
+## Enumeration Members
+
+### TRIGGER\_OPERATOR\_AND
+
+> **TRIGGER\_OPERATOR\_AND**: `1`
+
+***
+
+### TRIGGER\_OPERATOR\_OR
+
+> **TRIGGER\_OPERATOR\_OR**: `2`
+
+***
+
+### TRIGGER\_OPERATOR\_UNSPECIFIED
+
+> **TRIGGER\_OPERATOR\_UNSPECIFIED**: `0`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`

package/doc_md/models/interfaces/AboutInformation.md

@@ -0,0 +1,33 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / AboutInformation
+
+# Interface: AboutInformation
+
+Message for getting about information.
+
+## Properties
+
+### apiVersion
+
+> **apiVersion**: `string`
+
+The API version used by the service.
+
+***
+
+### canlibVersion
+
+> **canlibVersion**: `string`
+
+The Canlib version used
+
+***
+
+### serviceVersion
+
+> **serviceVersion**: `string`
+
+The service version running

package/doc_md/models/interfaces/ActivateLicenseRequest.md

@@ -0,0 +1,33 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / ActivateLicenseRequest
+
+# Interface: ActivateLicenseRequest
+
+Request message for activating a license.
+
+## Properties
+
+### licenseKey
+
+> **licenseKey**: `string`
+
+The license key.
+
+***
+
+### preferences
+
+> **preferences**: [`ApiPreferences`](ApiPreferences.md)
+
+API preferences.
+
+***
+
+### productId
+
+> **productId**: `string`
+
+Optional product_id, used if activating anything but the base CanKing product.

package/doc_md/models/interfaces/AddAllConnectedCanChannelsRequest.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) / AddAllConnectedCanChannelsRequest
+
+# Interface: AddAllConnectedCanChannelsRequest
+
+A request message for adding all connected CAN channels.

package/doc_md/models/interfaces/AddAllConnectedLinChannelsRequest.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) / AddAllConnectedLinChannelsRequest
+
+# Interface: AddAllConnectedLinChannelsRequest
+
+A request message for adding all connected LIN channels.

package/doc_md/models/interfaces/AddOrUpdateDataProcessorRequest.md

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

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

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

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

@@ -0,0 +1,25 @@
+[**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/BaseNodeProperties.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) / BaseNodeProperties
+
+# Interface: BaseNodeProperties
+
+A message for defining base node properties.

package/doc_md/models/interfaces/BusStatus.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) / BusStatus
+
+# Interface: BusStatus
+
+A message holding bus status information.

package/doc_md/models/interfaces/CanBusParamLimits.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) / CanBusParamLimits
+
+# Interface: CanBusParamLimits
+
+CAN channel bus parameter limits.

package/doc_md/models/interfaces/CanBusParams.md

@@ -0,0 +1,30 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.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

package/doc_md/models/interfaces/CanBusSpeedInfo.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) / 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/CanChannelCapacity.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) / CanChannelCapacity
+
+# Interface: CanChannelCapacity
+
+CAN channel capacity.
+
+## Properties
+
+### maxBitRate
+
+> **maxBitRate**: `number`
+
+Maximum bitrate of the channel. Zero means no limit on bitrate.