@blueyerobotics/protocol-definitions 3.2.0-45dcae42 → 3.2.0-4aec8fd7

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, WaterDensity, WeatherVaningState } from "./message_formats";
+import { AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, CameraPanTiltZoom, ConnectionDuration, FilterMessage, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, WaterDensity, WeatherVaningState } from "./message_formats";
 /**
  * Control
  *
@@ -219,6 +219,20 @@ export interface EndDiveCtrl {
  */
 export interface FormatRemovableStorageDeviceCtrl {
 }
+/** Message sent when the user wants to set turbidity filter settings. */
+export interface SetTurbidityFilterCtrl {
+    /** Message with the turbidity filter settings to set. */
+    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;
+}
 export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
 export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
 export declare const LightsCtrl: MessageFns<LightsCtrl>;
@@ -262,6 +276,8 @@ 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 SetTurbidityFilterCtrl: MessageFns<SetTurbidityFilterCtrl>;
+export declare const CameraPanTiltZoomCtrl: MessageFns<CameraPanTiltZoomCtrl>;
 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.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.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");
@@ -2109,6 +2109,118 @@ exports.FormatRemovableStorageDeviceCtrl = {
         return message;
     },
 };
+function createBaseSetTurbidityFilterCtrl() {
+    return { turbidityFilter: undefined };
+}
+exports.SetTurbidityFilterCtrl = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.turbidityFilter !== undefined) {
+            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 = createBaseSetTurbidityFilterCtrl();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.turbidityFilter = message_formats_1.FilterMessage.decode(reader, reader.uint32());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            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.FilterMessage.toJSON(message.turbidityFilter);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.SetTurbidityFilterCtrl.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSetTurbidityFilterCtrl();
+        message.turbidityFilter = (object.turbidityFilter !== undefined && object.turbidityFilter !== null)
+            ? 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;
+    },
+};
 const gt = (() => {
     if (typeof globalThis !== "undefined") {
         return globalThis;

package/dist/message_formats.d.ts

@@ -184,6 +184,8 @@ export declare enum Model {
     MODEL_X3 = 3,
     /** MODEL_X3_ULTRA - Blueye X3 Ultra. */
     MODEL_X3_ULTRA = 6,
+    /** MODEL_X7 - Blueye X7. */
+    MODEL_X7 = 7,
     /** MODEL_NEXT - Blueye ? */
     MODEL_NEXT = 5,
     UNRECOGNIZED = -1
@@ -218,11 +220,18 @@ export declare enum Resolution {
     RESOLUTION_FULLHD_1080P = 1,
     /** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
     RESOLUTION_UHD_4K = 3,
+    /** RESOLUTION_QHD_2K - 2K QHD (2560x1440, Only supported on X3 Ultra). */
+    RESOLUTION_QHD_2K = 5,
     UNRECOGNIZED = -1
 }
 export declare function resolutionFromJSON(object: any): Resolution;
 export declare function resolutionToJSON(object: Resolution): string;
-/** Available camera frame rates. */
+/**
+ * Available camera frame rates.
+ *
+ * If the requested frame rate is higher than what is supported at the current resolution,
+ * the frame rate will be reduced while the resolution is respected.
+ */
 export declare enum Framerate {
     /** FRAMERATE_UNSPECIFIED - Framerate not specified. */
     FRAMERATE_UNSPECIFIED = 0,
@@ -230,6 +239,8 @@ export declare enum Framerate {
     FRAMERATE_FPS_30 = 1,
     /** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
     FRAMERATE_FPS_25 = 2,
+    /** FRAMERATE_FPS_60 - 60 frames per second. (Only supported on X3 Ultra at QHD, 1080p and 720p) */
+    FRAMERATE_FPS_60 = 3,
     UNRECOGNIZED = -1
 }
 export declare function framerateFromJSON(object: any): Framerate;
@@ -419,8 +430,12 @@ export declare enum GuestPortDeviceID {
     GUEST_PORT_DEVICE_ID_WATERLINKED_SONAR_3D15 = 43,
     /** GUEST_PORT_DEVICE_ID_CERULEAN_TRACKER_650 - Cerulean Tracker 650. */
     GUEST_PORT_DEVICE_ID_CERULEAN_TRACKER_650 = 44,
-    /** GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE - Blueye External USB Storage */
+    /** GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE - Blueye External USB Storage. */
     GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE = 45,
+    /** GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 - Blueye Multibeam Skid Servo V2. */
+    GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 = 46,
+    /** GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT - Cerulean Omniscan 450 Compact. */
+    GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT = 47,
     UNRECOGNIZED = -1
 }
 export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
@@ -774,8 +789,12 @@ export interface RecordState {
     multibeamSeconds: number;
     /** Multibeam record fps. */
     multibeamFps: number;
-    /** Storage location used for recording. */
-    storageLocation: StorageLocation;
+    /** Storage location used for main camera recording. */
+    mainStorageLocation: StorageLocation;
+    /** Storage location used for guestport camera recording. */
+    guestportStorageLocation: StorageLocation;
+    /** Storage location used for multibeam recording. */
+    multibeamStorageLocation: StorageLocation;
 }
 /** Time-lapse state published if time-lapse mission is running. */
 export interface TimeLapseState {
@@ -1269,6 +1288,8 @@ export interface StoragePartition {
     devicePath: string;
     /** Mount path of the partition. */
     mountPath: string;
+    /** Label of the partition. */
+    label: string;
 }
 /** Removable storage device. */
 export interface RemovableStorageDevice {
@@ -1291,10 +1312,12 @@ export declare enum RemovableStorageDevice_Status {
     STATUS_UNSPECIFIED = 0,
     /** STATUS_READY - The storage device is valid and ready for use. */
     STATUS_READY = 1,
-    /** STATUS_FORMATTING - The storage device is being formatted */
+    /** STATUS_FORMATTING - The storage device is being formatted. */
     STATUS_FORMATTING = 2,
     /** STATUS_ERROR - The storage device is in an error state. */
     STATUS_ERROR = 3,
+    /** STATUS_UNPLUGGED - The storage device is not present. */
+    STATUS_UNPLUGGED = 4,
     UNRECOGNIZED = -1
 }
 export declare function removableStorageDevice_StatusFromJSON(object: any): RemovableStorageDevice_Status;
@@ -1561,6 +1584,12 @@ export interface CameraParameters {
     framerate: Framerate;
     /** Which camera the parameters belong to. */
     camera: Camera;
+    /**
+     * Network MTU (Maximum Transmission Unit) size for video streaming in bytes (68..65535).
+     * If 0 or unset, the system will use a default of 1400.
+     * The Blueye App allows users to set values between 500 and 1460.
+     */
+    mtuSize: number;
 }
 /**
  * Overlay parameters.
@@ -1786,8 +1815,7 @@ export interface MultibeamPing {
     /** Size in bytes of each row in the ping data image. */
     step: number;
     /**
-     * Bearing angle of each column of the sonar data
-     * (in 100th of a degree, multiply by 0.01 to get a value in degrees).
+     * Bearing angle of each column of the sonar data in degrees.
      * The sonar image is not sampled uniformly in the bearing direction.
      */
     bearings: number[];
@@ -1974,6 +2002,26 @@ export interface SurfaceUnitVersionInfo {
     /** Surface Unit firmware version (x.y.z). */
     version: string;
 }
+/** Generic filter settings. */
+export interface FilterMessage {
+    /** If the filter is enabled. */
+    enabled: boolean;
+    /** Intensity of the filter (0..1). */
+    intensity: number;
+}
+/**
+ * Digital pan, tilt, and zoom state for the main camera.
+ *
+ * Only supported on X3 Ultra. Controls digital (not mechanical) zoom.
+ */
+export interface CameraPanTiltZoom {
+    /** Horizontal pan (-1.0..1.0), where 0.0 is center. */
+    pan: number;
+    /** Vertical tilt (-1.0..1.0), where 0.0 is center. */
+    tilt: number;
+    /** Zoom level (0.0..1.0), where 0.0 is no zoom and 1.0 is maximum zoom. */
+    zoom: number;
+}
 export declare const BinlogRecord: MessageFns<BinlogRecord>;
 export declare const LogEntry: MessageFns<LogEntry>;
 export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
@@ -2065,6 +2113,8 @@ export declare const PersistentStorageSettings: MessageFns<PersistentStorageSett
 export declare const CPUInfo: MessageFns<CPUInfo>;
 export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
 export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
+export declare const FilterMessage: MessageFns<FilterMessage>;
+export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
 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]>;