@blueyerobotics/protocol-definitions 3.2.0-d3c78945 → 3.2.0-d6c9260a

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, 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, WaterDensity, WeatherVaningState } from "./message_formats";
4
4
  /**
5
5
  * Control
6
6
  *
@@ -221,11 +221,26 @@ export interface EndDiveCtrl {
221
221
  */
222
222
  export interface FormatRemovableStorageDeviceCtrl {
223
223
  }
224
- /** Message sent when the user wants to set turbidity filter settings. */
224
+ /**
225
+ * Message sent when the user wants to set turbidity filter settings.
226
+ * Uses CLAHE to enhance the contrast of the video, which can make it easier to see details in turbid water.
227
+ * Only supported on X3 Ultra.
228
+ */
225
229
  export interface SetTurbidityFilterCtrl {
226
230
  /** Message with the turbidity filter settings to set. */
227
231
  turbidityFilter: FilterMessage | undefined;
228
232
  }
233
+ /**
234
+ * Message sent when the user wants to set color correction settings.
235
+ * Applies depth- and scene-driven underwater color correction, restoring the
236
+ * red/blue balance lost with depth. The intensity field scales the correction
237
+ * (0.0 = off/identity, 1.0 = full).
238
+ * Only supported on X3 Ultra.
239
+ */
240
+ export interface SetColorCorrectionCtrl {
241
+ /** Message with the color correction settings to set. */
242
+ colorCorrectionFilter: FilterMessage | undefined;
243
+ }
229
244
  /**
230
245
  * Issue a command to set the digital pan, tilt, and zoom of the main camera.
231
246
  *
@@ -235,6 +250,41 @@ export interface CameraPanTiltZoomCtrl {
235
250
  /** The desired pan, tilt, and zoom state. */
236
251
  cameraPanTiltZoom: CameraPanTiltZoom | undefined;
237
252
  }
253
+ /** Message sent to start streaming log entries to the client. */
254
+ export interface StartLogStreamingCtrl {
255
+ }
256
+ /** Message sent to stop streaming log entries to the client. */
257
+ export interface StopLogStreamingCtrl {
258
+ }
259
+ /**
260
+ * Issue a command to set the single-object tracking (SOT) target.
261
+ *
262
+ * Send a bounding box to start tracking a new target. The CV pipeline will
263
+ * initialize the SOT tracker on the specified region of the video frame.
264
+ */
265
+ export interface SetSotTargetCtrl {
266
+ /** Target bounding box. */
267
+ boundingBox: BoundingBox | undefined;
268
+ /** Width of the frame the bounding box was drawn on. */
269
+ imageWidth: number;
270
+ /** Height of the frame the bounding box was drawn on. */
271
+ imageHeight: number;
272
+ }
273
+ /** Issue a command to clear the single-object tracking (SOT) target (stop tracking). */
274
+ export interface ClearSotTargetCtrl {
275
+ }
276
+ /**
277
+ * Request to add an annotation to the current dive.
278
+ *
279
+ * Sent by the app when a diver picks a type from the in-dive command palette.
280
+ * The drone stamps the authoritative time, publishes the result as an
281
+ * AnnotationTel to every connected client, and writes it to the dive logfile, so
282
+ * all clients converge on the same set. Fire-and-forget, like LightsCtrl.
283
+ */
284
+ export interface AnnotationCtrl {
285
+ /** The annotation to record. The drone owns the timestamp, not this message. */
286
+ annotation: Annotation | undefined;
287
+ }
238
288
  export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
239
289
  export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
240
290
  export declare const LightsCtrl: MessageFns<LightsCtrl>;
@@ -279,7 +329,13 @@ export declare const StartDiveCtrl: MessageFns<StartDiveCtrl>;
279
329
  export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
280
330
  export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
281
331
  export declare const SetTurbidityFilterCtrl: MessageFns<SetTurbidityFilterCtrl>;
332
+ export declare const SetColorCorrectionCtrl: MessageFns<SetColorCorrectionCtrl>;
282
333
  export declare const CameraPanTiltZoomCtrl: MessageFns<CameraPanTiltZoomCtrl>;
334
+ export declare const StartLogStreamingCtrl: MessageFns<StartLogStreamingCtrl>;
335
+ export declare const StopLogStreamingCtrl: MessageFns<StopLogStreamingCtrl>;
336
+ export declare const SetSotTargetCtrl: MessageFns<SetSotTargetCtrl>;
337
+ export declare const ClearSotTargetCtrl: MessageFns<ClearSotTargetCtrl>;
338
+ export declare const AnnotationCtrl: MessageFns<AnnotationCtrl>;
283
339
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
284
340
  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 {} ? {
285
341
  [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.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.ClearSotTargetCtrl = 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.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 = void 0;
9
10
  /* eslint-disable */
10
11
  const wire_1 = require("@bufbuild/protobuf/wire");
11
12
  const aquatroll_1 = require("./aquatroll");
@@ -2180,6 +2181,64 @@ exports.SetTurbidityFilterCtrl = {
2180
2181
  return message;
2181
2182
  },
2182
2183
  };
2184
+ function createBaseSetColorCorrectionCtrl() {
2185
+ return { colorCorrectionFilter: undefined };
2186
+ }
2187
+ exports.SetColorCorrectionCtrl = {
2188
+ encode(message, writer = new wire_1.BinaryWriter()) {
2189
+ if (message.colorCorrectionFilter !== undefined) {
2190
+ message_formats_1.FilterMessage.encode(message.colorCorrectionFilter, writer.uint32(10).fork()).join();
2191
+ }
2192
+ return writer;
2193
+ },
2194
+ decode(input, length) {
2195
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
2196
+ const end = length === undefined ? reader.len : reader.pos + length;
2197
+ const message = createBaseSetColorCorrectionCtrl();
2198
+ while (reader.pos < end) {
2199
+ const tag = reader.uint32();
2200
+ switch (tag >>> 3) {
2201
+ case 1: {
2202
+ if (tag !== 10) {
2203
+ break;
2204
+ }
2205
+ message.colorCorrectionFilter = message_formats_1.FilterMessage.decode(reader, reader.uint32());
2206
+ continue;
2207
+ }
2208
+ }
2209
+ if ((tag & 7) === 4 || tag === 0) {
2210
+ break;
2211
+ }
2212
+ reader.skip(tag & 7);
2213
+ }
2214
+ return message;
2215
+ },
2216
+ fromJSON(object) {
2217
+ return {
2218
+ colorCorrectionFilter: isSet(object.colorCorrectionFilter)
2219
+ ? message_formats_1.FilterMessage.fromJSON(object.colorCorrectionFilter)
2220
+ : undefined,
2221
+ };
2222
+ },
2223
+ toJSON(message) {
2224
+ const obj = {};
2225
+ if (message.colorCorrectionFilter !== undefined) {
2226
+ obj.colorCorrectionFilter = message_formats_1.FilterMessage.toJSON(message.colorCorrectionFilter);
2227
+ }
2228
+ return obj;
2229
+ },
2230
+ create(base) {
2231
+ return exports.SetColorCorrectionCtrl.fromPartial(base ?? {});
2232
+ },
2233
+ fromPartial(object) {
2234
+ const message = createBaseSetColorCorrectionCtrl();
2235
+ message.colorCorrectionFilter =
2236
+ (object.colorCorrectionFilter !== undefined && object.colorCorrectionFilter !== null)
2237
+ ? message_formats_1.FilterMessage.fromPartial(object.colorCorrectionFilter)
2238
+ : undefined;
2239
+ return message;
2240
+ },
2241
+ };
2183
2242
  function createBaseCameraPanTiltZoomCtrl() {
2184
2243
  return { cameraPanTiltZoom: undefined };
2185
2244
  }
@@ -2237,6 +2296,255 @@ exports.CameraPanTiltZoomCtrl = {
2237
2296
  return message;
2238
2297
  },
2239
2298
  };
2299
+ function createBaseStartLogStreamingCtrl() {
2300
+ return {};
2301
+ }
2302
+ exports.StartLogStreamingCtrl = {
2303
+ encode(_, writer = new wire_1.BinaryWriter()) {
2304
+ return writer;
2305
+ },
2306
+ decode(input, length) {
2307
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
2308
+ const end = length === undefined ? reader.len : reader.pos + length;
2309
+ const message = createBaseStartLogStreamingCtrl();
2310
+ while (reader.pos < end) {
2311
+ const tag = reader.uint32();
2312
+ switch (tag >>> 3) {
2313
+ }
2314
+ if ((tag & 7) === 4 || tag === 0) {
2315
+ break;
2316
+ }
2317
+ reader.skip(tag & 7);
2318
+ }
2319
+ return message;
2320
+ },
2321
+ fromJSON(_) {
2322
+ return {};
2323
+ },
2324
+ toJSON(_) {
2325
+ const obj = {};
2326
+ return obj;
2327
+ },
2328
+ create(base) {
2329
+ return exports.StartLogStreamingCtrl.fromPartial(base ?? {});
2330
+ },
2331
+ fromPartial(_) {
2332
+ const message = createBaseStartLogStreamingCtrl();
2333
+ return message;
2334
+ },
2335
+ };
2336
+ function createBaseStopLogStreamingCtrl() {
2337
+ return {};
2338
+ }
2339
+ exports.StopLogStreamingCtrl = {
2340
+ encode(_, writer = new wire_1.BinaryWriter()) {
2341
+ return writer;
2342
+ },
2343
+ decode(input, length) {
2344
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
2345
+ const end = length === undefined ? reader.len : reader.pos + length;
2346
+ const message = createBaseStopLogStreamingCtrl();
2347
+ while (reader.pos < end) {
2348
+ const tag = reader.uint32();
2349
+ switch (tag >>> 3) {
2350
+ }
2351
+ if ((tag & 7) === 4 || tag === 0) {
2352
+ break;
2353
+ }
2354
+ reader.skip(tag & 7);
2355
+ }
2356
+ return message;
2357
+ },
2358
+ fromJSON(_) {
2359
+ return {};
2360
+ },
2361
+ toJSON(_) {
2362
+ const obj = {};
2363
+ return obj;
2364
+ },
2365
+ create(base) {
2366
+ return exports.StopLogStreamingCtrl.fromPartial(base ?? {});
2367
+ },
2368
+ fromPartial(_) {
2369
+ const message = createBaseStopLogStreamingCtrl();
2370
+ return message;
2371
+ },
2372
+ };
2373
+ function createBaseSetSotTargetCtrl() {
2374
+ return { boundingBox: undefined, imageWidth: 0, imageHeight: 0 };
2375
+ }
2376
+ exports.SetSotTargetCtrl = {
2377
+ encode(message, writer = new wire_1.BinaryWriter()) {
2378
+ if (message.boundingBox !== undefined) {
2379
+ message_formats_1.BoundingBox.encode(message.boundingBox, writer.uint32(10).fork()).join();
2380
+ }
2381
+ if (message.imageWidth !== 0) {
2382
+ writer.uint32(16).uint32(message.imageWidth);
2383
+ }
2384
+ if (message.imageHeight !== 0) {
2385
+ writer.uint32(24).uint32(message.imageHeight);
2386
+ }
2387
+ return writer;
2388
+ },
2389
+ decode(input, length) {
2390
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
2391
+ const end = length === undefined ? reader.len : reader.pos + length;
2392
+ const message = createBaseSetSotTargetCtrl();
2393
+ while (reader.pos < end) {
2394
+ const tag = reader.uint32();
2395
+ switch (tag >>> 3) {
2396
+ case 1: {
2397
+ if (tag !== 10) {
2398
+ break;
2399
+ }
2400
+ message.boundingBox = message_formats_1.BoundingBox.decode(reader, reader.uint32());
2401
+ continue;
2402
+ }
2403
+ case 2: {
2404
+ if (tag !== 16) {
2405
+ break;
2406
+ }
2407
+ message.imageWidth = reader.uint32();
2408
+ continue;
2409
+ }
2410
+ case 3: {
2411
+ if (tag !== 24) {
2412
+ break;
2413
+ }
2414
+ message.imageHeight = reader.uint32();
2415
+ continue;
2416
+ }
2417
+ }
2418
+ if ((tag & 7) === 4 || tag === 0) {
2419
+ break;
2420
+ }
2421
+ reader.skip(tag & 7);
2422
+ }
2423
+ return message;
2424
+ },
2425
+ fromJSON(object) {
2426
+ return {
2427
+ boundingBox: isSet(object.boundingBox) ? message_formats_1.BoundingBox.fromJSON(object.boundingBox) : undefined,
2428
+ imageWidth: isSet(object.imageWidth) ? gt.Number(object.imageWidth) : 0,
2429
+ imageHeight: isSet(object.imageHeight) ? gt.Number(object.imageHeight) : 0,
2430
+ };
2431
+ },
2432
+ toJSON(message) {
2433
+ const obj = {};
2434
+ if (message.boundingBox !== undefined) {
2435
+ obj.boundingBox = message_formats_1.BoundingBox.toJSON(message.boundingBox);
2436
+ }
2437
+ if (message.imageWidth !== 0) {
2438
+ obj.imageWidth = Math.round(message.imageWidth);
2439
+ }
2440
+ if (message.imageHeight !== 0) {
2441
+ obj.imageHeight = Math.round(message.imageHeight);
2442
+ }
2443
+ return obj;
2444
+ },
2445
+ create(base) {
2446
+ return exports.SetSotTargetCtrl.fromPartial(base ?? {});
2447
+ },
2448
+ fromPartial(object) {
2449
+ const message = createBaseSetSotTargetCtrl();
2450
+ message.boundingBox = (object.boundingBox !== undefined && object.boundingBox !== null)
2451
+ ? message_formats_1.BoundingBox.fromPartial(object.boundingBox)
2452
+ : undefined;
2453
+ message.imageWidth = object.imageWidth ?? 0;
2454
+ message.imageHeight = object.imageHeight ?? 0;
2455
+ return message;
2456
+ },
2457
+ };
2458
+ function createBaseClearSotTargetCtrl() {
2459
+ return {};
2460
+ }
2461
+ exports.ClearSotTargetCtrl = {
2462
+ encode(_, writer = new wire_1.BinaryWriter()) {
2463
+ return writer;
2464
+ },
2465
+ decode(input, length) {
2466
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
2467
+ const end = length === undefined ? reader.len : reader.pos + length;
2468
+ const message = createBaseClearSotTargetCtrl();
2469
+ while (reader.pos < end) {
2470
+ const tag = reader.uint32();
2471
+ switch (tag >>> 3) {
2472
+ }
2473
+ if ((tag & 7) === 4 || tag === 0) {
2474
+ break;
2475
+ }
2476
+ reader.skip(tag & 7);
2477
+ }
2478
+ return message;
2479
+ },
2480
+ fromJSON(_) {
2481
+ return {};
2482
+ },
2483
+ toJSON(_) {
2484
+ const obj = {};
2485
+ return obj;
2486
+ },
2487
+ create(base) {
2488
+ return exports.ClearSotTargetCtrl.fromPartial(base ?? {});
2489
+ },
2490
+ fromPartial(_) {
2491
+ const message = createBaseClearSotTargetCtrl();
2492
+ return message;
2493
+ },
2494
+ };
2495
+ function createBaseAnnotationCtrl() {
2496
+ return { annotation: undefined };
2497
+ }
2498
+ exports.AnnotationCtrl = {
2499
+ encode(message, writer = new wire_1.BinaryWriter()) {
2500
+ if (message.annotation !== undefined) {
2501
+ message_formats_1.Annotation.encode(message.annotation, writer.uint32(10).fork()).join();
2502
+ }
2503
+ return writer;
2504
+ },
2505
+ decode(input, length) {
2506
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
2507
+ const end = length === undefined ? reader.len : reader.pos + length;
2508
+ const message = createBaseAnnotationCtrl();
2509
+ while (reader.pos < end) {
2510
+ const tag = reader.uint32();
2511
+ switch (tag >>> 3) {
2512
+ case 1: {
2513
+ if (tag !== 10) {
2514
+ break;
2515
+ }
2516
+ message.annotation = message_formats_1.Annotation.decode(reader, reader.uint32());
2517
+ continue;
2518
+ }
2519
+ }
2520
+ if ((tag & 7) === 4 || tag === 0) {
2521
+ break;
2522
+ }
2523
+ reader.skip(tag & 7);
2524
+ }
2525
+ return message;
2526
+ },
2527
+ fromJSON(object) {
2528
+ return { annotation: isSet(object.annotation) ? message_formats_1.Annotation.fromJSON(object.annotation) : undefined };
2529
+ },
2530
+ toJSON(message) {
2531
+ const obj = {};
2532
+ if (message.annotation !== undefined) {
2533
+ obj.annotation = message_formats_1.Annotation.toJSON(message.annotation);
2534
+ }
2535
+ return obj;
2536
+ },
2537
+ create(base) {
2538
+ return exports.AnnotationCtrl.fromPartial(base ?? {});
2539
+ },
2540
+ fromPartial(object) {
2541
+ const message = createBaseAnnotationCtrl();
2542
+ message.annotation = (object.annotation !== undefined && object.annotation !== null)
2543
+ ? message_formats_1.Annotation.fromPartial(object.annotation)
2544
+ : undefined;
2545
+ return message;
2546
+ },
2547
+ };
2240
2548
  const gt = (() => {
2241
2549
  if (typeof globalThis !== "undefined") {
2242
2550
  return globalThis;