@kvaser/canking-api 7.3.0 → 7.4.0

package/doc_md/ipc/functions/getMessageDataBeforeTimestamp.md

@@ -0,0 +1,38 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [ipc](../README.md) / getMessageDataBeforeTimestamp
+
+# Function: getMessageDataBeforeTimestamp()
+
+> **getMessageDataBeforeTimestamp**(`timestamp`, `maxCount`, `identifiers?`): `Promise`\<[`Frame`](../../models/interfaces/Frame.md)[]\>
+
+Gets message data (frames) before a specific timestamp.
+
+## Parameters
+
+### timestamp
+
+`number`
+
+The timestamp (in seconds since start of measurement) before which frames should be retrieved.
+
+### maxCount
+
+`number`
+
+The maximum number of frames to retrieve.
+
+### identifiers?
+
+[`FixedPosFrameIdentifier`](../../models/interfaces/FixedPosFrameIdentifier.md)[]
+
+An optional collection of frame identifiers to filter the results. If not specified, frames
+                     for all identifiers will be retrieved.
+
+## Returns
+
+`Promise`\<[`Frame`](../../models/interfaces/Frame.md)[]\>
+
+A promise that resolves with a collection of frames.

package/doc_md/ipc/functions/getMessageLogFileFormats.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)
 
 ***
 
@@ -6,12 +6,12 @@
 
 # Function: getMessageLogFileFormats()
 
-> **getMessageLogFileFormats**(): `Promise`\<[`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]\>
+> **getMessageLogFileFormats**(): `Promise`\<`LogFileFormatInfo`[]\>
 
 Gets all available message log file formats.
 
 ## Returns
 
-`Promise`\<[`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]\>
+`Promise`\<`LogFileFormatInfo`[]\>
 
 A promise that resolves with a collection of all available message log file formats.

package/doc_md/ipc/functions/getSignalLogFileFormats.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)
 
 ***
 
@@ -6,12 +6,12 @@
 
 # Function: getSignalLogFileFormats()
 
-> **getSignalLogFileFormats**(): `Promise`\<[`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]\>
+> **getSignalLogFileFormats**(): `Promise`\<`LogFileFormatInfo`[]\>
 
 Gets all available signal log file formats.
 
 ## Returns
 
-`Promise`\<[`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]\>
+`Promise`\<`LogFileFormatInfo`[]\>
 
 A promise that resolves with a collection of all available signal log file formats.

package/doc_md/ipc/functions/requestLinMessage.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/ipc/functions/sendCanMessage.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/ipc/functions/sendMessage.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/ipc/functions/showMessageBox.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/ipc/functions/showQuestionBox.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/ipc/functions/startLogReplay.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/ipc/functions/startMeasurement.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/ipc/functions/startPeriodicTransmission.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/ipc/functions/stopLogReplay.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/ipc/functions/stopMeasurement.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/ipc/functions/stopPeriodicTransmission.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/ipc/functions/updateDataProcessor.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/ipc/functions/updateLinMessage.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/ipc/functions/updatePeriodicTransmission.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/ipc/functions/updateSource.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/ipc/functions/updateTarget.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/ipc/interfaces/ILogger.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/README.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)
 
 ***
 
@@ -11,107 +11,58 @@ This module includes types to be used in communication with CanKing.
 ## Enumerations
 
 - [AccessMode](enumerations/AccessMode.md)
-- [AppEvent](enumerations/AppEvent.md)
 - [CanChannelCap](enumerations/CanChannelCap.md)
+- [CanConfigMode](enumerations/CanConfigMode.md)
 - [CanFrameFlag](enumerations/CanFrameFlag.md)
 - [CanMessageFilterType](enumerations/CanMessageFilterType.md)
 - [CanMode](enumerations/CanMode.md)
-- [DeviceEvent](enumerations/DeviceEvent.md)
+- [DecimalChar](enumerations/DecimalChar.md)
 - [FileConflictAction](enumerations/FileConflictAction.md)
-- [FileType](enumerations/FileType.md)
 - [LinFrameFlag](enumerations/LinFrameFlag.md)
 - [LogFileFormat](enumerations/LogFileFormat.md)
 - [LoggerState](enumerations/LoggerState.md)
 - [LogLevel](enumerations/LogLevel.md)
 - [LogReplayState](enumerations/LogReplayState.md)
-- [MeasurementEvent](enumerations/MeasurementEvent.md)
-- [Protocols](enumerations/Protocols.md)
-- [ServiceExtensionType](enumerations/ServiceExtensionType.md)
+- [Separator](enumerations/Separator.md)
 - [SignalEncoding](enumerations/SignalEncoding.md)
 - [SignalType](enumerations/SignalType.md)
 - [SignalValueTriggerOperator](enumerations/SignalValueTriggerOperator.md)
 - [StatusLevel](enumerations/StatusLevel.md)
+- [TimeReference](enumerations/TimeReference.md)
 - [TriggerOperator](enumerations/TriggerOperator.md)
 
 ## Interfaces
 
-- [AboutInformation](interfaces/AboutInformation.md)
-- [ActivateLicenseRequest](interfaces/ActivateLicenseRequest.md)
-- [AddAllConnectedCanChannelsRequest](interfaces/AddAllConnectedCanChannelsRequest.md)
-- [AddAllConnectedLinChannelsRequest](interfaces/AddAllConnectedLinChannelsRequest.md)
-- [AddOrUpdateDataProcessorRequest](interfaces/AddOrUpdateDataProcessorRequest.md)
-- [AddOrUpdateSourceRequest](interfaces/AddOrUpdateSourceRequest.md)
-- [AddOrUpdateTargetRequest](interfaces/AddOrUpdateTargetRequest.md)
-- [ApiPreferences](interfaces/ApiPreferences.md)
-- [AppEventArgs](interfaces/AppEventArgs.md)
 - [BaseNodeProperties](interfaces/BaseNodeProperties.md)
 - [BusStatus](interfaces/BusStatus.md)
 - [CanBusParamLimits](interfaces/CanBusParamLimits.md)
 - [CanBusParams](interfaces/CanBusParams.md)
-- [CanBusSpeedInfo](interfaces/CanBusSpeedInfo.md)
 - [CanChannelCapacity](interfaces/CanChannelCapacity.md)
 - [CanChannelConfiguration](interfaces/CanChannelConfiguration.md)
-- [CanFDBusSpeedCombination](interfaces/CanFDBusSpeedCombination.md)
-- [CanFDBusSpeedInfo](interfaces/CanFDBusSpeedInfo.md)
 - [CanFrameFlags](interfaces/CanFrameFlags.md)
 - [CanMessageFilterSettings](interfaces/CanMessageFilterSettings.md)
 - [Channel](interfaces/Channel.md)
 - [ChannelSettings](interfaces/ChannelSettings.md)
-- [ClearLinMessageRequest](interfaces/ClearLinMessageRequest.md)
-- [ConnectNodesRequest](interfaces/ConnectNodesRequest.md)
-- [DatabaseFiles](interfaces/DatabaseFiles.md)
 - [DatabasesSettings](interfaces/DatabasesSettings.md)
 - [DataProcessingStatus](interfaces/DataProcessingStatus.md)
 - [DataProcessorNodeProperties](interfaces/DataProcessorNodeProperties.md)
 - [Device](interfaces/Device.md)
-- [DeviceEventArgs](interfaces/DeviceEventArgs.md)
-- [DisconnectNodesRequest](interfaces/DisconnectNodesRequest.md)
+- [Devices](interfaces/Devices.md)
 - [Empty](interfaces/Empty.md)
 - [ErrorStatus](interfaces/ErrorStatus.md)
 - [FixedPosFrameIdentifier](interfaces/FixedPosFrameIdentifier.md)
 - [Frame](interfaces/Frame.md)
 - [FrameDefinition](interfaces/FrameDefinition.md)
+- [FrameDefinitions](interfaces/FrameDefinitions.md)
 - [FramePropertyValue](interfaces/FramePropertyValue.md)
 - [FrameReceivedTrigger](interfaces/FrameReceivedTrigger.md)
-- [GetCanChannelBusSpeedsRequest](interfaces/GetCanChannelBusSpeedsRequest.md)
-- [GetCanChannelBusSpeedsResponse](interfaces/GetCanChannelBusSpeedsResponse.md)
-- [GetCanFdBusSpeedsRequest](interfaces/GetCanFdBusSpeedsRequest.md)
-- [GetCanFdBusSpeedsResponse](interfaces/GetCanFdBusSpeedsResponse.md)
-- [GetChannelsFromLogFileRequest](interfaces/GetChannelsFromLogFileRequest.md)
-- [GetChannelsFromLogFileResponse](interfaces/GetChannelsFromLogFileResponse.md)
-- [GetClassicCanBusSpeedsRequest](interfaces/GetClassicCanBusSpeedsRequest.md)
-- [GetClassicCanBusSpeedsResponse](interfaces/GetClassicCanBusSpeedsResponse.md)
-- [GetDataFramesBeforeTimestampRequest](interfaces/GetDataFramesBeforeTimestampRequest.md)
-- [GetDataProcessorResponse](interfaces/GetDataProcessorResponse.md)
-- [GetDevicesRequest](interfaces/GetDevicesRequest.md)
-- [GetDevicesResponse](interfaces/GetDevicesResponse.md)
-- [GetFrameDefinitionsFromDatabaseFilesRequest](interfaces/GetFrameDefinitionsFromDatabaseFilesRequest.md)
-- [GetLicensesResponse](interfaces/GetLicensesResponse.md)
-- [GetLogFileFormatsRequest](interfaces/GetLogFileFormatsRequest.md)
-- [GetLogFileFormatsResponse](interfaces/GetLogFileFormatsResponse.md)
-- [GetLogLevelResponse](interfaces/GetLogLevelResponse.md)
-- [GetScheduleTablesFromDatabaseFilesRequest](interfaces/GetScheduleTablesFromDatabaseFilesRequest.md)
-- [GetScheduleTablesFromDatabaseFilesResponse](interfaces/GetScheduleTablesFromDatabaseFilesResponse.md)
-- [GetServiceExtensionInfoRequest](interfaces/GetServiceExtensionInfoRequest.md)
-- [GetServiceExtensionInfoResponse](interfaces/GetServiceExtensionInfoResponse.md)
-- [GetSignalDataFromMessageDataRequest](interfaces/GetSignalDataFromMessageDataRequest.md)
-- [GetSignalDataFromMessageDataResponse](interfaces/GetSignalDataFromMessageDataResponse.md)
-- [GetSourceResponse](interfaces/GetSourceResponse.md)
-- [GetTargetResponse](interfaces/GetTargetResponse.md)
-- [IdentifierRequest](interfaces/IdentifierRequest.md)
-- [IdentifiersRequest](interfaces/IdentifiersRequest.md)
-- [ILogFileFormat](interfaces/ILogFileFormat.md)
-- [InstallServiceExtensionRequest](interfaces/InstallServiceExtensionRequest.md)
+- [Frames](interfaces/Frames.md)
 - [InterpreterSettings](interfaces/InterpreterSettings.md)
-- [IProject](interfaces/IProject.md)
 - [IUserSettings](interfaces/IUserSettings.md)
 - [IWorkspaceComponentPaneData](interfaces/IWorkspaceComponentPaneData.md)
 - [IWorkspaceContainerPaneData](interfaces/IWorkspaceContainerPaneData.md)
-- [IWorkspaceData](interfaces/IWorkspaceData.md)
 - [IWorkspacePaneData](interfaces/IWorkspacePaneData.md)
 - [J1939InterpreterSettings](interfaces/J1939InterpreterSettings.md)
-- [LicenseInformation](interfaces/LicenseInformation.md)
-- [Licenses](interfaces/Licenses.md)
 - [LinChannelConfiguration](interfaces/LinChannelConfiguration.md)
 - [LinFrameFlags](interfaces/LinFrameFlags.md)
 - [LoggerStatus](interfaces/LoggerStatus.md)
@@ -119,39 +70,40 @@ This module includes types to be used in communication with CanKing.
 - [LogMessages](interfaces/LogMessages.md)
 - [LogReplaySettings](interfaces/LogReplaySettings.md)
 - [LogReplayStatus](interfaces/LogReplayStatus.md)
-- [MeasurementEventArgs](interfaces/MeasurementEventArgs.md)
 - [MeasurementSetup](interfaces/MeasurementSetup.md)
 - [MessageLoggerSettings](interfaces/MessageLoggerSettings.md)
 - [NodeStatus](interfaces/NodeStatus.md)
 - [NodeStatuses](interfaces/NodeStatuses.md)
 - [OnlineStatus](interfaces/OnlineStatus.md)
 - [PeriodicTransmissionSettings](interfaces/PeriodicTransmissionSettings.md)
-- [RequestLinMessageRequest](interfaces/RequestLinMessageRequest.md)
-- [ScheduleTable](interfaces/ScheduleTable.md)
-- [ScheduleTableEntry](interfaces/ScheduleTableEntry.md)
-- [SendLinWakeupFrameRequest](interfaces/SendLinWakeupFrameRequest.md)
-- [SendMessageRequest](interfaces/SendMessageRequest.md)
 - [ServiceExtensionSettings](interfaces/ServiceExtensionSettings.md)
-- [SetLogLevelRequest](interfaces/SetLogLevelRequest.md)
-- [SetMeasurementSetupRequest](interfaces/SetMeasurementSetupRequest.md)
-- [SetSignalDataToMessageDataRequest](interfaces/SetSignalDataToMessageDataRequest.md)
-- [SetSignalDataToMessageDataResponse](interfaces/SetSignalDataToMessageDataResponse.md)
 - [SignalDefinition](interfaces/SignalDefinition.md)
+- [SignalDefinitions](interfaces/SignalDefinitions.md)
 - [SignalFilterSettings](interfaces/SignalFilterSettings.md)
 - [SignalLoggerSettings](interfaces/SignalLoggerSettings.md)
 - [SignalValue](interfaces/SignalValue.md)
 - [SignalValueTrigger](interfaces/SignalValueTrigger.md)
 - [SourceNodeProperties](interfaces/SourceNodeProperties.md)
-- [StartPeriodicTransmissionRequest](interfaces/StartPeriodicTransmissionRequest.md)
-- [StartPeriodicTransmissionResponse](interfaces/StartPeriodicTransmissionResponse.md)
-- [SubscribeForDataRequest](interfaces/SubscribeForDataRequest.md)
 - [TargetNodeProperties](interfaces/TargetNodeProperties.md)
+- [TdcConfiguration](interfaces/TdcConfiguration.md)
 - [TriggerSettings](interfaces/TriggerSettings.md)
-- [UninstallServiceExtensionRequest](interfaces/UninstallServiceExtensionRequest.md)
-- [UpdateLinMessageRequest](interfaces/UpdateLinMessageRequest.md)
-- [UpdatePeriodicTransmissionRequest](interfaces/UpdatePeriodicTransmissionRequest.md)
 - [WriteFrame](interfaces/WriteFrame.md)
 
+## Type Aliases
+
+- [SerializableFrame](type-aliases/SerializableFrame.md)
+
 ## Variables
 
 - [defaultUserSettings](variables/defaultUserSettings.md)
+
+## Functions
+
+- [decimalToFixed](functions/decimalToFixed.md)
+- [decimalToHex](functions/decimalToHex.md)
+- [deep\_equal](functions/deep_equal.md)
+- [deserializeFrame](functions/deserializeFrame.md)
+- [jsonReplacer](functions/jsonReplacer.md)
+- [jsonReviver](functions/jsonReviver.md)
+- [longToNumber](functions/longToNumber.md)
+- [serializeFrame](functions/serializeFrame.md)

package/doc_md/models/enumerations/AccessMode.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,9 @@ If a handle to the CANlib channel is already open, the call to canOpenChannel()
 
 > **ACCESS\_MODE\_INIT\_ACCESS**: `1`
 
+ACCESS_MODE_INIT_ACCESS - Open the handle with init access.
+A handle opened with init access will set the bitrate when the handle is opened.
+
 ***
 
 ### ACCESS\_MODE\_NO\_INIT\_ACCESS

package/doc_md/models/enumerations/CanChannelCap.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/enumerations/CanConfigMode.md

@@ -0,0 +1,69 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanConfigMode
+
+# Enumeration: CanConfigMode
+
+Possible CAN configuration modes.
+
+## Enumeration Members
+
+### CAN\_CONFIG\_MODE\_3\_SAMPLES
+
+> **CAN\_CONFIG\_MODE\_3\_SAMPLES**: `4`
+
+CAN_CONFIG_MODE_3_SAMPLES - Triple sampling mode.
+
+***
+
+### CAN\_CONFIG\_MODE\_ERR\_SIGNAL\_OFF
+
+> **CAN\_CONFIG\_MODE\_ERR\_SIGNAL\_OFF**: `8192`
+
+CAN_CONFIG_MODE_ERR_SIGNAL_OFF - XL error signalling disable.
+
+***
+
+### CAN\_CONFIG\_MODE\_TDC\_ABS\_SP
+
+> **CAN\_CONFIG\_MODE\_TDC\_ABS\_SP**: `2048`
+
+CAN_CONFIG_MODE_TDC_ABS_SP - kvTdc.offset is relative to TDC instead of Sample Point (SP).
+
+***
+
+### CAN\_CONFIG\_MODE\_TDC\_MANUAL
+
+> **CAN\_CONFIG\_MODE\_TDC\_MANUAL**: `1024`
+
+CAN_CONFIG_MODE_TDC_MANUAL - Use kvTdc.offset instead of delay dynamically measured by the transceiver.
+
+***
+
+### CAN\_CONFIG\_MODE\_TDC\_OFF
+
+> **CAN\_CONFIG\_MODE\_TDC\_OFF**: `512`
+
+CAN_CONFIG_MODE_TDC_OFF - Disable Transmitter-Delay Compensation (TDC).
+
+***
+
+### CAN\_CONFIG\_MODE\_UNSPECIFIED
+
+> **CAN\_CONFIG\_MODE\_UNSPECIFIED**: `0`
+
+***
+
+### CAN\_CONFIG\_MODE\_XL\_TMS
+
+> **CAN\_CONFIG\_MODE\_XL\_TMS**: `4096`
+
+CAN_CONFIG_MODE_XL_TMS - Transceiver Mode Switching to Pulse-Width Modulation in XL Data phase.
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`