@blueyerobotics/protocol-definitions 3.2.0-9a7703f5 → 3.2.0-c785049b

package/README.md

@@ -0,0 +1,40 @@
+# @blueyerobotics/protocol-definitions
+
+TypeScript protobuf definitions for Blueye Robotics protocols generated using [ts-proto](https://github.com/stephenh/ts-proto).
+
+## Installation
+
+```bash
+npm install @blueyerobotics/protocol-definitions
+```
+
+## Usage
+
+```ts
+import { blueye } from "@blueyerobotics/protocol-definitions";
+
+// Create a new GetBatteryReq message
+const request = blueye.protocol.GetBatteryReq.create();
+
+// Serialize the message to a Uint8Array (binary)
+const binary = blueye.protocol.GetBatteryReq.encode(request).finish();
+
+// ...
+
+// For demonstration, we will simulate a response from the device
+const response = blueye.protocol.GetBatteryRep.create({
+  battery: {
+    level: 85,
+    voltage: 12.5,
+    temperature: 25,
+  },
+});
+
+const binaryResponse = blueye.protocol.GetBatteryRep.encode(response).finish();
+
+// Decode a binary response back into a message
+const decoded = blueye.protocol.GetBatteryRep.decode(binaryResponse);
+
+// Access fields
+console.log(decoded.battery?.level);
+```

package/dist/aquatroll.d.ts

@@ -424,18 +424,12 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
 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>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
 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<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
 }
 export {};

package/dist/control.d.ts

@@ -205,6 +205,16 @@ export interface StartDiveCtrl {
  */
 export interface EndDiveCtrl {
 }
+/**
+ * Message sent when the user wants to format a connected removable storage device.
+ *
+ * The app will receive a RemovableStorageTel message with information about the newly formatted drive.
+ *
+ * Warning: The drone will delete any partitions and format the drive with a single exFat partition.
+ * Any data on the drive will be lost.
+ */
+export interface FormatRemovableStorageDeviceCtrl {
+}
 export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
 export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
 export declare const LightsCtrl: MessageFns<LightsCtrl>;
@@ -247,22 +257,17 @@ export declare const ActivateMultibeamCtrl: MessageFns<ActivateMultibeamCtrl>;
 export declare const DeactivateMultibeamCtrl: MessageFns<DeactivateMultibeamCtrl>;
 export declare const StartDiveCtrl: MessageFns<StartDiveCtrl>;
 export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
+export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
 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>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
 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<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
 }
 export {};

package/dist/control.js

@@ -5,7 +5,7 @@
 //   protoc               v3.21.12
 // source: control.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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");
@@ -2041,6 +2041,43 @@ exports.EndDiveCtrl = {
         return message;
     },
 };
+function createBaseFormatRemovableStorageDeviceCtrl() {
+    return {};
+}
+exports.FormatRemovableStorageDeviceCtrl = {
+    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 = createBaseFormatRemovableStorageDeviceCtrl();
+        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.FormatRemovableStorageDeviceCtrl.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseFormatRemovableStorageDeviceCtrl();
+        return message;
+    },
+};
 const gt = (() => {
     if (typeof globalThis !== "undefined") {
         return globalThis;

package/dist/google/protobuf/any.d.ts

@@ -121,18 +121,12 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
 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>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
 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<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
 }
 export {};

package/dist/google/protobuf/duration.d.ts

@@ -81,18 +81,12 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
 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>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
 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<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
 }
 export {};

package/dist/google/protobuf/timestamp.d.ts

@@ -110,18 +110,12 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
 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>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
 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<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
 }
 export {};

package/dist/message_formats.d.ts

@@ -491,6 +491,46 @@ export interface BinlogRecord {
     /** Posix CLOCK_MONOTONIC timestamp. */
     clockMonotonic: Date | undefined;
 }
+/**
+ * Log entry
+ *
+ * Used to store ROS log entries in the bez file
+ */
+export interface LogEntry {
+    /** Timestamp of the log entry. */
+    timestamp: Date | undefined;
+    /** Name of the process that generated the log entry. */
+    processName: string;
+    /** Process ID of the log entry. */
+    processId: number;
+    /** Thread ID of the log entry. */
+    threadId: number;
+    /** Source of the log entry (specific class or named logger). */
+    source: string;
+    /** Log level, info, warning, error, etc. */
+    level: LogEntry_LogLevel;
+    /** Log message. */
+    message: string;
+}
+export declare enum LogEntry_LogLevel {
+    /** LOG_LEVEL_UNSPECIFIED - Unspecified log level. */
+    LOG_LEVEL_UNSPECIFIED = 0,
+    /** LOG_LEVEL_TRACE - Trace log level. */
+    LOG_LEVEL_TRACE = 1,
+    /** LOG_LEVEL_DEBUG - Debug log level. */
+    LOG_LEVEL_DEBUG = 2,
+    /** LOG_LEVEL_INFO - Info log level. */
+    LOG_LEVEL_INFO = 3,
+    /** LOG_LEVEL_WARNING - Warning log level. */
+    LOG_LEVEL_WARNING = 4,
+    /** LOG_LEVEL_ERROR - Error log level. */
+    LOG_LEVEL_ERROR = 5,
+    /** LOG_LEVEL_CRITICAL - Critical log level. */
+    LOG_LEVEL_CRITICAL = 6,
+    UNRECOGNIZED = -1
+}
+export declare function logEntry_LogLevelFromJSON(object: any): LogEntry_LogLevel;
+export declare function logEntry_LogLevelToJSON(object: LogEntry_LogLevel): string;
 /** If you use both values at the same time they cancel each other out. */
 export interface MotionInput {
     /** Forward (positive) and backwards (negative) movement. (-1..1). */
@@ -1143,6 +1183,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. */
@@ -1165,7 +1260,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. */
@@ -1186,7 +1281,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
 }
@@ -1749,6 +1844,7 @@ export interface CPUInfo {
     guestportQueueLoad: number;
 }
 export declare const BinlogRecord: MessageFns<BinlogRecord>;
+export declare const LogEntry: MessageFns<LogEntry>;
 export declare const MotionInput: MessageFns<MotionInput>;
 export declare const Lights: MessageFns<Lights>;
 export declare const Laser: MessageFns<Laser>;
@@ -1800,6 +1896,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>;
@@ -1835,18 +1934,12 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
 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>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
 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<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
 }
 export {};