@blueyerobotics/protocol-definitions 3.2.0-09fee2ba → 3.2.0-0c4af895
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 +75 -1
- package/dist/control.js +443 -7
- package/dist/message_formats.d.ts +703 -13
- package/dist/message_formats.js +4526 -119
- package/dist/mission_planning.d.ts +54 -0
- package/dist/mission_planning.js +243 -1
- package/dist/req_rep.d.ts +24 -0
- package/dist/req_rep.js +208 -1
- package/dist/telemetry.d.ts +96 -3
- package/dist/telemetry.js +491 -11
- package/package.json +1 -1
package/dist/telemetry.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
|
|
2
2
|
import { AquaTrollProbeMetadata, AquaTrollSensorMetadataArray, AquaTrollSensorParametersArray } from "./aquatroll";
|
|
3
|
-
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";
|
|
3
|
+
import { Altitude, Annotation, Attitude, Battery, BatteryBQ40Z50, CalibrationState, CameraPanTiltZoom, CanisterHumidity, CanisterTemperature, ConnectedClient, ControlForce, ControllerHealth, ControlMode, CpProbe, CPUInfo, CPUTemperature, Depth, DiveTime, DroneInfo, DvlVelocity, ErrorFlags, FilterMessage, ForwardDistance, GenericServo, GuestPortCurrent, Imu, IperfStatus, KernelLogEntry, Laser, LaserDetection, LatLongPosition, Lights, LogEntry, MagneticDeclination, MedusaSpectrometerData, ModelDetections, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers, PositionEstimate, RecordState, Reference, RemovableStorageDevice, SotState, StorageSpace, SurfaceUnitBatteryInfo, SurfaceUnitVersionInfo, SystemPerformanceInfo, SystemTime, ThicknessGauge, TiltAngle, TiltStabilizationState, TimeLapseState, WaterTemperature } from "./message_formats";
|
|
4
4
|
import { MissionStatus, ReferenceAutoPilot } from "./mission_planning";
|
|
5
5
|
/**
|
|
6
6
|
* Telemetry
|
|
@@ -86,6 +86,8 @@ export interface GuestPortLightsTel {
|
|
|
86
86
|
export interface LaserTel {
|
|
87
87
|
/** Laser status. */
|
|
88
88
|
laser: Laser | undefined;
|
|
89
|
+
/** Detection of the laser by the computer vision pipeline. Only */
|
|
90
|
+
laserDetection: LaserDetection | undefined;
|
|
89
91
|
}
|
|
90
92
|
/** Pilot position (originating from device GPS) for logging. */
|
|
91
93
|
export interface PilotGPSPositionTel {
|
|
@@ -102,18 +104,32 @@ export interface TimeLapseStateTel {
|
|
|
102
104
|
/** Time-lapse state. */
|
|
103
105
|
timeLapseState: TimeLapseState | undefined;
|
|
104
106
|
}
|
|
105
|
-
/**
|
|
107
|
+
/**
|
|
108
|
+
* Receive essential information about the battery status.
|
|
109
|
+
*
|
|
110
|
+
* On models with two batteries running in parallel (e.g. the X7), second_battery
|
|
111
|
+
* holds the essential information for the second battery. When only a single
|
|
112
|
+
* battery is used, second_battery is undefined (not set).
|
|
113
|
+
*/
|
|
106
114
|
export interface BatteryTel {
|
|
107
115
|
/** Essential battery information. */
|
|
108
116
|
battery: Battery | undefined;
|
|
117
|
+
/** Second battery, when present. Not set if only one battery is used. */
|
|
118
|
+
secondBattery: Battery | undefined;
|
|
109
119
|
}
|
|
110
120
|
/**
|
|
111
121
|
* Receive detailed information about a battery using the
|
|
112
122
|
* BQ40Z50 battery management system.
|
|
123
|
+
*
|
|
124
|
+
* On models with two batteries running in parallel (e.g. the X7), second_battery
|
|
125
|
+
* holds the detailed information for the second battery. When only a single
|
|
126
|
+
* battery is used, second_battery is undefined (not set).
|
|
113
127
|
*/
|
|
114
128
|
export interface BatteryBQ40Z50Tel {
|
|
115
129
|
/** Detailed battery information. */
|
|
116
130
|
battery: BatteryBQ40Z50 | undefined;
|
|
131
|
+
/** Second battery, when present. Not set if only one battery is used. */
|
|
132
|
+
secondBattery: BatteryBQ40Z50 | undefined;
|
|
117
133
|
}
|
|
118
134
|
/** Receive the dive time of the drone. */
|
|
119
135
|
export interface DiveTimeTel {
|
|
@@ -240,11 +256,15 @@ export interface ConnectedClientsTel {
|
|
|
240
256
|
export interface GenericServoTel {
|
|
241
257
|
/** Servo state. */
|
|
242
258
|
servo: GenericServo | undefined;
|
|
259
|
+
/** Servo set point (0..1). */
|
|
260
|
+
setPoint: number;
|
|
243
261
|
}
|
|
244
262
|
/** State of the servo installed in the multibeam. */
|
|
245
263
|
export interface MultibeamServoTel {
|
|
246
264
|
/** Multibeam servo state. */
|
|
247
265
|
servo: MultibeamServo | undefined;
|
|
266
|
+
/** Servo set point (-30..30). */
|
|
267
|
+
setPoint: number;
|
|
248
268
|
}
|
|
249
269
|
/** GuestPort current readings. */
|
|
250
270
|
export interface GuestPortCurrentTel {
|
|
@@ -296,11 +316,21 @@ export interface MultibeamDiscoveryTel {
|
|
|
296
316
|
/** Discovery data from a multibeam sonar. */
|
|
297
317
|
discovery: MultibeamDiscovery | undefined;
|
|
298
318
|
}
|
|
299
|
-
/** Information about
|
|
319
|
+
/** Information about CPU and memory usage (deprecated, use SystemPerformanceInfoTel instead). */
|
|
300
320
|
export interface CPUInfoTel {
|
|
301
321
|
/** CPU information. */
|
|
302
322
|
cpuInfo: CPUInfo | undefined;
|
|
303
323
|
}
|
|
324
|
+
/**
|
|
325
|
+
* System performance telemetry message.
|
|
326
|
+
*
|
|
327
|
+
* Comprehensive performance metrics including per-core CPU, GPU, DLA,
|
|
328
|
+
* memory, thermals, and video codec utilization.
|
|
329
|
+
*/
|
|
330
|
+
export interface SystemPerformanceInfoTel {
|
|
331
|
+
/** System performance information. */
|
|
332
|
+
systemPerformanceInfo: SystemPerformanceInfo | undefined;
|
|
333
|
+
}
|
|
304
334
|
/** Surface Unit telemetry message. */
|
|
305
335
|
export interface SurfaceUnitTel {
|
|
306
336
|
/** Battery information. */
|
|
@@ -315,6 +345,62 @@ export interface LogEntryTel {
|
|
|
315
345
|
/** Kernel log entry. */
|
|
316
346
|
kernel?: KernelLogEntry | undefined;
|
|
317
347
|
}
|
|
348
|
+
/** Object detections from all active computer vision models. */
|
|
349
|
+
export interface ObjectDetectionsTel {
|
|
350
|
+
/** Per-model detection results. */
|
|
351
|
+
modelDetections: ModelDetections[];
|
|
352
|
+
}
|
|
353
|
+
/**
|
|
354
|
+
* Turbidity filter settings telemetry message.
|
|
355
|
+
*
|
|
356
|
+
* Message is published when the filter settings are changed.
|
|
357
|
+
*/
|
|
358
|
+
export interface TurbidityFilterTel {
|
|
359
|
+
/** Turbidity filter settings. */
|
|
360
|
+
turbidityFilter: FilterMessage | undefined;
|
|
361
|
+
}
|
|
362
|
+
/**
|
|
363
|
+
* Color correction settings telemetry message.
|
|
364
|
+
*
|
|
365
|
+
* Message is published when the filter settings are changed.
|
|
366
|
+
*/
|
|
367
|
+
export interface ColorCorrectionTel {
|
|
368
|
+
/** Color correction settings. */
|
|
369
|
+
colorCorrectionFilter: FilterMessage | undefined;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* Digital pan, tilt, and zoom telemetry from the main camera.
|
|
373
|
+
*
|
|
374
|
+
* Reports the actual pan, tilt, and zoom state of the camera.
|
|
375
|
+
* Only supported on X3 Ultra.
|
|
376
|
+
*/
|
|
377
|
+
export interface CameraPanTiltZoomTel {
|
|
378
|
+
/** Current pan, tilt, and zoom state. */
|
|
379
|
+
cameraPanTiltZoom: CameraPanTiltZoom | undefined;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* Single-object tracking (SOT) state telemetry from the computer vision pipeline.
|
|
383
|
+
*
|
|
384
|
+
* Reports the current tracking state and the tracked bounding box when active.
|
|
385
|
+
* Published periodically while the SOT pipeline is running.
|
|
386
|
+
*/
|
|
387
|
+
export interface SotStateTel {
|
|
388
|
+
/** Current SOT state and bounding box. */
|
|
389
|
+
sotState: SotState | undefined;
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* An annotation that now exists on the dive.
|
|
393
|
+
*
|
|
394
|
+
* Either added by a client (the drone echoes its AnnotationCtrl here, source APP)
|
|
395
|
+
* or emitted by the drone itself (source DRONE); CLOUD is the post-dive Blueye
|
|
396
|
+
* Cloud path and is not seen here. Published to every connected client and
|
|
397
|
+
* written to the dive logfile. A late-joining client can fetch the most recent
|
|
398
|
+
* one with GetTelemetryReq("AnnotationTel").
|
|
399
|
+
*/
|
|
400
|
+
export interface AnnotationTel {
|
|
401
|
+
/** The annotation that was added. */
|
|
402
|
+
annotation: Annotation | undefined;
|
|
403
|
+
}
|
|
318
404
|
export declare const AttitudeTel: MessageFns<AttitudeTel>;
|
|
319
405
|
export declare const MagneticDeclinationTel: MessageFns<MagneticDeclinationTel>;
|
|
320
406
|
export declare const AltitudeTel: MessageFns<AltitudeTel>;
|
|
@@ -372,8 +458,15 @@ export declare const MultibeamPingTel: MessageFns<MultibeamPingTel>;
|
|
|
372
458
|
export declare const MultibeamConfigTel: MessageFns<MultibeamConfigTel>;
|
|
373
459
|
export declare const MultibeamDiscoveryTel: MessageFns<MultibeamDiscoveryTel>;
|
|
374
460
|
export declare const CPUInfoTel: MessageFns<CPUInfoTel>;
|
|
461
|
+
export declare const SystemPerformanceInfoTel: MessageFns<SystemPerformanceInfoTel>;
|
|
375
462
|
export declare const SurfaceUnitTel: MessageFns<SurfaceUnitTel>;
|
|
376
463
|
export declare const LogEntryTel: MessageFns<LogEntryTel>;
|
|
464
|
+
export declare const ObjectDetectionsTel: MessageFns<ObjectDetectionsTel>;
|
|
465
|
+
export declare const TurbidityFilterTel: MessageFns<TurbidityFilterTel>;
|
|
466
|
+
export declare const ColorCorrectionTel: MessageFns<ColorCorrectionTel>;
|
|
467
|
+
export declare const CameraPanTiltZoomTel: MessageFns<CameraPanTiltZoomTel>;
|
|
468
|
+
export declare const SotStateTel: MessageFns<SotStateTel>;
|
|
469
|
+
export declare const AnnotationTel: MessageFns<AnnotationTel>;
|
|
377
470
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
378
471
|
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 {} ? {
|
|
379
472
|
[K in keyof T]?: DeepPartial<T[K]>;
|