@blueyerobotics/protocol-definitions 3.2.0-fed2b1e2 → 3.3.0-e472bef2

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, ConnectionDuration, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, 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
  }
@@ -200,6 +213,8 @@ export interface DeactivateMultibeamCtrl {
200
213
  * at which point the user entered the dive view.
201
214
  */
202
215
  export interface StartDiveCtrl {
216
+ /** Optional information about the operator who started the dive. */
217
+ operatorInfo: OperatorInfo | undefined;
203
218
  }
204
219
  /**
205
220
  * Message sent when the user hits the end dive button in the app.
@@ -219,6 +234,78 @@ export interface EndDiveCtrl {
219
234
  */
220
235
  export interface FormatRemovableStorageDeviceCtrl {
221
236
  }
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
+ */
242
+ export interface SetTurbidityFilterCtrl {
243
+ /** Message with the turbidity filter settings to set. */
244
+ turbidityFilter: FilterMessage | undefined;
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
+ }
257
+ /**
258
+ * Issue a command to set the digital pan, tilt, and zoom of the main camera.
259
+ *
260
+ * Only supported on X3 Ultra.
261
+ */
262
+ export interface CameraPanTiltZoomCtrl {
263
+ /** The desired pan, tilt, and zoom state. */
264
+ cameraPanTiltZoom: CameraPanTiltZoom | undefined;
265
+ }
266
+ /** Message sent to start streaming log entries to the client. */
267
+ export interface StartLogStreamingCtrl {
268
+ }
269
+ /** Message sent to stop streaming log entries to the client. */
270
+ export interface StopLogStreamingCtrl {
271
+ }
272
+ /**
273
+ * Issue a command to set the single-object tracking (SOT) target.
274
+ *
275
+ * Send a bounding box to start tracking a new target. The CV pipeline will
276
+ * initialize the SOT tracker on the specified region of the video frame.
277
+ */
278
+ export interface SetSotTargetCtrl {
279
+ /** Target bounding box. */
280
+ boundingBox: BoundingBox | undefined;
281
+ /** Width of the frame the bounding box was drawn on. */
282
+ imageWidth: number;
283
+ /** Height of the frame the bounding box was drawn on. */
284
+ imageHeight: number;
285
+ }
286
+ /** Issue a command to clear the single-object tracking (SOT) target (stop tracking). */
287
+ export interface ClearSotTargetCtrl {
288
+ }
289
+ /**
290
+ * Issue a command to rescan the computer vision model packages installed on the drone.
291
+ *
292
+ * The drone rediscovers model packages on disk and publishes an updated model
293
+ * list. Use after installing or removing a model package without rebooting.
294
+ */
295
+ export interface RescanCvModelsCtrl {
296
+ }
297
+ /**
298
+ * Request to add an annotation to the current dive.
299
+ *
300
+ * Sent by the app when a diver picks a type from the in-dive command palette.
301
+ * The drone stamps the authoritative time, publishes the result as an
302
+ * AnnotationTel to every connected client, and writes it to the dive logfile, so
303
+ * all clients converge on the same set. Fire-and-forget, like LightsCtrl.
304
+ */
305
+ export interface AnnotationCtrl {
306
+ /** The annotation to record. The drone owns the timestamp, not this message. */
307
+ annotation: Annotation | undefined;
308
+ }
222
309
  export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
223
310
  export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
224
311
  export declare const LightsCtrl: MessageFns<LightsCtrl>;
@@ -238,6 +325,7 @@ export declare const StationKeepingCtrl: MessageFns<StationKeepingCtrl>;
238
325
  export declare const WeatherVaningCtrl: MessageFns<WeatherVaningCtrl>;
239
326
  export declare const AutoPilotSurgeYawCtrl: MessageFns<AutoPilotSurgeYawCtrl>;
240
327
  export declare const AutoPilotHeaveCtrl: MessageFns<AutoPilotHeaveCtrl>;
328
+ export declare const VisionTrackingCtrl: MessageFns<VisionTrackingCtrl>;
241
329
  export declare const RunMissionCtrl: MessageFns<RunMissionCtrl>;
242
330
  export declare const PauseMissionCtrl: MessageFns<PauseMissionCtrl>;
243
331
  export declare const ClearMissionCtrl: MessageFns<ClearMissionCtrl>;
@@ -262,6 +350,15 @@ export declare const DeactivateMultibeamCtrl: MessageFns<DeactivateMultibeamCtrl
262
350
  export declare const StartDiveCtrl: MessageFns<StartDiveCtrl>;
263
351
  export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
264
352
  export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
353
+ export declare const SetTurbidityFilterCtrl: MessageFns<SetTurbidityFilterCtrl>;
354
+ export declare const SetColorCorrectionCtrl: MessageFns<SetColorCorrectionCtrl>;
355
+ export declare const CameraPanTiltZoomCtrl: MessageFns<CameraPanTiltZoomCtrl>;
356
+ export declare const StartLogStreamingCtrl: MessageFns<StartLogStreamingCtrl>;
357
+ export declare const StopLogStreamingCtrl: MessageFns<StopLogStreamingCtrl>;
358
+ export declare const SetSotTargetCtrl: MessageFns<SetSotTargetCtrl>;
359
+ export declare const ClearSotTargetCtrl: MessageFns<ClearSotTargetCtrl>;
360
+ export declare const RescanCvModelsCtrl: MessageFns<RescanCvModelsCtrl>;
361
+ export declare const AnnotationCtrl: MessageFns<AnnotationCtrl>;
265
362
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
266
363
  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 {} ? {
267
364
  [K in keyof T]?: DeepPartial<T[K]>;