@blueyerobotics/protocol-definitions 3.2.0-0a6e99a1

package/dist/control.d.ts

@@ -0,0 +1,277 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { SetAquaTrollConnectionStatus, SetAquaTrollParameterUnit } from "./aquatroll";
+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";
+/**
+ * Control
+ *
+ * These messages define control messages accepted by the Blueye drone.
+ */
+/** Issue a command to move the drone in the surge, sway, heave, or yaw direction. */
+export interface MotionInputCtrl {
+    /** Message with the desired movement in each direction. */
+    motionInput: MotionInput | undefined;
+}
+/** Issue a command to tilt the drone camera. */
+export interface TiltVelocityCtrl {
+    /** Message with the desired tilt velocity (direction and speed). */
+    velocity: TiltVelocity | undefined;
+}
+/** Issue a command to set the main light intensity. */
+export interface LightsCtrl {
+    /** Message with the desired light intensity. */
+    lights: Lights | undefined;
+}
+/** Issue a command to set the guest port light intensity. */
+export interface GuestportLightsCtrl {
+    /** Message with the desired light intensity. */
+    lights: Lights | undefined;
+}
+/** Issue a command to set the laser intensity. */
+export interface LaserCtrl {
+    /** Message with the desired laser intensity. */
+    laser: Laser | undefined;
+}
+/** Issue a command with the GPS position of the pilot. */
+export interface PilotGPSPositionCtrl {
+    /** The GPS position of the pilot. */
+    position: LatLongPosition | undefined;
+}
+/**
+ * Issue a watchdog message to indicate that the remote client is connected and working as expected.
+ *
+ * If a watchdog message is not received every second, the drone will turn off lights and other auto
+ * functions to indicate that connection with the client has been lost.
+ */
+export interface WatchdogCtrl {
+    /** Message with the number of seconds the client has been connected. */
+    connectionDuration: ConnectionDuration | undefined;
+    /** The ID of the client, received in the ConnectClientRep response. */
+    clientId: number;
+}
+/** Issue a command to start video or multibeam recording. */
+export interface RecordCtrl {
+    /** Message specifying which cameras to record. */
+    recordOn: RecordOn | undefined;
+    /** Storage location to use for the recordings. */
+    storageLocation: StorageLocation;
+}
+/** Issue a command to take a picture. */
+export interface TakePictureCtrl {
+    /** Storage location to use for the picture. */
+    storageLocation: StorageLocation;
+}
+/** Issue a command to start compass calibration. */
+export interface StartCalibrationCtrl {
+}
+/** Issue a command to cancel compass calibration. */
+export interface CancelCalibrationCtrl {
+}
+/** Issue a command to finish compass calibration. */
+export interface FinishCalibrationCtrl {
+}
+/** Issue a command to set auto heading to a desired state. */
+export interface AutoHeadingCtrl {
+    /** State of the heading controller. */
+    state: AutoHeadingState | undefined;
+}
+/** Issue a command to set auto depth to a desired state. */
+export interface AutoDepthCtrl {
+    /** State of the depth controller. */
+    state: AutoDepthState | undefined;
+}
+/** Issue a command to set auto altitude to a desired state. */
+export interface AutoAltitudeCtrl {
+    /** State of the altitude controller. */
+    state: AutoAltitudeState | undefined;
+}
+/** Issue a command to set station keeping to a desired state. */
+export interface StationKeepingCtrl {
+    /** State of the station keeping controller. */
+    state: StationKeepingState | undefined;
+}
+/** Issue a command to set station keeping with weather vaning to a desired state. */
+export interface WeatherVaningCtrl {
+    /** State of the weather vaning controller. */
+    state: WeatherVaningState | undefined;
+}
+/** Issue a command to set Auto Pilot for cruising and turning to a desired state. */
+export interface AutoPilotSurgeYawCtrl {
+    /** State of the auto pilot surge yaw controller. */
+    state: AutoPilotSurgeYawState | undefined;
+}
+/** Issue a command to set Auto Pilot for vertiacl movement to a desired state. */
+export interface AutoPilotHeaveCtrl {
+    /** State of the auto pilot heave controller- */
+    state: AutoPilotHeaveState | undefined;
+}
+/** Issue a command to start and pause the loaded mission. */
+export interface RunMissionCtrl {
+}
+/** Issue a command to pause the loaded mission. */
+export interface PauseMissionCtrl {
+}
+/** Clear the loaded mission. */
+export interface ClearMissionCtrl {
+}
+/** Issue a command to reset the position estimate. */
+export interface ResetPositionCtrl {
+    /** Reset settings. */
+    settings: ResetPositionSettings | undefined;
+}
+/** Issue a command to reset the odometer. */
+export interface ResetOdometerCtrl {
+}
+/** Issue a command to calibrate the DVL gyro. */
+export interface CalibrateDvlGyroCtrl {
+}
+/** Issue a command to enable or disable tilt stabilization. */
+export interface TiltStabilizationCtrl {
+    /** Message with the tilt stabilization state to set. */
+    state: TiltStabilizationState | undefined;
+}
+/** Issue a command to set the water density. */
+export interface WaterDensityCtrl {
+    /** Message with the water density to set. */
+    density: WaterDensity | undefined;
+}
+/** Issue a command to set the pinger configuration. */
+export interface PingerConfigurationCtrl {
+    /** Message with the pinger configuration to set. */
+    configuration: PingerConfiguration | undefined;
+}
+/** Issue a command to set the system time on the drone. */
+export interface SystemTimeCtrl {
+    /** Message with the system time to set. */
+    systemTime: SystemTime | undefined;
+}
+/** Issue a command to control the gripper. */
+export interface GripperCtrl {
+    /** The desired gripping and rotation velocity. */
+    gripperVelocities: GripperVelocities | undefined;
+}
+/** Issue a command to set a generic servo value. */
+export interface GenericServoCtrl {
+    /** Message with the desired servo value. */
+    servo: GenericServo | undefined;
+}
+/** Issue a command to set multibeam servo angle. */
+export interface MultibeamServoCtrl {
+    /** Message with the desired servo angle. */
+    servo: MultibeamServo | undefined;
+}
+/** Deactivate the guest port power. */
+export interface DeactivateGuestPortsCtrl {
+}
+/** Activated the guest port power. */
+export interface ActivateGuestPortsCtrl {
+}
+/** Restart the guest ports by turning power on and off. */
+export interface RestartGuestPortsCtrl {
+    /** Message with information about how long to keep the guest ports off. */
+    restartInfo: GuestPortRestartInfo | undefined;
+}
+/** Request to set an In-Situ Aqua Troll parameter unit. */
+export interface SetAquaTrollParameterUnitCtrl {
+    /** Message with information about which parameter to set and the unit to set it to. */
+    parameterInfo: SetAquaTrollParameterUnit | undefined;
+}
+/** Request to change the In-Situ Aqua Troll connection status. */
+export interface SetAquaTrollConnectionStatusCtrl {
+    /** Message with information about which parameter to set and the unit to set it to. */
+    connectionStatus: SetAquaTrollConnectionStatus | undefined;
+}
+/** Update the multibeam settings. */
+export interface SetMultibeamConfigCtrl {
+    /** Message with the multibeam ping configuration to set. */
+    config: MultibeamConfig | undefined;
+}
+/** Activate the multibeam with specified configuration. */
+export interface ActivateMultibeamCtrl {
+    /** Message with the multibeam ping configuration to set on connect. */
+    config: MultibeamConfig | undefined;
+}
+/** Deactivate the multibeam. */
+export interface DeactivateMultibeamCtrl {
+}
+/**
+ * Message sent when the user hits the start dive button in the app.
+ *
+ * The message does not do anything, but is included in the log files so we can see
+ * at which point the user entered the dive view.
+ */
+export interface StartDiveCtrl {
+}
+/**
+ * Message sent when the user hits the end dive button in the app.
+ *
+ * The message does not do anything, but is included in the log files so we can see
+ * at which point the user exited the dive view.
+ */
+export interface EndDiveCtrl {
+}
+/**
+ * Message sent when the user wants to format a connected removable storage device.
+ *
+ * The app will receive a RemovableStorageTel message with information about the newly formatted drive.
+ *
+ * Warning: The drone will delete any partitions and format the drive with a single exFat partition.
+ * Any data on the drive will be lost.
+ */
+export interface FormatRemovableStorageDeviceCtrl {
+}
+export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
+export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
+export declare const LightsCtrl: MessageFns<LightsCtrl>;
+export declare const GuestportLightsCtrl: MessageFns<GuestportLightsCtrl>;
+export declare const LaserCtrl: MessageFns<LaserCtrl>;
+export declare const PilotGPSPositionCtrl: MessageFns<PilotGPSPositionCtrl>;
+export declare const WatchdogCtrl: MessageFns<WatchdogCtrl>;
+export declare const RecordCtrl: MessageFns<RecordCtrl>;
+export declare const TakePictureCtrl: MessageFns<TakePictureCtrl>;
+export declare const StartCalibrationCtrl: MessageFns<StartCalibrationCtrl>;
+export declare const CancelCalibrationCtrl: MessageFns<CancelCalibrationCtrl>;
+export declare const FinishCalibrationCtrl: MessageFns<FinishCalibrationCtrl>;
+export declare const AutoHeadingCtrl: MessageFns<AutoHeadingCtrl>;
+export declare const AutoDepthCtrl: MessageFns<AutoDepthCtrl>;
+export declare const AutoAltitudeCtrl: MessageFns<AutoAltitudeCtrl>;
+export declare const StationKeepingCtrl: MessageFns<StationKeepingCtrl>;
+export declare const WeatherVaningCtrl: MessageFns<WeatherVaningCtrl>;
+export declare const AutoPilotSurgeYawCtrl: MessageFns<AutoPilotSurgeYawCtrl>;
+export declare const AutoPilotHeaveCtrl: MessageFns<AutoPilotHeaveCtrl>;
+export declare const RunMissionCtrl: MessageFns<RunMissionCtrl>;
+export declare const PauseMissionCtrl: MessageFns<PauseMissionCtrl>;
+export declare const ClearMissionCtrl: MessageFns<ClearMissionCtrl>;
+export declare const ResetPositionCtrl: MessageFns<ResetPositionCtrl>;
+export declare const ResetOdometerCtrl: MessageFns<ResetOdometerCtrl>;
+export declare const CalibrateDvlGyroCtrl: MessageFns<CalibrateDvlGyroCtrl>;
+export declare const TiltStabilizationCtrl: MessageFns<TiltStabilizationCtrl>;
+export declare const WaterDensityCtrl: MessageFns<WaterDensityCtrl>;
+export declare const PingerConfigurationCtrl: MessageFns<PingerConfigurationCtrl>;
+export declare const SystemTimeCtrl: MessageFns<SystemTimeCtrl>;
+export declare const GripperCtrl: MessageFns<GripperCtrl>;
+export declare const GenericServoCtrl: MessageFns<GenericServoCtrl>;
+export declare const MultibeamServoCtrl: MessageFns<MultibeamServoCtrl>;
+export declare const DeactivateGuestPortsCtrl: MessageFns<DeactivateGuestPortsCtrl>;
+export declare const ActivateGuestPortsCtrl: MessageFns<ActivateGuestPortsCtrl>;
+export declare const RestartGuestPortsCtrl: MessageFns<RestartGuestPortsCtrl>;
+export declare const SetAquaTrollParameterUnitCtrl: MessageFns<SetAquaTrollParameterUnitCtrl>;
+export declare const SetAquaTrollConnectionStatusCtrl: MessageFns<SetAquaTrollConnectionStatusCtrl>;
+export declare const SetMultibeamConfigCtrl: MessageFns<SetMultibeamConfigCtrl>;
+export declare const ActivateMultibeamCtrl: MessageFns<ActivateMultibeamCtrl>;
+export declare const DeactivateMultibeamCtrl: MessageFns<DeactivateMultibeamCtrl>;
+export declare const StartDiveCtrl: MessageFns<StartDiveCtrl>;
+export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
+export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+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 {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
+}
+export {};