@kvaser/canking-api 7.1.0-beta.231 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +142 -44
- package/REDISTRIBUTABLES.txt +86 -2
- package/dist/ElectronAPIFake.js +1 -1
- package/dist/ElectronAPIFake.mjs +16 -13
- package/dist/controls/CanIdentifierControl.d.ts +21 -3
- package/dist/controls/ColumnItemControl.d.ts +36 -0
- package/dist/controls/OneLineButton.d.ts +1 -1
- package/dist/controls/index.d.ts +2 -0
- package/dist/controls.js +1 -1
- package/dist/controls.mjs +1359 -1119
- package/dist/grpc.js +1 -1
- package/dist/grpc.mjs +139 -125
- package/dist/index.js +1 -1
- package/dist/ipc/index.d.ts +6 -0
- package/dist/ipc.js +1 -1
- package/dist/ipc.mjs +28 -25
- package/dist/measurement_settings.js +1 -1
- package/dist/measurement_settings.mjs +461 -430
- package/dist/models/index.d.ts +4 -1
- package/dist/models.js +1 -1
- package/dist/models.mjs +193 -186
- package/dist/protos/app_params.d.ts +10 -0
- package/dist/protos/app_service.d.ts +1 -1
- package/dist/protos/device_service.d.ts +1 -1
- package/dist/protos/frame_params.d.ts +2 -0
- package/dist/protos/measurement_params.d.ts +9 -0
- package/dist/protos/measurement_service.d.ts +30 -2
- package/dist/protos/measurement_settings.d.ts +3 -3
- package/dist/protos/signal_params.d.ts +3 -0
- package/dist/status_params.js +1 -1
- package/dist/status_params.mjs +1932 -1834
- package/doc/assets/favicon.png +0 -0
- package/doc/assets/hierarchy.js +1 -0
- package/doc/assets/highlight.css +16 -16
- package/doc/assets/icons.js +1 -1
- package/doc/assets/icons.svg +1 -1
- package/doc/assets/main.js +5 -5
- package/doc/assets/navigation.js +1 -1
- package/doc/assets/search.js +1 -1
- package/doc/assets/style.css +1405 -1288
- package/doc/classes/controls.LocalizedStrings.html +3 -176
- package/doc/classes/models.DataBuffer.html +16 -189
- package/doc/classes/models.DataBufferView.html +11 -184
- package/doc/classes/models.Point.html +7 -180
- package/doc/enums/models.AccessMode.html +9 -182
- package/doc/enums/models.AppEvent.html +6 -179
- package/doc/enums/models.CanChannelCap.html +44 -217
- package/doc/enums/models.CanFrameFlag.html +27 -200
- package/doc/enums/models.CanMode.html +7 -180
- package/doc/enums/models.DecimalChar.html +5 -178
- package/doc/enums/models.DeviceEvent.html +6 -179
- package/doc/enums/models.FileConflictAction.html +7 -180
- package/doc/enums/models.FileType.html +7 -0
- package/doc/enums/models.LinFrameFlag.html +12 -185
- package/doc/enums/models.LogFileFormat.html +48 -221
- package/doc/enums/models.LogLevel.html +17 -190
- package/doc/enums/models.LogReplayState.html +6 -179
- package/doc/enums/models.MeasurementEvent.html +12 -185
- package/doc/enums/models.MessageLoggerState.html +7 -180
- package/doc/enums/models.Protocols.html +9 -182
- package/doc/enums/models.Separator.html +5 -178
- package/doc/enums/models.SignalEncoding.html +5 -178
- package/doc/enums/models.SignalType.html +12 -185
- package/doc/enums/models.SignalValueTriggerOperator.html +13 -186
- package/doc/enums/models.StatusLevel.html +7 -180
- package/doc/enums/models.TimeReference.html +5 -178
- package/doc/enums/models.TriggerOperator.html +6 -179
- package/doc/functions/controls.CanChannelSelectControl.html +2 -175
- package/doc/functions/controls.CanIdentifierControl.html +2 -175
- package/doc/functions/controls.CanIdentifierFrameControl.html +2 -175
- package/doc/functions/controls.CanIdentifierGeneratorControl.html +2 -175
- package/doc/functions/controls.CanIdentifierGeneratorSettingsControl.html +2 -175
- package/doc/functions/controls.CanKingDataProvider.html +5 -178
- package/doc/functions/controls.CheckboxControl.html +2 -175
- package/doc/functions/controls.ColumnItemControl.html +2 -0
- package/doc/functions/controls.ContextMenu.html +2 -175
- package/doc/functions/controls.DropdownButton.html +2 -175
- package/doc/functions/controls.DropdownButtonTextItems.html +2 -175
- package/doc/functions/controls.DropdownPanel.html +2 -175
- package/doc/functions/controls.FillBox.html +19 -192
- package/doc/functions/controls.FormControlRow.html +2 -175
- package/doc/functions/controls.InlineEditor.html +2 -175
- package/doc/functions/controls.NumberRangeControl.html +2 -175
- package/doc/functions/controls.OneLineButton.html +19 -192
- package/doc/functions/controls.RadioControl.html +2 -175
- package/doc/functions/controls.RadioGroupControl.html +2 -175
- package/doc/functions/controls.SectionControl.html +2 -175
- package/doc/functions/controls.SelectControl.html +2 -175
- package/doc/functions/controls.SizedBox.html +19 -192
- package/doc/functions/controls.TableControl.html +3 -176
- package/doc/functions/controls.TabsPanel.html +19 -192
- package/doc/functions/controls.TextControl.html +2 -175
- package/doc/functions/controls.ToolbarControl.html +2 -175
- package/doc/functions/controls.ValidateableTextControl.html +2 -175
- package/doc/functions/controls.useColumnItem.html +3 -0
- package/doc/functions/controls.useColumnItems.html +4 -0
- package/doc/functions/hooks.useDevices.html +3 -176
- package/doc/functions/hooks.useIsOnline.html +3 -176
- package/doc/functions/hooks.useLanguage.html +3 -176
- package/doc/functions/hooks.useLocalizedStrings.html +3 -176
- package/doc/functions/hooks.useLogMessages.html +3 -176
- package/doc/functions/hooks.useMaxDataBytes.html +2 -175
- package/doc/functions/hooks.useMeasurementSetup.html +3 -176
- package/doc/functions/hooks.useMeasurementStatus.html +3 -176
- package/doc/functions/hooks.useMessageLogFileFormats.html +2 -175
- package/doc/functions/hooks.useNewMeasurementData.html +5 -178
- package/doc/functions/hooks.useNodeStatus.html +3 -176
- package/doc/functions/hooks.useNumericRadix.html +3 -176
- package/doc/functions/hooks.useOnlineStatus.html +3 -176
- package/doc/functions/hooks.useOverallStatusLevel.html +3 -176
- package/doc/functions/hooks.useProjectData.html +5 -178
- package/doc/functions/hooks.useRecentProjectFiles.html +2 -175
- package/doc/functions/hooks.useRunningPeriodicTransmissions.html +3 -176
- package/doc/functions/hooks.useSessionData.html +5 -178
- package/doc/functions/hooks.useUserSettings.html +3 -176
- package/doc/functions/hooks.useWorkspacePaneWithId.html +2 -175
- package/doc/functions/icons.AddIcon.html +4 -175
- package/doc/functions/icons.ArrowDownIcon.html +4 -175
- package/doc/functions/icons.ArrowLeftIcon.html +4 -175
- package/doc/functions/icons.ArrowRightIcon.html +4 -175
- package/doc/functions/icons.ArrowUpIcon.html +4 -175
- package/doc/functions/icons.BusIsOffIcon.html +4 -175
- package/doc/functions/icons.BusIsOnIcon.html +4 -175
- package/doc/functions/icons.CloseIcon.html +4 -175
- package/doc/functions/icons.CopyIcon.html +4 -175
- package/doc/functions/icons.DarkModeIcon.html +4 -175
- package/doc/functions/icons.DeleteIcon.html +4 -175
- package/doc/functions/icons.DisableIcon.html +4 -175
- package/doc/functions/icons.EditIcon.html +4 -175
- package/doc/functions/icons.FilterIcon.html +4 -175
- package/doc/functions/icons.FixedPositionIcon.html +4 -175
- package/doc/functions/icons.LeaveFullScreenIcon.html +4 -175
- package/doc/functions/icons.LightModeIcon.html +4 -175
- package/doc/functions/icons.LineArrowDownIcon.html +4 -175
- package/doc/functions/icons.LineArrowUpIcon.html +4 -175
- package/doc/functions/icons.MaximizeWindowIcon.html +4 -175
- package/doc/functions/icons.MeasurementSetupIcon.html +4 -175
- package/doc/functions/icons.MoreHorizIcon.html +4 -175
- package/doc/functions/icons.MoreVertIcon.html +4 -175
- package/doc/functions/icons.NewIcon.html +4 -175
- package/doc/functions/icons.OpenExternallyIcon.html +4 -175
- package/doc/functions/icons.OpenIcon.html +4 -175
- package/doc/functions/icons.PauseIcon.html +4 -175
- package/doc/functions/icons.PlayIcon.html +4 -175
- package/doc/functions/icons.PlaySolidIcon.html +4 -175
- package/doc/functions/icons.SaveIcon.html +4 -175
- package/doc/functions/icons.SelectAllIcon.html +4 -175
- package/doc/functions/icons.ServiceIconActive.html +4 -175
- package/doc/functions/icons.ServiceIconInactive.html +4 -175
- package/doc/functions/icons.SettingsIcon.html +4 -175
- package/doc/functions/icons.StopIcon.html +4 -175
- package/doc/functions/icons.StopSolidIcon.html +4 -175
- package/doc/functions/icons.ToolsPanelHiddenIcon.html +4 -175
- package/doc/functions/icons.ToolsPanelVisibleIcon.html +4 -175
- package/doc/functions/icons.UnmaximizeWindowIcon.html +4 -175
- package/doc/functions/icons.WorkspacesIcon.html +4 -175
- package/doc/functions/ipc.addDataProcessor.html +3 -176
- package/doc/functions/ipc.addSource.html +3 -176
- package/doc/functions/ipc.addTarget.html +3 -176
- package/doc/functions/ipc.connectNodes.html +3 -176
- package/doc/functions/ipc.deleteDataProcessor.html +3 -176
- package/doc/functions/ipc.deleteSource.html +3 -176
- package/doc/functions/ipc.deleteTarget.html +3 -176
- package/doc/functions/ipc.disableNode.html +3 -176
- package/doc/functions/ipc.disconnectNodes.html +3 -176
- package/doc/functions/ipc.enableNode.html +3 -176
- package/doc/functions/ipc.getFrameDefinitions.html +3 -176
- package/doc/functions/ipc.getLogger.html +3 -176
- package/doc/functions/ipc.getMessageLogFileFormats.html +3 -176
- package/doc/functions/ipc.sendCanMessage.html +4 -177
- package/doc/functions/ipc.sendMessage.html +3 -176
- package/doc/functions/ipc.showMessageBox.html +3 -176
- package/doc/functions/ipc.showQuestionBox.html +3 -176
- package/doc/functions/ipc.startLogReplay.html +3 -176
- package/doc/functions/ipc.startMeasurement.html +2 -175
- package/doc/functions/ipc.startPeriodicTransmission.html +3 -176
- package/doc/functions/ipc.stopLogReplay.html +3 -176
- package/doc/functions/ipc.stopMeasurement.html +2 -175
- package/doc/functions/ipc.stopPeriodicTransmission.html +3 -176
- package/doc/functions/ipc.updateDataProcessor.html +3 -176
- package/doc/functions/ipc.updatePeriodicTransmission.html +4 -0
- package/doc/functions/ipc.updateSource.html +3 -176
- package/doc/functions/ipc.updateTarget.html +3 -176
- package/doc/functions/models.accessModeFromJSON.html +1 -174
- package/doc/functions/models.accessModeToJSON.html +1 -174
- package/doc/functions/models.appEventFromJSON.html +1 -174
- package/doc/functions/models.appEventToJSON.html +1 -174
- package/doc/functions/models.canChannelCapFromJSON.html +1 -174
- package/doc/functions/models.canChannelCapToJSON.html +1 -174
- package/doc/functions/models.canFrameFlagFromJSON.html +1 -174
- package/doc/functions/models.canFrameFlagToJSON.html +1 -174
- package/doc/functions/models.canModeFromJSON.html +1 -174
- package/doc/functions/models.canModeToJSON.html +1 -174
- package/doc/functions/models.createElectronApiFake.html +3 -176
- package/doc/functions/models.decimalCharFromJSON.html +1 -174
- package/doc/functions/models.decimalCharToJSON.html +1 -174
- package/doc/functions/models.decimalToFixed.html +1 -174
- package/doc/functions/models.decimalToHex.html +1 -174
- package/doc/functions/models.deviceEventFromJSON.html +1 -174
- package/doc/functions/models.deviceEventToJSON.html +1 -174
- package/doc/functions/models.fileConflictActionFromJSON.html +1 -174
- package/doc/functions/models.fileConflictActionToJSON.html +1 -174
- package/doc/functions/models.fileTypeFromJSON.html +1 -0
- package/doc/functions/models.fileTypeToJSON.html +1 -0
- package/doc/functions/models.linFrameFlagFromJSON.html +1 -174
- package/doc/functions/models.linFrameFlagToJSON.html +1 -174
- package/doc/functions/models.logFileFormatFromJSON.html +1 -174
- package/doc/functions/models.logFileFormatToJSON.html +1 -174
- package/doc/functions/models.logLevelFromJSON.html +1 -174
- package/doc/functions/models.logLevelToJSON.html +1 -174
- package/doc/functions/models.logReplayStateFromJSON.html +1 -174
- package/doc/functions/models.logReplayStateToJSON.html +1 -174
- package/doc/functions/models.longToNumber.html +1 -174
- package/doc/functions/models.measurementEventFromJSON.html +1 -174
- package/doc/functions/models.measurementEventToJSON.html +1 -174
- package/doc/functions/models.messageLoggerStateFromJSON.html +1 -174
- package/doc/functions/models.messageLoggerStateToJSON.html +1 -174
- package/doc/functions/models.protocolsFromJSON.html +1 -174
- package/doc/functions/models.protocolsToJSON.html +1 -174
- package/doc/functions/models.separatorFromJSON.html +1 -174
- package/doc/functions/models.separatorToJSON.html +1 -174
- package/doc/functions/models.signalEncodingFromJSON.html +1 -174
- package/doc/functions/models.signalEncodingToJSON.html +1 -174
- package/doc/functions/models.signalTypeFromJSON.html +1 -174
- package/doc/functions/models.signalTypeToJSON.html +1 -174
- package/doc/functions/models.signalValueTriggerOperatorFromJSON.html +1 -174
- package/doc/functions/models.signalValueTriggerOperatorToJSON.html +1 -174
- package/doc/functions/models.statusLevelFromJSON.html +1 -174
- package/doc/functions/models.statusLevelToJSON.html +1 -174
- package/doc/functions/models.timeReferenceFromJSON.html +1 -174
- package/doc/functions/models.timeReferenceToJSON.html +1 -174
- package/doc/functions/models.triggerOperatorFromJSON.html +1 -174
- package/doc/functions/models.triggerOperatorToJSON.html +1 -174
- package/doc/hierarchy.html +1 -174
- package/doc/index.html +99 -227
- package/doc/interfaces/controls.ButtonGroupProps.html +6 -179
- package/doc/interfaces/controls.ButtonProps.html +10 -183
- package/doc/interfaces/controls.CanChannelSelectControlProps.html +14 -187
- package/doc/interfaces/controls.CanIdentifierControlProps.html +16 -189
- package/doc/interfaces/controls.CanIdentifierFrameControlProps.html +14 -185
- package/doc/interfaces/controls.CanIdentifierGeneratorControlProps.html +27 -196
- package/doc/interfaces/controls.CanIdentifierGeneratorSettingsControlProps.html +17 -186
- package/doc/interfaces/controls.CheckboxControlProps.html +7 -180
- package/doc/interfaces/controls.ColumnItemControlProps.html +4 -0
- package/doc/interfaces/controls.ContextMenuProps.html +6 -179
- package/doc/interfaces/controls.DropdownButtonChildrenProps.html +4 -177
- package/doc/interfaces/controls.DropdownButtonProps.html +11 -184
- package/doc/interfaces/controls.DropdownButtonTextItemsProps.html +9 -182
- package/doc/interfaces/controls.DropdownPanelProps.html +15 -188
- package/doc/interfaces/controls.FormControlRowProps.html +7 -180
- package/doc/interfaces/controls.ILocalizedStrings.html +3 -176
- package/doc/interfaces/controls.InlineEditorProps.html +9 -182
- package/doc/interfaces/controls.LabelProps.html +3 -176
- package/doc/interfaces/controls.NumberRangeControlProps.html +41 -214
- package/doc/interfaces/controls.RadioControlProps.html +4 -177
- package/doc/interfaces/controls.RadioGroupControlProps.html +6 -179
- package/doc/interfaces/controls.SectionControlProps.html +8 -181
- package/doc/interfaces/controls.SelectControlProps.html +20 -193
- package/doc/interfaces/controls.TableColumn.html +10 -183
- package/doc/interfaces/controls.TableControlProps.html +18 -191
- package/doc/interfaces/controls.TextControlProps.html +24 -197
- package/doc/interfaces/controls.ToggleButtonGroupProps.html +9 -182
- package/doc/interfaces/controls.ToggleButtonProps.html +5 -178
- package/doc/interfaces/controls.ToolbarControlProps.html +9 -182
- package/doc/interfaces/controls.ValidateableTextControlProps.html +40 -213
- package/doc/interfaces/controls.toolbarItem.html +7 -180
- package/doc/interfaces/ipc.ILogger.html +3 -176
- package/doc/interfaces/models.AboutInformation.html +8 -181
- package/doc/interfaces/models.ActivateLicenseRequest.html +6 -179
- package/doc/interfaces/models.AddAllConnectedCanChannelsRequest.html +3 -176
- package/doc/interfaces/models.AddAllConnectedLinChannelsRequest.html +3 -176
- package/doc/interfaces/models.AddOrUpdateDataProcessorRequest.html +9 -182
- package/doc/interfaces/models.AddOrUpdateSourceRequest.html +5 -178
- package/doc/interfaces/models.AddOrUpdateTargetRequest.html +5 -178
- package/doc/interfaces/models.ApiPreferences.html +5 -178
- package/doc/interfaces/models.AppEventArgs.html +4 -177
- package/doc/interfaces/models.BaseNodeProperties.html +5 -178
- package/doc/interfaces/models.BusStatus.html +17 -190
- package/doc/interfaces/models.CanBusParamLimits.html +7 -180
- package/doc/interfaces/models.CanBusParams.html +3 -176
- package/doc/interfaces/models.CanBusSpeed.html +12 -185
- package/doc/interfaces/models.CanBusSpeedInfo.html +18 -191
- package/doc/interfaces/models.CanChannelCapacity.html +7 -180
- package/doc/interfaces/models.CanChannelConfiguration.html +12 -185
- package/doc/interfaces/models.CanFDBusSpeedCombination.html +4 -177
- package/doc/interfaces/models.CanFDBusSpeedInfo.html +14 -187
- package/doc/interfaces/models.CanFrameFlags.html +3 -176
- package/doc/interfaces/models.CanMessageFilterSettings.html +5 -178
- package/doc/interfaces/models.Channel.html +5 -178
- package/doc/interfaces/models.ChannelSettings.html +20 -193
- package/doc/interfaces/models.ClearLinMessageRequest.html +6 -179
- package/doc/interfaces/models.ConnectNodesRequest.html +4 -177
- package/doc/interfaces/models.DataProcessingStatus.html +6 -179
- package/doc/interfaces/models.DataProcessorNodeProperties.html +8 -181
- package/doc/interfaces/models.DatabasesSettings.html +3 -176
- package/doc/interfaces/models.Device.html +6 -179
- package/doc/interfaces/models.DeviceEventArgs.html +4 -177
- package/doc/interfaces/models.Devices.html +2 -175
- package/doc/interfaces/models.DisconnectNodesRequest.html +4 -177
- package/doc/interfaces/models.Empty.html +2 -175
- package/doc/interfaces/models.ErrorStatus.html +3 -176
- package/doc/interfaces/models.Frame.html +19 -192
- package/doc/interfaces/models.FrameDefinition.html +10 -181
- package/doc/interfaces/models.FrameDefinitions.html +2 -175
- package/doc/interfaces/models.FramePropertyValue.html +4 -177
- package/doc/interfaces/models.FrameReceivedTrigger.html +6 -179
- package/doc/interfaces/models.Frame_PropertiesEntry.html +2 -175
- package/doc/interfaces/models.Frames.html +2 -175
- package/doc/interfaces/models.GetCanChannelBusSpeedsRequest.html +3 -176
- package/doc/interfaces/models.GetCanChannelBusSpeedsResponse.html +6 -179
- package/doc/interfaces/models.GetCanFdBusSpeedsRequest.html +5 -178
- package/doc/interfaces/models.GetCanFdBusSpeedsResponse.html +4 -177
- package/doc/interfaces/models.GetChannelsFromLogFileRequest.html +4 -177
- package/doc/interfaces/models.GetChannelsFromLogFileResponse.html +3 -176
- package/doc/interfaces/models.GetClassicCanBusSpeedsRequest.html +4 -177
- package/doc/interfaces/models.GetClassicCanBusSpeedsResponse.html +4 -177
- package/doc/interfaces/models.GetDataProcessorResponse.html +3 -176
- package/doc/interfaces/models.GetDevicesRequest.html +3 -176
- package/doc/interfaces/models.GetDevicesResponse.html +3 -176
- package/doc/interfaces/models.GetFrameDefinitionsFromDatabaseFilesRequest.html +3 -176
- package/doc/interfaces/models.GetLicensesResponse.html +3 -176
- package/doc/interfaces/models.GetLogFileFormatsRequest.html +6 -179
- package/doc/interfaces/models.GetLogFileFormatsResponse.html +3 -176
- package/doc/interfaces/models.GetLogLevelResponse.html +4 -177
- package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesRequest.html +3 -176
- package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesResponse.html +3 -176
- package/doc/interfaces/models.GetServiceExtensionInfoRequest.html +4 -177
- package/doc/interfaces/models.GetServiceExtensionInfoResponse.html +7 -180
- package/doc/interfaces/models.GetSignalDataFromMessageDataRequest.html +5 -178
- package/doc/interfaces/models.GetSignalDataFromMessageDataResponse.html +4 -177
- package/doc/interfaces/models.GetSourceResponse.html +3 -176
- package/doc/interfaces/models.GetTargetResponse.html +3 -176
- package/doc/interfaces/models.ILogFileFormat.html +3 -176
- package/doc/interfaces/models.IProject.html +4 -177
- package/doc/interfaces/models.IUserSettings.html +13 -183
- package/doc/interfaces/models.IWorkspaceComponentPaneData.html +4 -177
- package/doc/interfaces/models.IWorkspaceContainerPaneData.html +4 -177
- package/doc/interfaces/models.IWorkspaceData.html +4 -177
- package/doc/interfaces/models.IWorkspacePaneData.html +4 -177
- package/doc/interfaces/models.IdentifierRequest.html +3 -176
- package/doc/interfaces/models.IdentifiersRequest.html +3 -176
- package/doc/interfaces/models.InstallServiceExtensionRequest.html +6 -179
- package/doc/interfaces/models.InterpreterSettings.html +4 -177
- package/doc/interfaces/models.J1939InterpreterSettings.html +2 -175
- package/doc/interfaces/models.LicenseInformation.html +18 -191
- package/doc/interfaces/models.Licenses.html +3 -176
- package/doc/interfaces/models.LinChannelConfiguration.html +12 -185
- package/doc/interfaces/models.LinFrameFlags.html +3 -176
- package/doc/interfaces/models.LogMessage.html +8 -181
- package/doc/interfaces/models.LogMessages.html +3 -176
- package/doc/interfaces/models.LogReplaySettings.html +24 -197
- package/doc/interfaces/models.LogReplaySettings_ChannelIdentifiersEntry.html +2 -175
- package/doc/interfaces/models.LogReplayStatus.html +3 -176
- package/doc/interfaces/models.MeasurementEventArgs.html +5 -178
- package/doc/interfaces/models.MeasurementSetup.html +3 -176
- package/doc/interfaces/models.MessageLoggerSettings.html +40 -213
- package/doc/interfaces/models.MessageLoggerStatus.html +3 -176
- package/doc/interfaces/models.NodeStatus.html +18 -191
- package/doc/interfaces/models.NodeStatuses.html +3 -176
- package/doc/interfaces/models.OnlineStatus.html +3 -176
- package/doc/interfaces/models.PeriodicTransmissionSettings.html +34 -207
- package/doc/interfaces/models.RequestLinMessageRequest.html +6 -179
- package/doc/interfaces/models.ScheduleTable.html +5 -178
- package/doc/interfaces/models.ScheduleTableEntry.html +5 -178
- package/doc/interfaces/models.SendLinWakeupFrameRequest.html +4 -177
- package/doc/interfaces/models.SendMessageRequest.html +3 -176
- package/doc/interfaces/models.ServiceExtensionSettings.html +4 -177
- package/doc/interfaces/models.SetLogLevelRequest.html +4 -177
- package/doc/interfaces/models.SetMeasurementSetupRequest.html +3 -176
- package/doc/interfaces/models.SetSignalDataToMessageDataRequest.html +7 -180
- package/doc/interfaces/models.SetSignalDataToMessageDataResponse.html +5 -178
- package/doc/interfaces/models.SignalDefinition.html +11 -181
- package/doc/interfaces/models.SignalDefinition_EnumValuesEntry.html +2 -175
- package/doc/interfaces/models.SignalDefinitions.html +2 -175
- package/doc/interfaces/models.SignalValue.html +5 -178
- package/doc/interfaces/models.SignalValueTrigger.html +14 -187
- package/doc/interfaces/models.SourceNodeProperties.html +7 -180
- package/doc/interfaces/models.StartPeriodicTransmissionRequest.html +3 -176
- package/doc/interfaces/models.StartPeriodicTransmissionResponse.html +3 -176
- package/doc/interfaces/models.TargetNodeProperties.html +5 -178
- package/doc/interfaces/models.TriggerSettings.html +8 -181
- package/doc/interfaces/models.UninstallServiceExtensionRequest.html +3 -176
- package/doc/interfaces/models.UpdateLinMessageRequest.html +4 -177
- package/doc/interfaces/models.UpdatePeriodicTransmissionRequest.html +7 -0
- package/doc/interfaces/models.WriteFrame.html +6 -179
- package/doc/modules/controls.html +3 -237
- package/doc/modules/hooks.html +3 -196
- package/doc/modules/icons.html +2 -216
- package/doc/modules/ipc.html +2 -202
- package/doc/modules/models.html +2 -478
- package/doc/modules.html +1 -179
- package/doc/types/controls.ContextMenuOption.html +6 -179
- package/doc/types/controls.SelectOption.html +4 -177
- package/doc/types/controls.StringsMap.html +2 -175
- package/doc/types/controls.canIdentifierType.html +2 -175
- package/doc/types/models.IReadOnlyDataBuffer.html +1 -174
- package/doc/types/models.themes.html +1 -174
- package/doc/variables/models.AboutInformation-1.html +1 -174
- package/doc/variables/models.ActivateLicenseRequest-1.html +1 -174
- package/doc/variables/models.AddAllConnectedCanChannelsRequest-1.html +1 -174
- package/doc/variables/models.AddAllConnectedLinChannelsRequest-1.html +1 -174
- package/doc/variables/models.AddOrUpdateDataProcessorRequest-1.html +1 -174
- package/doc/variables/models.AddOrUpdateSourceRequest-1.html +1 -174
- package/doc/variables/models.AddOrUpdateTargetRequest-1.html +1 -174
- package/doc/variables/models.ApiPreferences-1.html +1 -174
- package/doc/variables/models.AppEventArgs-1.html +1 -174
- package/doc/variables/models.BaseNodeProperties-1.html +1 -174
- package/doc/variables/models.BusStatus-1.html +1 -174
- package/doc/variables/models.CanBusParamLimits-1.html +1 -174
- package/doc/variables/models.CanBusParams-1.html +1 -174
- package/doc/variables/models.CanBusSpeed-1.html +1 -174
- package/doc/variables/models.CanBusSpeedInfo-1.html +1 -174
- package/doc/variables/models.CanChannelCapacity-1.html +1 -174
- package/doc/variables/models.CanChannelConfiguration-1.html +1 -174
- package/doc/variables/models.CanFDBusSpeedCombination-1.html +1 -174
- package/doc/variables/models.CanFDBusSpeedInfo-1.html +1 -174
- package/doc/variables/models.CanFrameFlags-1.html +1 -174
- package/doc/variables/models.CanMessageFilterSettings-1.html +1 -174
- package/doc/variables/models.Channel-1.html +1 -174
- package/doc/variables/models.ChannelSettings-1.html +1 -174
- package/doc/variables/models.ClearLinMessageRequest-1.html +1 -174
- package/doc/variables/models.ConnectNodesRequest-1.html +1 -174
- package/doc/variables/models.DataProcessingStatus-1.html +1 -174
- package/doc/variables/models.DataProcessorNodeProperties-1.html +1 -174
- package/doc/variables/models.DatabasesSettings-1.html +1 -174
- package/doc/variables/models.Device-1.html +1 -174
- package/doc/variables/models.DeviceEventArgs-1.html +1 -174
- package/doc/variables/models.Devices-1.html +1 -174
- package/doc/variables/models.DisconnectNodesRequest-1.html +1 -174
- package/doc/variables/models.Empty-1.html +1 -174
- package/doc/variables/models.ErrorStatus-1.html +1 -174
- package/doc/variables/models.Frame-1.html +1 -174
- package/doc/variables/models.FrameDefinition-1.html +1 -174
- package/doc/variables/models.FrameDefinitions-1.html +1 -174
- package/doc/variables/models.FramePropertyValue-1.html +1 -174
- package/doc/variables/models.FrameReceivedTrigger-1.html +1 -174
- package/doc/variables/models.Frame_PropertiesEntry-1.html +1 -174
- package/doc/variables/models.Frames-1.html +1 -174
- package/doc/variables/models.GetCanChannelBusSpeedsRequest-1.html +1 -174
- package/doc/variables/models.GetCanChannelBusSpeedsResponse-1.html +1 -174
- package/doc/variables/models.GetCanFdBusSpeedsRequest-1.html +1 -174
- package/doc/variables/models.GetCanFdBusSpeedsResponse-1.html +1 -174
- package/doc/variables/models.GetChannelsFromLogFileRequest-1.html +1 -174
- package/doc/variables/models.GetChannelsFromLogFileResponse-1.html +1 -174
- package/doc/variables/models.GetClassicCanBusSpeedsRequest-1.html +1 -174
- package/doc/variables/models.GetClassicCanBusSpeedsResponse-1.html +1 -174
- package/doc/variables/models.GetDataProcessorResponse-1.html +1 -174
- package/doc/variables/models.GetDevicesRequest-1.html +1 -174
- package/doc/variables/models.GetDevicesResponse-1.html +1 -174
- package/doc/variables/models.GetFrameDefinitionsFromDatabaseFilesRequest-1.html +1 -174
- package/doc/variables/models.GetLicensesResponse-1.html +1 -174
- package/doc/variables/models.GetLogFileFormatsRequest-1.html +1 -174
- package/doc/variables/models.GetLogFileFormatsResponse-1.html +1 -174
- package/doc/variables/models.GetLogLevelResponse-1.html +1 -174
- package/doc/variables/models.GetScheduleTablesFromDatabaseFilesRequest-1.html +1 -174
- package/doc/variables/models.GetScheduleTablesFromDatabaseFilesResponse-1.html +1 -174
- package/doc/variables/models.GetServiceExtensionInfoRequest-1.html +1 -174
- package/doc/variables/models.GetServiceExtensionInfoResponse-1.html +1 -174
- package/doc/variables/models.GetSignalDataFromMessageDataRequest-1.html +1 -174
- package/doc/variables/models.GetSignalDataFromMessageDataResponse-1.html +1 -174
- package/doc/variables/models.GetSourceResponse-1.html +1 -174
- package/doc/variables/models.GetTargetResponse-1.html +1 -174
- package/doc/variables/models.IdentifierRequest-1.html +1 -174
- package/doc/variables/models.IdentifiersRequest-1.html +1 -174
- package/doc/variables/models.InstallServiceExtensionRequest-1.html +1 -174
- package/doc/variables/models.InterpreterSettings-1.html +1 -174
- package/doc/variables/models.J1939InterpreterSettings-1.html +1 -174
- package/doc/variables/models.LicenseInformation-1.html +1 -174
- package/doc/variables/models.Licenses-1.html +1 -174
- package/doc/variables/models.LinChannelConfiguration-1.html +1 -174
- package/doc/variables/models.LinFrameFlags-1.html +1 -174
- package/doc/variables/models.LogMessage-1.html +1 -174
- package/doc/variables/models.LogMessages-1.html +1 -174
- package/doc/variables/models.LogReplaySettings-1.html +1 -174
- package/doc/variables/models.LogReplaySettings_ChannelIdentifiersEntry-1.html +1 -174
- package/doc/variables/models.LogReplayStatus-1.html +1 -174
- package/doc/variables/models.MeasurementEventArgs-1.html +1 -174
- package/doc/variables/models.MeasurementSetup-1.html +1 -174
- package/doc/variables/models.MessageLoggerSettings-1.html +1 -174
- package/doc/variables/models.MessageLoggerStatus-1.html +1 -174
- package/doc/variables/models.NodeStatus-1.html +1 -174
- package/doc/variables/models.NodeStatuses-1.html +1 -174
- package/doc/variables/models.OnlineStatus-1.html +1 -174
- package/doc/variables/models.PeriodicTransmissionSettings-1.html +1 -174
- package/doc/variables/models.RequestLinMessageRequest-1.html +1 -174
- package/doc/variables/models.ScheduleTable-1.html +1 -174
- package/doc/variables/models.ScheduleTableEntry-1.html +1 -174
- package/doc/variables/models.SendLinWakeupFrameRequest-1.html +1 -174
- package/doc/variables/models.SendMessageRequest-1.html +1 -174
- package/doc/variables/models.ServiceExtensionSettings-1.html +1 -174
- package/doc/variables/models.SetLogLevelRequest-1.html +1 -174
- package/doc/variables/models.SetMeasurementSetupRequest-1.html +1 -174
- package/doc/variables/models.SetSignalDataToMessageDataRequest-1.html +1 -174
- package/doc/variables/models.SetSignalDataToMessageDataResponse-1.html +1 -174
- package/doc/variables/models.SignalDefinition-1.html +1 -174
- package/doc/variables/models.SignalDefinition_EnumValuesEntry-1.html +1 -174
- package/doc/variables/models.SignalDefinitions-1.html +1 -174
- package/doc/variables/models.SignalValue-1.html +1 -174
- package/doc/variables/models.SignalValueTrigger-1.html +1 -174
- package/doc/variables/models.SourceNodeProperties-1.html +1 -174
- package/doc/variables/models.StartPeriodicTransmissionRequest-1.html +1 -174
- package/doc/variables/models.StartPeriodicTransmissionResponse-1.html +1 -174
- package/doc/variables/models.TargetNodeProperties-1.html +1 -174
- package/doc/variables/models.TriggerSettings-1.html +1 -174
- package/doc/variables/models.UninstallServiceExtensionRequest-1.html +1 -174
- package/doc/variables/models.UpdateLinMessageRequest-1.html +1 -174
- package/doc/variables/models.UpdatePeriodicTransmissionRequest-1.html +1 -0
- package/doc/variables/models.WriteFrame-1.html +1 -174
- package/doc/variables/models.defaultUserSettings.html +2 -175
- package/index.js +14 -0
- package/licenses/ELECTRON-TOOLKIT-PRELOAD_MIT.TXT +21 -0
- package/licenses/FAST-DEEP-EQUAL_MIT.TXT +21 -0
- package/licenses/GOOGLE-PROTOBUF_(BSD-3-CLAUSE AND APACHE-2.0).TXT +29 -0
- package/licenses/REACT-DOM_MIT.TXT +21 -0
- package/licenses/REACT_MIT.TXT +21 -0
- package/licenses/UUID_MIT.TXT +9 -0
- package/licenses/licenses.css +22 -0
- package/licenses/licenses.html +67 -0
- package/package.json +11 -18
- package/doc/assets/material-style.css +0 -247
- package/scripts/createCanKingExtension.js +0 -403
- package/scripts/index.js +0 -39
- package/scripts/template/_.eslintrc.cjs +0 -38
- package/scripts/template/_.gitignore +0 -24
- package/scripts/template/_.npmrc +0 -2
- package/scripts/template/_.prettierrc +0 -8
- package/scripts/template/_.vscode/_launch.json +0 -28
- package/scripts/template/_index.html +0 -15
- package/scripts/template/_tsconfig.app.json +0 -27
- package/scripts/template/_tsconfig.json +0 -11
- package/scripts/template/_tsconfig.node.json +0 -13
- package/scripts/template/_vite.config.ts +0 -7
- package/scripts/template/src/App.tsx +0 -12
- package/scripts/template/src/WorkspaceView/index.tsx +0 -47
- package/scripts/template/src/main.css +0 -9
- package/scripts/template/src/main.tsx +0 -19
- package/scripts/template/src/vite-env.d.ts +0 -1
package/README.md
CHANGED
|
@@ -1,58 +1,140 @@
|
|
|
1
1
|
# Kvaser CanKing GUI Extensions SDK
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Introduction
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
The purpose with this package is to help developers to create user interface extensions for the Kvaser CanKing bus analysis tool.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Kvaser CanKing is a free of charge, general-purpose CAN and LIN bus analysis software that is compatible with all Kvaser CAN
|
|
8
|
+
and LIN interfaces and the Kvaser virtual CAN bus. It's available on Windows (x64) and Linux (x64 and ARM).
|
|
8
9
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
10
|
+
There are a lot of functionality already included in the base version of CanKing, but it is also possible to extend the
|
|
11
|
+
functionality and the user interface by creating extensions.
|
|
12
|
+
|
|
13
|
+
An extension is developed as a stand-alone [React](<https://react.dev/>) web application. The web application will be hosted
|
|
14
|
+
by an express web server inside CanKing and it will be mounted into the CanKing user interface using a webview element.
|
|
15
|
+
|
|
16
|
+
When an extension is mounted into CanKing, then a preload script will run to inject inter-process communication (IPC)
|
|
17
|
+
functions. These functions will make it possible for the extension to communicate with CanKing to get information and to
|
|
18
|
+
interact with the CAN/LIN bus.
|
|
19
|
+
|
|
20
|
+
The IPC functions are accessible by importing different modules from the @kvaser/canking-api package.
|
|
21
|
+
|
|
22
|
+
To get or subscribe on CanKing data there are different React hooks to be used. All these can be found in the hooks module.
|
|
23
|
+
|
|
24
|
+
```tsx
|
|
25
|
+
import { useUserSetting, useMeasurementSetup } from '@kvaser/canking-api/hooks';
|
|
12
26
|
|
|
13
|
-
|
|
27
|
+
...
|
|
14
28
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
- install node.js version 22.9: ```nvm install 22.9```
|
|
19
|
-
- change node.js version to 22.9: ```nvm use 22.9```
|
|
20
|
-
- **NOTE:**
|
|
21
|
-
- If nvm keyword can't be found make sure environment path for nvm.exe is set.
|
|
22
|
-
- CanKing is coded with node version 22.9, so version 22.9 is recommended.
|
|
29
|
+
const userSettings = useUserSettings();
|
|
30
|
+
const measurementSetup = useMeasurementSetup();
|
|
31
|
+
```
|
|
23
32
|
|
|
24
|
-
|
|
33
|
+
To interact with CanKing there are different functions that can be imported from the ipc module.
|
|
25
34
|
|
|
26
|
-
|
|
27
|
-
|
|
35
|
+
```tsx
|
|
36
|
+
import { sendCanMessage } from '@kvaser/canking-api/ipc';
|
|
28
37
|
|
|
29
|
-
|
|
30
|
-
The script is used like this:
|
|
38
|
+
...
|
|
31
39
|
|
|
32
|
-
|
|
40
|
+
sendCanMessage(channelId, frameId, data, flags);
|
|
41
|
+
```
|
|
33
42
|
|
|
34
|
-
|
|
35
|
-
|
|
43
|
+
The @kvaser/canking-api package also includes some React components that you can use, e.g. there is a component for selecting
|
|
44
|
+
channel.
|
|
36
45
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
--view-name <string> workspace view name (default: "")
|
|
40
|
-
--desc <string> project description (default: "A CanKing GUI extension.")
|
|
41
|
-
--author <string> project author (default: "")
|
|
42
|
-
--verbose print additional logs
|
|
43
|
-
--force use installed script even if a newer version exists
|
|
44
|
-
--show-doc opens the documentation
|
|
45
|
-
-h, --help display help for command
|
|
46
|
+
```tsx
|
|
47
|
+
import { CanChannelSelectControl } from '@kvaser/canking-api/controls';
|
|
46
48
|
|
|
47
|
-
|
|
49
|
+
...
|
|
48
50
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
+
function WorkspaceView() {
|
|
52
|
+
const [channelId, setChannelId] = useState('');
|
|
53
|
+
return (
|
|
54
|
+
<CanChannelSelectControl
|
|
55
|
+
channelIdentifier={channelId}
|
|
56
|
+
onChannelIdentifierChange={setChannelId}
|
|
57
|
+
hideSectionControl
|
|
58
|
+
/>
|
|
59
|
+
);
|
|
60
|
+
}
|
|
61
|
+
```
|
|
51
62
|
|
|
52
|
-
|
|
53
|
-
|
|
63
|
+
## Prerequisites
|
|
64
|
+
|
|
65
|
+
Before creating a new CanKing Extension the following softwares need to be installed.
|
|
54
66
|
|
|
55
|
-
|
|
67
|
+
- Node.js: <https://nodejs.org/>
|
|
68
|
+
- Kvaser CanKing: <https://kvaser.com/canking/>
|
|
69
|
+
- Kvaser Drivers: <https://resources.kvaser.com/7330130980013/latest/kvaser_drivers_setup.exe>
|
|
70
|
+
|
|
71
|
+
You will also need an IDE (Integrated Development Environment) to edit and debug your code. We recommend that you're using
|
|
72
|
+
[Visual Studio Code](https://code.visualstudio.com/).
|
|
73
|
+
|
|
74
|
+
With Visual Studio Code you might also want to install these extensions to help you with code formatting and code analysing:
|
|
75
|
+
|
|
76
|
+
- [ESLint (dbaeumer.vscode-eslint)](<https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint>)
|
|
77
|
+
- [Prettier - Code formatter (esbenp.prettier-vscode)](<https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode>)
|
|
78
|
+
- [EditorConfig for VS Code (editorconfig.editorconfig)](<https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig>)
|
|
79
|
+
|
|
80
|
+
## Generate a new CanKing Extension project
|
|
81
|
+
|
|
82
|
+
The simplest way to create a new CanKing Extension project is to use the script that is included in the
|
|
83
|
+
[@kvaser/create-canking-extension](<https://www.npmjs.com/package/@kvaser/create-canking-extension>) package. The script is
|
|
84
|
+
used like this:
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
npm create @kvaser/canking-extension@latest
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Then follow the prompts.
|
|
91
|
+
|
|
92
|
+
You can also specify a project name via a command line argument.
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
npm create @kvaser/canking-extension@latest my-ck-extension
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
This command will create a new project in a new folder with the same name as the specified project name (my-ck-extension).
|
|
99
|
+
You can use `.` for the project name to scaffold your project in the current directory.
|
|
100
|
+
|
|
101
|
+
The command above will create a folder structure like this:
|
|
102
|
+
|
|
103
|
+
```text
|
|
104
|
+
my-ck-extension
|
|
105
|
+
│ .gitignore
|
|
106
|
+
│ .prettierrc
|
|
107
|
+
│ eslint.config.mjs
|
|
108
|
+
│ index.html
|
|
109
|
+
│ package.json
|
|
110
|
+
│ tsconfig.app.json
|
|
111
|
+
│ tsconfig.json
|
|
112
|
+
│ tsconfig.node.json
|
|
113
|
+
│ vite.config.ts
|
|
114
|
+
│
|
|
115
|
+
├───.vscode
|
|
116
|
+
│ launch.json
|
|
117
|
+
│
|
|
118
|
+
└───src
|
|
119
|
+
│ App.tsx
|
|
120
|
+
│ main.tsx
|
|
121
|
+
│ vite-env.d.ts
|
|
122
|
+
│
|
|
123
|
+
├───assets
|
|
124
|
+
│ icon.png
|
|
125
|
+
│
|
|
126
|
+
└───WorkspaceView
|
|
127
|
+
index.tsx
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
The project follows a similar file structure as the one that is created for a [Vite](<https://vite.dev/>) project created
|
|
131
|
+
using the react-ts template. There are some extra information added to the package.json file that are needed for CanKing and
|
|
132
|
+
the src files are modified to be used inside CanKing.
|
|
133
|
+
|
|
134
|
+
The my-ck-extension/src/WorkspaceView/index.tsx file is the file that includes the React component that will be mounted into
|
|
135
|
+
CanKing, so this is the file you should implement to create your extension.
|
|
136
|
+
|
|
137
|
+
## Develop a CanKing Extension
|
|
56
138
|
|
|
57
139
|
To match the CanKing look and feel, it's recommended to use Material UI components when applicable,
|
|
58
140
|
<https://mui.com/material-ui/all-components/>.
|
|
@@ -62,9 +144,11 @@ so this is the component that should be implemented to implement the extension.
|
|
|
62
144
|
|
|
63
145
|
To run the extension from command line enter:
|
|
64
146
|
|
|
65
|
-
|
|
147
|
+
```bash
|
|
148
|
+
npm run start
|
|
149
|
+
```
|
|
66
150
|
|
|
67
|
-
To run the extension using
|
|
151
|
+
To run the extension using Visual Studio Code debugger:
|
|
68
152
|
|
|
69
153
|
- Select 'Run and Debug' or press Ctrl+Shift+D
|
|
70
154
|
- Select the configuration named 'Debug'
|
|
@@ -72,16 +156,30 @@ To run the extension using VS Code debugger:
|
|
|
72
156
|
|
|
73
157
|
To run a production build of the extension you can enter this command:
|
|
74
158
|
|
|
75
|
-
|
|
159
|
+
```bash
|
|
160
|
+
npm run startpreview
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
If you need more information and help about how to interact with CanKing then you can run this command:
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
npx @kvaser/canking-api --help
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
This will open up a help file in your web browser.
|
|
76
170
|
|
|
77
|
-
## Package and Install a CanKing
|
|
171
|
+
## Package and Install a CanKing Extension
|
|
78
172
|
|
|
79
173
|
To package your extension for distribution you should run this command from the command line:
|
|
80
174
|
|
|
81
|
-
|
|
175
|
+
```bash
|
|
176
|
+
npm pack
|
|
177
|
+
```
|
|
82
178
|
|
|
83
179
|
This command will create a tarball file in the root folder of your project called:
|
|
84
180
|
|
|
85
|
-
|
|
181
|
+
```text
|
|
182
|
+
<project-name>-<version>.tgz
|
|
183
|
+
```
|
|
86
184
|
|
|
87
185
|
This tarball can then be installed in CanKing using the head menu 'More'->'Extensions'->'Install'.
|
package/REDISTRIBUTABLES.txt
CHANGED
|
@@ -1,5 +1,89 @@
|
|
|
1
1
|
Redistributable files in Kvaser CanKing GUI Extensions SDK
|
|
2
2
|
===================================================================================================
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
provided they are only used together with genuine Kvaser hardware.
|
|
4
|
+
The following files in the dist folder and in its sub-folders may be redistributed with your
|
|
5
|
+
application, provided they are only used together with genuine Kvaser hardware.
|
|
6
|
+
|
|
7
|
+
dist
|
|
8
|
+
│ controls.js
|
|
9
|
+
│ controls.mjs
|
|
10
|
+
│ ElectronAPIFake.js
|
|
11
|
+
│ ElectronAPIFake.mjs
|
|
12
|
+
│ grpc.js
|
|
13
|
+
│ grpc.mjs
|
|
14
|
+
│ hooks.js
|
|
15
|
+
│ hooks.mjs
|
|
16
|
+
│ icons.js
|
|
17
|
+
│ icons.mjs
|
|
18
|
+
│ index.d.ts
|
|
19
|
+
│ index.js
|
|
20
|
+
│ index.mjs
|
|
21
|
+
│ ipc.js
|
|
22
|
+
│ ipc.mjs
|
|
23
|
+
│ measurement_settings.js
|
|
24
|
+
│ measurement_settings.mjs
|
|
25
|
+
│ models.js
|
|
26
|
+
│ models.mjs
|
|
27
|
+
│ status_params.js
|
|
28
|
+
│ status_params.mjs
|
|
29
|
+
│
|
|
30
|
+
├───controls
|
|
31
|
+
│ CanChannelSelectControl.d.ts
|
|
32
|
+
│ CanIdentifierControl.d.ts
|
|
33
|
+
│ CanKingDataProvider.d.ts
|
|
34
|
+
│ CheckboxControl.d.ts
|
|
35
|
+
│ ContextMenu.d.ts
|
|
36
|
+
│ DropdownButton.d.ts
|
|
37
|
+
│ DropdownPanel.d.ts
|
|
38
|
+
│ FillBox.d.ts
|
|
39
|
+
│ FormControlRow.d.ts
|
|
40
|
+
│ index.d.ts
|
|
41
|
+
│ InlineEditor.d.ts
|
|
42
|
+
│ LocalizedStrings.d.ts
|
|
43
|
+
│ NumberRangeControl.d.ts
|
|
44
|
+
│ OneLineButton.d.ts
|
|
45
|
+
│ RadioControl.d.ts
|
|
46
|
+
│ RadioGroupControl.d.ts
|
|
47
|
+
│ SectionControl.d.ts
|
|
48
|
+
│ SelectControl.d.ts
|
|
49
|
+
│ SizedBox.d.ts
|
|
50
|
+
│ TableControl.d.ts
|
|
51
|
+
│ TabsPanel.d.ts
|
|
52
|
+
│ TextControl.d.ts
|
|
53
|
+
│ ToolbarControl.d.ts
|
|
54
|
+
│ ValidateableTextControl.d.ts
|
|
55
|
+
│
|
|
56
|
+
├───grpc
|
|
57
|
+
│ index.d.ts
|
|
58
|
+
│
|
|
59
|
+
├───hooks
|
|
60
|
+
│ index.d.ts
|
|
61
|
+
│
|
|
62
|
+
├───icons
|
|
63
|
+
│ index.d.ts
|
|
64
|
+
│
|
|
65
|
+
├───ipc
|
|
66
|
+
│ index.d.ts
|
|
67
|
+
│
|
|
68
|
+
├───models
|
|
69
|
+
│ DataBuffer.d.ts
|
|
70
|
+
│ ElectronAPIFake.d.ts
|
|
71
|
+
│ index.d.ts
|
|
72
|
+
│ Point.d.ts
|
|
73
|
+
│
|
|
74
|
+
└───protos
|
|
75
|
+
│ app_params.d.ts
|
|
76
|
+
│ app_service.d.ts
|
|
77
|
+
│ common_params.d.ts
|
|
78
|
+
│ device_params.d.ts
|
|
79
|
+
│ device_service.d.ts
|
|
80
|
+
│ frame_params.d.ts
|
|
81
|
+
│ measurement_params.d.ts
|
|
82
|
+
│ measurement_service.d.ts
|
|
83
|
+
│ measurement_settings.d.ts
|
|
84
|
+
│ signal_params.d.ts
|
|
85
|
+
│ status_params.d.ts
|
|
86
|
+
│
|
|
87
|
+
└───google
|
|
88
|
+
└───protobuf
|
|
89
|
+
empty.d.ts
|
package/dist/ElectronAPIFake.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";var p=Object.defineProperty;var g=(r,e,s)=>e in r?p(r,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):r[e]=s;var t=(r,e,s)=>g(r,typeof e!="symbol"?e+"":e,s);require("long");const
|
|
1
|
+
"use strict";var p=Object.defineProperty;var g=(r,e,s)=>e in r?p(r,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):r[e]=s;var t=(r,e,s)=>g(r,typeof e!="symbol"?e+"":e,s);require("long");const d=require("./measurement_settings.js");class v{constructor(e){t(this,"userSettings");this.userSettings=e}on(e,s){return()=>{}}once(e,s){return()=>{}}removeAllListeners(e){}removeListener(e,s){return this}send(e,...s){}invoke(e,...s){switch(e){case"rpc-get-devices":const n=[];return Promise.resolve(n);case"app-get-session-data":return Promise.resolve(null);case"app-get-user-settings":return Promise.resolve(this.userSettings);case"rpc-get-online-status":const o={isOnline:!1};return Promise.resolve(o);case"rpc-get-node-statuses":const c=[];return Promise.resolve(c);case"prj-get-meas-setup":return Promise.resolve(d.MeasurementSetup.create());case"prj-get-workspaces":const i=[];return Promise.resolve(i);case"prj-get-workspace-panes":const l=[];return Promise.resolve(l);case"app-get-workspace-view-session-data":case"rpc-start-periodic-transmission":return Promise.resolve("");case"rpc-get-message-log-file-formats":const u=[];return Promise.resolve(u);case"rpc-get-frame-definitions":const m=[];return Promise.resolve(m);case"mm-get-measurement-data-buffer":case"mm-get-latest-measurement-data":return Promise.resolve(frames);default:return Promise.resolve()}}postMessage(e,s,n){}sendSync(e,...s){}sendTo(e,s,...n){}sendToHost(e,...s){}}class F{insertCSS(e){return""}setZoomFactor(e){}setZoomLevel(e){}}class P{constructor(){t(this,"platform");t(this,"versions");t(this,"env")}}const a=r=>{const e={version:"1.0.0",theme:"light",language:"en",strings:{},showToolsPanel:!0,useHexNumericBase:!0,maxDataBytes:16,defaultProjectFolder:"",defaultLogFilesFolder:"",defaultCANDatabasesFolder:"",defaultLINDatabasesFolder:"",currentProjectFile:"",currentProjectFileName:"",recentProjectFiles:[],closeAppServiceAction:"prompt"};return{ipcRenderer:new v(r??e),webFrame:new F,process:new P}},f=a();exports.createElectronApiFake=a;exports.electronApiFake=f;
|
package/dist/ElectronAPIFake.mjs
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
var
|
|
2
|
-
var p = (r, e, s) => e in r ?
|
|
1
|
+
var m = Object.defineProperty;
|
|
2
|
+
var p = (r, e, s) => e in r ? m(r, e, { enumerable: !0, configurable: !0, writable: !0, value: s }) : r[e] = s;
|
|
3
3
|
var t = (r, e, s) => p(r, typeof e != "symbol" ? e + "" : e, s);
|
|
4
4
|
import "long";
|
|
5
5
|
import { ab as g } from "./measurement_settings.mjs";
|
|
6
|
-
class
|
|
6
|
+
class d {
|
|
7
7
|
/**
|
|
8
8
|
* Creates a new IpcRendererFake.
|
|
9
9
|
*/
|
|
@@ -124,8 +124,8 @@ class v {
|
|
|
124
124
|
const l = [];
|
|
125
125
|
return Promise.resolve(l);
|
|
126
126
|
case "rpc-get-frame-definitions":
|
|
127
|
-
const
|
|
128
|
-
return Promise.resolve(
|
|
127
|
+
const u = [];
|
|
128
|
+
return Promise.resolve(u);
|
|
129
129
|
case "mm-get-measurement-data-buffer":
|
|
130
130
|
case "mm-get-latest-measurement-data":
|
|
131
131
|
return Promise.resolve(frames);
|
|
@@ -190,7 +190,7 @@ class v {
|
|
|
190
190
|
sendToHost(e, ...s) {
|
|
191
191
|
}
|
|
192
192
|
}
|
|
193
|
-
class
|
|
193
|
+
class v {
|
|
194
194
|
/**
|
|
195
195
|
* A key for the inserted CSS that can later be used to remove the CSS via
|
|
196
196
|
* `webFrame.removeInsertedCSS(key)`.
|
|
@@ -222,7 +222,7 @@ class d {
|
|
|
222
222
|
setZoomLevel(e) {
|
|
223
223
|
}
|
|
224
224
|
}
|
|
225
|
-
class
|
|
225
|
+
class f {
|
|
226
226
|
constructor() {
|
|
227
227
|
/**
|
|
228
228
|
* The process.platform property returns a string identifying the operating system platform
|
|
@@ -239,7 +239,7 @@ class P {
|
|
|
239
239
|
t(this, "env");
|
|
240
240
|
}
|
|
241
241
|
}
|
|
242
|
-
const
|
|
242
|
+
const F = (r) => {
|
|
243
243
|
const e = {
|
|
244
244
|
version: "1.0.0",
|
|
245
245
|
theme: "light",
|
|
@@ -249,18 +249,21 @@ const f = (r) => {
|
|
|
249
249
|
useHexNumericBase: !0,
|
|
250
250
|
maxDataBytes: 16,
|
|
251
251
|
defaultProjectFolder: "",
|
|
252
|
+
defaultLogFilesFolder: "",
|
|
253
|
+
defaultCANDatabasesFolder: "",
|
|
254
|
+
defaultLINDatabasesFolder: "",
|
|
252
255
|
currentProjectFile: "",
|
|
253
256
|
currentProjectFileName: "",
|
|
254
257
|
recentProjectFiles: [],
|
|
255
258
|
closeAppServiceAction: "prompt"
|
|
256
259
|
};
|
|
257
260
|
return {
|
|
258
|
-
ipcRenderer: new
|
|
259
|
-
webFrame: new
|
|
260
|
-
process: new
|
|
261
|
+
ipcRenderer: new d(r ?? e),
|
|
262
|
+
webFrame: new v(),
|
|
263
|
+
process: new f()
|
|
261
264
|
};
|
|
262
|
-
}, w =
|
|
265
|
+
}, w = F();
|
|
263
266
|
export {
|
|
264
|
-
|
|
267
|
+
F as c,
|
|
265
268
|
w as e
|
|
266
269
|
};
|
|
@@ -67,6 +67,8 @@ interface CanIdentifierFrameControlProps {
|
|
|
67
67
|
* @param errors The new errors state.
|
|
68
68
|
*/
|
|
69
69
|
onErrorsChange?: (errors: boolean) => void;
|
|
70
|
+
/** Set to true if this control shouldn't be encapsulated inside a SectionControl. */
|
|
71
|
+
hideSection?: boolean;
|
|
70
72
|
/** Set to true if the SectionControl should be collapsible. */
|
|
71
73
|
collapsible?: boolean;
|
|
72
74
|
/** Current collapse state of the SectionControl. */
|
|
@@ -82,7 +84,7 @@ interface CanIdentifierFrameControlProps {
|
|
|
82
84
|
* @param props Component properties.
|
|
83
85
|
* @returns The CanIdentifierFrameControl React component.
|
|
84
86
|
*/
|
|
85
|
-
declare function CanIdentifierFrameControl({ frame, onFrameChange, onErrorsChange, collapsible, collapsed, collapsedChange, }: CanIdentifierFrameControlProps): import("react/jsx-runtime").JSX.Element;
|
|
87
|
+
declare function CanIdentifierFrameControl({ frame, onFrameChange, onErrorsChange, hideSection, collapsible, collapsed, collapsedChange, }: CanIdentifierFrameControlProps): import("react/jsx-runtime").JSX.Element;
|
|
86
88
|
/**
|
|
87
89
|
* Properties of the CanIdentifierGeneratorControl React component.
|
|
88
90
|
*/
|
|
@@ -128,13 +130,21 @@ interface CanIdentifierGeneratorControlProps {
|
|
|
128
130
|
* @param value The new collapse state.
|
|
129
131
|
*/
|
|
130
132
|
collapsedChange?: (value: boolean) => void;
|
|
133
|
+
/**
|
|
134
|
+
* Callback for specifying if the select message dialog should be visible.
|
|
135
|
+
*/
|
|
136
|
+
showSelectMessageDialogChange: (value: boolean) => void;
|
|
137
|
+
/**
|
|
138
|
+
* Callback for specifying if the signal values table should be visible.
|
|
139
|
+
*/
|
|
140
|
+
showSignalValuesTable: (value: boolean) => void;
|
|
131
141
|
}
|
|
132
142
|
/**
|
|
133
143
|
* Creates an UI control for editing CAN identifier(s) used by a message generator.
|
|
134
144
|
* @param props Component properties.
|
|
135
145
|
* @returns The CanIdentifierGeneratorControl React component.
|
|
136
146
|
*/
|
|
137
|
-
declare function CanIdentifierGeneratorControl({ canIdentifier, identifierGeneratorType, minCanIdentifier, maxCanIdentifier, canIdentifierType, onChange, onErrorsChange, canIdentifierGeneratorSettingsError, disabled, collapsible, collapsed, collapsedChange, }: CanIdentifierGeneratorControlProps): import("react/jsx-runtime").JSX.Element;
|
|
147
|
+
declare function CanIdentifierGeneratorControl({ canIdentifier, identifierGeneratorType, minCanIdentifier, maxCanIdentifier, canIdentifierType, onChange, onErrorsChange, canIdentifierGeneratorSettingsError, disabled, collapsible, collapsed, collapsedChange, showSelectMessageDialogChange, showSignalValuesTable, }: CanIdentifierGeneratorControlProps): import("react/jsx-runtime").JSX.Element;
|
|
138
148
|
/**
|
|
139
149
|
* Properties of the CanIdentifierGeneratorSettingsControl React component.
|
|
140
150
|
*/
|
|
@@ -164,6 +174,14 @@ interface CanIdentifierGeneratorSettingsControlProps {
|
|
|
164
174
|
* @param value The new collapse state.
|
|
165
175
|
*/
|
|
166
176
|
collapsedChange?: (value: boolean) => void;
|
|
177
|
+
/**
|
|
178
|
+
* Callback for specifying if the select message dialog should be visible.
|
|
179
|
+
*/
|
|
180
|
+
showSelectMessageDialogChange: (value: boolean) => void;
|
|
181
|
+
/**
|
|
182
|
+
* Callback for specifying if the signal values table should be visible.
|
|
183
|
+
*/
|
|
184
|
+
showSignalValuesTable: (value: boolean) => void;
|
|
167
185
|
}
|
|
168
186
|
/**
|
|
169
187
|
* Creates an UI control for editing CAN identifier(s) used by a message generator
|
|
@@ -171,6 +189,6 @@ interface CanIdentifierGeneratorSettingsControlProps {
|
|
|
171
189
|
* @param props Component properties.
|
|
172
190
|
* @returns The CanIdentifierGeneratorSettingsControl React component.
|
|
173
191
|
*/
|
|
174
|
-
declare function CanIdentifierGeneratorSettingsControl({ settings, onSettingsChange, onErrorsChange, canIdentifierGeneratorSettingsError, disabled, collapsible, collapsed, collapsedChange, }: CanIdentifierGeneratorSettingsControlProps): import("react/jsx-runtime").JSX.Element;
|
|
192
|
+
declare function CanIdentifierGeneratorSettingsControl({ settings, onSettingsChange, onErrorsChange, canIdentifierGeneratorSettingsError, disabled, collapsible, collapsed, collapsedChange, showSelectMessageDialogChange, showSignalValuesTable, }: CanIdentifierGeneratorSettingsControlProps): import("react/jsx-runtime").JSX.Element;
|
|
175
193
|
export default CanIdentifierControl;
|
|
176
194
|
export { type CanIdentifierControlProps, CanIdentifierControl, type CanIdentifierFrameControlProps, CanIdentifierFrameControl, type CanIdentifierGeneratorControlProps, CanIdentifierGeneratorControl, type CanIdentifierGeneratorSettingsControlProps, CanIdentifierGeneratorSettingsControl, };
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This module includes a form row UI control, a container component that can be used to
|
|
3
|
+
* display form controls on one row.
|
|
4
|
+
*
|
|
5
|
+
* To be able to use these controls the CanKingDataProvider component must be present in the
|
|
6
|
+
* component tree above your component. Normally the CanKingDataProvider is added
|
|
7
|
+
* at the root of the component tree.
|
|
8
|
+
*
|
|
9
|
+
* @packageDocumentation
|
|
10
|
+
*/
|
|
11
|
+
import React from 'react';
|
|
12
|
+
interface ColumnItem {
|
|
13
|
+
ref: React.Ref<HTMLDivElement>;
|
|
14
|
+
width?: number;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Gets a ColumnItem object that can be used in calls to useColumnItems and as props to ColumnItemControl.
|
|
18
|
+
* @returns A ColumnItem object
|
|
19
|
+
*/
|
|
20
|
+
export declare const useColumnItem: () => ColumnItem;
|
|
21
|
+
/**
|
|
22
|
+
* Calculate max width from all specified column items as soon as all items have widths values.
|
|
23
|
+
* @param columnItems All column items to set width for.
|
|
24
|
+
* @returns The max width, the width to use
|
|
25
|
+
*/
|
|
26
|
+
export declare const useColumnItems: (...columnItems: ColumnItem[]) => number;
|
|
27
|
+
export interface ColumnItemControlProps {
|
|
28
|
+
columnItem: ColumnItem;
|
|
29
|
+
width?: number;
|
|
30
|
+
children?: React.ReactNode;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* A react component to be used when different components should share the same width.
|
|
34
|
+
*/
|
|
35
|
+
declare function ColumnItemControl({ columnItem, width, children }: ColumnItemControlProps): import("react/jsx-runtime").JSX.Element;
|
|
36
|
+
export default ColumnItemControl;
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
declare const OneLineButton: import("@emotion/styled").StyledComponent<import("@mui/material").ButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
|
|
5
5
|
ref?: import("react").Ref<HTMLButtonElement>;
|
|
6
|
-
}, "variant" | "color" | "style" | "action" | "className" | "children" | "tabIndex" | "disabled" | "size" | "href" | "sx" | "classes" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "fullWidth" | "disableElevation" | "endIcon" | "startIcon"> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme> & {
|
|
6
|
+
}, "variant" | "color" | "loading" | "style" | "action" | "className" | "children" | "tabIndex" | "disabled" | "size" | "href" | "sx" | "classes" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "loadingIndicator" | "fullWidth" | "disableElevation" | "endIcon" | "loadingPosition" | "startIcon"> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme> & {
|
|
7
7
|
component?: React.ElementType;
|
|
8
8
|
}, {}, {}>;
|
|
9
9
|
export default OneLineButton;
|
package/dist/controls/index.d.ts
CHANGED
|
@@ -59,6 +59,8 @@
|
|
|
59
59
|
export { type ILocalizedStrings, LocalizedStrings, type StringsMap } from './LocalizedStrings';
|
|
60
60
|
export * from './CheckboxControl';
|
|
61
61
|
export { default as CheckboxControl } from './CheckboxControl';
|
|
62
|
+
export * from './ColumnItemControl';
|
|
63
|
+
export { default as ColumnItemControl } from './ColumnItemControl';
|
|
62
64
|
export * from './DropdownButton';
|
|
63
65
|
export { default as OneLineButton } from './OneLineButton';
|
|
64
66
|
export * from './OneLineButton';
|