@blueyerobotics/protocol-definitions 3.3.0-991d560c → 3.3.0-9bfb9893

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 { 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";
3
+ import { Annotation, AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, BoundingBox, CameraPanTiltZoom, CartesianManipulatorInput, ConnectionDuration, CylindricalManipulatorInput, FilterMessage, GenericServo, GripperVelocities, GuestPortRestartInfo, KnownPoseManipulatorInput, Laser, LatLongPosition, Lights, MarineSnowFilterFrames, 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
  *
@@ -157,10 +157,26 @@ export interface SystemTimeCtrl {
157
157
  /** Message with the system time to set. */
158
158
  systemTime: SystemTime | undefined;
159
159
  }
160
- /** Issue a command to control the gripper. */
160
+ /**
161
+ * Issue a command to control the gripper.
162
+ *
163
+ * On a manipulator arm the command can also move the arm. Each command stands until the next one: the
164
+ * arm stops on a command without arm input, or when the client watchdog (WatchdogCtrl) lapses.
165
+ */
161
166
  export interface GripperCtrl {
162
167
  /** The desired gripping and rotation velocity. */
163
168
  gripperVelocities: GripperVelocities | undefined;
169
+ /** In the drone body frame. */
170
+ cartesian?: CartesianManipulatorInput | undefined;
171
+ /** About the axis of the arm's base joint. */
172
+ cylindrical?: CylindricalManipulatorInput | undefined;
173
+ /** Towards a named pose, such as stowed or deployed. */
174
+ knownPose?: KnownPoseManipulatorInput | undefined;
175
+ /**
176
+ * Speed of the arm input relative to the drone default (-1.0..1.0): negative is slower, positive is
177
+ * faster, and 0 is the default speed. Scales arm_input only, not gripper_velocities.
178
+ */
179
+ speedModifier: number;
164
180
  }
165
181
  /** Issue a command to set a generic servo value. */
166
182
  export interface GenericServoCtrl {
@@ -254,6 +270,18 @@ export interface SetColorCorrectionCtrl {
254
270
  /** Message with the color correction settings to set. */
255
271
  colorCorrectionFilter: FilterMessage | undefined;
256
272
  }
273
+ /**
274
+ * Message sent when the user wants to set marine snow filter settings.
275
+ * Removes bright particles, such as marine snow, from the video. The intensity field sets how faint a particle can be
276
+ * and still be removed (0.0 = only the brightest, 1.0 = faint particles as well). Turn it off during laser detection.
277
+ * Only supported on X3 Ultra.
278
+ */
279
+ export interface SetMarineSnowFilterCtrl {
280
+ /** Message with the marine snow filter settings to set. */
281
+ marineSnowFilter: FilterMessage | undefined;
282
+ /** Frames to compare with. Leave it unset to keep the current frames. */
283
+ frames: MarineSnowFilterFrames | undefined;
284
+ }
257
285
  /**
258
286
  * Issue a command to set the digital pan, tilt, and zoom of the main camera.
259
287
  *
@@ -352,6 +380,7 @@ export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
352
380
  export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
353
381
  export declare const SetTurbidityFilterCtrl: MessageFns<SetTurbidityFilterCtrl>;
354
382
  export declare const SetColorCorrectionCtrl: MessageFns<SetColorCorrectionCtrl>;
383
+ export declare const SetMarineSnowFilterCtrl: MessageFns<SetMarineSnowFilterCtrl>;
355
384
  export declare const CameraPanTiltZoomCtrl: MessageFns<CameraPanTiltZoomCtrl>;
356
385
  export declare const StartLogStreamingCtrl: MessageFns<StartLogStreamingCtrl>;
357
386
  export declare const StopLogStreamingCtrl: MessageFns<StopLogStreamingCtrl>;
package/dist/control.js CHANGED
@@ -5,8 +5,8 @@
5
5
  // protoc v3.21.12
6
6
  // source: control.proto
7
7
  Object.defineProperty(exports, "__esModule", { value: true });
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.RescanCvModelsCtrl = exports.ClearSotTargetCtrl = void 0;
8
+ exports.StopLogStreamingCtrl = exports.StartLogStreamingCtrl = exports.CameraPanTiltZoomCtrl = exports.SetMarineSnowFilterCtrl = 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.RescanCvModelsCtrl = exports.ClearSotTargetCtrl = exports.SetSotTargetCtrl = void 0;
10
10
  /* eslint-disable */
11
11
  const wire_1 = require("@bufbuild/protobuf/wire");
12
12
  const aquatroll_1 = require("./aquatroll");
@@ -1508,13 +1508,31 @@ exports.SystemTimeCtrl = {
1508
1508
  },
1509
1509
  };
1510
1510
  function createBaseGripperCtrl() {
1511
- return { gripperVelocities: undefined };
1511
+ return {
1512
+ gripperVelocities: undefined,
1513
+ cartesian: undefined,
1514
+ cylindrical: undefined,
1515
+ knownPose: undefined,
1516
+ speedModifier: 0,
1517
+ };
1512
1518
  }
1513
1519
  exports.GripperCtrl = {
1514
1520
  encode(message, writer = new wire_1.BinaryWriter()) {
1515
1521
  if (message.gripperVelocities !== undefined) {
1516
1522
  message_formats_1.GripperVelocities.encode(message.gripperVelocities, writer.uint32(10).fork()).join();
1517
1523
  }
1524
+ if (message.cartesian !== undefined) {
1525
+ message_formats_1.CartesianManipulatorInput.encode(message.cartesian, writer.uint32(18).fork()).join();
1526
+ }
1527
+ if (message.cylindrical !== undefined) {
1528
+ message_formats_1.CylindricalManipulatorInput.encode(message.cylindrical, writer.uint32(26).fork()).join();
1529
+ }
1530
+ if (message.knownPose !== undefined) {
1531
+ message_formats_1.KnownPoseManipulatorInput.encode(message.knownPose, writer.uint32(42).fork()).join();
1532
+ }
1533
+ if (message.speedModifier !== 0) {
1534
+ writer.uint32(37).float(message.speedModifier);
1535
+ }
1518
1536
  return writer;
1519
1537
  },
1520
1538
  decode(input, length) {
@@ -1531,6 +1549,34 @@ exports.GripperCtrl = {
1531
1549
  message.gripperVelocities = message_formats_1.GripperVelocities.decode(reader, reader.uint32());
1532
1550
  continue;
1533
1551
  }
1552
+ case 2: {
1553
+ if (tag !== 18) {
1554
+ break;
1555
+ }
1556
+ message.cartesian = message_formats_1.CartesianManipulatorInput.decode(reader, reader.uint32());
1557
+ continue;
1558
+ }
1559
+ case 3: {
1560
+ if (tag !== 26) {
1561
+ break;
1562
+ }
1563
+ message.cylindrical = message_formats_1.CylindricalManipulatorInput.decode(reader, reader.uint32());
1564
+ continue;
1565
+ }
1566
+ case 5: {
1567
+ if (tag !== 42) {
1568
+ break;
1569
+ }
1570
+ message.knownPose = message_formats_1.KnownPoseManipulatorInput.decode(reader, reader.uint32());
1571
+ continue;
1572
+ }
1573
+ case 4: {
1574
+ if (tag !== 37) {
1575
+ break;
1576
+ }
1577
+ message.speedModifier = reader.float();
1578
+ continue;
1579
+ }
1534
1580
  }
1535
1581
  if ((tag & 7) === 4 || tag === 0) {
1536
1582
  break;
@@ -1544,6 +1590,10 @@ exports.GripperCtrl = {
1544
1590
  gripperVelocities: isSet(object.gripperVelocities)
1545
1591
  ? message_formats_1.GripperVelocities.fromJSON(object.gripperVelocities)
1546
1592
  : undefined,
1593
+ cartesian: isSet(object.cartesian) ? message_formats_1.CartesianManipulatorInput.fromJSON(object.cartesian) : undefined,
1594
+ cylindrical: isSet(object.cylindrical) ? message_formats_1.CylindricalManipulatorInput.fromJSON(object.cylindrical) : undefined,
1595
+ knownPose: isSet(object.knownPose) ? message_formats_1.KnownPoseManipulatorInput.fromJSON(object.knownPose) : undefined,
1596
+ speedModifier: isSet(object.speedModifier) ? gt.Number(object.speedModifier) : 0,
1547
1597
  };
1548
1598
  },
1549
1599
  toJSON(message) {
@@ -1551,6 +1601,18 @@ exports.GripperCtrl = {
1551
1601
  if (message.gripperVelocities !== undefined) {
1552
1602
  obj.gripperVelocities = message_formats_1.GripperVelocities.toJSON(message.gripperVelocities);
1553
1603
  }
1604
+ if (message.cartesian !== undefined) {
1605
+ obj.cartesian = message_formats_1.CartesianManipulatorInput.toJSON(message.cartesian);
1606
+ }
1607
+ if (message.cylindrical !== undefined) {
1608
+ obj.cylindrical = message_formats_1.CylindricalManipulatorInput.toJSON(message.cylindrical);
1609
+ }
1610
+ if (message.knownPose !== undefined) {
1611
+ obj.knownPose = message_formats_1.KnownPoseManipulatorInput.toJSON(message.knownPose);
1612
+ }
1613
+ if (message.speedModifier !== 0) {
1614
+ obj.speedModifier = message.speedModifier;
1615
+ }
1554
1616
  return obj;
1555
1617
  },
1556
1618
  create(base) {
@@ -1561,6 +1623,16 @@ exports.GripperCtrl = {
1561
1623
  message.gripperVelocities = (object.gripperVelocities !== undefined && object.gripperVelocities !== null)
1562
1624
  ? message_formats_1.GripperVelocities.fromPartial(object.gripperVelocities)
1563
1625
  : undefined;
1626
+ message.cartesian = (object.cartesian !== undefined && object.cartesian !== null)
1627
+ ? message_formats_1.CartesianManipulatorInput.fromPartial(object.cartesian)
1628
+ : undefined;
1629
+ message.cylindrical = (object.cylindrical !== undefined && object.cylindrical !== null)
1630
+ ? message_formats_1.CylindricalManipulatorInput.fromPartial(object.cylindrical)
1631
+ : undefined;
1632
+ message.knownPose = (object.knownPose !== undefined && object.knownPose !== null)
1633
+ ? message_formats_1.KnownPoseManipulatorInput.fromPartial(object.knownPose)
1634
+ : undefined;
1635
+ message.speedModifier = object.speedModifier ?? 0;
1564
1636
  return message;
1565
1637
  },
1566
1638
  };
@@ -2292,6 +2364,78 @@ exports.SetColorCorrectionCtrl = {
2292
2364
  return message;
2293
2365
  },
2294
2366
  };
2367
+ function createBaseSetMarineSnowFilterCtrl() {
2368
+ return { marineSnowFilter: undefined, frames: undefined };
2369
+ }
2370
+ exports.SetMarineSnowFilterCtrl = {
2371
+ encode(message, writer = new wire_1.BinaryWriter()) {
2372
+ if (message.marineSnowFilter !== undefined) {
2373
+ message_formats_1.FilterMessage.encode(message.marineSnowFilter, writer.uint32(10).fork()).join();
2374
+ }
2375
+ if (message.frames !== undefined) {
2376
+ message_formats_1.MarineSnowFilterFrames.encode(message.frames, writer.uint32(18).fork()).join();
2377
+ }
2378
+ return writer;
2379
+ },
2380
+ decode(input, length) {
2381
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
2382
+ const end = length === undefined ? reader.len : reader.pos + length;
2383
+ const message = createBaseSetMarineSnowFilterCtrl();
2384
+ while (reader.pos < end) {
2385
+ const tag = reader.uint32();
2386
+ switch (tag >>> 3) {
2387
+ case 1: {
2388
+ if (tag !== 10) {
2389
+ break;
2390
+ }
2391
+ message.marineSnowFilter = message_formats_1.FilterMessage.decode(reader, reader.uint32());
2392
+ continue;
2393
+ }
2394
+ case 2: {
2395
+ if (tag !== 18) {
2396
+ break;
2397
+ }
2398
+ message.frames = message_formats_1.MarineSnowFilterFrames.decode(reader, reader.uint32());
2399
+ continue;
2400
+ }
2401
+ }
2402
+ if ((tag & 7) === 4 || tag === 0) {
2403
+ break;
2404
+ }
2405
+ reader.skip(tag & 7);
2406
+ }
2407
+ return message;
2408
+ },
2409
+ fromJSON(object) {
2410
+ return {
2411
+ marineSnowFilter: isSet(object.marineSnowFilter) ? message_formats_1.FilterMessage.fromJSON(object.marineSnowFilter) : undefined,
2412
+ frames: isSet(object.frames) ? message_formats_1.MarineSnowFilterFrames.fromJSON(object.frames) : undefined,
2413
+ };
2414
+ },
2415
+ toJSON(message) {
2416
+ const obj = {};
2417
+ if (message.marineSnowFilter !== undefined) {
2418
+ obj.marineSnowFilter = message_formats_1.FilterMessage.toJSON(message.marineSnowFilter);
2419
+ }
2420
+ if (message.frames !== undefined) {
2421
+ obj.frames = message_formats_1.MarineSnowFilterFrames.toJSON(message.frames);
2422
+ }
2423
+ return obj;
2424
+ },
2425
+ create(base) {
2426
+ return exports.SetMarineSnowFilterCtrl.fromPartial(base ?? {});
2427
+ },
2428
+ fromPartial(object) {
2429
+ const message = createBaseSetMarineSnowFilterCtrl();
2430
+ message.marineSnowFilter = (object.marineSnowFilter !== undefined && object.marineSnowFilter !== null)
2431
+ ? message_formats_1.FilterMessage.fromPartial(object.marineSnowFilter)
2432
+ : undefined;
2433
+ message.frames = (object.frames !== undefined && object.frames !== null)
2434
+ ? message_formats_1.MarineSnowFilterFrames.fromPartial(object.frames)
2435
+ : undefined;
2436
+ return message;
2437
+ },
2438
+ };
2295
2439
  function createBaseCameraPanTiltZoomCtrl() {
2296
2440
  return { cameraPanTiltZoom: undefined };
2297
2441
  }