@blueyerobotics/protocol-definitions 3.2.0-0a6e99a1

package/dist/telemetry.d.ts

@@ -0,0 +1,389 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { AquaTrollProbeMetadata, AquaTrollSensorMetadataArray, AquaTrollSensorParametersArray } from "./aquatroll";
+import { Altitude, Attitude, Battery, BatteryBQ40Z50, CalibrationState, CanisterHumidity, CanisterTemperature, ConnectedClient, ControlForce, ControllerHealth, ControlMode, CpProbe, CPUInfo, CPUTemperature, Depth, DiveTime, DroneInfo, DvlVelocity, ErrorFlags, ForwardDistance, GenericServo, GuestPortCurrent, Imu, IperfStatus, KernelLogEntry, Laser, LatLongPosition, Lights, LogEntry, MagneticDeclination, MedusaSpectrometerData, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers, PositionEstimate, RecordState, Reference, RemovableStorageDevice, StorageSpace, SurfaceUnitBatteryInfo, SurfaceUnitVersionInfo, SystemTime, ThicknessGauge, TiltAngle, TiltStabilizationState, TimeLapseState, WaterTemperature } from "./message_formats";
+import { MissionStatus, ReferenceAutoPilot } from "./mission_planning";
+/**
+ * Telemetry
+ *
+ * These messages define telemetry messages from the Blueye drone.
+ */
+/** Receive the current attitude of the drone. */
+export interface AttitudeTel {
+    /** The attitude of the drone. */
+    attitude: Attitude | undefined;
+}
+/** Current Magnetic Declination status. Used to get true North compass readings based on location. */
+export interface MagneticDeclinationTel {
+    /** The current magnetic declination status of the drone. */
+    magneticDeclination: MagneticDeclination | undefined;
+}
+/** Receive the current altitude of the drone. */
+export interface AltitudeTel {
+    /** The altitude of the drone. */
+    altitude: Altitude | undefined;
+}
+/** Distance to an object in front of the drone when a 1D pinger is mounted forwards. */
+export interface ForwardDistanceTel {
+    /** The distance to an object in front of the drone. */
+    forwardDistance: ForwardDistance | undefined;
+}
+/** Dvl raw sensor data. */
+export interface DvlVelocityTel {
+    /** Dvl velocity data. */
+    dvlVelocity: DvlVelocity | undefined;
+}
+/** Position estimate of the drone if a DVL or a positioning system is available. */
+export interface PositionEstimateTel {
+    /** Position estimate of the drone. */
+    positionEstimate: PositionEstimate | undefined;
+}
+/** Measurement of the drones position relative to the sea surface. */
+export interface DepthTel {
+    /** The depth of the drone. */
+    depth: Depth | undefined;
+}
+/** Reference signals indicating desired states. */
+export interface ReferenceTel {
+    /** Reference signals. */
+    reference: Reference | undefined;
+}
+/** Reference for the auto pilot when a mission is active. */
+export interface ReferenceAutoPilotTel {
+    /** Reference for the auto pilot. */
+    referenceAutoPilot: ReferenceAutoPilot | undefined;
+}
+/** Mission status from the mission supervisor. */
+export interface MissionStatusTel {
+    /** Mission status. */
+    missionStatus: MissionStatus | undefined;
+}
+/** Notification from the control system. */
+export interface NotificationTel {
+    /** Notification from the control system. */
+    notification: Notification | undefined;
+}
+/** Control force in all directions. */
+export interface ControlForceTel {
+    /** Control force in all directions. */
+    controlForce: ControlForce | undefined;
+}
+/** Controller health indicating the load of the controller, used to set a color in the heading and depth bar. */
+export interface ControllerHealthTel {
+    /** Controller health. */
+    controllerHealth: ControllerHealth | undefined;
+}
+/** Receive the status of the main lights of the drone. */
+export interface LightsTel {
+    /** Main light status. */
+    lights: Lights | undefined;
+}
+/** Receive the status of any guest port lights connected to the drone. */
+export interface GuestPortLightsTel {
+    /** Guest port light status. */
+    lights: Lights | undefined;
+}
+/** Receive the status of any lasers connected to the drone. */
+export interface LaserTel {
+    /** Laser status. */
+    laser: Laser | undefined;
+}
+/** Pilot position (originating from device GPS) for logging. */
+export interface PilotGPSPositionTel {
+    /** The GPS position of the pilot. */
+    position: LatLongPosition | undefined;
+}
+/** Record state from the drone. */
+export interface RecordStateTel {
+    /** Record state. */
+    recordState: RecordState | undefined;
+}
+/** Time-lapse state from the drone. */
+export interface TimeLapseStateTel {
+    /** Time-lapse state. */
+    timeLapseState: TimeLapseState | undefined;
+}
+/** Receive essential information about the battery status. */
+export interface BatteryTel {
+    /** Essential battery information. */
+    battery: Battery | undefined;
+}
+/**
+ * Receive detailed information about a battery using the
+ * BQ40Z50 battery management system.
+ */
+export interface BatteryBQ40Z50Tel {
+    /** Detailed battery information. */
+    battery: BatteryBQ40Z50 | undefined;
+}
+/** Receive the dive time of the drone. */
+export interface DiveTimeTel {
+    /** The current dive time of the drone. */
+    diveTime: DiveTime | undefined;
+}
+/** Receive time information from the drone. */
+export interface DroneTimeTel {
+    /** The real-time clock of the drone. */
+    realTimeClock: SystemTime | undefined;
+    /** The monotonic clock of the drone (time since power on). */
+    monotonicClock: SystemTime | undefined;
+}
+/** Water temperature from the depth sensor. */
+export interface WaterTemperatureTel {
+    /** Water temperature. */
+    temperature: WaterTemperature | undefined;
+}
+/** Drone CPU temperature */
+export interface CPUTemperatureTel {
+    /** CPU temperature. */
+    temperature: CPUTemperature | undefined;
+}
+/** Receive temperature information from the bottom canister. */
+export interface CanisterBottomTemperatureTel {
+    /** Temperature information. */
+    temperature: CanisterTemperature | undefined;
+}
+/** Receive humidity information from the bottom canister. */
+export interface CanisterBottomHumidityTel {
+    /** Humidity information. */
+    humidity: CanisterHumidity | undefined;
+}
+/** Video storage info. */
+export interface VideoStorageSpaceTel {
+    /** Internal Video storage information. */
+    storageSpace: StorageSpace | undefined;
+    /** Removable Video storage information. Can be empty. */
+    removableSpace: StorageSpace | undefined;
+}
+/** Information about removable storage device. */
+export interface RemovableStorageTel {
+    /** Information about the storage device (such as partitions) */
+    storageDevice: RemovableStorageDevice | undefined;
+}
+/** Data storage info. */
+export interface DataStorageSpaceTel {
+    /** Data storage information. */
+    storageSpace: StorageSpace | undefined;
+}
+/** Calibration state used for calibration routine. */
+export interface CalibrationStateTel {
+    /** Calibration state. */
+    calibrationState: CalibrationState | undefined;
+}
+/** Tilt stabilization state. */
+export interface TiltStabilizationTel {
+    /** Tilt stabilization state. */
+    state: TiltStabilizationState | undefined;
+}
+/** Iperf indicates the available bandwidth on the tether from drone to surface unit. */
+export interface IperfTel {
+    /** Information about the available bandwidth. */
+    status: IperfStatus | undefined;
+}
+/** Number of connected clients streaming video. */
+export interface NStreamersTel {
+    /** Information about the number of connected clients. */
+    nStreamers: NStreamers | undefined;
+}
+/** Tilt angle state on main camera. */
+export interface TiltAngleTel {
+    /** Main camera tilt angle. */
+    angle: TiltAngle | undefined;
+}
+/** Receive metadata and information about the connected drone. */
+export interface DroneInfoTel {
+    /** Various metadata such as software versions and serial number. */
+    droneInfo: DroneInfo | undefined;
+}
+/** Receive currently set error flags. */
+export interface ErrorFlagsTel {
+    /** Currently set error flags on the drone. */
+    errorFlags: ErrorFlags | undefined;
+}
+/** Receive the current state of the control system. */
+export interface ControlModeTel {
+    /** State of the control system. */
+    state: ControlMode | undefined;
+}
+/** Thickness gauge measurement telemetry message. */
+export interface ThicknessGaugeTel {
+    /** Thickness measurement with a cygnus gauge. */
+    thicknessGauge: ThicknessGauge | undefined;
+}
+/** Cathodic Protection Potential probe telemetry message */
+export interface CpProbeTel {
+    /** Reading from cp probe. */
+    cpProbe: CpProbe | undefined;
+}
+/** Metadata from the In-Situ Aqua Troll probe's common registers */
+export interface AquaTrollProbeMetadataTel {
+    /** AquaTroll message containing sensor array. */
+    probe: AquaTrollProbeMetadata | undefined;
+}
+/** Metadata from a single sensor from In-Situ Aqua Troll probe */
+export interface AquaTrollSensorMetadataTel {
+    /** AquaTroll message containing sensor array. */
+    sensors: AquaTrollSensorMetadataArray | undefined;
+}
+/** Single sensor from In-Situ Aqua Troll probe */
+export interface AquaTrollSensorParametersTel {
+    /** AquaTroll message containing parameter array. */
+    sensors: AquaTrollSensorParametersArray | undefined;
+}
+/** List of connected clients telemetry message. */
+export interface ConnectedClientsTel {
+    /** The client id of the client in control. */
+    clientIdInControl: number;
+    /** List of connected clients. */
+    connectedClients: ConnectedClient[];
+}
+/** State of a generic servo. */
+export interface GenericServoTel {
+    /** Servo state. */
+    servo: GenericServo | undefined;
+}
+/** State of the servo installed in the multibeam. */
+export interface MultibeamServoTel {
+    /** Multibeam servo state. */
+    servo: MultibeamServo | undefined;
+}
+/** GuestPort current readings. */
+export interface GuestPortCurrentTel {
+    /** Guest port current readings. */
+    current: GuestPortCurrent | undefined;
+}
+/** Calibrated IMU data. */
+export interface CalibratedImuTel {
+    /** Calibrated IMU data. */
+    imu: Imu | undefined;
+}
+/** Raw IMU data from IMU 1 */
+export interface Imu1Tel {
+    /** Raw IMU data. */
+    imu: Imu | undefined;
+}
+/** Raw IMU data from IMU 2 */
+export interface Imu2Tel {
+    /** Raw IMU data. */
+    imu: Imu | undefined;
+}
+/** Raw IMU data from High Precision IMU */
+export interface ImuHpTel {
+    /** Raw High Precision IMU data (no magnetometer) */
+    imu: Imu | undefined;
+}
+/** Calibrated High Precision IMU data */
+export interface CalibratedImuHpTel {
+    /** Calibrated High Precision IMU (no magnetometer) */
+    imu: Imu | undefined;
+}
+/** Medusa gamma ray sensor spectrometer data. */
+export interface MedusaSpectrometerDataTel {
+    /** Medusa gamma ray sensor spectrometer data. */
+    data: MedusaSpectrometerData | undefined;
+}
+/** Multibeam sonar ping data. */
+export interface MultibeamPingTel {
+    /** Ping data from a multibeam sonar. */
+    ping: MultibeamPing | undefined;
+}
+/** Multibeam sonar config. */
+export interface MultibeamConfigTel {
+    /** Config data from a multibeam sonar. */
+    config: MultibeamConfig | undefined;
+}
+/** Multibeam sonar status message. */
+export interface MultibeamDiscoveryTel {
+    /** Discovery data from a multibeam sonar. */
+    discovery: MultibeamDiscovery | undefined;
+}
+/** Information about cpu and memory usage. */
+export interface CPUInfoTel {
+    /** CPU information. */
+    cpuInfo: CPUInfo | undefined;
+}
+/** Surface Unit telemetry message. */
+export interface SurfaceUnitTel {
+    /** Battery information. */
+    batteryInfo: SurfaceUnitBatteryInfo | undefined;
+    /** Version information. */
+    versionInfo: SurfaceUnitVersionInfo | undefined;
+}
+/** Log entry telemetry message. */
+export interface LogEntryTel {
+    /** Blunux log entry. */
+    blunux?: LogEntry | undefined;
+    /** Kernel log entry. */
+    kernel?: KernelLogEntry | undefined;
+}
+export declare const AttitudeTel: MessageFns<AttitudeTel>;
+export declare const MagneticDeclinationTel: MessageFns<MagneticDeclinationTel>;
+export declare const AltitudeTel: MessageFns<AltitudeTel>;
+export declare const ForwardDistanceTel: MessageFns<ForwardDistanceTel>;
+export declare const DvlVelocityTel: MessageFns<DvlVelocityTel>;
+export declare const PositionEstimateTel: MessageFns<PositionEstimateTel>;
+export declare const DepthTel: MessageFns<DepthTel>;
+export declare const ReferenceTel: MessageFns<ReferenceTel>;
+export declare const ReferenceAutoPilotTel: MessageFns<ReferenceAutoPilotTel>;
+export declare const MissionStatusTel: MessageFns<MissionStatusTel>;
+export declare const NotificationTel: MessageFns<NotificationTel>;
+export declare const ControlForceTel: MessageFns<ControlForceTel>;
+export declare const ControllerHealthTel: MessageFns<ControllerHealthTel>;
+export declare const LightsTel: MessageFns<LightsTel>;
+export declare const GuestPortLightsTel: MessageFns<GuestPortLightsTel>;
+export declare const LaserTel: MessageFns<LaserTel>;
+export declare const PilotGPSPositionTel: MessageFns<PilotGPSPositionTel>;
+export declare const RecordStateTel: MessageFns<RecordStateTel>;
+export declare const TimeLapseStateTel: MessageFns<TimeLapseStateTel>;
+export declare const BatteryTel: MessageFns<BatteryTel>;
+export declare const BatteryBQ40Z50Tel: MessageFns<BatteryBQ40Z50Tel>;
+export declare const DiveTimeTel: MessageFns<DiveTimeTel>;
+export declare const DroneTimeTel: MessageFns<DroneTimeTel>;
+export declare const WaterTemperatureTel: MessageFns<WaterTemperatureTel>;
+export declare const CPUTemperatureTel: MessageFns<CPUTemperatureTel>;
+export declare const CanisterBottomTemperatureTel: MessageFns<CanisterBottomTemperatureTel>;
+export declare const CanisterBottomHumidityTel: MessageFns<CanisterBottomHumidityTel>;
+export declare const VideoStorageSpaceTel: MessageFns<VideoStorageSpaceTel>;
+export declare const RemovableStorageTel: MessageFns<RemovableStorageTel>;
+export declare const DataStorageSpaceTel: MessageFns<DataStorageSpaceTel>;
+export declare const CalibrationStateTel: MessageFns<CalibrationStateTel>;
+export declare const TiltStabilizationTel: MessageFns<TiltStabilizationTel>;
+export declare const IperfTel: MessageFns<IperfTel>;
+export declare const NStreamersTel: MessageFns<NStreamersTel>;
+export declare const TiltAngleTel: MessageFns<TiltAngleTel>;
+export declare const DroneInfoTel: MessageFns<DroneInfoTel>;
+export declare const ErrorFlagsTel: MessageFns<ErrorFlagsTel>;
+export declare const ControlModeTel: MessageFns<ControlModeTel>;
+export declare const ThicknessGaugeTel: MessageFns<ThicknessGaugeTel>;
+export declare const CpProbeTel: MessageFns<CpProbeTel>;
+export declare const AquaTrollProbeMetadataTel: MessageFns<AquaTrollProbeMetadataTel>;
+export declare const AquaTrollSensorMetadataTel: MessageFns<AquaTrollSensorMetadataTel>;
+export declare const AquaTrollSensorParametersTel: MessageFns<AquaTrollSensorParametersTel>;
+export declare const ConnectedClientsTel: MessageFns<ConnectedClientsTel>;
+export declare const GenericServoTel: MessageFns<GenericServoTel>;
+export declare const MultibeamServoTel: MessageFns<MultibeamServoTel>;
+export declare const GuestPortCurrentTel: MessageFns<GuestPortCurrentTel>;
+export declare const CalibratedImuTel: MessageFns<CalibratedImuTel>;
+export declare const Imu1Tel: MessageFns<Imu1Tel>;
+export declare const Imu2Tel: MessageFns<Imu2Tel>;
+export declare const ImuHpTel: MessageFns<ImuHpTel>;
+export declare const CalibratedImuHpTel: MessageFns<CalibratedImuHpTel>;
+export declare const MedusaSpectrometerDataTel: MessageFns<MedusaSpectrometerDataTel>;
+export declare const MultibeamPingTel: MessageFns<MultibeamPingTel>;
+export declare const MultibeamConfigTel: MessageFns<MultibeamConfigTel>;
+export declare const MultibeamDiscoveryTel: MessageFns<MultibeamDiscoveryTel>;
+export declare const CPUInfoTel: MessageFns<CPUInfoTel>;
+export declare const SurfaceUnitTel: MessageFns<SurfaceUnitTel>;
+export declare const LogEntryTel: MessageFns<LogEntryTel>;
+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 {};