@kvaser/canking-api 7.2.1 → 7.3.0

package/doc_md/models/interfaces/PeriodicTransmissionSettings.md

@@ -0,0 +1,145 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / PeriodicTransmissionSettings
+
+# Interface: PeriodicTransmissionSettings
+
+A message defining a periodic transmission setup.
+
+## Properties
+
+### channelIdentifier
+
+> **channelIdentifier**: `string`
+
+The channel to be used
+
+***
+
+### constantBurstSize
+
+> **constantBurstSize**: `number`
+
+Constant burst size that is used if random_burst_size is false
+
+***
+
+### constantIntervalMs
+
+> **constantIntervalMs**: `number`
+
+Constant interval in milliseconds that is used if random_interval is false
+
+***
+
+### frame
+
+> **frame**: [`WriteFrame`](WriteFrame.md)
+
+The message frame to be sent out
+
+***
+
+### identifierMax
+
+> **identifierMax**: `number`
+
+Random/Scan max identifier
+
+***
+
+### identifierMin
+
+> **identifierMin**: `number`
+
+Random/Scan min identifier
+
+***
+
+### numberOfMessages
+
+> **numberOfMessages**: `number`
+
+Number of messages to send out, if set to 0 then messages will be sent out continuously until stop is called
+
+***
+
+### randomBurstSize
+
+> **randomBurstSize**: `boolean`
+
+Send out with random or constant burst size
+
+***
+
+### randomBurstSizeMax
+
+> **randomBurstSizeMax**: `number`
+
+Random max burst size that is used if random_burst_size is true
+
+***
+
+### randomBurstSizeMin
+
+> **randomBurstSizeMin**: `number`
+
+Random min burst size that is used if random_burst_size is true
+
+***
+
+### randomDataLength
+
+> **randomDataLength**: `boolean`
+
+Randomize the messages' data length
+
+***
+
+### randomIdentifier
+
+> **randomIdentifier**: `boolean`
+
+Send out with random identifier, ignored if scan_identifier is set
+
+***
+
+### randomInterval
+
+> **randomInterval**: `boolean`
+
+Send out with random or constant interval
+
+***
+
+### randomIntervalMaxMs
+
+> **randomIntervalMaxMs**: `number`
+
+Random max interval in milliseconds that is used if random_interval is true
+
+***
+
+### randomIntervalMinMs
+
+> **randomIntervalMinMs**: `number`
+
+Random min interval in milliseconds that is used if random_interval is true
+
+***
+
+### randomMessageData
+
+> **randomMessageData**: `boolean`
+
+Randomize the messages' data
+
+***
+
+### scanIdentifier
+
+> **scanIdentifier**: `boolean`
+
+Send out with identifier set from min to max

package/doc_md/models/interfaces/RequestLinMessageRequest.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) / RequestLinMessageRequest
+
+# Interface: RequestLinMessageRequest
+
+A request message for writing a LIN message header to the LIN bus.
+
+## Properties
+
+### channelIdentifier
+
+> **channelIdentifier**: `string`
+
+Identifier of the LIN channel to clear the message buffer on.
+
+***
+
+### frameId
+
+> **frameId**: `number`
+
+The LIN message id to write to the LIN bus.

package/doc_md/models/interfaces/ScheduleTable.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) / ScheduleTable
+
+# Interface: ScheduleTable
+
+A message describing a schedule table.
+
+## Properties
+
+### entries
+
+> **entries**: [`ScheduleTableEntry`](ScheduleTableEntry.md)[]
+
+Schedule table entries
+
+***
+
+### name
+
+> **name**: `string`
+
+Name of the schedule table
+
+***
+
+### qualifiedName
+
+> **qualifiedName**: `string`
+
+Qualified name of the schedule table

package/doc_md/models/interfaces/ScheduleTableEntry.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) / ScheduleTableEntry
+
+# Interface: ScheduleTableEntry
+
+A message describing an entry in a schedule table.
+
+## Properties
+
+### delay
+
+> **delay**: `number`
+
+Delay in milliseconds
+
+***
+
+### messageQualifiedName
+
+> **messageQualifiedName**: `string`
+
+Message qualified name

package/doc_md/models/interfaces/SendLinWakeupFrameRequest.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) / SendLinWakeupFrameRequest
+
+# Interface: SendLinWakeupFrameRequest
+
+A request message for sending out one LIN wakeup frame.
+
+## Properties
+
+### channelIdentifier
+
+> **channelIdentifier**: `string`
+
+Identifier of the LIN channel to send the wakeup frame on.
+
+***
+
+### count
+
+> **count**: `number`
+
+The number of wakeup frames to send. Maximum value of count is 255 (0xFF).
+
+***
+
+### interval
+
+> **interval**: `number`
+
+The time, in bit times, between the wakeup frames. Maximum value of interval is either 255 (0xFF) or 65535 (0xFFFF) depending on device.

package/doc_md/models/interfaces/SendMessageRequest.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) / SendMessageRequest
+
+# Interface: SendMessageRequest
+
+A request message for sending out one message frame.

package/doc_md/models/interfaces/ServiceExtensionSettings.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) / ServiceExtensionSettings
+
+# Interface: ServiceExtensionSettings
+
+A message for defining service extension settings.

package/doc_md/models/interfaces/SetLogLevelRequest.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) / SetLogLevelRequest
+
+# Interface: SetLogLevelRequest
+
+A request message for setting log level.
+
+## Properties
+
+### logLevel
+
+> **logLevel**: [`LogLevel`](../enumerations/LogLevel.md)
+
+The new log level.
+
+***
+
+### preferences
+
+> **preferences**: [`ApiPreferences`](ApiPreferences.md)
+
+API preferences.

package/doc_md/models/interfaces/SetMeasurementSetupRequest.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) / SetMeasurementSetupRequest
+
+# Interface: SetMeasurementSetupRequest
+
+A request message for setting a new measurement setup.

package/doc_md/models/interfaces/SetSignalDataToMessageDataRequest.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) / SetSignalDataToMessageDataRequest
+
+# Interface: SetSignalDataToMessageDataRequest
+
+A request message to set all signal values for a message.
+
+## Properties
+
+### data
+
+> **data**: `number`[]
+
+The current message data.
+
+***
+
+### messageQualifiedName
+
+> **messageQualifiedName**: `string`
+
+Message qualified name.
+
+***
+
+### signalValues
+
+> **signalValues**: [`SignalValue`](SignalValue.md)[]
+
+New signal values. One or more signals to be updated.

package/doc_md/models/interfaces/SetSignalDataToMessageDataResponse.md

@@ -0,0 +1,26 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SetSignalDataToMessageDataResponse
+
+# Interface: SetSignalDataToMessageDataResponse
+
+A response message for SetSignalDataToMessageData request.
+
+## Properties
+
+### data
+
+> **data**: `number`[]
+
+Updated message data.
+
+***
+
+### signalValues
+
+> **signalValues**: [`SignalValue`](SignalValue.md)[]
+
+Updated signal values. Might be different from the once passed in the request if the
+specified signal value couldn't be exactly represented in raw data.

package/doc_md/models/interfaces/SignalDefinition.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) / SignalDefinition
+
+# Interface: SignalDefinition
+
+A message that holds information about a signal.

package/doc_md/models/interfaces/SignalFilterSettings.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) / SignalFilterSettings
+
+# Interface: SignalFilterSettings
+
+A message for defining a signal filter's settings.
+
+## Properties
+
+### selectedSignals
+
+> **selectedSignals**: `string`[]
+
+A comma separated list containing the qualified names of the signals to log

package/doc_md/models/interfaces/SignalLoggerSettings.md

@@ -0,0 +1,225 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SignalLoggerSettings
+
+# Interface: SignalLoggerSettings
+
+A message for defining a signal logger's settings.
+
+## Properties
+
+### autoRestartAfterStop
+
+> **autoRestartAfterStop**: `boolean`
+
+A flag indicating if the logger should auto-restart after stop. Default value is false
+
+***
+
+### colSeparator?
+
+> `optional` **colSeparator**: `Separator`
+
+The column separator to be used. Default value is a comma (,)
+
+***
+
+### dataBytesConverterLimit?
+
+> `optional` **dataBytesConverterLimit**: `number`
+
+Number of data bytes a converter will max write to the log file (1-64). Default value is 64
+
+***
+
+### decimalSeparator?
+
+> `optional` **decimalSeparator**: `DecimalChar`
+
+The decimal separator to be used. Default value is a dot (.)
+
+***
+
+### fileConflictAction
+
+> **fileConflictAction**: [`FileConflictAction`](../enumerations/FileConflictAction.md)
+
+Name conflict action
+
+***
+
+### fileFormat
+
+> **fileFormat**: [`LogFileFormat`](../enumerations/LogFileFormat.md)
+
+The file format to be used
+
+***
+
+### fileName
+
+> **fileName**: `string`
+
+Name of the file to log signals to
+
+***
+
+### numberOfDataDecimals?
+
+> `optional` **numberOfDataDecimals**: `number`
+
+Number of data decimals (0-9). Default value is 4
+
+***
+
+### numberOfTimeDecimals?
+
+> `optional` **numberOfTimeDecimals**: `number`
+
+Number of time decimals (0-9). Default value is 9
+
+***
+
+### signalFilter
+
+> **signalFilter**: [`SignalFilterSettings`](SignalFilterSettings.md)
+
+Any filter
+
+***
+
+### sizeLimit?
+
+> `optional` **sizeLimit**: `number`
+
+Max file size in megabytes before writing to a new file
+
+***
+
+### startTriggerSettings
+
+> **startTriggerSettings**: [`TriggerSettings`](TriggerSettings.md)[]
+
+Any start triggers
+
+***
+
+### startTriggersOperator
+
+> **startTriggersOperator**: [`TriggerOperator`](../enumerations/TriggerOperator.md)
+
+The trigger operator to be used between start triggers
+
+***
+
+### stopTriggerSettings
+
+> **stopTriggerSettings**: [`TriggerSettings`](TriggerSettings.md)[]
+
+Any stop triggers
+
+***
+
+### stopTriggersOperator
+
+> **stopTriggersOperator**: [`TriggerOperator`](../enumerations/TriggerOperator.md)
+
+The trigger operator to be used between stop triggers
+
+***
+
+### timeLimit?
+
+> `optional` **timeLimit**: `number`
+
+Max number of seconds between first and last event before writing to a new file
+
+***
+
+### timeReference?
+
+> `optional` **timeReference**: `TimeReference`
+
+Use the specified time reference. Default value is FIRST_TRIGGER
+
+***
+
+### useCalendarTime?
+
+> `optional` **useCalendarTime**: `boolean`
+
+Write timestamps in calendar time instead of seconds. Default value is false
+
+***
+
+### useEnumValues?
+
+> `optional` **useEnumValues**: `boolean`
+
+Use strings from database instead of integer values. Default value is false
+
+***
+
+### useUtcTime?
+
+> `optional` **useUtcTime**: `boolean`
+
+Use UTC instead of local time for absolute timestamps. Default value is true
+
+***
+
+### writeCounter?
+
+> `optional` **writeCounter**: `boolean`
+
+Write counter. Default value is false
+
+***
+
+### writeDataInHex?
+
+> `optional` **writeDataInHex**: `boolean`
+
+Write data in hexadecimal format. Default value is true
+
+***
+
+### writeFileHeader?
+
+> `optional` **writeFileHeader**: `boolean`
+
+Write file header. Default value is true
+
+***
+
+### writeFullyQualifiedNames?
+
+> `optional` **writeFullyQualifiedNames**: `boolean`
+
+Write fully qualified names. Default value is false
+
+***
+
+### writeIdInHex?
+
+> `optional` **writeIdInHex**: `boolean`
+
+Write ID in hexadecimal format. Default value is true
+
+***
+
+### writeOnlySignals?
+
+> `optional` **writeOnlySignals**: `boolean`
+
+Write only signals and not any data frames. Default value is true
+
+***
+
+### writeUnitsOnOwnRow?
+
+> `optional` **writeUnitsOnOwnRow**: `boolean`
+
+Write units on a new row. Default value is false

package/doc_md/models/interfaces/SignalValue.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) / SignalValue
+
+# Interface: SignalValue
+
+A message that holds a signal's value.

package/doc_md/models/interfaces/SignalValueTrigger.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) / SignalValueTrigger
+
+# Interface: SignalValueTrigger
+
+A message for defining an On Signal Value trigger.
+
+## Properties
+
+### frameId
+
+> **frameId**: `string`
+
+The identifier of the frame containing the signal. Prefix with 0x to indicate hex-format.
+
+***
+
+### frameIdType
+
+> **frameIdType**: `string`
+
+The type of id used, 'extended' or 'standard'
+
+***
+
+### operator
+
+> **operator**: [`SignalValueTriggerOperator`](../enumerations/SignalValueTriggerOperator.md)
+
+The operator to use.
+
+***
+
+### signalMaxValue
+
+> **signalMaxValue**: `number`
+
+The max value to look for, if a value range is used.
+
+***
+
+### signalMinValue
+
+> **signalMinValue**: `number`
+
+The min value to look for, if a value range is used.
+
+***
+
+### signalQualifiedName
+
+> **signalQualifiedName**: `string`
+
+The name of the signal.
+
+***
+
+### signalValue
+
+> **signalValue**: `number`
+
+The value to look for, if a single value is used.