@blueyerobotics/protocol-definitions 3.2.0-d9b151ea → 3.2.0-db84868b

package/dist/control.d.ts

@@ -1,6 +1,6 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import { SetAquaTrollConnectionStatus, SetAquaTrollParameterUnit } from "./aquatroll";
-import { AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, ConnectionDuration, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, TurbidityFilter, WaterDensity, WeatherVaningState } from "./message_formats";
+import { AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, BoundingBox, CameraPanTiltZoom, ConnectionDuration, FilterMessage, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, OperatorInfo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, WaterDensity, WeatherVaningState } from "./message_formats";
 /**
  * Control
  *
@@ -200,6 +200,8 @@ export interface DeactivateMultibeamCtrl {
  * at which point the user entered the dive view.
  */
 export interface StartDiveCtrl {
+    /** Optional information about the operator who started the dive. */
+    operatorInfo: OperatorInfo | undefined;
 }
 /**
  * Message sent when the user hits the end dive button in the app.
@@ -220,9 +222,41 @@ export interface EndDiveCtrl {
 export interface FormatRemovableStorageDeviceCtrl {
 }
 /** Message sent when the user wants to set turbidity filter settings. */
-export interface SetTurbidityFilter {
+export interface SetTurbidityFilterCtrl {
     /** Message with the turbidity filter settings to set. */
-    turbidityFilter: TurbidityFilter | undefined;
+    turbidityFilter: FilterMessage | undefined;
+}
+/**
+ * Issue a command to set the digital pan, tilt, and zoom of the main camera.
+ *
+ * Only supported on X3 Ultra.
+ */
+export interface CameraPanTiltZoomCtrl {
+    /** The desired pan, tilt, and zoom state. */
+    cameraPanTiltZoom: CameraPanTiltZoom | undefined;
+}
+/** Message sent to start streaming log entries to the client. */
+export interface StartLogStreamingCtrl {
+}
+/** Message sent to stop streaming log entries to the client. */
+export interface StopLogStreamingCtrl {
+}
+/**
+ * Issue a command to set the single-object tracking (SOT) target.
+ *
+ * Send a bounding box to start tracking a new target. The CV pipeline will
+ * initialize the SOT tracker on the specified region of the video frame.
+ */
+export interface SetSotTargetCtrl {
+    /** Target bounding box. */
+    boundingBox: BoundingBox | undefined;
+    /** Width of the frame the bounding box was drawn on. */
+    imageWidth: number;
+    /** Height of the frame the bounding box was drawn on. */
+    imageHeight: number;
+}
+/** Issue a command to clear the single-object tracking (SOT) target (stop tracking). */
+export interface ClearSotTargetCtrl {
 }
 export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
 export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
@@ -267,7 +301,12 @@ export declare const DeactivateMultibeamCtrl: MessageFns<DeactivateMultibeamCtrl
 export declare const StartDiveCtrl: MessageFns<StartDiveCtrl>;
 export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
 export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
-export declare const SetTurbidityFilter: MessageFns<SetTurbidityFilter>;
+export declare const SetTurbidityFilterCtrl: MessageFns<SetTurbidityFilterCtrl>;
+export declare const CameraPanTiltZoomCtrl: MessageFns<CameraPanTiltZoomCtrl>;
+export declare const StartLogStreamingCtrl: MessageFns<StartLogStreamingCtrl>;
+export declare const StopLogStreamingCtrl: MessageFns<StopLogStreamingCtrl>;
+export declare const SetSotTargetCtrl: MessageFns<SetSotTargetCtrl>;
+export declare const ClearSotTargetCtrl: MessageFns<ClearSotTargetCtrl>;
 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]>;

package/dist/control.js

@@ -5,7 +5,7 @@
 //   protoc               v3.21.12
 // source: control.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SetTurbidityFilter = exports.FormatRemovableStorageDeviceCtrl = exports.EndDiveCtrl = exports.StartDiveCtrl = exports.DeactivateMultibeamCtrl = exports.ActivateMultibeamCtrl = exports.SetMultibeamConfigCtrl = exports.SetAquaTrollConnectionStatusCtrl = exports.SetAquaTrollParameterUnitCtrl = exports.RestartGuestPortsCtrl = exports.ActivateGuestPortsCtrl = exports.DeactivateGuestPortsCtrl = exports.MultibeamServoCtrl = exports.GenericServoCtrl = exports.GripperCtrl = exports.SystemTimeCtrl = exports.PingerConfigurationCtrl = exports.WaterDensityCtrl = exports.TiltStabilizationCtrl = exports.CalibrateDvlGyroCtrl = exports.ResetOdometerCtrl = exports.ResetPositionCtrl = exports.ClearMissionCtrl = exports.PauseMissionCtrl = exports.RunMissionCtrl = exports.AutoPilotHeaveCtrl = exports.AutoPilotSurgeYawCtrl = exports.WeatherVaningCtrl = exports.StationKeepingCtrl = exports.AutoAltitudeCtrl = exports.AutoDepthCtrl = exports.AutoHeadingCtrl = exports.FinishCalibrationCtrl = exports.CancelCalibrationCtrl = exports.StartCalibrationCtrl = exports.TakePictureCtrl = exports.RecordCtrl = exports.WatchdogCtrl = exports.PilotGPSPositionCtrl = exports.LaserCtrl = exports.GuestportLightsCtrl = exports.LightsCtrl = exports.TiltVelocityCtrl = exports.MotionInputCtrl = void 0;
+exports.ClearSotTargetCtrl = exports.SetSotTargetCtrl = exports.StopLogStreamingCtrl = exports.StartLogStreamingCtrl = exports.CameraPanTiltZoomCtrl = exports.SetTurbidityFilterCtrl = exports.FormatRemovableStorageDeviceCtrl = exports.EndDiveCtrl = exports.StartDiveCtrl = exports.DeactivateMultibeamCtrl = exports.ActivateMultibeamCtrl = exports.SetMultibeamConfigCtrl = exports.SetAquaTrollConnectionStatusCtrl = exports.SetAquaTrollParameterUnitCtrl = exports.RestartGuestPortsCtrl = exports.ActivateGuestPortsCtrl = exports.DeactivateGuestPortsCtrl = exports.MultibeamServoCtrl = exports.GenericServoCtrl = exports.GripperCtrl = exports.SystemTimeCtrl = exports.PingerConfigurationCtrl = exports.WaterDensityCtrl = exports.TiltStabilizationCtrl = exports.CalibrateDvlGyroCtrl = exports.ResetOdometerCtrl = exports.ResetPositionCtrl = exports.ClearMissionCtrl = exports.PauseMissionCtrl = exports.RunMissionCtrl = exports.AutoPilotHeaveCtrl = exports.AutoPilotSurgeYawCtrl = exports.WeatherVaningCtrl = exports.StationKeepingCtrl = exports.AutoAltitudeCtrl = exports.AutoDepthCtrl = exports.AutoHeadingCtrl = exports.FinishCalibrationCtrl = exports.CancelCalibrationCtrl = exports.StartCalibrationCtrl = exports.TakePictureCtrl = exports.RecordCtrl = exports.WatchdogCtrl = exports.PilotGPSPositionCtrl = exports.LaserCtrl = exports.GuestportLightsCtrl = exports.LightsCtrl = exports.TiltVelocityCtrl = exports.MotionInputCtrl = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const aquatroll_1 = require("./aquatroll");
@@ -1999,10 +1999,13 @@ exports.DeactivateMultibeamCtrl = {
     },
 };
 function createBaseStartDiveCtrl() {
-    return {};
+    return { operatorInfo: undefined };
 }
 exports.StartDiveCtrl = {
-    encode(_, writer = new wire_1.BinaryWriter()) {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.operatorInfo !== undefined) {
+            message_formats_1.OperatorInfo.encode(message.operatorInfo, writer.uint32(10).fork()).join();
+        }
         return writer;
     },
     decode(input, length) {
@@ -2012,6 +2015,13 @@ exports.StartDiveCtrl = {
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.operatorInfo = message_formats_1.OperatorInfo.decode(reader, reader.uint32());
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -2020,18 +2030,24 @@ exports.StartDiveCtrl = {
         }
         return message;
     },
-    fromJSON(_) {
-        return {};
+    fromJSON(object) {
+        return { operatorInfo: isSet(object.operatorInfo) ? message_formats_1.OperatorInfo.fromJSON(object.operatorInfo) : undefined };
     },
-    toJSON(_) {
+    toJSON(message) {
         const obj = {};
+        if (message.operatorInfo !== undefined) {
+            obj.operatorInfo = message_formats_1.OperatorInfo.toJSON(message.operatorInfo);
+        }
         return obj;
     },
     create(base) {
         return exports.StartDiveCtrl.fromPartial(base ?? {});
     },
-    fromPartial(_) {
+    fromPartial(object) {
         const message = createBaseStartDiveCtrl();
+        message.operatorInfo = (object.operatorInfo !== undefined && object.operatorInfo !== null)
+            ? message_formats_1.OperatorInfo.fromPartial(object.operatorInfo)
+            : undefined;
         return message;
     },
 };
@@ -2109,20 +2125,20 @@ exports.FormatRemovableStorageDeviceCtrl = {
         return message;
     },
 };
-function createBaseSetTurbidityFilter() {
+function createBaseSetTurbidityFilterCtrl() {
     return { turbidityFilter: undefined };
 }
-exports.SetTurbidityFilter = {
+exports.SetTurbidityFilterCtrl = {
     encode(message, writer = new wire_1.BinaryWriter()) {
         if (message.turbidityFilter !== undefined) {
-            message_formats_1.TurbidityFilter.encode(message.turbidityFilter, writer.uint32(10).fork()).join();
+            message_formats_1.FilterMessage.encode(message.turbidityFilter, writer.uint32(10).fork()).join();
         }
         return writer;
     },
     decode(input, length) {
         const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
         const end = length === undefined ? reader.len : reader.pos + length;
-        const message = createBaseSetTurbidityFilter();
+        const message = createBaseSetTurbidityFilterCtrl();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
@@ -2130,7 +2146,7 @@ exports.SetTurbidityFilter = {
                     if (tag !== 10) {
                         break;
                     }
-                    message.turbidityFilter = message_formats_1.TurbidityFilter.decode(reader, reader.uint32());
+                    message.turbidityFilter = message_formats_1.FilterMessage.decode(reader, reader.uint32());
                     continue;
                 }
             }
@@ -2143,24 +2159,277 @@ exports.SetTurbidityFilter = {
     },
     fromJSON(object) {
         return {
-            turbidityFilter: isSet(object.turbidityFilter) ? message_formats_1.TurbidityFilter.fromJSON(object.turbidityFilter) : undefined,
+            turbidityFilter: isSet(object.turbidityFilter) ? message_formats_1.FilterMessage.fromJSON(object.turbidityFilter) : undefined,
         };
     },
     toJSON(message) {
         const obj = {};
         if (message.turbidityFilter !== undefined) {
-            obj.turbidityFilter = message_formats_1.TurbidityFilter.toJSON(message.turbidityFilter);
+            obj.turbidityFilter = message_formats_1.FilterMessage.toJSON(message.turbidityFilter);
         }
         return obj;
     },
     create(base) {
-        return exports.SetTurbidityFilter.fromPartial(base ?? {});
+        return exports.SetTurbidityFilterCtrl.fromPartial(base ?? {});
     },
     fromPartial(object) {
-        const message = createBaseSetTurbidityFilter();
+        const message = createBaseSetTurbidityFilterCtrl();
         message.turbidityFilter = (object.turbidityFilter !== undefined && object.turbidityFilter !== null)
-            ? message_formats_1.TurbidityFilter.fromPartial(object.turbidityFilter)
+            ? message_formats_1.FilterMessage.fromPartial(object.turbidityFilter)
+            : undefined;
+        return message;
+    },
+};
+function createBaseCameraPanTiltZoomCtrl() {
+    return { cameraPanTiltZoom: undefined };
+}
+exports.CameraPanTiltZoomCtrl = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.cameraPanTiltZoom !== undefined) {
+            message_formats_1.CameraPanTiltZoom.encode(message.cameraPanTiltZoom, writer.uint32(10).fork()).join();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseCameraPanTiltZoomCtrl();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.cameraPanTiltZoom = message_formats_1.CameraPanTiltZoom.decode(reader, reader.uint32());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            cameraPanTiltZoom: isSet(object.cameraPanTiltZoom)
+                ? message_formats_1.CameraPanTiltZoom.fromJSON(object.cameraPanTiltZoom)
+                : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.cameraPanTiltZoom !== undefined) {
+            obj.cameraPanTiltZoom = message_formats_1.CameraPanTiltZoom.toJSON(message.cameraPanTiltZoom);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.CameraPanTiltZoomCtrl.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseCameraPanTiltZoomCtrl();
+        message.cameraPanTiltZoom = (object.cameraPanTiltZoom !== undefined && object.cameraPanTiltZoom !== null)
+            ? message_formats_1.CameraPanTiltZoom.fromPartial(object.cameraPanTiltZoom)
+            : undefined;
+        return message;
+    },
+};
+function createBaseStartLogStreamingCtrl() {
+    return {};
+}
+exports.StartLogStreamingCtrl = {
+    encode(_, writer = new wire_1.BinaryWriter()) {
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseStartLogStreamingCtrl();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(_) {
+        return {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.StartLogStreamingCtrl.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseStartLogStreamingCtrl();
+        return message;
+    },
+};
+function createBaseStopLogStreamingCtrl() {
+    return {};
+}
+exports.StopLogStreamingCtrl = {
+    encode(_, writer = new wire_1.BinaryWriter()) {
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseStopLogStreamingCtrl();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(_) {
+        return {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.StopLogStreamingCtrl.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseStopLogStreamingCtrl();
+        return message;
+    },
+};
+function createBaseSetSotTargetCtrl() {
+    return { boundingBox: undefined, imageWidth: 0, imageHeight: 0 };
+}
+exports.SetSotTargetCtrl = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.boundingBox !== undefined) {
+            message_formats_1.BoundingBox.encode(message.boundingBox, writer.uint32(10).fork()).join();
+        }
+        if (message.imageWidth !== 0) {
+            writer.uint32(16).uint32(message.imageWidth);
+        }
+        if (message.imageHeight !== 0) {
+            writer.uint32(24).uint32(message.imageHeight);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseSetSotTargetCtrl();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.boundingBox = message_formats_1.BoundingBox.decode(reader, reader.uint32());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.imageWidth = reader.uint32();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.imageHeight = reader.uint32();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            boundingBox: isSet(object.boundingBox) ? message_formats_1.BoundingBox.fromJSON(object.boundingBox) : undefined,
+            imageWidth: isSet(object.imageWidth) ? gt.Number(object.imageWidth) : 0,
+            imageHeight: isSet(object.imageHeight) ? gt.Number(object.imageHeight) : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.boundingBox !== undefined) {
+            obj.boundingBox = message_formats_1.BoundingBox.toJSON(message.boundingBox);
+        }
+        if (message.imageWidth !== 0) {
+            obj.imageWidth = Math.round(message.imageWidth);
+        }
+        if (message.imageHeight !== 0) {
+            obj.imageHeight = Math.round(message.imageHeight);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.SetSotTargetCtrl.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSetSotTargetCtrl();
+        message.boundingBox = (object.boundingBox !== undefined && object.boundingBox !== null)
+            ? message_formats_1.BoundingBox.fromPartial(object.boundingBox)
             : undefined;
+        message.imageWidth = object.imageWidth ?? 0;
+        message.imageHeight = object.imageHeight ?? 0;
+        return message;
+    },
+};
+function createBaseClearSotTargetCtrl() {
+    return {};
+}
+exports.ClearSotTargetCtrl = {
+    encode(_, writer = new wire_1.BinaryWriter()) {
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseClearSotTargetCtrl();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(_) {
+        return {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.ClearSotTargetCtrl.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseClearSotTargetCtrl();
         return message;
     },
 };