@kvaser/canking-api 7.1.0 → 7.2.1

package/dist/protos/frame_params.d.ts

@@ -71,7 +71,7 @@ export interface SignalValue {
     qualifiedName: string;
     unit: string;
     stringValue?: string | undefined;
-    doubleValue?: number | undefined;
+    doubleValue: number;
 }
 /** A message describing a frame. */
 export interface Frame {
@@ -142,6 +142,13 @@ export interface FrameDefinition {
 export interface FrameDefinitions {
     items: FrameDefinition[];
 }
+/** A message describing database files for both database nodes and LIN channels. */
+export interface DatabaseFiles {
+    /** Database files for CAN channels */
+    dbcFiles: string[];
+    /** Database files for LIN channels */
+    ldfFiles: string[];
+}
 /** A message describing an entry in a schedule table. */
 export interface ScheduleTableEntry {
     /** Message qualified name */
@@ -168,6 +175,7 @@ export declare const Frames: MessageFns<Frames>;
 export declare const WriteFrame: MessageFns<WriteFrame>;
 export declare const FrameDefinition: MessageFns<FrameDefinition>;
 export declare const FrameDefinitions: MessageFns<FrameDefinitions>;
+export declare const DatabaseFiles: MessageFns<DatabaseFiles>;
 export declare const ScheduleTableEntry: MessageFns<ScheduleTableEntry>;
 export declare const ScheduleTable: MessageFns<ScheduleTable>;
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;

package/dist/protos/measurement_params.d.ts

@@ -189,6 +189,8 @@ export interface GetLogFileFormatsRequest {
     messageLog: boolean;
     /** Set to true to include signal value log formats. */
     signalLog: boolean;
+    /** Set to true to only include formats with read support. */
+    readSupport: boolean;
 }
 /** A response message for GetLogFileFormats request. */
 export interface GetLogFileFormatsResponse {

package/dist/protos/measurement_service.d.ts

@@ -1,6 +1,6 @@
 import { type CallOptions, ChannelCredentials, Client, type ClientOptions, type ClientReadableStream, type ClientUnaryCall, type handleServerStreamingCall, type handleUnaryCall, Metadata, type ServiceError, type UntypedServiceImplementation } from "@grpc/grpc-js";
 import { ApiPreferences } from "./common_params";
-import { FrameDefinitions, Frames } from "./frame_params";
+import { DatabaseFiles, FrameDefinitions, Frames } from "./frame_params";
 import { Empty } from "./google/protobuf/empty";
 import { AddAllConnectedCanChannelsRequest, AddAllConnectedLinChannelsRequest, AddOrUpdateDataProcessorRequest, AddOrUpdateSourceRequest, AddOrUpdateTargetRequest, ClearLinMessageRequest, ConnectNodesRequest, DisconnectNodesRequest, GetChannelsFromLogFileRequest, GetChannelsFromLogFileResponse, GetDataProcessorResponse, GetFrameDefinitionsFromDatabaseFilesRequest, GetLogFileFormatsRequest, GetLogFileFormatsResponse, GetScheduleTablesFromDatabaseFilesRequest, GetScheduleTablesFromDatabaseFilesResponse, GetSignalDataFromMessageDataRequest, GetSignalDataFromMessageDataResponse, GetSourceResponse, GetTargetResponse, IdentifierRequest, MeasurementEventArgs, OnlineStatus, RequestLinMessageRequest, SendLinWakeupFrameRequest, SendMessageRequest, SetMeasurementSetupRequest, SetSignalDataToMessageDataRequest, SetSignalDataToMessageDataResponse, StartPeriodicTransmissionRequest, StartPeriodicTransmissionResponse, UpdateLinMessageRequest, UpdatePeriodicTransmissionRequest } from "./measurement_params";
 import { MeasurementSetup } from "./measurement_settings";
@@ -624,6 +624,20 @@ export declare const MeasurementServiceService: {
         readonly responseSerialize: (value: FrameDefinitions) => Buffer;
         readonly responseDeserialize: (value: Buffer) => FrameDefinitions;
     };
+    /**
+     * Gets all available database files in the current measurement setup.
+     * @param request A request message with an optional node identifier.
+     * @returns A response message with the available database files.
+     */
+    readonly getDatabaseFiles: {
+        readonly path: "/measurementservice.MeasurementService/GetDatabaseFiles";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: IdentifierRequest) => Buffer;
+        readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
+        readonly responseSerialize: (value: DatabaseFiles) => Buffer;
+        readonly responseDeserialize: (value: Buffer) => DatabaseFiles;
+    };
     /**
      * Gets all schedule tables in the provided database files.
      * @param request A request message with the database files to be parsed.
@@ -946,6 +960,12 @@ export interface MeasurementServiceServer extends UntypedServiceImplementation {
      * @returns A response message with the frame definitions parsed from the database files.
      */
     getFrameDefinitionsFromDatabaseFiles: handleUnaryCall<GetFrameDefinitionsFromDatabaseFilesRequest, FrameDefinitions>;
+    /**
+     * Gets all available database files in the current measurement setup.
+     * @param request A request message with an optional node identifier.
+     * @returns A response message with the available database files.
+     */
+    getDatabaseFiles: handleUnaryCall<IdentifierRequest, DatabaseFiles>;
     /**
      * Gets all schedule tables in the provided database files.
      * @param request A request message with the database files to be parsed.
@@ -1321,6 +1341,14 @@ export interface MeasurementServiceClient extends Client {
     getFrameDefinitionsFromDatabaseFiles(request: GetFrameDefinitionsFromDatabaseFilesRequest, callback: (error: ServiceError | null, response: FrameDefinitions) => void): ClientUnaryCall;
     getFrameDefinitionsFromDatabaseFiles(request: GetFrameDefinitionsFromDatabaseFilesRequest, metadata: Metadata, callback: (error: ServiceError | null, response: FrameDefinitions) => void): ClientUnaryCall;
     getFrameDefinitionsFromDatabaseFiles(request: GetFrameDefinitionsFromDatabaseFilesRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: FrameDefinitions) => void): ClientUnaryCall;
+    /**
+     * Gets all available database files in the current measurement setup.
+     * @param request A request message with an optional node identifier.
+     * @returns A response message with the available database files.
+     */
+    getDatabaseFiles(request: IdentifierRequest, callback: (error: ServiceError | null, response: DatabaseFiles) => void): ClientUnaryCall;
+    getDatabaseFiles(request: IdentifierRequest, metadata: Metadata, callback: (error: ServiceError | null, response: DatabaseFiles) => void): ClientUnaryCall;
+    getDatabaseFiles(request: IdentifierRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: DatabaseFiles) => void): ClientUnaryCall;
     /**
      * Gets all schedule tables in the provided database files.
      * @param request A request message with the database files to be parsed.

package/dist/protos/measurement_settings.d.ts

@@ -1,5 +1,6 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import Long from "long";
+import { CanBusParams } from "./device_params";
 import { WriteFrame } from "./frame_params";
 /** Possible CAN modes. */
 export declare enum CanMode {
@@ -33,6 +34,15 @@ export declare enum AccessMode {
 }
 export declare function accessModeFromJSON(object: any): AccessMode;
 export declare function accessModeToJSON(object: AccessMode): string;
+/** Possible CAN message filter types. */
+export declare enum CanMessageFilterType {
+    CAN_MESSAGE_FILTER_TYPE_UNSPECIFIED = 0,
+    CAN_MESSAGE_FILTER_TYPE_PASS = 1,
+    CAN_MESSAGE_FILTER_TYPE_BLOCK = 2,
+    UNRECOGNIZED = -1
+}
+export declare function canMessageFilterTypeFromJSON(object: any): CanMessageFilterType;
+export declare function canMessageFilterTypeToJSON(object: CanMessageFilterType): string;
 /** Possible signal value trigger operators. */
 export declare enum SignalValueTriggerOperator {
     SIGNAL_VALUE_TRIGGER_OPERATOR_UNSPECIFIED = 0,
@@ -85,9 +95,11 @@ export declare enum LogFileFormat {
     LOG_FILE_FORMAT_MDF = 101,
     /** LOG_FILE_FORMAT_MATLAB - Output file format. */
     LOG_FILE_FORMAT_MATLAB = 102,
-    /** LOG_FILE_FORMAT_J1587 - Output file format. */
-    LOG_FILE_FORMAT_J1587 = 103,
-    /** LOG_FILE_FORMAT_J1587_ALT - Obsolete. */
+    /**
+     * LOG_FILE_FORMAT_J1587_ALT - Output file format. Currently not supported.
+     * LOG_FILE_FORMAT_J1587 = 103;
+     * Obsolete.
+     */
     LOG_FILE_FORMAT_J1587_ALT = 104,
     /** LOG_FILE_FORMAT_FAMOS - Output file format. */
     LOG_FILE_FORMAT_FAMOS = 105,
@@ -143,21 +155,6 @@ export declare enum TimeReference {
 }
 export declare function timeReferenceFromJSON(object: any): TimeReference;
 export declare function timeReferenceToJSON(object: TimeReference): string;
-/** A message for defining the selected CAN bus speed. */
-export interface CanBusSpeed {
-    /** Bit rate (measured in bits per second); or one of the predefined constants (canBITRATE_xxx for classic CAN and canFD_BITRATE_xxx for CAN FD). */
-    bitRate: number;
-    /** Time segment 1, that is, the number of quanta from (but not including) the Sync Segment to the sampling point. */
-    timeSegment1: number;
-    /** Time segment 2, that is, the number of quanta from the sampling point to the end of the bit. */
-    timeSegment2: number;
-    /** The Synchronization Jump Width. */
-    syncJumpWidth: number;
-    /** The number of sampling points; can be 1 or 3. */
-    numberOfSamplePoints: number;
-    /** The prescaler */
-    prescaler: number;
-}
 /** A message for defining a CAN channel's configuration. */
 export interface CanChannelConfiguration {
     /** The CAN mode to use. */
@@ -166,10 +163,14 @@ export interface CanChannelConfiguration {
     accessMode: AccessMode;
     /** Set to true to enable silent mode, otherwise the channel will be setup as normal. */
     silentMode: boolean;
-    /** The selected bus speed for classic CAN or the selected bus seed for the arbitration phase in CAN FD. */
-    busSpeed: CanBusSpeed | undefined;
-    /** The selected bus speed for the data phase in CAN FD. */
-    busSpeedDataPhase: CanBusSpeed | undefined;
+    /** Bit rate of the selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD. */
+    busParamsBitRate: number;
+    /** The selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD. */
+    busParams: CanBusParams | undefined;
+    /** Bit rate of the selected bus params for the data phase in CAN FD. */
+    busParamsDataPhaseBitRate?: number | undefined;
+    /** The selected bus params for the data phase in CAN FD. */
+    busParamsDataPhase?: CanBusParams | undefined;
 }
 /** A message for defining a LIN channel's configuration. */
 export interface LinChannelConfiguration {
@@ -183,6 +184,8 @@ export interface LinChannelConfiguration {
     databaseFile?: string | undefined;
     /** If master mode is set to true, this is the schedule table to use. */
     scheduleTable?: string | undefined;
+    /** Set to true if LIN message info should be saved. */
+    saveMessageInfo: boolean;
 }
 /** A message for defining a channel's settings. */
 export interface ChannelSettings {
@@ -279,7 +282,12 @@ export interface PeriodicTransmissionSettings {
 export interface CanMessageFilterSettings {
     stdCanIds: string;
     extCanIds: string;
-    filterType: string;
+    filterType: CanMessageFilterType;
+}
+/** A message for defining a signal filter's settings. */
+export interface SignalFilterSettings {
+    /** A comma separated list containing the qualified names of the signals to log */
+    selectedSignals: string[];
 }
 /** A message for defining a database's settings. */
 export interface DatabasesSettings {
@@ -354,23 +362,84 @@ export interface MessageLoggerSettings {
     /** Write file header. Default value is true */
     writeFileHeader?: boolean | undefined;
     /** Write data in hexadecimal format. Default value is true */
-    dataInHex?: boolean | undefined;
+    writeDataInHex?: boolean | undefined;
+    /** Write ID in hexadecimal format. Default value is true */
+    writeIdInHex?: boolean | undefined;
+    /** The decimal separator to be used. Default value is a dot (.) */
+    decimalSeparator?: DecimalChar | undefined;
+    /** The column separator to be used. Default value is a comma (,) */
+    colSeparator?: Separator | undefined;
+    /** Number of data bytes to max write to the log file (1-64). Default value is 8 */
+    dataBytesConverterLimit?: number | undefined;
+    /** Max file size in megabytes before writing to a new file */
+    sizeLimit?: number | undefined;
+    /** Max number of seconds between first and last event before writing to a new file */
+    timeLimit?: number | undefined;
+    /** Number of time decimals (0-9). Default value is 9 */
+    numberOfTimeDecimals?: number | undefined;
+    /** Use the specified time reference. Default value is FIRST_TRIGGER */
+    timeReference?: TimeReference | undefined;
+    /** Write timestamps in calendar time instead of seconds. Default value is false */
+    useCalendarTime?: boolean | undefined;
+    /** Use UTC instead of local time for absolute timestamps. Default value is true */
+    useUtcTime?: boolean | undefined;
+}
+/** A message for defining a signal logger's settings. */
+export interface SignalLoggerSettings {
+    /** Name of the file to log signals to */
+    fileName: string;
+    /** The file format to be used */
+    fileFormat: LogFileFormat;
+    /** Name conflict action */
+    fileConflictAction: FileConflictAction;
+    /** Any filter */
+    signalFilter: SignalFilterSettings | undefined;
+    /** Any start triggers */
+    startTriggerSettings: TriggerSettings[];
+    /** The trigger operator to be used between start triggers */
+    startTriggersOperator: TriggerOperator;
+    /** Any stop triggers */
+    stopTriggerSettings: TriggerSettings[];
+    /** The trigger operator to be used between stop triggers */
+    stopTriggersOperator: TriggerOperator;
+    /** A flag indicating if the logger should auto-restart after stop. Default value is false */
+    autoRestartAfterStop: boolean;
+    /** Write file header. Default value is true */
+    writeFileHeader?: boolean | undefined;
+    /** Write data in hexadecimal format. Default value is true */
+    writeDataInHex?: boolean | undefined;
     /** Write ID in hexadecimal format. Default value is true */
-    idInHex?: boolean | undefined;
+    writeIdInHex?: boolean | undefined;
     /** The decimal separator to be used. Default value is a dot (.) */
     decimalSeparator?: DecimalChar | undefined;
     /** The column separator to be used. Default value is a comma (,) */
     colSeparator?: Separator | undefined;
-    /** Number of data bytes to max write to the log file (1-64). Default value is 8. */
-    dataBytesLimit?: number | undefined;
-    /** Number of time decimals (0-9). Default value is 4 */
+    /** Number of data bytes a converter will max write to the log file (1-64). Default value is 64 */
+    dataBytesConverterLimit?: number | undefined;
+    /** Max file size in megabytes before writing to a new file */
+    sizeLimit?: number | undefined;
+    /** Number of data decimals (0-9). Default value is 4 */
+    numberOfDataDecimals?: number | undefined;
+    /** Max number of seconds between first and last event before writing to a new file */
+    timeLimit?: number | undefined;
+    /** Number of time decimals (0-9). Default value is 9 */
     numberOfTimeDecimals?: number | undefined;
     /** Use the specified time reference. Default value is FIRST_TRIGGER */
     timeReference?: TimeReference | undefined;
     /** Write timestamps in calendar time instead of seconds. Default value is false */
-    calendarTime?: boolean | undefined;
-    /** Use UTC instead of local time for absolute timestamps. Default value is false */
-    utcTime?: boolean | undefined;
+    useCalendarTime?: boolean | undefined;
+    /** Use UTC instead of local time for absolute timestamps. Default value is true */
+    useUtcTime?: boolean | undefined;
+    /** Use strings from database instead of integer values. Default value is false */
+    useEnumValues?: boolean | undefined;
+    /** Write fully qualified names. Default value is false */
+    writeFullyQualifiedNames?: boolean | undefined;
+    /** Write counter. Default value is false */
+    writeCounter?: boolean | undefined;
+    /** Write units on a new row. Default value is false */
+    writeUnitsOnOwnRow?: boolean | undefined;
+    /** Write only signals and not any data frames. Default value is true */
+    writeOnlySignals?: boolean | undefined;
 }
 /** A message for defining base node properties. */
 export interface BaseNodeProperties {
@@ -403,6 +472,7 @@ export interface TargetNodeProperties {
     baseNode: BaseNodeProperties | undefined;
     connectedNodes: string[];
     messageLoggerSettings?: MessageLoggerSettings | undefined;
+    signalLoggerSettings?: SignalLoggerSettings | undefined;
 }
 /** A message for defining a measurement setup. */
 export interface MeasurementSetup {
@@ -411,7 +481,6 @@ export interface MeasurementSetup {
     targets: TargetNodeProperties[];
     language: string;
 }
-export declare const CanBusSpeed: MessageFns<CanBusSpeed>;
 export declare const CanChannelConfiguration: MessageFns<CanChannelConfiguration>;
 export declare const LinChannelConfiguration: MessageFns<LinChannelConfiguration>;
 export declare const ChannelSettings: MessageFns<ChannelSettings>;
@@ -419,6 +488,7 @@ export declare const LogReplaySettings: MessageFns<LogReplaySettings>;
 export declare const LogReplaySettings_ChannelIdentifiersEntry: MessageFns<LogReplaySettings_ChannelIdentifiersEntry>;
 export declare const PeriodicTransmissionSettings: MessageFns<PeriodicTransmissionSettings>;
 export declare const CanMessageFilterSettings: MessageFns<CanMessageFilterSettings>;
+export declare const SignalFilterSettings: MessageFns<SignalFilterSettings>;
 export declare const DatabasesSettings: MessageFns<DatabasesSettings>;
 export declare const InterpreterSettings: MessageFns<InterpreterSettings>;
 export declare const J1939InterpreterSettings: MessageFns<J1939InterpreterSettings>;
@@ -427,6 +497,7 @@ export declare const FrameReceivedTrigger: MessageFns<FrameReceivedTrigger>;
 export declare const SignalValueTrigger: MessageFns<SignalValueTrigger>;
 export declare const TriggerSettings: MessageFns<TriggerSettings>;
 export declare const MessageLoggerSettings: MessageFns<MessageLoggerSettings>;
+export declare const SignalLoggerSettings: MessageFns<SignalLoggerSettings>;
 export declare const BaseNodeProperties: MessageFns<BaseNodeProperties>;
 export declare const SourceNodeProperties: MessageFns<SourceNodeProperties>;
 export declare const DataProcessorNodeProperties: MessageFns<DataProcessorNodeProperties>;

package/dist/protos/signal_params.d.ts

@@ -38,15 +38,15 @@ export interface SignalDefinition {
     minValue: number;
     maxValue: number;
     enumValues: {
-        [key: string]: number;
+        [key: number]: string;
     };
     isMultiplexer: boolean;
     isMultiplexed: boolean;
     multiplexValue?: number | undefined;
 }
 export interface SignalDefinition_EnumValuesEntry {
-    key: string;
-    value: number;
+    key: number;
+    value: string;
 }
 export interface SignalDefinitions {
     items: SignalDefinition[];

package/dist/protos/status_params.d.ts

@@ -19,16 +19,16 @@ export declare enum LogReplayState {
 }
 export declare function logReplayStateFromJSON(object: any): LogReplayState;
 export declare function logReplayStateToJSON(object: LogReplayState): string;
-/** Possible message logger states. */
-export declare enum MessageLoggerState {
+/** Possible message or signal logger states. */
+export declare enum LoggerState {
     MESSAGE_LOGGER_STATE_UNSPECIFIED = 0,
     MESSAGE_LOGGER_STATE_PRESTART = 1,
     MESSAGE_LOGGER_STATE_STARTED = 2,
     MESSAGE_LOGGER_STATE_STOPPED = 3,
     UNRECOGNIZED = -1
 }
-export declare function messageLoggerStateFromJSON(object: any): MessageLoggerState;
-export declare function messageLoggerStateToJSON(object: MessageLoggerState): string;
+export declare function loggerStateFromJSON(object: any): LoggerState;
+export declare function loggerStateToJSON(object: LoggerState): string;
 /** A message holding bus status information. */
 export interface BusStatus {
     rxMessageCounter: number;
@@ -58,9 +58,9 @@ export interface DataProcessingStatus {
 export interface LogReplayStatus {
     state: LogReplayState;
 }
-/** A message holding special message logger status information. */
-export interface MessageLoggerStatus {
-    state: MessageLoggerState;
+/** A message holding special message or signal logger status information. */
+export interface LoggerStatus {
+    state: LoggerState;
 }
 /** A message holding any errors associated with a node. */
 export interface ErrorStatus {
@@ -82,7 +82,7 @@ export interface NodeStatus {
     /** Special log replay status */
     logReplayStatus: LogReplayStatus | undefined;
     /** Special message logger status */
-    messageLoggerStatus: MessageLoggerStatus | undefined;
+    loggerStatus: LoggerStatus | undefined;
     /** Error status */
     errorStatus: ErrorStatus | undefined;
 }
@@ -93,7 +93,7 @@ export interface NodeStatuses {
 export declare const BusStatus: MessageFns<BusStatus>;
 export declare const DataProcessingStatus: MessageFns<DataProcessingStatus>;
 export declare const LogReplayStatus: MessageFns<LogReplayStatus>;
-export declare const MessageLoggerStatus: MessageFns<MessageLoggerStatus>;
+export declare const LoggerStatus: MessageFns<LoggerStatus>;
 export declare const ErrorStatus: MessageFns<ErrorStatus>;
 export declare const NodeStatus: MessageFns<NodeStatus>;
 export declare const NodeStatuses: MessageFns<NodeStatuses>;