@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
987 lines (986 loc) • 84.7 kB
TypeScript
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 { 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";
import { NodeStatuses } from "./status_params";
/** The measurement service. This service is responsible for the measurement setup. */
export type MeasurementServiceService = typeof MeasurementServiceService;
export declare const MeasurementServiceService: {
/**
* Starts a subscription for measurement events.
* @param request A request message with API preferences.
* @returns A stream of MeasurementEventArgs messages.
*/
readonly subscribeForEvents: {
readonly path: "/measurementservice.MeasurementService/SubscribeForEvents";
readonly requestStream: false;
readonly responseStream: true;
readonly requestSerialize: (value: ApiPreferences) => Buffer;
readonly requestDeserialize: (value: Buffer) => ApiPreferences;
readonly responseSerialize: (value: MeasurementEventArgs) => Buffer;
readonly responseDeserialize: (value: Buffer) => MeasurementEventArgs;
};
/**
* Starts a subscription for measurement data.
* @param request A request message with API preferences.
* @returns A stream of Frames messages.
*/
readonly subscribeForData: {
readonly path: "/measurementservice.MeasurementService/SubscribeForData";
readonly requestStream: false;
readonly responseStream: true;
readonly requestSerialize: (value: ApiPreferences) => Buffer;
readonly requestDeserialize: (value: Buffer) => ApiPreferences;
readonly responseSerialize: (value: Frames) => Buffer;
readonly responseDeserialize: (value: Buffer) => Frames;
};
/**
* Starts a subscription for measurement status.
* @param request A request message with API preferences.
* @returns A stream of NodeStatuses messages.
*/
readonly subscribeForStatus: {
readonly path: "/measurementservice.MeasurementService/SubscribeForStatus";
readonly requestStream: false;
readonly responseStream: true;
readonly requestSerialize: (value: ApiPreferences) => Buffer;
readonly requestDeserialize: (value: Buffer) => ApiPreferences;
readonly responseSerialize: (value: NodeStatuses) => Buffer;
readonly responseDeserialize: (value: Buffer) => NodeStatuses;
};
/**
* Asks the service to clear status for the specified node.
* @param request A request message with a node identifier.
* @returns An empty response message.
*/
readonly clearStatus: {
readonly path: "/measurementservice.MeasurementService/ClearStatus";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Gets the current measurement setup.
* @param request A request message with API preferences.
* @returns A response message with the current setup.
*/
readonly getSetup: {
readonly path: "/measurementservice.MeasurementService/GetSetup";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: ApiPreferences) => Buffer;
readonly requestDeserialize: (value: Buffer) => ApiPreferences;
readonly responseSerialize: (value: MeasurementSetup) => Buffer;
readonly responseDeserialize: (value: Buffer) => MeasurementSetup;
};
/**
* Sets a new measurement setup.
* @param request A request message with the new setup.
* @returns An empty response message.
*/
readonly setSetup: {
readonly path: "/measurementservice.MeasurementService/SetSetup";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: SetMeasurementSetupRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => SetMeasurementSetupRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Gets the current online status.
* @param request A request message with API preferences.
* @returns A response message with the current online status.
*/
readonly getOnlineStatus: {
readonly path: "/measurementservice.MeasurementService/GetOnlineStatus";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: ApiPreferences) => Buffer;
readonly requestDeserialize: (value: Buffer) => ApiPreferences;
readonly responseSerialize: (value: OnlineStatus) => Buffer;
readonly responseDeserialize: (value: Buffer) => OnlineStatus;
};
/**
* Asks the service to add all connected CAN channels with the specified settings.
* @param request A request message with CAN channel settings.
* @returns An empty response message.
*/
readonly addAllConnectedCanChannels: {
readonly path: "/measurementservice.MeasurementService/AddAllConnectedCanChannels";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: AddAllConnectedCanChannelsRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => AddAllConnectedCanChannelsRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to add all connected LIN channels with the specified settings.
* @param request A request message with LIN channel settings.
* @returns An empty response message.
*/
readonly addAllConnectedLinChannels: {
readonly path: "/measurementservice.MeasurementService/AddAllConnectedLinChannels";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: AddAllConnectedLinChannelsRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => AddAllConnectedLinChannelsRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to add a new source node with the specified settings.
* @param request A request message with source node settings.
* @returns An empty response message.
*/
readonly addSource: {
readonly path: "/measurementservice.MeasurementService/AddSource";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: AddOrUpdateSourceRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => AddOrUpdateSourceRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Gets the source node with the specified identifier.
* @param request A request message with source node identifier.
* @returns A response message with the source node settings.
*/
readonly getSource: {
readonly path: "/measurementservice.MeasurementService/GetSource";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: GetSourceResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetSourceResponse;
};
/**
* Asks the service to update a source node with the specified settings.
* @param request A request message with source node settings.
* @returns An empty response message.
*/
readonly updateSource: {
readonly path: "/measurementservice.MeasurementService/UpdateSource";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: AddOrUpdateSourceRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => AddOrUpdateSourceRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to delete a source node with the specified identifier.
* @param request A request message with source node identifier.
* @returns An empty response message.
*/
readonly deleteSource: {
readonly path: "/measurementservice.MeasurementService/DeleteSource";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to add a new data processor node with the specified settings.
* @param request A request message with data processor node settings.
* @returns An empty response message.
*/
readonly addDataProcessor: {
readonly path: "/measurementservice.MeasurementService/AddDataProcessor";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: AddOrUpdateDataProcessorRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => AddOrUpdateDataProcessorRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Gets the data processor node with the specified identifier.
* @param request A request message with data processor node identifier.
* @returns A response message with the data processor node settings.
*/
readonly getDataProcessor: {
readonly path: "/measurementservice.MeasurementService/GetDataProcessor";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: GetDataProcessorResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetDataProcessorResponse;
};
/**
* Asks the service to update a data processor node with the specified settings.
* @param request A request message with data processor node settings.
* @returns An empty response message.
*/
readonly updateDataProcessor: {
readonly path: "/measurementservice.MeasurementService/UpdateDataProcessor";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: AddOrUpdateDataProcessorRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => AddOrUpdateDataProcessorRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to delete a data processor node with the specified identifier.
* @param request A request message with data processor node identifier.
* @returns An empty response message.
*/
readonly deleteDataProcessor: {
readonly path: "/measurementservice.MeasurementService/DeleteDataProcessor";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to add a new target node with the specified settings.
* @param request A request message with target node settings.
* @returns An empty response message.
*/
readonly addTarget: {
readonly path: "/measurementservice.MeasurementService/AddTarget";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: AddOrUpdateTargetRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => AddOrUpdateTargetRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Gets the target node with the specified identifier.
* @param request A request message with target node identifier.
* @returns A response message with the target node settings.
*/
readonly getTarget: {
readonly path: "/measurementservice.MeasurementService/GetTarget";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: GetTargetResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetTargetResponse;
};
/**
* Asks the service to update a target node with the specified settings.
* @param request A request message with target node settings.
* @returns An empty response message.
*/
readonly updateTarget: {
readonly path: "/measurementservice.MeasurementService/UpdateTarget";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: AddOrUpdateTargetRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => AddOrUpdateTargetRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to delete a target node with the specified identifier.
* @param request A request message with target node identifier.
* @returns An empty response message.
*/
readonly deleteTarget: {
readonly path: "/measurementservice.MeasurementService/DeleteTarget";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to connect two nodes.
* @param request A request message with node identifiers.
* @returns An empty response message.
*/
readonly connectNodes: {
readonly path: "/measurementservice.MeasurementService/ConnectNodes";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: ConnectNodesRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => ConnectNodesRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to disconnect two nodes.
* @param request A request message with node identifiers.
* @returns An empty response message.
*/
readonly disconnectNodes: {
readonly path: "/measurementservice.MeasurementService/DisconnectNodes";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: DisconnectNodesRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => DisconnectNodesRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to enable a node.
* @param request A request message with node identifier.
* @returns An empty response message.
*/
readonly enableNode: {
readonly path: "/measurementservice.MeasurementService/EnableNode";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to disable a node.
* @param request A request message with node identifier.
* @returns An empty response message.
*/
readonly disableNode: {
readonly path: "/measurementservice.MeasurementService/DisableNode";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to start a channel node (go bus on).
* @param request A request message with node identifier.
* @returns An empty response message.
*/
readonly startChannel: {
readonly path: "/measurementservice.MeasurementService/StartChannel";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to stop a channel node (go bus off).
* @param request A request message with node identifier.
* @returns An empty response message.
*/
readonly stopChannel: {
readonly path: "/measurementservice.MeasurementService/StopChannel";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to start a measurement (go online).
* @param request A request message with API preferences.
* @returns An empty response message.
*/
readonly startMeasurement: {
readonly path: "/measurementservice.MeasurementService/StartMeasurement";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: ApiPreferences) => Buffer;
readonly requestDeserialize: (value: Buffer) => ApiPreferences;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to stop a measurement (go offline).
* @param request A request message with API preferences.
* @returns An empty response message.
*/
readonly stopMeasurement: {
readonly path: "/measurementservice.MeasurementService/StopMeasurement";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: ApiPreferences) => Buffer;
readonly requestDeserialize: (value: Buffer) => ApiPreferences;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to send a message.
* @param request A request message with information about the message to be sent out.
* @returns An empty response message.
*/
readonly sendMessage: {
readonly path: "/measurementservice.MeasurementService/SendMessage";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: SendMessageRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => SendMessageRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to send a LIN wakeup frame.
* @param request A request message with information about the frame to be sent out.
* @returns An empty response message.
*/
readonly sendLinWakeupFrame: {
readonly path: "/measurementservice.MeasurementService/SendLinWakeupFrame";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: SendLinWakeupFrameRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => SendLinWakeupFrameRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to write a LIN message header to the LIN bus.
* @param request A request message with information about the frame to be updated.
* @returns An empty response message.
*/
readonly requestLinMessage: {
readonly path: "/measurementservice.MeasurementService/RequestLinMessage";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: RequestLinMessageRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => RequestLinMessageRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to update a LIN slave's message buffer.
* @param request A request message with information about the frame to be updated.
* @returns An empty response message.
*/
readonly updateLinMessage: {
readonly path: "/measurementservice.MeasurementService/UpdateLinMessage";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: UpdateLinMessageRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => UpdateLinMessageRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to clear a LIN slave's message buffer.
* @param request A request message with information about the frame to be cleared.
* @returns An empty response message.
*/
readonly clearLinMessage: {
readonly path: "/measurementservice.MeasurementService/ClearLinMessage";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: ClearLinMessageRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => ClearLinMessageRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to start a periodic transmission.
* @param request A request message with information about the periodic transmission.
* @returns A response message with an identifier connected to the started periodic transmission.
*/
readonly startPeriodicTransmission: {
readonly path: "/measurementservice.MeasurementService/StartPeriodicTransmission";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: StartPeriodicTransmissionRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => StartPeriodicTransmissionRequest;
readonly responseSerialize: (value: StartPeriodicTransmissionResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => StartPeriodicTransmissionResponse;
};
/**
* Asks the service to update a periodic transmission with new settings.
* @param request A request message with the newsettings and the identifier of the periodic transmission.
* @returns An empty response message.
*/
readonly updatePeriodicTransmission: {
readonly path: "/measurementservice.MeasurementService/UpdatePeriodicTransmission";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: UpdatePeriodicTransmissionRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => UpdatePeriodicTransmissionRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to stop a periodic transmission.
* @param request A request message with identifier of the periodic transmission to be stopped.
* @returns An empty response message.
*/
readonly stopPeriodicTransmission: {
readonly path: "/measurementservice.MeasurementService/StopPeriodicTransmission";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to start a log replay.
* @param request A request message with identifier of the log replay to be started.
* @returns An empty response message.
*/
readonly startLogReplay: {
readonly path: "/measurementservice.MeasurementService/StartLogReplay";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to stop a log replay.
* @param request A request message with identifier of the log replay to be stopped.
* @returns An empty response message.
*/
readonly stopLogReplay: {
readonly path: "/measurementservice.MeasurementService/StopLogReplay";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to start a traffic generator.
* @param request A request message with identifier of the traffic generator to be started.
* @returns An empty response message.
*/
readonly startTrafficGenerator: {
readonly path: "/measurementservice.MeasurementService/StartTrafficGenerator";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Asks the service to stop a traffic generator.
* @param request A request message with identifier of the traffic generator to be stopped.
* @returns An empty response message.
*/
readonly stopTrafficGenerator: {
readonly path: "/measurementservice.MeasurementService/StopTrafficGenerator";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: Empty) => Buffer;
readonly responseDeserialize: (value: Buffer) => Empty;
};
/**
* Gets all supported log file formats.
* @param request A request message with filter information.
* @returns A response message with the supported log file formats.
*/
readonly getLogFileFormats: {
readonly path: "/measurementservice.MeasurementService/GetLogFileFormats";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: GetLogFileFormatsRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetLogFileFormatsRequest;
readonly responseSerialize: (value: GetLogFileFormatsResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetLogFileFormatsResponse;
};
/**
* Gets all available frame definitions in the current measurement setup.
* @param request A request message with an optional node identifier.
* @returns A response message with the available frame definitions.
*/
readonly getFrameDefinitions: {
readonly path: "/measurementservice.MeasurementService/GetFrameDefinitions";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: IdentifierRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => IdentifierRequest;
readonly responseSerialize: (value: FrameDefinitions) => Buffer;
readonly responseDeserialize: (value: Buffer) => FrameDefinitions;
};
/**
* Gets all frame definitions in the provided database files.
* @param request A request message with the database files to be parsed.
* @returns A response message with the frame definitions parsed from the database files.
*/
readonly getFrameDefinitionsFromDatabaseFiles: {
readonly path: "/measurementservice.MeasurementService/GetFrameDefinitionsFromDatabaseFiles";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: GetFrameDefinitionsFromDatabaseFilesRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetFrameDefinitionsFromDatabaseFilesRequest;
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.
* @returns A response message with the schedule tables parsed from the database files.
*/
readonly getScheduleTablesFromDatabaseFiles: {
readonly path: "/measurementservice.MeasurementService/GetScheduleTablesFromDatabaseFiles";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: GetScheduleTablesFromDatabaseFilesRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetScheduleTablesFromDatabaseFilesRequest;
readonly responseSerialize: (value: GetScheduleTablesFromDatabaseFilesResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetScheduleTablesFromDatabaseFilesResponse;
};
/**
* Gets all channels in the provided log file.
* @param request A request message with the log file to be parsed and a flag saying that if needed for converting (and thereby parsing), any KME50 file at the same path with the same name as the log file may be overwritten or not.
* @returns A response message with the channels parsed from the log file.
*/
readonly getChannelsFromLogFile: {
readonly path: "/measurementservice.MeasurementService/GetChannelsFromLogFile";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: GetChannelsFromLogFileRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetChannelsFromLogFileRequest;
readonly responseSerialize: (value: GetChannelsFromLogFileResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetChannelsFromLogFileResponse;
};
/**
* Gets all signal values for a message.
* @param request A request message with message name and message data.
* @returns A response message with all signal values.
*/
readonly getSignalDataFromMessageData: {
readonly path: "/measurementservice.MeasurementService/GetSignalDataFromMessageData";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: GetSignalDataFromMessageDataRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetSignalDataFromMessageDataRequest;
readonly responseSerialize: (value: GetSignalDataFromMessageDataResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetSignalDataFromMessageDataResponse;
};
/**
* Sets all signal values for a message.
* @param request A request message with message name and signal values.
* @returns A response message with message data and all updated signal values.
*/
readonly setSignalDataToMessageData: {
readonly path: "/measurementservice.MeasurementService/SetSignalDataToMessageData";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: SetSignalDataToMessageDataRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => SetSignalDataToMessageDataRequest;
readonly responseSerialize: (value: SetSignalDataToMessageDataResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => SetSignalDataToMessageDataResponse;
};
};
export interface MeasurementServiceServer extends UntypedServiceImplementation {
/**
* Starts a subscription for measurement events.
* @param request A request message with API preferences.
* @returns A stream of MeasurementEventArgs messages.
*/
subscribeForEvents: handleServerStreamingCall<ApiPreferences, MeasurementEventArgs>;
/**
* Starts a subscription for measurement data.
* @param request A request message with API preferences.
* @returns A stream of Frames messages.
*/
subscribeForData: handleServerStreamingCall<ApiPreferences, Frames>;
/**
* Starts a subscription for measurement status.
* @param request A request message with API preferences.
* @returns A stream of NodeStatuses messages.
*/
subscribeForStatus: handleServerStreamingCall<ApiPreferences, NodeStatuses>;
/**
* Asks the service to clear status for the specified node.
* @param request A request message with a node identifier.
* @returns An empty response message.
*/
clearStatus: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Gets the current measurement setup.
* @param request A request message with API preferences.
* @returns A response message with the current setup.
*/
getSetup: handleUnaryCall<ApiPreferences, MeasurementSetup>;
/**
* Sets a new measurement setup.
* @param request A request message with the new setup.
* @returns An empty response message.
*/
setSetup: handleUnaryCall<SetMeasurementSetupRequest, Empty>;
/**
* Gets the current online status.
* @param request A request message with API preferences.
* @returns A response message with the current online status.
*/
getOnlineStatus: handleUnaryCall<ApiPreferences, OnlineStatus>;
/**
* Asks the service to add all connected CAN channels with the specified settings.
* @param request A request message with CAN channel settings.
* @returns An empty response message.
*/
addAllConnectedCanChannels: handleUnaryCall<AddAllConnectedCanChannelsRequest, Empty>;
/**
* Asks the service to add all connected LIN channels with the specified settings.
* @param request A request message with LIN channel settings.
* @returns An empty response message.
*/
addAllConnectedLinChannels: handleUnaryCall<AddAllConnectedLinChannelsRequest, Empty>;
/**
* Asks the service to add a new source node with the specified settings.
* @param request A request message with source node settings.
* @returns An empty response message.
*/
addSource: handleUnaryCall<AddOrUpdateSourceRequest, Empty>;
/**
* Gets the source node with the specified identifier.
* @param request A request message with source node identifier.
* @returns A response message with the source node settings.
*/
getSource: handleUnaryCall<IdentifierRequest, GetSourceResponse>;
/**
* Asks the service to update a source node with the specified settings.
* @param request A request message with source node settings.
* @returns An empty response message.
*/
updateSource: handleUnaryCall<AddOrUpdateSourceRequest, Empty>;
/**
* Asks the service to delete a source node with the specified identifier.
* @param request A request message with source node identifier.
* @returns An empty response message.
*/
deleteSource: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to add a new data processor node with the specified settings.
* @param request A request message with data processor node settings.
* @returns An empty response message.
*/
addDataProcessor: handleUnaryCall<AddOrUpdateDataProcessorRequest, Empty>;
/**
* Gets the data processor node with the specified identifier.
* @param request A request message with data processor node identifier.
* @returns A response message with the data processor node settings.
*/
getDataProcessor: handleUnaryCall<IdentifierRequest, GetDataProcessorResponse>;
/**
* Asks the service to update a data processor node with the specified settings.
* @param request A request message with data processor node settings.
* @returns An empty response message.
*/
updateDataProcessor: handleUnaryCall<AddOrUpdateDataProcessorRequest, Empty>;
/**
* Asks the service to delete a data processor node with the specified identifier.
* @param request A request message with data processor node identifier.
* @returns An empty response message.
*/
deleteDataProcessor: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to add a new target node with the specified settings.
* @param request A request message with target node settings.
* @returns An empty response message.
*/
addTarget: handleUnaryCall<AddOrUpdateTargetRequest, Empty>;
/**
* Gets the target node with the specified identifier.
* @param request A request message with target node identifier.
* @returns A response message with the target node settings.
*/
getTarget: handleUnaryCall<IdentifierRequest, GetTargetResponse>;
/**
* Asks the service to update a target node with the specified settings.
* @param request A request message with target node settings.
* @returns An empty response message.
*/
updateTarget: handleUnaryCall<AddOrUpdateTargetRequest, Empty>;
/**
* Asks the service to delete a target node with the specified identifier.
* @param request A request message with target node identifier.
* @returns An empty response message.
*/
deleteTarget: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to connect two nodes.
* @param request A request message with node identifiers.
* @returns An empty response message.
*/
connectNodes: handleUnaryCall<ConnectNodesRequest, Empty>;
/**
* Asks the service to disconnect two nodes.
* @param request A request message with node identifiers.
* @returns An empty response message.
*/
disconnectNodes: handleUnaryCall<DisconnectNodesRequest, Empty>;
/**
* Asks the service to enable a node.
* @param request A request message with node identifier.
* @returns An empty response message.
*/
enableNode: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to disable a node.
* @param request A request message with node identifier.
* @returns An empty response message.
*/
disableNode: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to start a channel node (go bus on).
* @param request A request message with node identifier.
* @returns An empty response message.
*/
startChannel: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to stop a channel node (go bus off).
* @param request A request message with node identifier.
* @returns An empty response message.
*/
stopChannel: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to start a measurement (go online).
* @param request A request message with API preferences.
* @returns An empty response message.
*/
startMeasurement: handleUnaryCall<ApiPreferences, Empty>;
/**
* Asks the service to stop a measurement (go offline).
* @param request A request message with API preferences.
* @returns An empty response message.
*/
stopMeasurement: handleUnaryCall<ApiPreferences, Empty>;
/**
* Asks the service to send a message.
* @param request A request message with information about the message to be sent out.
* @returns An empty response message.
*/
sendMessage: handleUnaryCall<SendMessageRequest, Empty>;
/**
* Asks the service to send a LIN wakeup frame.
* @param request A request message with information about the frame to be sent out.
* @returns An empty response message.
*/
sendLinWakeupFrame: handleUnaryCall<SendLinWakeupFrameRequest, Empty>;
/**
* Asks the service to write a LIN message header to the LIN bus.
* @param request A request message with information about the frame to be updated.
* @returns An empty response message.
*/
requestLinMessage: handleUnaryCall<RequestLinMessageRequest, Empty>;
/**
* Asks the service to update a LIN slave's message buffer.
* @param request A request message with information about the frame to be updated.
* @returns An empty response message.
*/
updateLinMessage: handleUnaryCall<UpdateLinMessageRequest, Empty>;
/**
* Asks the service to clear a LIN slave's message buffer.
* @param request A request message with information about the frame to be cleared.
* @returns An empty response message.
*/
clearLinMessage: handleUnaryCall<ClearLinMessageRequest, Empty>;
/**
* Asks the service to start a periodic transmission.
* @param request A request message with information about the periodic transmission.
* @returns A response message with an identifier connected to the started periodic transmission.
*/
startPeriodicTransmission: handleUnaryCall<StartPeriodicTransmissionRequest, StartPeriodicTransmissionResponse>;
/**
* Asks the service to update a periodic transmission with new settings.
* @param request A request message with the newsettings and the identifier of the periodic transmission.
* @returns An empty response message.
*/
updatePeriodicTransmission: handleUnaryCall<UpdatePeriodicTransmissionRequest, Empty>;
/**
* Asks the service to stop a periodic transmission.
* @param request A request message with identifier of the periodic transmission to be stopped.
* @returns An empty response message.
*/
stopPeriodicTransmission: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to start a log replay.
* @param request A request message with identifier of the log replay to be started.
* @returns An empty response message.
*/
startLogReplay: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to stop a log replay.
* @param request A request message with identifier of the log replay to be stopped.
* @returns An empty response message.
*/
stopLogReplay: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to start a traffic generator.
* @param request A request message with identifier of the traffic generator to be started.
* @returns An empty response message.
*/
startTrafficGenerator: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Asks the service to stop a traffic generator.
* @param request A request message with identifier of the traffic generator to be stopped.
* @returns An empty response message.
*/
stopTrafficGenerator: handleUnaryCall<IdentifierRequest, Empty>;
/**
* Gets all supported log file formats.
* @param request A request message with filter information.
* @returns A response message with the supported log file formats.
*/
getLogFileFormats: handleUnaryCall<GetLogFileFormatsRequest, GetLogFileFormatsResponse>;
/**
* Gets all available frame definitions in the current measurement setup.
* @param request A request message with an optional node identifier.
* @returns A response message with the available frame definitions.
*/
getFrameDefinitions: handleUnaryCall<IdentifierRequest, FrameDefinitions>;
/**
* Gets all frame definitions in the provided database files.
* @param request A request message with the database files to be parsed.
* @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.
* @returns A response message with the schedule tables parsed from the database files.
*/
getScheduleTablesFromDatabaseFiles: handleUnaryCall<GetScheduleTablesFromDatabaseFilesRequest, GetScheduleTablesFromDatabaseFilesResponse>;
/**
* Gets all channels in the provided log file.
* @param request A request message with the log file to be parsed and a flag saying that if needed for converting (and thereby parsing), any KME50 file at the same path with the same name as the log file may be overwritten or not.
* @returns A response message with the channels parsed from the log file.
*/
getChannelsFromLogFile: handleUnaryCall<GetChannelsFromLogFileRequest, GetChannelsFromLogFileResponse>;
/**
* Gets all signal values for a message.
* @param request A request message with message name and message data.
* @returns A response message with all signal values.
*/
getSignalDataFromMessageData: handleUnaryCall<GetSignalDataFromMessageDataRequest, GetSignalDataFromMessageDataResponse>;