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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/control.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
2
2
  import { SetAquaTrollConnectionStatus, SetAquaTrollParameterUnit } from "./aquatroll";
3
- 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";
3
+ import { Annotation, 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, VisionTrackingState, WaterDensity, WeatherVaningState } from "./message_formats";
4
4
  /**
5
5
  * Control
6
6
  *
@@ -104,6 +104,19 @@ export interface AutoPilotHeaveCtrl {
104
104
  /** State of the auto pilot heave controller- */
105
105
  state: AutoPilotHeaveState | undefined;
106
106
  }
107
+ /**
108
+ * Issue a command to set the vision-based tracking mode.
109
+ *
110
+ * Setting a mode requires an actively tracked single-object-tracking (SOT)
111
+ * target; the drone refuses to enable a mode otherwise. Setting a different
112
+ * mode while one is active switches atomically. Sending a state with no
113
+ * mode set disables vision tracking. An OrbitState with a zero rate is
114
+ * rejected.
115
+ */
116
+ export interface VisionTrackingCtrl {
117
+ /** The desired vision tracking mode, or none to disable. */
118
+ state: VisionTrackingState | undefined;
119
+ }
107
120
  /** Issue a command to start and pause the loaded mission. */
108
121
  export interface RunMissionCtrl {
109
122
  }
@@ -221,11 +234,26 @@ export interface EndDiveCtrl {
221
234
  */
222
235
  export interface FormatRemovableStorageDeviceCtrl {
223
236
  }
224
- /** Message sent when the user wants to set turbidity filter settings. */
237
+ /**
238
+ * Message sent when the user wants to set turbidity filter settings.
239
+ * Uses CLAHE to enhance the contrast of the video, which can make it easier to see details in turbid water.
240
+ * Only supported on X3 Ultra.
241
+ */
225
242
  export interface SetTurbidityFilterCtrl {
226
243
  /** Message with the turbidity filter settings to set. */
227
244
  turbidityFilter: FilterMessage | undefined;
228
245
  }
246
+ /**
247
+ * Message sent when the user wants to set color correction settings.
248
+ * Applies depth- and scene-driven underwater color correction, restoring the
249
+ * red/blue balance lost with depth. The intensity field scales the correction
250
+ * (0.0 = off/identity, 1.0 = full).
251
+ * Only supported on X3 Ultra.
252
+ */
253
+ export interface SetColorCorrectionCtrl {
254
+ /** Message with the color correction settings to set. */
255
+ colorCorrectionFilter: FilterMessage | undefined;
256
+ }
229
257
  /**
230
258
  * Issue a command to set the digital pan, tilt, and zoom of the main camera.
231
259
  *
@@ -258,6 +286,18 @@ export interface SetSotTargetCtrl {
258
286
  /** Issue a command to clear the single-object tracking (SOT) target (stop tracking). */
259
287
  export interface ClearSotTargetCtrl {
260
288
  }
289
+ /**
290
+ * Request to add an annotation to the current dive.
291
+ *
292
+ * Sent by the app when a diver picks a type from the in-dive command palette.
293
+ * The drone stamps the authoritative time, publishes the result as an
294
+ * AnnotationTel to every connected client, and writes it to the dive logfile, so
295
+ * all clients converge on the same set. Fire-and-forget, like LightsCtrl.
296
+ */
297
+ export interface AnnotationCtrl {
298
+ /** The annotation to record. The drone owns the timestamp, not this message. */
299
+ annotation: Annotation | undefined;
300
+ }
261
301
  export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
262
302
  export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
263
303
  export declare const LightsCtrl: MessageFns<LightsCtrl>;
@@ -277,6 +317,7 @@ export declare const StationKeepingCtrl: MessageFns<StationKeepingCtrl>;
277
317
  export declare const WeatherVaningCtrl: MessageFns<WeatherVaningCtrl>;
278
318
  export declare const AutoPilotSurgeYawCtrl: MessageFns<AutoPilotSurgeYawCtrl>;
279
319
  export declare const AutoPilotHeaveCtrl: MessageFns<AutoPilotHeaveCtrl>;
320
+ export declare const VisionTrackingCtrl: MessageFns<VisionTrackingCtrl>;
280
321
  export declare const RunMissionCtrl: MessageFns<RunMissionCtrl>;
281
322
  export declare const PauseMissionCtrl: MessageFns<PauseMissionCtrl>;
282
323
  export declare const ClearMissionCtrl: MessageFns<ClearMissionCtrl>;
@@ -302,11 +343,13 @@ export declare const StartDiveCtrl: MessageFns<StartDiveCtrl>;
302
343
  export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
303
344
  export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
304
345
  export declare const SetTurbidityFilterCtrl: MessageFns<SetTurbidityFilterCtrl>;
346
+ export declare const SetColorCorrectionCtrl: MessageFns<SetColorCorrectionCtrl>;
305
347
  export declare const CameraPanTiltZoomCtrl: MessageFns<CameraPanTiltZoomCtrl>;
306
348
  export declare const StartLogStreamingCtrl: MessageFns<StartLogStreamingCtrl>;
307
349
  export declare const StopLogStreamingCtrl: MessageFns<StopLogStreamingCtrl>;
308
350
  export declare const SetSotTargetCtrl: MessageFns<SetSotTargetCtrl>;
309
351
  export declare const ClearSotTargetCtrl: MessageFns<ClearSotTargetCtrl>;
352
+ export declare const AnnotationCtrl: MessageFns<AnnotationCtrl>;
310
353
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
311
354
  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 {} ? {
312
355
  [K in keyof T]?: DeepPartial<T[K]>;
package/dist/control.js CHANGED
@@ -5,7 +5,8 @@
5
5
  // protoc v3.21.12
6
6
  // source: control.proto
7
7
  Object.defineProperty(exports, "__esModule", { value: true });
8
- 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;
8
+ exports.SetSotTargetCtrl = exports.StopLogStreamingCtrl = exports.StartLogStreamingCtrl = exports.CameraPanTiltZoomCtrl = exports.SetColorCorrectionCtrl = 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.VisionTrackingCtrl = 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;
9
+ exports.AnnotationCtrl = exports.ClearSotTargetCtrl = void 0;
9
10
  /* eslint-disable */
10
11
  const wire_1 = require("@bufbuild/protobuf/wire");
11
12
  const aquatroll_1 = require("./aquatroll");
@@ -1001,6 +1002,59 @@ exports.AutoPilotHeaveCtrl = {
1001
1002
  return message;
1002
1003
  },
1003
1004
  };
1005
+ function createBaseVisionTrackingCtrl() {
1006
+ return { state: undefined };
1007
+ }
1008
+ exports.VisionTrackingCtrl = {
1009
+ encode(message, writer = new wire_1.BinaryWriter()) {
1010
+ if (message.state !== undefined) {
1011
+ message_formats_1.VisionTrackingState.encode(message.state, writer.uint32(10).fork()).join();
1012
+ }
1013
+ return writer;
1014
+ },
1015
+ decode(input, length) {
1016
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
1017
+ const end = length === undefined ? reader.len : reader.pos + length;
1018
+ const message = createBaseVisionTrackingCtrl();
1019
+ while (reader.pos < end) {
1020
+ const tag = reader.uint32();
1021
+ switch (tag >>> 3) {
1022
+ case 1: {
1023
+ if (tag !== 10) {
1024
+ break;
1025
+ }
1026
+ message.state = message_formats_1.VisionTrackingState.decode(reader, reader.uint32());
1027
+ continue;
1028
+ }
1029
+ }
1030
+ if ((tag & 7) === 4 || tag === 0) {
1031
+ break;
1032
+ }
1033
+ reader.skip(tag & 7);
1034
+ }
1035
+ return message;
1036
+ },
1037
+ fromJSON(object) {
1038
+ return { state: isSet(object.state) ? message_formats_1.VisionTrackingState.fromJSON(object.state) : undefined };
1039
+ },
1040
+ toJSON(message) {
1041
+ const obj = {};
1042
+ if (message.state !== undefined) {
1043
+ obj.state = message_formats_1.VisionTrackingState.toJSON(message.state);
1044
+ }
1045
+ return obj;
1046
+ },
1047
+ create(base) {
1048
+ return exports.VisionTrackingCtrl.fromPartial(base ?? {});
1049
+ },
1050
+ fromPartial(object) {
1051
+ const message = createBaseVisionTrackingCtrl();
1052
+ message.state = (object.state !== undefined && object.state !== null)
1053
+ ? message_formats_1.VisionTrackingState.fromPartial(object.state)
1054
+ : undefined;
1055
+ return message;
1056
+ },
1057
+ };
1004
1058
  function createBaseRunMissionCtrl() {
1005
1059
  return {};
1006
1060
  }
@@ -2180,6 +2234,64 @@ exports.SetTurbidityFilterCtrl = {
2180
2234
  return message;
2181
2235
  },
2182
2236
  };
2237
+ function createBaseSetColorCorrectionCtrl() {
2238
+ return { colorCorrectionFilter: undefined };
2239
+ }
2240
+ exports.SetColorCorrectionCtrl = {
2241
+ encode(message, writer = new wire_1.BinaryWriter()) {
2242
+ if (message.colorCorrectionFilter !== undefined) {
2243
+ message_formats_1.FilterMessage.encode(message.colorCorrectionFilter, writer.uint32(10).fork()).join();
2244
+ }
2245
+ return writer;
2246
+ },
2247
+ decode(input, length) {
2248
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
2249
+ const end = length === undefined ? reader.len : reader.pos + length;
2250
+ const message = createBaseSetColorCorrectionCtrl();
2251
+ while (reader.pos < end) {
2252
+ const tag = reader.uint32();
2253
+ switch (tag >>> 3) {
2254
+ case 1: {
2255
+ if (tag !== 10) {
2256
+ break;
2257
+ }
2258
+ message.colorCorrectionFilter = message_formats_1.FilterMessage.decode(reader, reader.uint32());
2259
+ continue;
2260
+ }
2261
+ }
2262
+ if ((tag & 7) === 4 || tag === 0) {
2263
+ break;
2264
+ }
2265
+ reader.skip(tag & 7);
2266
+ }
2267
+ return message;
2268
+ },
2269
+ fromJSON(object) {
2270
+ return {
2271
+ colorCorrectionFilter: isSet(object.colorCorrectionFilter)
2272
+ ? message_formats_1.FilterMessage.fromJSON(object.colorCorrectionFilter)
2273
+ : undefined,
2274
+ };
2275
+ },
2276
+ toJSON(message) {
2277
+ const obj = {};
2278
+ if (message.colorCorrectionFilter !== undefined) {
2279
+ obj.colorCorrectionFilter = message_formats_1.FilterMessage.toJSON(message.colorCorrectionFilter);
2280
+ }
2281
+ return obj;
2282
+ },
2283
+ create(base) {
2284
+ return exports.SetColorCorrectionCtrl.fromPartial(base ?? {});
2285
+ },
2286
+ fromPartial(object) {
2287
+ const message = createBaseSetColorCorrectionCtrl();
2288
+ message.colorCorrectionFilter =
2289
+ (object.colorCorrectionFilter !== undefined && object.colorCorrectionFilter !== null)
2290
+ ? message_formats_1.FilterMessage.fromPartial(object.colorCorrectionFilter)
2291
+ : undefined;
2292
+ return message;
2293
+ },
2294
+ };
2183
2295
  function createBaseCameraPanTiltZoomCtrl() {
2184
2296
  return { cameraPanTiltZoom: undefined };
2185
2297
  }
@@ -2433,6 +2545,59 @@ exports.ClearSotTargetCtrl = {
2433
2545
  return message;
2434
2546
  },
2435
2547
  };
2548
+ function createBaseAnnotationCtrl() {
2549
+ return { annotation: undefined };
2550
+ }
2551
+ exports.AnnotationCtrl = {
2552
+ encode(message, writer = new wire_1.BinaryWriter()) {
2553
+ if (message.annotation !== undefined) {
2554
+ message_formats_1.Annotation.encode(message.annotation, writer.uint32(10).fork()).join();
2555
+ }
2556
+ return writer;
2557
+ },
2558
+ decode(input, length) {
2559
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
2560
+ const end = length === undefined ? reader.len : reader.pos + length;
2561
+ const message = createBaseAnnotationCtrl();
2562
+ while (reader.pos < end) {
2563
+ const tag = reader.uint32();
2564
+ switch (tag >>> 3) {
2565
+ case 1: {
2566
+ if (tag !== 10) {
2567
+ break;
2568
+ }
2569
+ message.annotation = message_formats_1.Annotation.decode(reader, reader.uint32());
2570
+ continue;
2571
+ }
2572
+ }
2573
+ if ((tag & 7) === 4 || tag === 0) {
2574
+ break;
2575
+ }
2576
+ reader.skip(tag & 7);
2577
+ }
2578
+ return message;
2579
+ },
2580
+ fromJSON(object) {
2581
+ return { annotation: isSet(object.annotation) ? message_formats_1.Annotation.fromJSON(object.annotation) : undefined };
2582
+ },
2583
+ toJSON(message) {
2584
+ const obj = {};
2585
+ if (message.annotation !== undefined) {
2586
+ obj.annotation = message_formats_1.Annotation.toJSON(message.annotation);
2587
+ }
2588
+ return obj;
2589
+ },
2590
+ create(base) {
2591
+ return exports.AnnotationCtrl.fromPartial(base ?? {});
2592
+ },
2593
+ fromPartial(object) {
2594
+ const message = createBaseAnnotationCtrl();
2595
+ message.annotation = (object.annotation !== undefined && object.annotation !== null)
2596
+ ? message_formats_1.Annotation.fromPartial(object.annotation)
2597
+ : undefined;
2598
+ return message;
2599
+ },
2600
+ };
2436
2601
  const gt = (() => {
2437
2602
  if (typeof globalThis !== "undefined") {
2438
2603
  return globalThis;