@blueyerobotics/protocol-definitions 3.3.0-e472bef2 → 3.4.0-618bf0b0

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
- 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";
2
+ import { SetAquaTrollConnectionStatus, SetAquaTrollParameterUnit } from "./aquatroll.js";
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.js";
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>;