@kvaser/canking-api 7.2.1 → 7.3.0

package/doc_md/hooks/functions/useFixedPositionModeMeasurementData.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useFixedPositionModeMeasurementData
+
+# Function: useFixedPositionModeMeasurementData()
+
+> **useFixedPositionModeMeasurementData**(`start?`): [`Frame`](../../models/interfaces/Frame.md)[]
+
+A hook for fixed position mode measurement data. Will return the latest measurement data for each unique frame id and type.
+
+## Parameters
+
+### start?
+
+`number`
+
+Optional start time to read from the fixed position data buffer. Any frame with a timestamp less than this will be excluded.
+
+## Returns
+
+[`Frame`](../../models/interfaces/Frame.md)[]
+
+The measurement data.

package/doc_md/hooks/functions/useIsOnline.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useIsOnline
+
+# Function: useIsOnline()
+
+> **useIsOnline**(): `boolean`
+
+Hook keeping track of if the measurement is online.
+
+## Returns
+
+`boolean`
+
+A flag that indicates if a measurement is started.

package/doc_md/hooks/functions/useLanguage.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useLanguage
+
+# Function: useLanguage()
+
+> **useLanguage**(): `string`
+
+Hook keeping track of the selected language.
+
+## Returns
+
+`string`
+
+The selected language.

package/doc_md/hooks/functions/useLocalizedStrings.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useLocalizedStrings
+
+# Function: useLocalizedStrings()
+
+> **useLocalizedStrings**(): [`ILocalizedStrings`](../../controls/interfaces/ILocalizedStrings.md)
+
+Hook keeping track of localized strings.
+
+## Returns
+
+[`ILocalizedStrings`](../../controls/interfaces/ILocalizedStrings.md)
+
+The localized strings object.

package/doc_md/hooks/functions/useLogMessages.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useLogMessages
+
+# Function: useLogMessages()
+
+> **useLogMessages**(): [`LogMessage`](../../models/interfaces/LogMessage.md)[]
+
+A hook for log messages.
+
+## Returns
+
+[`LogMessage`](../../models/interfaces/LogMessage.md)[]
+
+The log messages.

package/doc_md/hooks/functions/useMaxDataBytes.md

@@ -0,0 +1,15 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useMaxDataBytes
+
+# Function: useMaxDataBytes()
+
+> **useMaxDataBytes**(): `number`
+
+Hook keeping track of the selected radix for converting numeric values to strings.
+
+## Returns
+
+`number`

package/doc_md/hooks/functions/useMeasurementSetup.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useMeasurementSetup
+
+# Function: useMeasurementSetup()
+
+> **useMeasurementSetup**(): [`MeasurementSetup`](../../models/interfaces/MeasurementSetup.md)
+
+A hook for measurement setup.
+
+## Returns
+
+[`MeasurementSetup`](../../models/interfaces/MeasurementSetup.md)
+
+The measurement setup.

package/doc_md/hooks/functions/useMeasurementStatus.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useMeasurementStatus
+
+# Function: useMeasurementStatus()
+
+> **useMeasurementStatus**(): [`NodeStatus`](../../models/interfaces/NodeStatus.md)[]
+
+A hook for measurement status.
+
+## Returns
+
+[`NodeStatus`](../../models/interfaces/NodeStatus.md)[]
+
+The measurement status.

package/doc_md/hooks/functions/useMessageData.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useMessageData
+
+# Function: useMessageData()
+
+> **useMessageData**(`identifiers`): [`Frame`](../../models/interfaces/Frame.md)[]
+
+A hook for extracting message data from the measurement context. Will return the latest measurement data for the specified identifier.
+
+## Parameters
+
+### identifiers
+
+[`FixedPosFrameIdentifier`](../../models/interfaces/FixedPosFrameIdentifier.md)[]
+
+The fixed position frame identifier to get data for. To avoid unnecessary re-renders, make sure to memoize this object.
+
+## Returns
+
+[`Frame`](../../models/interfaces/Frame.md)[]
+
+The measurement data for the specified identifier.

package/doc_md/hooks/functions/useMessageLogFileFormats.md

@@ -0,0 +1,23 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useMessageLogFileFormats
+
+# Function: useMessageLogFileFormats()
+
+> **useMessageLogFileFormats**(`read_support`): [`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]
+
+Hook keeping track of message log file formats.
+
+## Parameters
+
+### read\_support
+
+`boolean` = `false`
+
+Optional flag to indicate if read support is required.
+
+## Returns
+
+[`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]

package/doc_md/hooks/functions/useNewMeasurementData.md

@@ -0,0 +1,35 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useNewMeasurementData
+
+# ~~Function: useNewMeasurementData()~~
+
+> **useNewMeasurementData**(`numberOfHistoryFrames?`, `predicate?`): [`Frame`](../../models/interfaces/Frame.md)[]
+
+A hook for new measurement data.
+
+## Parameters
+
+### numberOfHistoryFrames?
+
+`number`
+
+Optional number of history frames to read from data buffer when this hook initializes.
+
+### predicate?
+
+(`frame`) => `boolean`
+
+An optional predicate to filter out which data to return.
+
+## Returns
+
+[`Frame`](../../models/interfaces/Frame.md)[]
+
+The new measurement data.
+
+## Deprecated
+
+Use `useScrollModeMeasurementData`, `useFixedPositionModeMeasurementData`, `useMessageData` or `useSignalData` instead.

package/doc_md/hooks/functions/useNodeStatus.md

@@ -0,0 +1,23 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useNodeStatus
+
+# Function: useNodeStatus()
+
+> **useNodeStatus**(`id`): [`NodeStatus`](../../models/interfaces/NodeStatus.md)
+
+Hook to get status for one node.
+
+## Parameters
+
+### id
+
+`string`
+
+## Returns
+
+[`NodeStatus`](../../models/interfaces/NodeStatus.md)
+
+The node status.

package/doc_md/hooks/functions/useNumericRadix.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useNumericRadix
+
+# Function: useNumericRadix()
+
+> **useNumericRadix**(): `number`
+
+Hook keeping track of the selected radix for converting numeric values to strings.
+
+## Returns
+
+`number`
+
+The selected numeric radix.

package/doc_md/hooks/functions/useOnlineStatus.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useOnlineStatus
+
+# Function: useOnlineStatus()
+
+> **useOnlineStatus**(): [`OnlineStatus`](../../models/interfaces/OnlineStatus.md)
+
+A hook for online status.
+
+## Returns
+
+[`OnlineStatus`](../../models/interfaces/OnlineStatus.md)
+
+The online status.

package/doc_md/hooks/functions/useOverallStatusLevel.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useOverallStatusLevel
+
+# Function: useOverallStatusLevel()
+
+> **useOverallStatusLevel**(): [`StatusLevel`](../../models/enumerations/StatusLevel.md)
+
+Hook to get the measurement's highest overall status level.
+
+## Returns
+
+[`StatusLevel`](../../models/enumerations/StatusLevel.md)
+
+The measurement's highest overall status.

package/doc_md/hooks/functions/useProjectData.md

@@ -0,0 +1,49 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useProjectData
+
+# Function: useProjectData()
+
+> **useProjectData**\<`T`\>(`id`, `defaultValue?`): `object`
+
+A hook for data that should be saved to the current project.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### id
+
+`number`
+
+The unique id of the view.
+
+### defaultValue?
+
+`T`
+
+The default value or a callback to set default value.
+
+## Returns
+
+`object`
+
+An object with a flag indicating if the project data has been initialized, the current project data and a setter callback.
+
+### projectData
+
+> **projectData**: `T`
+
+### projectDataIsInitialized
+
+> **projectDataIsInitialized**: `boolean`
+
+### setProjectData
+
+> **setProjectData**: `Dispatch`\<`SetStateAction`\<`T`\>\>

package/doc_md/hooks/functions/useRecentProjectFiles.md

@@ -0,0 +1,15 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useRecentProjectFiles
+
+# Function: useRecentProjectFiles()
+
+> **useRecentProjectFiles**(): `string`[]
+
+Hook keeping track of recent project files.
+
+## Returns
+
+`string`[]

package/doc_md/hooks/functions/useRunningPeriodicTransmissions.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useRunningPeriodicTransmissions
+
+# Function: useRunningPeriodicTransmissions()
+
+> **useRunningPeriodicTransmissions**(): `string`[]
+
+A hook for running periodic transmissions.
+
+## Returns
+
+`string`[]
+
+The running periodic transmissions.

package/doc_md/hooks/functions/useScrollModeMeasurementData.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useScrollModeMeasurementData
+
+# Function: useScrollModeMeasurementData()
+
+> **useScrollModeMeasurementData**(`start?`): [`Frame`](../../models/interfaces/Frame.md)[]
+
+A hook for scroll mode measurement data. Will return the latest measurement data. Will include at most 500 frames.
+
+## Parameters
+
+### start?
+
+`number`
+
+Optional start time to read from the scroll data buffer. Any frame with a timestamp less than this will be excluded.
+
+## Returns
+
+[`Frame`](../../models/interfaces/Frame.md)[]
+
+The measurement data.

package/doc_md/hooks/functions/useSessionData.md

@@ -0,0 +1,49 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useSessionData
+
+# Function: useSessionData()
+
+> **useSessionData**\<`T`\>(`id`, `defaultValue?`): `object`
+
+A hook for data that should be saved to the session data.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### id
+
+`number`
+
+The unique id of the view.
+
+### defaultValue?
+
+`T`
+
+The default value or a callback to set default value.
+
+## Returns
+
+`object`
+
+An object with a flag indicating if the session data has been initialized, the current session data and a setter callback.
+
+### sessionData
+
+> **sessionData**: `T`
+
+### sessionDataIsInitialized
+
+> **sessionDataIsInitialized**: `boolean`
+
+### setSessionData
+
+> **setSessionData**: `Dispatch`\<`SetStateAction`\<`T`\>\>

package/doc_md/hooks/functions/useSignalData.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useSignalData
+
+# Function: useSignalData()
+
+> **useSignalData**(`qualifiedSignalNames`): [`ISignalData`](../interfaces/ISignalData.md)[]
+
+A hook for extracting signal data from the measurement context. Will return the latest measurement data for the specified signal names.
+
+## Parameters
+
+### qualifiedSignalNames
+
+`string`[]
+
+The qualified names of the signals to extract data for. To avoid unnecessary re-renders, make sure to memoize this object.
+
+## Returns
+
+[`ISignalData`](../interfaces/ISignalData.md)[]
+
+The extracted signal data.

package/doc_md/hooks/functions/useSignalLogFileFormats.md

@@ -0,0 +1,15 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useSignalLogFileFormats
+
+# Function: useSignalLogFileFormats()
+
+> **useSignalLogFileFormats**(): [`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]
+
+Hook keeping track of signal log file formats.
+
+## Returns
+
+[`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]

package/doc_md/hooks/functions/useUserSettings.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useUserSettings
+
+# Function: useUserSettings()
+
+> **useUserSettings**(): [`IUserSettings`](../../models/interfaces/IUserSettings.md)
+
+A hook for user settings.
+
+## Returns
+
+[`IUserSettings`](../../models/interfaces/IUserSettings.md)
+
+The user settings.

package/doc_md/hooks/functions/useWorkspacePaneWithId.md

@@ -0,0 +1,21 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useWorkspacePaneWithId
+
+# Function: useWorkspacePaneWithId()
+
+> **useWorkspacePaneWithId**(`id`): [`IWorkspacePaneData`](../../models/interfaces/IWorkspacePaneData.md)
+
+Hook to get/set a workspace pane by id.
+
+## Parameters
+
+### id
+
+`number`
+
+## Returns
+
+[`IWorkspacePaneData`](../../models/interfaces/IWorkspacePaneData.md)

package/doc_md/hooks/interfaces/ISignalData.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / ISignalData
+
+# Interface: ISignalData
+
+Interface for signal data.

package/doc_md/icons/README.md

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../modules.md) / icons
+
+# icons
+
+This module includes icons that can be used in the CanKing UI.

package/doc_md/ipc/README.md

@@ -0,0 +1,47 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../modules.md) / ipc
+
+# ipc
+
+This module includes Inter-Process Communication calls for getting/setting data from/to CanKing.
+
+## Interfaces
+
+- [ILogger](interfaces/ILogger.md)
+
+## Functions
+
+- [addDataProcessor](functions/addDataProcessor.md)
+- [addSource](functions/addSource.md)
+- [addTarget](functions/addTarget.md)
+- [clearLinMessage](functions/clearLinMessage.md)
+- [connectNodes](functions/connectNodes.md)
+- [deleteDataProcessor](functions/deleteDataProcessor.md)
+- [deleteSource](functions/deleteSource.md)
+- [deleteTarget](functions/deleteTarget.md)
+- [disableNode](functions/disableNode.md)
+- [disconnectNodes](functions/disconnectNodes.md)
+- [enableNode](functions/enableNode.md)
+- [getFrameDefinitions](functions/getFrameDefinitions.md)
+- [getLogger](functions/getLogger.md)
+- [getMessageLogFileFormats](functions/getMessageLogFileFormats.md)
+- [getSignalLogFileFormats](functions/getSignalLogFileFormats.md)
+- [requestLinMessage](functions/requestLinMessage.md)
+- [sendCanMessage](functions/sendCanMessage.md)
+- [sendMessage](functions/sendMessage.md)
+- [showMessageBox](functions/showMessageBox.md)
+- [showQuestionBox](functions/showQuestionBox.md)
+- [startLogReplay](functions/startLogReplay.md)
+- [startMeasurement](functions/startMeasurement.md)
+- [startPeriodicTransmission](functions/startPeriodicTransmission.md)
+- [stopLogReplay](functions/stopLogReplay.md)
+- [stopMeasurement](functions/stopMeasurement.md)
+- [stopPeriodicTransmission](functions/stopPeriodicTransmission.md)
+- [updateDataProcessor](functions/updateDataProcessor.md)
+- [updateLinMessage](functions/updateLinMessage.md)
+- [updatePeriodicTransmission](functions/updatePeriodicTransmission.md)
+- [updateSource](functions/updateSource.md)
+- [updateTarget](functions/updateTarget.md)

package/doc_md/ipc/functions/addDataProcessor.md

@@ -0,0 +1,35 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [ipc](../README.md) / addDataProcessor
+
+# Function: addDataProcessor()
+
+> **addDataProcessor**(`dataProcessorNode`, `previousNode?`, `nextNode?`): `Promise`\<`void`\>
+
+Adds a new data processor node to the current measurement setup.
+
+## Parameters
+
+### dataProcessorNode
+
+[`DataProcessorNodeProperties`](../../models/interfaces/DataProcessorNodeProperties.md)
+
+The new data processor node.
+
+### previousNode?
+
+`string`
+
+Identifier of the pervious node in the measurement setup.
+
+### nextNode?
+
+`string`
+
+Identifier of the next node in the measurement setup.
+
+## Returns
+
+`Promise`\<`void`\>