@kvaser/canking-api 7.2.1 → 7.4.0

package/dist/protos/measurement_params.d.ts

@@ -1,9 +1,12 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import Long from "long";
 import { ApiPreferences } from "./common_params";
-import { ScheduleTable, SignalValue, WriteFrame } from "./frame_params";
+import { FixedPosFrameIdentifier, ScheduleTable, SignalValue, WriteFrame } from "./frame_params";
 import { CanChannelConfiguration, DataProcessorNodeProperties, LinChannelConfiguration, LogFileFormat, MeasurementSetup, PeriodicTransmissionSettings, SourceNodeProperties, TargetNodeProperties } from "./measurement_settings";
-/** Possible events. */
+/**
+ * Possible events.
+ * @internal
+ */
 export declare enum MeasurementEvent {
     MEASUREMENT_EVENT_UNSPECIFIED = 0,
     /** MEASUREMENT_EVENT_MEASUREMENT_SETUP_CHANGED - Raised when the measurement setup has changed, will pass the new MeasurementSetup as event data */
@@ -18,22 +21,34 @@ export declare enum MeasurementEvent {
 }
 export declare function measurementEventFromJSON(object: any): MeasurementEvent;
 export declare function measurementEventToJSON(object: MeasurementEvent): string;
-/** A request message for setting a new measurement setup. */
+/**
+ * A request message for setting a new measurement setup.
+ * @internal
+ */
 export interface SetMeasurementSetupRequest {
     preferences: ApiPreferences | undefined;
     setup: MeasurementSetup | undefined;
 }
-/** A request message for adding all connected CAN channels. */
+/**
+ * A request message for adding all connected CAN channels.
+ * @internal
+ */
 export interface AddAllConnectedCanChannelsRequest {
     preferences: ApiPreferences | undefined;
     configuration: CanChannelConfiguration | undefined;
 }
-/** A request message for adding all connected LIN channels. */
+/**
+ * A request message for adding all connected LIN channels.
+ * @internal
+ */
 export interface AddAllConnectedLinChannelsRequest {
     preferences: ApiPreferences | undefined;
     configuration: LinChannelConfiguration | undefined;
 }
-/** A request message for adding or updating a source node. */
+/**
+ * A request message for adding or updating a source node.
+ * @internal
+ */
 export interface AddOrUpdateSourceRequest {
     preferences: ApiPreferences | undefined;
     source: SourceNodeProperties | undefined;
@@ -44,11 +59,17 @@ export interface AddOrUpdateSourceRequest {
      */
     replaceAllProperties: boolean;
 }
-/** A response message for getting a source node. */
+/**
+ * A response message for getting a source node.
+ * @internal
+ */
 export interface GetSourceResponse {
     source: SourceNodeProperties | undefined;
 }
-/** A request message for adding or updating a data processor node. */
+/**
+ * A request message for adding or updating a data processor node.
+ * @internal
+ */
 export interface AddOrUpdateDataProcessorRequest {
     preferences: ApiPreferences | undefined;
     dataProcessor: DataProcessorNodeProperties | undefined;
@@ -63,11 +84,17 @@ export interface AddOrUpdateDataProcessorRequest {
      */
     replaceAllProperties: boolean;
 }
-/** A response message for getting a data processor node. */
+/**
+ * A response message for getting a data processor node.
+ * @internal
+ */
 export interface GetDataProcessorResponse {
     dataProcessor: DataProcessorNodeProperties | undefined;
 }
-/** A request message for adding or updating a target node. */
+/**
+ * A request message for adding or updating a target node.
+ * @internal
+ */
 export interface AddOrUpdateTargetRequest {
     preferences: ApiPreferences | undefined;
     target: TargetNodeProperties | undefined;
@@ -78,17 +105,26 @@ export interface AddOrUpdateTargetRequest {
      */
     replaceAllProperties: boolean;
 }
-/** A response message for getting a target node. */
+/**
+ * A response message for getting a target node.
+ * @internal
+ */
 export interface GetTargetResponse {
     target: TargetNodeProperties | undefined;
 }
-/** A request message for connecting two nodes. */
+/**
+ * A request message for connecting two nodes.
+ * @internal
+ */
 export interface ConnectNodesRequest {
     preferences: ApiPreferences | undefined;
     startNode: string;
     endNode: string;
 }
-/** A request message for disconnecting two nodes. */
+/**
+ * A request message for disconnecting two nodes.
+ * @internal
+ */
 export interface DisconnectNodesRequest {
     preferences: ApiPreferences | undefined;
     startNode: string;
@@ -97,6 +133,7 @@ export interface DisconnectNodesRequest {
 /**
  * A request message for any service method that needs to know one identifier of a node
  * in the measurement setup.
+ * @internal
  */
 export interface IdentifierRequest {
     preferences: ApiPreferences | undefined;
@@ -105,18 +142,34 @@ export interface IdentifierRequest {
 /**
  * A request message for any service method that needs to know identifiers of a nodes
  * in the measurement setup.
+ * @internal
  */
 export interface IdentifiersRequest {
     preferences: ApiPreferences | undefined;
     identifiers: string[];
 }
-/** A request message for sending out one message frame. */
+/**
+ * A request message for sending out one message frame.
+ * @internal
+ */
 export interface SendMessageRequest {
     preferences: ApiPreferences | undefined;
     channelIdentifier: string;
     frame: WriteFrame | undefined;
 }
-/** A request message for sending out one LIN wakeup frame. */
+/**
+ * A request message for sending out several message frames.
+ * @internal
+ */
+export interface SendMessagesRequest {
+    preferences: ApiPreferences | undefined;
+    channelIdentifier: string;
+    frames: WriteFrame[];
+}
+/**
+ * A request message for sending out one LIN wakeup frame.
+ * @internal
+ */
 export interface SendLinWakeupFrameRequest {
     preferences: ApiPreferences | undefined;
     /** Identifier of the LIN channel to send the wakeup frame on. */
@@ -126,7 +179,10 @@ export interface SendLinWakeupFrameRequest {
     /** The time, in bit times, between the wakeup frames. Maximum value of interval is either 255 (0xFF) or 65535 (0xFFFF) depending on device. */
     interval: number;
 }
-/** A request message for writing a LIN message header to the LIN bus. */
+/**
+ * A request message for writing a LIN message header to the LIN bus.
+ * @internal
+ */
 export interface RequestLinMessageRequest {
     preferences: ApiPreferences | undefined;
     /** Identifier of the LIN channel to clear the message buffer on. */
@@ -137,6 +193,7 @@ export interface RequestLinMessageRequest {
 /**
  * A request message for updating a message buffer in a slave. The contents of the message buffer will be used the next time the slave
  * is polled for the specified LIN message id.
+ * @internal
  */
 export interface UpdateLinMessageRequest {
     preferences: ApiPreferences | undefined;
@@ -145,7 +202,10 @@ export interface UpdateLinMessageRequest {
     /** The new LIN message. */
     frame: WriteFrame | undefined;
 }
-/** A request message for clearing a message buffer for a LIN slave. The slave will not answer next time it is polled. */
+/**
+ * A request message for clearing a message buffer for a LIN slave. The slave will not answer next time it is polled.
+ * @internal
+ */
 export interface ClearLinMessageRequest {
     preferences: ApiPreferences | undefined;
     /** Identifier of the LIN channel to clear the message buffer on. */
@@ -153,13 +213,19 @@ export interface ClearLinMessageRequest {
     /** The LIN message id for which the corresponding buffer will be cleared. */
     frameId: number;
 }
-/** A request message for start sending out message frames periodically. */
+/**
+ * A request message for start sending out message frames periodically.
+ * @internal
+ */
 export interface StartPeriodicTransmissionRequest {
     preferences: ApiPreferences | undefined;
     /** Periodic transmission settings */
     settings: PeriodicTransmissionSettings | undefined;
 }
-/** A request message for updating the settings of a periodic transmission. */
+/**
+ * A request message for updating the settings of a periodic transmission.
+ * @internal
+ */
 export interface UpdatePeriodicTransmissionRequest {
     preferences: ApiPreferences | undefined;
     /** Periodic transmission settings */
@@ -167,22 +233,34 @@ export interface UpdatePeriodicTransmissionRequest {
     /** Identifier of periodic transmission */
     identifier: string;
 }
-/** A response message for start sending out message frames periodically. */
+/**
+ * A response message for start sending out message frames periodically.
+ * @internal
+ */
 export interface StartPeriodicTransmissionResponse {
     periodicTransmissionIdentifier: string;
 }
 /** A message for streaming online status information. */
 export interface OnlineStatus {
+    /** Indicates if the measurement is online. */
     isOnline: boolean;
+    /** Counter that is increased every time the measurement goes online. This can be used to detect when the measurement goes offline and then online again. */
+    onlineCounter: number;
 }
-/** Event arguments */
+/**
+ * Event arguments
+ * @internal
+ */
 export interface MeasurementEventArgs {
     eventType: MeasurementEvent;
     identifier?: string | undefined;
     measurementSetup?: MeasurementSetup | undefined;
     onlineStatus?: OnlineStatus | undefined;
 }
-/** A request message to get supported log file formats. */
+/**
+ * A request message to get supported log file formats.
+ * @internal
+ */
 export interface GetLogFileFormatsRequest {
     preferences: ApiPreferences | undefined;
     /** Set to true to include message log formats. */
@@ -192,46 +270,70 @@ export interface GetLogFileFormatsRequest {
     /** Set to true to only include formats with read support. */
     readSupport: boolean;
 }
-/** A response message for GetLogFileFormats request. */
+/**
+ * Information about a log file format.
+ * @internal
+ */
+export interface LogFileFormatInfo {
+    /** File format. */
+    format: LogFileFormat;
+    /** File format name. */
+    name: string;
+    /** File format file extension. */
+    extension: string;
+    /** File format description. */
+    description: string;
+    /** Supported protocols by the format. */
+    supportedProtocols: string[];
+}
+/**
+ * A response message for GetLogFileFormats request.
+ * @internal
+ */
 export interface GetLogFileFormatsResponse {
     /** All supported formats. */
-    formats: LogFileFormat[];
-    /** Name of each supported format. */
-    names: string[];
-    /** File extensions for each supported format. */
-    extensions: string[];
-    /** Description of each supported format. */
-    descriptions: string[];
-}
-/** A request message to get all channels listed in a log file. */
+    formats: LogFileFormatInfo[];
+}
+/**
+ * A request message to get all channels listed in a log file.
+ * @internal
+ */
 export interface GetChannelsFromLogFileRequest {
     preferences: ApiPreferences | undefined;
     /** Log file to retrieve channels from. */
     logFile: string;
 }
-/** A response message for GetChannelsFromLogFile request. */
+/**
+ * A response message for GetChannelsFromLogFile request.
+ * @internal
+ */
 export interface GetChannelsFromLogFileResponse {
     /** Channels listed in the log file. */
     channels: number[];
+    /** Channel protocols listed in the log file. */
+    protocols: string[];
 }
-/** A request message to get all frame definitions listed in the specified database files. */
-export interface GetFrameDefinitionsFromDatabaseFilesRequest {
-    preferences: ApiPreferences | undefined;
-    /** Database files to retrieve frame definitions from. */
-    files: string[];
-}
-/** A request message to get all schedule tables listed in the specified database files. */
+/**
+ * A request message to get all schedule tables listed in the specified database files.
+ * @internal
+ */
 export interface GetScheduleTablesFromDatabaseFilesRequest {
     preferences: ApiPreferences | undefined;
     /** Database files to retrieve schedule tables from. */
     files: string[];
 }
-/** A response message for GetScheduleTablesFromDatabaseFiles request. */
+/**
+ * A response message for GetScheduleTablesFromDatabaseFiles request.
+ * @internal
+ */
 export interface GetScheduleTablesFromDatabaseFilesResponse {
     /** Tables listed in the database file. */
     tables: ScheduleTable[];
 }
-/** A request message to get all signal values for a message. */
+/**
+ * A request message to get all signal values for a message.
+ * @internal
+ */
 export interface GetSignalDataFromMessageDataRequest {
     preferences: ApiPreferences | undefined;
     /** Message qualified name. */
@@ -239,12 +341,18 @@ export interface GetSignalDataFromMessageDataRequest {
     /** Message data. */
     data: number[];
 }
-/** A response message for GetSignalDataFromMessageData request. */
+/**
+ * A response message for GetSignalDataFromMessageData request.
+ * @internal
+ */
 export interface GetSignalDataFromMessageDataResponse {
     /** Signal values. */
     signalValues: SignalValue[];
 }
-/** A request message to set all signal values for a message. */
+/**
+ * A request message to set all signal values for a message.
+ * @internal
+ */
 export interface SetSignalDataToMessageDataRequest {
     preferences: ApiPreferences | undefined;
     /** Message qualified name. */
@@ -254,7 +362,10 @@ export interface SetSignalDataToMessageDataRequest {
     /** New signal values. One or more signals to be updated. */
     signalValues: SignalValue[];
 }
-/** A response message for SetSignalDataToMessageData request. */
+/**
+ * A response message for SetSignalDataToMessageData request.
+ * @internal
+ */
 export interface SetSignalDataToMessageDataResponse {
     /**
      * Updated signal values. Might be different from the once passed in the request if the
@@ -264,6 +375,85 @@ export interface SetSignalDataToMessageDataResponse {
     /** Updated message data. */
     data: number[];
 }
+/**
+ * A request message to get data frames before a specified timestamp.
+ * @internal
+ */
+export interface GetDataFramesBeforeTimestampRequest {
+    preferences: ApiPreferences | undefined;
+    /** Timestamp in seconds to retrieve frames before. */
+    timestamp: number;
+    /** Maximum number of frames to retrieve. */
+    maxCount?: number | undefined;
+}
+/**
+ * A request message to get data frames between specified timestamps.
+ * @internal
+ */
+export interface GetDataFramesBetweenTimestampsRequest {
+    preferences: ApiPreferences | undefined;
+    /** Timestamp in seconds to retrieve frames from (inclusive). */
+    startTimestamp: number;
+    /** Timestamp in seconds to retrieve frames to (exclusive). */
+    endTimestamp: number;
+    /** Optional frame identifiers to filter on. If no frame identifiers are specified, frames from all identifiers are retrieved. */
+    frameIds: FixedPosFrameIdentifier[];
+}
+/**
+ * A request message to subscribe for data frames.
+ * @internal
+ */
+export interface SubscribeForDataRequest {
+    preferences: ApiPreferences | undefined;
+    /** Subscribed frame identifiers, for frames specified here all data will be streamed. */
+    frameIds: FixedPosFrameIdentifier[];
+}
+/**
+ * A request message to get data envelopes between specified timestamps for specific frames.
+ * @internal
+ */
+export interface GetFrameEnvelopesRequest {
+    preferences: ApiPreferences | undefined;
+    /** Timestamp in microseconds to retrieve envelopes from (inclusive). */
+    startTimestampUs: Long;
+    /** Timestamp in microseconds to retrieve envelopes to (exclusive). */
+    endTimestampUs: Long;
+    /** Width of the view in pixels. */
+    viewWidthPx: number;
+    /** Optional frame identifiers to filter on. If no frame identifiers are specified, envelopes from all identifiers are retrieved. */
+    frameIds: FixedPosFrameIdentifier[];
+}
+/**
+ * A data envelope for a specific signal.
+ * All arrays must have the same length.
+ * @internal
+ */
+export interface SignalDataEnvelope {
+    /** Signal qualified name. */
+    signalQualifiedName: string;
+    /** Timestamps in microseconds. */
+    timestampsUs: Long[];
+    /** Minimum values. */
+    minValues: number[];
+    /** Maximum values. */
+    maxValues: number[];
+    /** Frame identifiers to filter on. */
+    frameIds: FixedPosFrameIdentifier[];
+}
+export interface FrameDataEnvelope {
+    /** Frame identifier. */
+    frameId: FixedPosFrameIdentifier | undefined;
+    /** Signal data envelopes for all signals in the frame. */
+    signalEnvelopes: SignalDataEnvelope[];
+}
+/**
+ * A response message for GetFrameEnvelopes request.
+ * @internal
+ */
+export interface GetFrameEnvelopesResponse {
+    /** Data envelopes for all signals for each requested frame identifier. */
+    envelopes: FrameDataEnvelope[];
+}
 export declare const SetMeasurementSetupRequest: MessageFns<SetMeasurementSetupRequest>;
 export declare const AddAllConnectedCanChannelsRequest: MessageFns<AddAllConnectedCanChannelsRequest>;
 export declare const AddAllConnectedLinChannelsRequest: MessageFns<AddAllConnectedLinChannelsRequest>;
@@ -278,6 +468,7 @@ export declare const DisconnectNodesRequest: MessageFns<DisconnectNodesRequest>;
 export declare const IdentifierRequest: MessageFns<IdentifierRequest>;
 export declare const IdentifiersRequest: MessageFns<IdentifiersRequest>;
 export declare const SendMessageRequest: MessageFns<SendMessageRequest>;
+export declare const SendMessagesRequest: MessageFns<SendMessagesRequest>;
 export declare const SendLinWakeupFrameRequest: MessageFns<SendLinWakeupFrameRequest>;
 export declare const RequestLinMessageRequest: MessageFns<RequestLinMessageRequest>;
 export declare const UpdateLinMessageRequest: MessageFns<UpdateLinMessageRequest>;
@@ -288,16 +479,23 @@ export declare const StartPeriodicTransmissionResponse: MessageFns<StartPeriodic
 export declare const OnlineStatus: MessageFns<OnlineStatus>;
 export declare const MeasurementEventArgs: MessageFns<MeasurementEventArgs>;
 export declare const GetLogFileFormatsRequest: MessageFns<GetLogFileFormatsRequest>;
+export declare const LogFileFormatInfo: MessageFns<LogFileFormatInfo>;
 export declare const GetLogFileFormatsResponse: MessageFns<GetLogFileFormatsResponse>;
 export declare const GetChannelsFromLogFileRequest: MessageFns<GetChannelsFromLogFileRequest>;
 export declare const GetChannelsFromLogFileResponse: MessageFns<GetChannelsFromLogFileResponse>;
-export declare const GetFrameDefinitionsFromDatabaseFilesRequest: MessageFns<GetFrameDefinitionsFromDatabaseFilesRequest>;
 export declare const GetScheduleTablesFromDatabaseFilesRequest: MessageFns<GetScheduleTablesFromDatabaseFilesRequest>;
 export declare const GetScheduleTablesFromDatabaseFilesResponse: MessageFns<GetScheduleTablesFromDatabaseFilesResponse>;
 export declare const GetSignalDataFromMessageDataRequest: MessageFns<GetSignalDataFromMessageDataRequest>;
 export declare const GetSignalDataFromMessageDataResponse: MessageFns<GetSignalDataFromMessageDataResponse>;
 export declare const SetSignalDataToMessageDataRequest: MessageFns<SetSignalDataToMessageDataRequest>;
 export declare const SetSignalDataToMessageDataResponse: MessageFns<SetSignalDataToMessageDataResponse>;
+export declare const GetDataFramesBeforeTimestampRequest: MessageFns<GetDataFramesBeforeTimestampRequest>;
+export declare const GetDataFramesBetweenTimestampsRequest: MessageFns<GetDataFramesBetweenTimestampsRequest>;
+export declare const SubscribeForDataRequest: MessageFns<SubscribeForDataRequest>;
+export declare const GetFrameEnvelopesRequest: MessageFns<GetFrameEnvelopesRequest>;
+export declare const SignalDataEnvelope: MessageFns<SignalDataEnvelope>;
+export declare const FrameDataEnvelope: MessageFns<FrameDataEnvelope>;
+export declare const GetFrameEnvelopesResponse: MessageFns<GetFrameEnvelopesResponse>;
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 type DeepPartial<T> = T extends Builtin ? T : T extends Long ? string | number | Long : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;