@blueyerobotics/protocol-definitions 3.2.0-56e1f510 → 3.2.0-6025f25a

package/dist/message_formats.d.ts

@@ -154,6 +154,22 @@ export declare enum NotificationLevel {
 }
 export declare function notificationLevelFromJSON(object: any): NotificationLevel;
 export declare function notificationLevelToJSON(object: NotificationLevel): string;
+/**
+ * Storage location.
+ *
+ * Used to specify which storage location to use for recording photos and videos.
+ */
+export declare enum StorageLocation {
+    /** STORAGE_LOCATION_UNSPECIFIED - Unspecified. */
+    STORAGE_LOCATION_UNSPECIFIED = 0,
+    /** STORAGE_LOCATION_INTERNAL - Internal storage of the drone. */
+    STORAGE_LOCATION_INTERNAL = 1,
+    /** STORAGE_LOCATION_REMOVABLE - Removable storage device. */
+    STORAGE_LOCATION_REMOVABLE = 2,
+    UNRECOGNIZED = -1
+}
+export declare function storageLocationFromJSON(object: any): StorageLocation;
+export declare function storageLocationToJSON(object: StorageLocation): string;
 /** Drone models produced by Blueye. */
 export declare enum Model {
     /** MODEL_UNSPECIFIED - ModelName not specified. */
@@ -194,11 +210,13 @@ export declare function pressureSensorTypeToJSON(object: PressureSensorType): st
 export declare enum Resolution {
     /** RESOLUTION_UNSPECIFIED - Resolution not specified. */
     RESOLUTION_UNSPECIFIED = 0,
-    /** RESOLUTION_FULLHD_1080P - 1080p Full HD resolution. */
-    RESOLUTION_FULLHD_1080P = 1,
-    /** RESOLUTION_HD_720P - 720p HD resolution. */
+    /** RESOLUTION_VGA_480P - VGA (640x480). */
+    RESOLUTION_VGA_480P = 4,
+    /** RESOLUTION_HD_720P - 720p HD (1280x720). */
     RESOLUTION_HD_720P = 2,
-    /** RESOLUTION_UHD_4K - 4K Ultra HD resolution. */
+    /** RESOLUTION_FULLHD_1080P - 1080p Full HD (1920x1080). */
+    RESOLUTION_FULLHD_1080P = 1,
+    /** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
     RESOLUTION_UHD_4K = 3,
     UNRECOGNIZED = -1
 }
@@ -210,7 +228,7 @@ export declare enum Framerate {
     FRAMERATE_UNSPECIFIED = 0,
     /** FRAMERATE_FPS_30 - 30 frames per second. */
     FRAMERATE_FPS_30 = 1,
-    /** FRAMERATE_FPS_25 - 25 frames per second. */
+    /** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
     FRAMERATE_FPS_25 = 2,
     UNRECOGNIZED = -1
 }
@@ -228,6 +246,17 @@ export declare enum Camera {
 }
 export declare function cameraFromJSON(object: any): Camera;
 export declare function cameraToJSON(object: Camera): string;
+export declare enum StreamingProtocol {
+    /** STREAMING_PROTOCOL_UNSPECIFIED - Streaming protocol not specified. */
+    STREAMING_PROTOCOL_UNSPECIFIED = 0,
+    /** STREAMING_PROTOCOL_RTSP_H264 - RTSP streaming protocol using H264 codec. */
+    STREAMING_PROTOCOL_RTSP_H264 = 1,
+    /** STREAMING_PROTOCOL_RTSP_MJPEG - RTSP streaming protocol using MJPEG codec. No recording when activated. */
+    STREAMING_PROTOCOL_RTSP_MJPEG = 2,
+    UNRECOGNIZED = -1
+}
+export declare function streamingProtocolFromJSON(object: any): StreamingProtocol;
+export declare function streamingProtocolToJSON(object: StreamingProtocol): string;
 /** Available temperature units. */
 export declare enum TemperatureUnit {
     /** TEMPERATURE_UNIT_UNSPECIFIED - Temperature unit not specified. */
@@ -390,6 +419,8 @@ 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 = 45,
     UNRECOGNIZED = -1
 }
 export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
@@ -700,6 +731,8 @@ export interface RecordState {
     multibeamSeconds: number;
     /** Multibeam record fps. */
     multibeamFps: number;
+    /** Storage location used for recording. */
+    storageLocation: StorageLocation;
 }
 /** Time-lapse state published if time-lapse mission is running. */
 export interface TimeLapseState {
@@ -1167,7 +1200,7 @@ export interface DiveTime {
     /** Number of seconds the drone has been submerged. */
     value: number;
 }
-/** Which cameras are supposed to be recording. */
+/** Which cameras or multibeam are supposed to be recording. */
 export interface RecordOn {
     /** Record the main camera. */
     main: boolean;
@@ -1183,6 +1216,61 @@ export interface StorageSpace {
     /** Available bytes of storage space (B). */
     freeSpace: number;
 }
+/** Storage partition. */
+export interface StoragePartition {
+    /** The amount of storage space on the device. */
+    storageSpace: StorageSpace | undefined;
+    /** File system type of the removable storage device. */
+    fileSystemType: string;
+    /** Partition device path */
+    devicePath: string;
+    /** Mount path of the partition. */
+    mountPath: string;
+}
+/** Removable storage device. */
+export interface RemovableStorageDevice {
+    /** USB vendor name. */
+    vendorName: string;
+    /** Model name of the USB storage device. */
+    modelName: string;
+    /** Mount path of the storage device. */
+    devicePath: string;
+    /** Status of the storage device. */
+    status: RemovableStorageDevice_Status;
+    /** Any active error flags for the storage device. */
+    errorFlags: RemovableStorageErrorFlags | undefined;
+    /** List of partitions on the storage device. */
+    partitions: StoragePartition[];
+}
+/** Overall status of the storage device. */
+export declare enum RemovableStorageDevice_Status {
+    /** STATUS_UNSPECIFIED - Unspecified. */
+    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 = 2,
+    /** STATUS_ERROR - The storage device is in an error state. */
+    STATUS_ERROR = 3,
+    UNRECOGNIZED = -1
+}
+export declare function removableStorageDevice_StatusFromJSON(object: any): RemovableStorageDevice_Status;
+export declare function removableStorageDevice_StatusToJSON(object: RemovableStorageDevice_Status): string;
+/** Error flags related to a removable storage device. */
+export interface RemovableStorageErrorFlags {
+    /** Optional error message to give additional information from the drone to a client about active error flags. */
+    errorMessage: string;
+    /** Device is attached but no partitions are found. */
+    noPartitionsFound: boolean;
+    /** Multiple partitions are found. */
+    multiplePartitionsFound: boolean;
+    /** The wrong file system is found. */
+    wrongFileSystemFound: boolean;
+    /** The device is in read-only mode. */
+    deviceIsReadOnly: boolean;
+    /** Formatting of the device failed. */
+    formattingFailed: boolean;
+}
 /** Compass calibration state. */
 export interface CalibrationState {
     /** Current calibration status. */
@@ -1205,7 +1293,7 @@ export interface CalibrationState {
 /**
  * Status of the compass calibration procedure.
  *
- * When calibration is started, the status will indicate the active (upfacing) axis.
+ * When calibration is started, the status will indicate the active (up facing) axis.
  */
 export declare enum CalibrationState_Status {
     /** STATUS_UNSPECIFIED - Unspecified status. */
@@ -1226,7 +1314,7 @@ export declare enum CalibrationState_Status {
     STATUS_CALIBRATING_Z_POSITIVE = 7,
     /** STATUS_CALIBRATING_Z_NEGATIVE - Compass is calibrating and the negative Z axis is active. */
     STATUS_CALIBRATING_Z_NEGATIVE = 8,
-    /** STATUS_CALIBRATING_THRUSTER - Compass is calibrating for thruster interferance. */
+    /** STATUS_CALIBRATING_THRUSTER - Compass is calibrating for thruster interference. */
     STATUS_CALIBRATING_THRUSTER = 9,
     UNRECOGNIZED = -1
 }
@@ -1392,18 +1480,40 @@ export interface CameraParameters {
     mjpgBitrate: number;
     /** Shutter speed  (1/10000 * s), -1 for automatic exposure. */
     exposure: number;
-    /** White balance temperature (2800..9300), -1 for automatic white balance. */
+    /** White balance temp (Pioneer/Pro/X1/X3: 2800..9300, Ultra: 2300..15000), -1 for auto. */
     whiteBalance: number;
-    /** Hue (-40..40), 0 as default. */
+    /** Hue (-40..40), 0 as default. Only available on Pioneer/Pro/X1/X3. */
     hue: number;
-    /** Iso gain (0..1). */
+    /** Iso gain (0..1). Only available on Pioneer/Pro/X1/X3. */
     gain: number;
+    /** Brightness (-10..10), 0 as default. Only available on Ultra */
+    brightness: number;
+    /** Contrast (-50..50), 0 as default. Only available on Ultra. */
+    contrast: number;
+    /** Saturation (0..50), 8 as default. Only available on Ultra. */
+    saturation: number;
+    /** Gamma (4..79), 22 as default. Only available on Ultra. */
+    gamma: number;
+    /** Sharpness (-20..20), -20 as default. Only available on Ultra. */
+    sharpness: number;
+    /** Backlight compensation (-150..150), 10 as default. Only available on Ultra. */
+    backlightCompensation: number;
+    /** Noise reduction (-20..20), -20 as default. Only available on Ultra. */
+    denoise: number;
+    /** Enable eHDR mode. Default true. Only available on Ultra. */
+    ehdrEnabled: boolean;
+    /** Minimum number of eHDR frames. (1..4), default 1. Only available on Ultra. */
+    ehdrExposureMinNumber: number;
+    /** Maximum number of eHDR frames. (1..4), default 2. Only on Ultra. Setting larger than 2 can reduce the framerate. */
+    ehdrExposureMaxNumber: number;
     /** Stream, recording and image resolution (deprecated). */
     resolution: Resolution;
     /** Stream resolution. */
     streamResolution: Resolution;
     /** Recording and image resolution. */
     recordingResolution: Resolution;
+    /** Streaming protocol. */
+    streamingProtocol: StreamingProtocol;
     /** Stream and recording framerate. */
     framerate: Framerate;
     /** Which camera the parameters belong to. */
@@ -1787,6 +1897,39 @@ export interface CPUInfo {
     mainQueueLoad: number;
     /** Guestport queue load (0..1). */
     guestportQueueLoad: number;
+    /** Communication queue load (0..1). */
+    commQueueLoad: number;
+}
+/**
+ * Surface Unit battery information.
+ *
+ * This message is published by the Surface Unit, and re-published by
+ * the drone over the communication protocol.
+ */
+export interface SurfaceUnitBatteryInfo {
+    /** Battery charge status. */
+    status: SurfaceUnitBatteryInfo_ChargeStatus;
+    /** Battery level (0..1). */
+    level: number;
+}
+export declare enum SurfaceUnitBatteryInfo_ChargeStatus {
+    CHARGE_STATUS_UNSPECIFIED = 0,
+    CHARGE_STATUS_DISCHARGE = 1,
+    CHARGE_STATUS_CHARGE = 2,
+    CHARGE_STATUS_CHARGE_ERROR = 3,
+    UNRECOGNIZED = -1
+}
+export declare function surfaceUnitBatteryInfo_ChargeStatusFromJSON(object: any): SurfaceUnitBatteryInfo_ChargeStatus;
+export declare function surfaceUnitBatteryInfo_ChargeStatusToJSON(object: SurfaceUnitBatteryInfo_ChargeStatus): string;
+/**
+ * Surface Unit version information.
+ *
+ * This message is published by the Surface Unit, and re-published by
+ * the drone over the communication protocol.
+ */
+export interface SurfaceUnitVersionInfo {
+    /** Surface Unit firmware version (x.y.z). */
+    version: string;
 }
 export declare const BinlogRecord: MessageFns<BinlogRecord>;
 export declare const LogEntry: MessageFns<LogEntry>;
@@ -1841,6 +1984,9 @@ export declare const ControllerHealth: MessageFns<ControllerHealth>;
 export declare const DiveTime: MessageFns<DiveTime>;
 export declare const RecordOn: MessageFns<RecordOn>;
 export declare const StorageSpace: MessageFns<StorageSpace>;
+export declare const StoragePartition: MessageFns<StoragePartition>;
+export declare const RemovableStorageDevice: MessageFns<RemovableStorageDevice>;
+export declare const RemovableStorageErrorFlags: MessageFns<RemovableStorageErrorFlags>;
 export declare const CalibrationState: MessageFns<CalibrationState>;
 export declare const IperfStatus: MessageFns<IperfStatus>;
 export declare const NStreamers: MessageFns<NStreamers>;
@@ -1872,6 +2018,8 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
 export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
 export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
 export declare const CPUInfo: MessageFns<CPUInfo>;
+export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
+export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
 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]>;