@blueyerobotics/protocol-definitions 3.2.0-fed2b1e2 → 3.3.0-053a9cb8
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 +98 -1
- package/dist/control.js +533 -7
- package/dist/message_formats.d.ts +967 -17
- package/dist/message_formats.js +8504 -2687
- package/dist/mission_planning.d.ts +54 -0
- package/dist/mission_planning.js +243 -1
- package/dist/req_rep.d.ts +86 -2
- package/dist/req_rep.js +628 -3
- package/dist/telemetry.d.ts +114 -3
- package/dist/telemetry.js +647 -12
- 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, GnssStatus, 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,12 +86,19 @@ 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 {
|
|
92
94
|
/** The GPS position of the pilot. */
|
|
93
95
|
position: LatLongPosition | undefined;
|
|
94
96
|
}
|
|
97
|
+
/** Status of the onboard Blueye GNSS receiver and its driver. */
|
|
98
|
+
export interface GnssStatusTel {
|
|
99
|
+
/** Status of the Blueye GNSS receiver. */
|
|
100
|
+
gnssStatus: GnssStatus | undefined;
|
|
101
|
+
}
|
|
95
102
|
/** Record state from the drone. */
|
|
96
103
|
export interface RecordStateTel {
|
|
97
104
|
/** Record state. */
|
|
@@ -102,18 +109,32 @@ export interface TimeLapseStateTel {
|
|
|
102
109
|
/** Time-lapse state. */
|
|
103
110
|
timeLapseState: TimeLapseState | undefined;
|
|
104
111
|
}
|
|
105
|
-
/**
|
|
112
|
+
/**
|
|
113
|
+
* Receive essential information about the battery status.
|
|
114
|
+
*
|
|
115
|
+
* On models with two batteries running in parallel (e.g. the X7), second_battery
|
|
116
|
+
* holds the essential information for the second battery. When only a single
|
|
117
|
+
* battery is used, second_battery is undefined (not set).
|
|
118
|
+
*/
|
|
106
119
|
export interface BatteryTel {
|
|
107
120
|
/** Essential battery information. */
|
|
108
121
|
battery: Battery | undefined;
|
|
122
|
+
/** Second battery, when present. Not set if only one battery is used. */
|
|
123
|
+
secondBattery: Battery | undefined;
|
|
109
124
|
}
|
|
110
125
|
/**
|
|
111
126
|
* Receive detailed information about a battery using the
|
|
112
127
|
* BQ40Z50 battery management system.
|
|
128
|
+
*
|
|
129
|
+
* On models with two batteries running in parallel (e.g. the X7), second_battery
|
|
130
|
+
* holds the detailed information for the second battery. When only a single
|
|
131
|
+
* battery is used, second_battery is undefined (not set).
|
|
113
132
|
*/
|
|
114
133
|
export interface BatteryBQ40Z50Tel {
|
|
115
134
|
/** Detailed battery information. */
|
|
116
135
|
battery: BatteryBQ40Z50 | undefined;
|
|
136
|
+
/** Second battery, when present. Not set if only one battery is used. */
|
|
137
|
+
secondBattery: BatteryBQ40Z50 | undefined;
|
|
117
138
|
}
|
|
118
139
|
/** Receive the dive time of the drone. */
|
|
119
140
|
export interface DiveTimeTel {
|
|
@@ -240,11 +261,15 @@ export interface ConnectedClientsTel {
|
|
|
240
261
|
export interface GenericServoTel {
|
|
241
262
|
/** Servo state. */
|
|
242
263
|
servo: GenericServo | undefined;
|
|
264
|
+
/** Servo set point (0..1). */
|
|
265
|
+
setPoint: number;
|
|
243
266
|
}
|
|
244
267
|
/** State of the servo installed in the multibeam. */
|
|
245
268
|
export interface MultibeamServoTel {
|
|
246
269
|
/** Multibeam servo state. */
|
|
247
270
|
servo: MultibeamServo | undefined;
|
|
271
|
+
/** Servo set point (-30..30). */
|
|
272
|
+
setPoint: number;
|
|
248
273
|
}
|
|
249
274
|
/** GuestPort current readings. */
|
|
250
275
|
export interface GuestPortCurrentTel {
|
|
@@ -266,6 +291,16 @@ export interface Imu2Tel {
|
|
|
266
291
|
/** Raw IMU data. */
|
|
267
292
|
imu: Imu | undefined;
|
|
268
293
|
}
|
|
294
|
+
/** Raw IMU data from High Precision IMU */
|
|
295
|
+
export interface ImuHpTel {
|
|
296
|
+
/** Raw High Precision IMU data (no magnetometer) */
|
|
297
|
+
imu: Imu | undefined;
|
|
298
|
+
}
|
|
299
|
+
/** Calibrated High Precision IMU data */
|
|
300
|
+
export interface CalibratedImuHpTel {
|
|
301
|
+
/** Calibrated High Precision IMU (no magnetometer) */
|
|
302
|
+
imu: Imu | undefined;
|
|
303
|
+
}
|
|
269
304
|
/** Medusa gamma ray sensor spectrometer data. */
|
|
270
305
|
export interface MedusaSpectrometerDataTel {
|
|
271
306
|
/** Medusa gamma ray sensor spectrometer data. */
|
|
@@ -286,11 +321,21 @@ export interface MultibeamDiscoveryTel {
|
|
|
286
321
|
/** Discovery data from a multibeam sonar. */
|
|
287
322
|
discovery: MultibeamDiscovery | undefined;
|
|
288
323
|
}
|
|
289
|
-
/** Information about
|
|
324
|
+
/** Information about CPU and memory usage (deprecated, use SystemPerformanceInfoTel instead). */
|
|
290
325
|
export interface CPUInfoTel {
|
|
291
326
|
/** CPU information. */
|
|
292
327
|
cpuInfo: CPUInfo | undefined;
|
|
293
328
|
}
|
|
329
|
+
/**
|
|
330
|
+
* System performance telemetry message.
|
|
331
|
+
*
|
|
332
|
+
* Comprehensive performance metrics including per-core CPU, GPU, DLA,
|
|
333
|
+
* memory, thermals, and video codec utilization.
|
|
334
|
+
*/
|
|
335
|
+
export interface SystemPerformanceInfoTel {
|
|
336
|
+
/** System performance information. */
|
|
337
|
+
systemPerformanceInfo: SystemPerformanceInfo | undefined;
|
|
338
|
+
}
|
|
294
339
|
/** Surface Unit telemetry message. */
|
|
295
340
|
export interface SurfaceUnitTel {
|
|
296
341
|
/** Battery information. */
|
|
@@ -305,6 +350,62 @@ export interface LogEntryTel {
|
|
|
305
350
|
/** Kernel log entry. */
|
|
306
351
|
kernel?: KernelLogEntry | undefined;
|
|
307
352
|
}
|
|
353
|
+
/** Object detections from all active computer vision models. */
|
|
354
|
+
export interface ObjectDetectionsTel {
|
|
355
|
+
/** Per-model detection results. */
|
|
356
|
+
modelDetections: ModelDetections[];
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
* Turbidity filter settings telemetry message.
|
|
360
|
+
*
|
|
361
|
+
* Message is published when the filter settings are changed.
|
|
362
|
+
*/
|
|
363
|
+
export interface TurbidityFilterTel {
|
|
364
|
+
/** Turbidity filter settings. */
|
|
365
|
+
turbidityFilter: FilterMessage | undefined;
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* Color correction settings telemetry message.
|
|
369
|
+
*
|
|
370
|
+
* Message is published when the filter settings are changed.
|
|
371
|
+
*/
|
|
372
|
+
export interface ColorCorrectionTel {
|
|
373
|
+
/** Color correction settings. */
|
|
374
|
+
colorCorrectionFilter: FilterMessage | undefined;
|
|
375
|
+
}
|
|
376
|
+
/**
|
|
377
|
+
* Digital pan, tilt, and zoom telemetry from the main camera.
|
|
378
|
+
*
|
|
379
|
+
* Reports the actual pan, tilt, and zoom state of the camera.
|
|
380
|
+
* Only supported on X3 Ultra.
|
|
381
|
+
*/
|
|
382
|
+
export interface CameraPanTiltZoomTel {
|
|
383
|
+
/** Current pan, tilt, and zoom state. */
|
|
384
|
+
cameraPanTiltZoom: CameraPanTiltZoom | undefined;
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* Single-object tracking (SOT) state telemetry from the computer vision pipeline.
|
|
388
|
+
*
|
|
389
|
+
* Reports the current tracking state and the tracked bounding box when active.
|
|
390
|
+
* Published periodically while the SOT pipeline is running.
|
|
391
|
+
*/
|
|
392
|
+
export interface SotStateTel {
|
|
393
|
+
/** Current SOT state and bounding box. */
|
|
394
|
+
sotState: SotState | undefined;
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* An annotation that now exists on the dive.
|
|
398
|
+
*
|
|
399
|
+
* Either added by a client (the drone echoes its AnnotationCtrl here, source APP)
|
|
400
|
+
* or emitted by the drone itself (source DRONE); CLOUD is the post-dive Blueye
|
|
401
|
+
* Cloud path and is not seen here. Published to every connected client and
|
|
402
|
+
* written to the dive logfile. A late-joining client can fetch the most recent
|
|
403
|
+
* one with GetTelemetryReq("AnnotationTel").
|
|
404
|
+
*/
|
|
405
|
+
export interface AnnotationTel {
|
|
406
|
+
/** The annotation that was added. */
|
|
407
|
+
annotation: Annotation | undefined;
|
|
408
|
+
}
|
|
308
409
|
export declare const AttitudeTel: MessageFns<AttitudeTel>;
|
|
309
410
|
export declare const MagneticDeclinationTel: MessageFns<MagneticDeclinationTel>;
|
|
310
411
|
export declare const AltitudeTel: MessageFns<AltitudeTel>;
|
|
@@ -322,6 +423,7 @@ export declare const LightsTel: MessageFns<LightsTel>;
|
|
|
322
423
|
export declare const GuestPortLightsTel: MessageFns<GuestPortLightsTel>;
|
|
323
424
|
export declare const LaserTel: MessageFns<LaserTel>;
|
|
324
425
|
export declare const PilotGPSPositionTel: MessageFns<PilotGPSPositionTel>;
|
|
426
|
+
export declare const GnssStatusTel: MessageFns<GnssStatusTel>;
|
|
325
427
|
export declare const RecordStateTel: MessageFns<RecordStateTel>;
|
|
326
428
|
export declare const TimeLapseStateTel: MessageFns<TimeLapseStateTel>;
|
|
327
429
|
export declare const BatteryTel: MessageFns<BatteryTel>;
|
|
@@ -355,13 +457,22 @@ export declare const GuestPortCurrentTel: MessageFns<GuestPortCurrentTel>;
|
|
|
355
457
|
export declare const CalibratedImuTel: MessageFns<CalibratedImuTel>;
|
|
356
458
|
export declare const Imu1Tel: MessageFns<Imu1Tel>;
|
|
357
459
|
export declare const Imu2Tel: MessageFns<Imu2Tel>;
|
|
460
|
+
export declare const ImuHpTel: MessageFns<ImuHpTel>;
|
|
461
|
+
export declare const CalibratedImuHpTel: MessageFns<CalibratedImuHpTel>;
|
|
358
462
|
export declare const MedusaSpectrometerDataTel: MessageFns<MedusaSpectrometerDataTel>;
|
|
359
463
|
export declare const MultibeamPingTel: MessageFns<MultibeamPingTel>;
|
|
360
464
|
export declare const MultibeamConfigTel: MessageFns<MultibeamConfigTel>;
|
|
361
465
|
export declare const MultibeamDiscoveryTel: MessageFns<MultibeamDiscoveryTel>;
|
|
362
466
|
export declare const CPUInfoTel: MessageFns<CPUInfoTel>;
|
|
467
|
+
export declare const SystemPerformanceInfoTel: MessageFns<SystemPerformanceInfoTel>;
|
|
363
468
|
export declare const SurfaceUnitTel: MessageFns<SurfaceUnitTel>;
|
|
364
469
|
export declare const LogEntryTel: MessageFns<LogEntryTel>;
|
|
470
|
+
export declare const ObjectDetectionsTel: MessageFns<ObjectDetectionsTel>;
|
|
471
|
+
export declare const TurbidityFilterTel: MessageFns<TurbidityFilterTel>;
|
|
472
|
+
export declare const ColorCorrectionTel: MessageFns<ColorCorrectionTel>;
|
|
473
|
+
export declare const CameraPanTiltZoomTel: MessageFns<CameraPanTiltZoomTel>;
|
|
474
|
+
export declare const SotStateTel: MessageFns<SotStateTel>;
|
|
475
|
+
export declare const AnnotationTel: MessageFns<AnnotationTel>;
|
|
365
476
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
366
477
|
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 {} ? {
|
|
367
478
|
[K in keyof T]?: DeepPartial<T[K]>;
|