@blueyerobotics/protocol-definitions 3.2.0-09fee2ba

package/dist/req_rep.d.ts

@@ -0,0 +1,284 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { Any } from "./google/protobuf/any";
+import { Battery, Camera, CameraParameters, ClientInfo, ConnectedClient, HeadingMode, OverlayParameters, PersistentStorageSettings, SystemTime } from "./message_formats";
+import { Instruction, Mission } from "./mission_planning";
+/**
+ * Request reply
+ *
+ * These messages define request / reply messages for the Blueye drone.
+ */
+/** Request to set video overlay parameters. */
+export interface SetOverlayParametersReq {
+    /** The video overlay parameters to apply. */
+    overlayParameters: OverlayParameters | undefined;
+}
+/** Response after setting video overlay parameters. */
+export interface SetOverlayParametersRep {
+}
+/** Request to get currently set video overlay parameters. */
+export interface GetOverlayParametersReq {
+}
+/** Response with the currently set video overlay parameters. */
+export interface GetOverlayParametersRep {
+    /** The currently set overlay parameters. */
+    overlayParameters: OverlayParameters | undefined;
+}
+/** Request to set camera parameters. */
+export interface SetCameraParametersReq {
+    /** The camera parameters to apply. */
+    cameraParameters: CameraParameters | undefined;
+}
+/** Response after setting the camera parameters. */
+export interface SetCameraParametersRep {
+}
+/** Request to get the currently set camera parameters. */
+export interface GetCameraParametersReq {
+    /** Which camera to read camera parameters from. */
+    camera: Camera;
+}
+/** Response with the currently set camera parameters. */
+export interface GetCameraParametersRep {
+    /** The currently set camera parameters. */
+    cameraParameters: CameraParameters | undefined;
+}
+/** Request to set the system time on the drone. */
+export interface SyncTimeReq {
+    /** The time to set on the drone. */
+    time: SystemTime | undefined;
+}
+/** Response after setting the system time on the drone. */
+export interface SyncTimeRep {
+    /** If the time was set successfully. */
+    success: boolean;
+}
+/**
+ * The simplest message to use to test request/reply communication with the drone.
+ *
+ * The drone replies with a PingRep message immediately after receiving the PingReq.
+ */
+export interface PingReq {
+}
+/** Response message from a PingReq request. */
+export interface PingRep {
+}
+/**
+ * Request to set parameters for ultrasonic thickness gauge.
+ *
+ * The sound velocity is used to calculate the thickness of the material being measured.
+ */
+export interface SetThicknessGaugeParametersReq {
+    /** Sound velocity in m/s */
+    soundVelocity: number;
+}
+/** Response after setting thickness gauge parameters. */
+export interface SetThicknessGaugeParametersRep {
+}
+/** Connect a new client to the drone. */
+export interface ConnectClientReq {
+    /** Information about the client connecting to the drone. */
+    clientInfo: ClientInfo | undefined;
+}
+/**
+ * Response after connecting a client to the drone.
+ *
+ * Contains information about which client is in control, and a list of
+ * all connected clients.
+ */
+export interface ConnectClientRep {
+    /** The assigned ID of this client. */
+    clientId: number;
+    /** The ID of the client in control of the drone. */
+    clientIdInControl: number;
+    /** List of connected clients. */
+    connectedClients: ConnectedClient[];
+}
+/**
+ * Disconnect a client from the drone.
+ *
+ * This request will remove the client from the list of connected clients.
+ * It allows clients to disconnect instantly, without waiting for a watchdog to
+ * clear the client in control, or promote a new client to be in control.
+ */
+export interface DisconnectClientReq {
+    /** The assigned ID of the client to disconnect. */
+    clientId: number;
+}
+/**
+ * Response after disconnecting a client from the drone.
+ *
+ * Contains information about which clients are connected and in control.
+ */
+export interface DisconnectClientRep {
+    /** The ID of the client in control of the drone. */
+    clientIdInControl: number;
+    /** List of connected clients. */
+    connectedClients: ConnectedClient[];
+}
+/**
+ * Request essential battery information.
+ *
+ * Can be used to instantly get battery information,
+ * instead of having to wait for the BatteryTel message to be received.
+ */
+export interface GetBatteryReq {
+}
+/** Response with essential battery information. */
+export interface GetBatteryRep {
+    /** Essential battery information. */
+    battery: Battery | undefined;
+}
+/** Issue a desired mission to the reference_generator. */
+export interface SetMissionReq {
+    /** Requested mission issued to the reference generator. */
+    mission: Mission | undefined;
+}
+/** Response after setting a new mission. */
+export interface SetMissionRep {
+}
+/** Service request to the reference_generator to get the active mission. */
+export interface GetMissionReq {
+}
+/** Get active mission response. */
+export interface GetMissionRep {
+    /** Active mission with waypoints. */
+    mission: Mission | undefined;
+}
+/** Updates an instruction in current mission with a new instruction payload. */
+export interface SetInstructionUpdateReq {
+    /** instruction that will replace the desired instruction. */
+    instruction: Instruction | undefined;
+}
+/** Response after updating an instruction in the current mission. */
+export interface SetInstructionUpdateRep {
+}
+/** Set the heading mode used in dead reckoning. */
+export interface SetHeadingModeReq {
+    /** The heading mode to set. */
+    headingMode: HeadingMode;
+}
+/** Response after setting the heading mode. */
+export interface SetHeadingModeRep {
+}
+/** Request to update the publish frequency */
+export interface SetPubFrequencyReq {
+    /** Message name, f. ex. "AttitudeTel" */
+    messageType: string;
+    /** Publish frequency (max 100 Hz). */
+    frequency: number;
+}
+/** Response after updating publish frequency */
+export interface SetPubFrequencyRep {
+    /** True if message name valid and frequency successfully updated. */
+    success: boolean;
+}
+/** Request to get latest telemetry data */
+export interface GetTelemetryReq {
+    /** Message name, f. ex. "AttitudeTel". */
+    messageType: string;
+}
+/** Response with latest telemetry */
+export interface GetTelemetryRep {
+    /** The latest telemetry data, empty if no data available. */
+    payload: Any | undefined;
+}
+/** Request to set persistent storage settings. */
+export interface SetPersistentStorageSettingsReq {
+    /** The persistent storage settings to apply. */
+    persistentStorageSettings: PersistentStorageSettings | undefined;
+}
+/** Response after setting persistent storage settings. */
+export interface SetPersistentStorageSettingsRep {
+    /** If the persistent storage settings were set successfully. */
+    success: boolean;
+}
+/** Request to get currently set persistent storage settings. */
+export interface GetPersistentStorageSettingsReq {
+}
+/** Response with the currently set persistent storage settings. */
+export interface GetPersistentStorageSettingsRep {
+    /** The currently set persistent storage settings. */
+    persistentStorageSettings: PersistentStorageSettings | undefined;
+}
+/** Request to flash ESC settings. */
+export interface FlashEscSettingsReq {
+    /** If startup sounds should be disabled. */
+    silent: boolean;
+}
+/** Response after flashing ESC settings. */
+export interface FlashEscSettingsRep {
+    /** If the ESC settings were flashed successfully. */
+    success: boolean;
+}
+/** Request to set iperf task status. */
+export interface SetIperfStatusReq {
+    /** If background iperf task should be enabled or disabled. */
+    enabled: boolean;
+}
+/** Response after setting iperf status. */
+export interface SetIperfStatusRep {
+    /** If background iperf task is enabled or disabled. */
+    enabled: boolean;
+}
+/** Request to get current iperf task status. */
+export interface GetIperfStatusReq {
+}
+/** Response with current iperf status. */
+export interface GetIperfStatusRep {
+    /** If background iperf task is enabled or disabled. */
+    enabled: boolean;
+}
+export declare const SetOverlayParametersReq: MessageFns<SetOverlayParametersReq>;
+export declare const SetOverlayParametersRep: MessageFns<SetOverlayParametersRep>;
+export declare const GetOverlayParametersReq: MessageFns<GetOverlayParametersReq>;
+export declare const GetOverlayParametersRep: MessageFns<GetOverlayParametersRep>;
+export declare const SetCameraParametersReq: MessageFns<SetCameraParametersReq>;
+export declare const SetCameraParametersRep: MessageFns<SetCameraParametersRep>;
+export declare const GetCameraParametersReq: MessageFns<GetCameraParametersReq>;
+export declare const GetCameraParametersRep: MessageFns<GetCameraParametersRep>;
+export declare const SyncTimeReq: MessageFns<SyncTimeReq>;
+export declare const SyncTimeRep: MessageFns<SyncTimeRep>;
+export declare const PingReq: MessageFns<PingReq>;
+export declare const PingRep: MessageFns<PingRep>;
+export declare const SetThicknessGaugeParametersReq: MessageFns<SetThicknessGaugeParametersReq>;
+export declare const SetThicknessGaugeParametersRep: MessageFns<SetThicknessGaugeParametersRep>;
+export declare const ConnectClientReq: MessageFns<ConnectClientReq>;
+export declare const ConnectClientRep: MessageFns<ConnectClientRep>;
+export declare const DisconnectClientReq: MessageFns<DisconnectClientReq>;
+export declare const DisconnectClientRep: MessageFns<DisconnectClientRep>;
+export declare const GetBatteryReq: MessageFns<GetBatteryReq>;
+export declare const GetBatteryRep: MessageFns<GetBatteryRep>;
+export declare const SetMissionReq: MessageFns<SetMissionReq>;
+export declare const SetMissionRep: MessageFns<SetMissionRep>;
+export declare const GetMissionReq: MessageFns<GetMissionReq>;
+export declare const GetMissionRep: MessageFns<GetMissionRep>;
+export declare const SetInstructionUpdateReq: MessageFns<SetInstructionUpdateReq>;
+export declare const SetInstructionUpdateRep: MessageFns<SetInstructionUpdateRep>;
+export declare const SetHeadingModeReq: MessageFns<SetHeadingModeReq>;
+export declare const SetHeadingModeRep: MessageFns<SetHeadingModeRep>;
+export declare const SetPubFrequencyReq: MessageFns<SetPubFrequencyReq>;
+export declare const SetPubFrequencyRep: MessageFns<SetPubFrequencyRep>;
+export declare const GetTelemetryReq: MessageFns<GetTelemetryReq>;
+export declare const GetTelemetryRep: MessageFns<GetTelemetryRep>;
+export declare const SetPersistentStorageSettingsReq: MessageFns<SetPersistentStorageSettingsReq>;
+export declare const SetPersistentStorageSettingsRep: MessageFns<SetPersistentStorageSettingsRep>;
+export declare const GetPersistentStorageSettingsReq: MessageFns<GetPersistentStorageSettingsReq>;
+export declare const GetPersistentStorageSettingsRep: MessageFns<GetPersistentStorageSettingsRep>;
+export declare const FlashEscSettingsReq: MessageFns<FlashEscSettingsReq>;
+export declare const FlashEscSettingsRep: MessageFns<FlashEscSettingsRep>;
+export declare const SetIperfStatusReq: MessageFns<SetIperfStatusReq>;
+export declare const SetIperfStatusRep: MessageFns<SetIperfStatusRep>;
+export declare const GetIperfStatusReq: MessageFns<GetIperfStatusReq>;
+export declare const GetIperfStatusRep: MessageFns<GetIperfStatusRep>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+type DeepPartial<T> = T extends Builtin ? T : 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]>;
+} : Partial<T>;
+interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
+}
+export {};