@blueyerobotics/protocol-definitions 3.2.0-3e0ba702 → 3.2.0-3e35b5c5

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.
@@ -136,6 +136,8 @@ export declare enum NotificationType {
136
136
  NOTIFICATION_TYPE_DVL_HIGH_TEMPERATURE_DETECTED = 31,
137
137
  /** NOTIFICATION_TYPE_DVL_THERMAL_PROTECTION_MODE_DETECTED - DVL thermal protection mode detected. */
138
138
  NOTIFICATION_TYPE_DVL_THERMAL_PROTECTION_MODE_DETECTED = 32,
139
+ /** NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED - Video partition not mounted. */
140
+ NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED = 33,
139
141
  UNRECOGNIZED = -1
140
142
  }
141
143
  export declare function notificationTypeFromJSON(object: any): NotificationType;
@@ -154,6 +156,22 @@ export declare enum NotificationLevel {
154
156
  }
155
157
  export declare function notificationLevelFromJSON(object: any): NotificationLevel;
156
158
  export declare function notificationLevelToJSON(object: NotificationLevel): string;
159
+ /**
160
+ * Storage location.
161
+ *
162
+ * Used to specify which storage location to use for recording photos and videos.
163
+ */
164
+ export declare enum StorageLocation {
165
+ /** STORAGE_LOCATION_UNSPECIFIED - Unspecified. */
166
+ STORAGE_LOCATION_UNSPECIFIED = 0,
167
+ /** STORAGE_LOCATION_INTERNAL - Internal storage of the drone. */
168
+ STORAGE_LOCATION_INTERNAL = 1,
169
+ /** STORAGE_LOCATION_REMOVABLE - Removable storage device. */
170
+ STORAGE_LOCATION_REMOVABLE = 2,
171
+ UNRECOGNIZED = -1
172
+ }
173
+ export declare function storageLocationFromJSON(object: any): StorageLocation;
174
+ export declare function storageLocationToJSON(object: StorageLocation): string;
157
175
  /** Drone models produced by Blueye. */
158
176
  export declare enum Model {
159
177
  /** MODEL_UNSPECIFIED - ModelName not specified. */
@@ -168,6 +186,8 @@ export declare enum Model {
168
186
  MODEL_X3 = 3,
169
187
  /** MODEL_X3_ULTRA - Blueye X3 Ultra. */
170
188
  MODEL_X3_ULTRA = 6,
189
+ /** MODEL_X7 - Blueye X7. */
190
+ MODEL_X7 = 7,
171
191
  /** MODEL_NEXT - Blueye ? */
172
192
  MODEL_NEXT = 5,
173
193
  UNRECOGNIZED = -1
@@ -190,28 +210,57 @@ export declare enum PressureSensorType {
190
210
  }
191
211
  export declare function pressureSensorTypeFromJSON(object: any): PressureSensorType;
192
212
  export declare function pressureSensorTypeToJSON(object: PressureSensorType): string;
213
+ /**
214
+ * How the drone is powered.
215
+ *
216
+ * Lets clients determine the power configuration (e.g. parallel batteries on the
217
+ * X7) directly from DroneInfo, without waiting for telemetry. May be extended in
218
+ * the future, e.g. with topside power.
219
+ */
220
+ export declare enum PowerSource {
221
+ /** POWER_SOURCE_UNSPECIFIED - Power source unknown / not determined. */
222
+ POWER_SOURCE_UNSPECIFIED = 0,
223
+ /** POWER_SOURCE_SINGLE_BATTERY - A single battery. */
224
+ POWER_SOURCE_SINGLE_BATTERY = 1,
225
+ /** POWER_SOURCE_PARALLEL_BATTERIES - Two batteries running in parallel (e.g. X7). */
226
+ POWER_SOURCE_PARALLEL_BATTERIES = 2,
227
+ UNRECOGNIZED = -1
228
+ }
229
+ export declare function powerSourceFromJSON(object: any): PowerSource;
230
+ export declare function powerSourceToJSON(object: PowerSource): string;
193
231
  /** Available camera resolutions. */
194
232
  export declare enum Resolution {
195
233
  /** RESOLUTION_UNSPECIFIED - Resolution not specified. */
196
234
  RESOLUTION_UNSPECIFIED = 0,
197
- /** RESOLUTION_FULLHD_1080P - 1080p Full HD resolution. */
198
- RESOLUTION_FULLHD_1080P = 1,
199
- /** RESOLUTION_HD_720P - 720p HD resolution. */
235
+ /** RESOLUTION_VGA_480P - VGA (640x480). */
236
+ RESOLUTION_VGA_480P = 4,
237
+ /** RESOLUTION_HD_720P - 720p HD (1280x720). */
200
238
  RESOLUTION_HD_720P = 2,
201
- /** RESOLUTION_UHD_4K - 4K Ultra HD resolution. */
239
+ /** RESOLUTION_FULLHD_1080P - 1080p Full HD (1920x1080). */
240
+ RESOLUTION_FULLHD_1080P = 1,
241
+ /** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
202
242
  RESOLUTION_UHD_4K = 3,
243
+ /** RESOLUTION_QHD_2K - 2K QHD (2560x1440, Only supported on X3 Ultra). */
244
+ RESOLUTION_QHD_2K = 5,
203
245
  UNRECOGNIZED = -1
204
246
  }
205
247
  export declare function resolutionFromJSON(object: any): Resolution;
206
248
  export declare function resolutionToJSON(object: Resolution): string;
207
- /** Available camera frame rates. */
249
+ /**
250
+ * Available camera frame rates.
251
+ *
252
+ * If the requested frame rate is higher than what is supported at the current resolution,
253
+ * the frame rate will be reduced while the resolution is respected.
254
+ */
208
255
  export declare enum Framerate {
209
256
  /** FRAMERATE_UNSPECIFIED - Framerate not specified. */
210
257
  FRAMERATE_UNSPECIFIED = 0,
211
258
  /** FRAMERATE_FPS_30 - 30 frames per second. */
212
259
  FRAMERATE_FPS_30 = 1,
213
- /** FRAMERATE_FPS_25 - 25 frames per second. */
260
+ /** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
214
261
  FRAMERATE_FPS_25 = 2,
262
+ /** FRAMERATE_FPS_60 - 60 frames per second. (Only supported on X3 Ultra at QHD, 1080p and 720p) */
263
+ FRAMERATE_FPS_60 = 3,
215
264
  UNRECOGNIZED = -1
216
265
  }
217
266
  export declare function framerateFromJSON(object: any): Framerate;
@@ -228,6 +277,29 @@ export declare enum Camera {
228
277
  }
229
278
  export declare function cameraFromJSON(object: any): Camera;
230
279
  export declare function cameraToJSON(object: Camera): string;
280
+ export declare enum StreamingProtocol {
281
+ /** STREAMING_PROTOCOL_UNSPECIFIED - Streaming protocol not specified. */
282
+ STREAMING_PROTOCOL_UNSPECIFIED = 0,
283
+ /** STREAMING_PROTOCOL_RTSP_H264 - RTSP streaming protocol using H264 codec. */
284
+ STREAMING_PROTOCOL_RTSP_H264 = 1,
285
+ /** STREAMING_PROTOCOL_RTSP_MJPEG - RTSP streaming protocol using MJPEG codec. No recording when activated. */
286
+ STREAMING_PROTOCOL_RTSP_MJPEG = 2,
287
+ UNRECOGNIZED = -1
288
+ }
289
+ export declare function streamingProtocolFromJSON(object: any): StreamingProtocol;
290
+ export declare function streamingProtocolToJSON(object: StreamingProtocol): string;
291
+ /** Recording video codec. */
292
+ export declare enum RecordingCodec {
293
+ /** RECORDING_CODEC_UNSPECIFIED - Use platform default (H.264). */
294
+ RECORDING_CODEC_UNSPECIFIED = 0,
295
+ /** RECORDING_CODEC_H264 - H.264/AVC codec. Wider compatibility with players/editors. */
296
+ RECORDING_CODEC_H264 = 1,
297
+ /** RECORDING_CODEC_H265 - H.265/HEVC codec. Better compression, limited compatibility. Ultra only. */
298
+ RECORDING_CODEC_H265 = 2,
299
+ UNRECOGNIZED = -1
300
+ }
301
+ export declare function recordingCodecFromJSON(object: any): RecordingCodec;
302
+ export declare function recordingCodecToJSON(object: RecordingCodec): string;
231
303
  /** Available temperature units. */
232
304
  export declare enum TemperatureUnit {
233
305
  /** TEMPERATURE_UNIT_UNSPECIFIED - Temperature unit not specified. */
@@ -294,6 +366,8 @@ export declare enum FontSize {
294
366
  FONT_SIZE_PX35 = 5,
295
367
  /** FONT_SIZE_PX40 - 40 px. */
296
368
  FONT_SIZE_PX40 = 6,
369
+ /** FONT_SIZE_PX50 - 50 px. */
370
+ FONT_SIZE_PX50 = 7,
297
371
  UNRECOGNIZED = -1
298
372
  }
299
373
  export declare function fontSizeFromJSON(object: any): FontSize;
@@ -390,6 +464,19 @@ export declare enum GuestPortDeviceID {
390
464
  GUEST_PORT_DEVICE_ID_WATERLINKED_SONAR_3D15 = 43,
391
465
  /** GUEST_PORT_DEVICE_ID_CERULEAN_TRACKER_650 - Cerulean Tracker 650. */
392
466
  GUEST_PORT_DEVICE_ID_CERULEAN_TRACKER_650 = 44,
467
+ /** GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE - Blueye External USB Storage. */
468
+ GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE = 45,
469
+ /** GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 - Blueye Multibeam Skid Servo V2. */
470
+ GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 = 46,
471
+ /** GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT - Cerulean Omniscan 450 Compact. */
472
+ GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT = 47,
473
+ /** GUEST_PORT_DEVICE_ID_BLUEYE_SCALING_LASER - Blueye Scaling Laser. */
474
+ GUEST_PORT_DEVICE_ID_BLUEYE_SCALING_LASER = 48,
475
+ /**
476
+ * GUEST_PORT_DEVICE_ID_CYGNUS_MINI_ROV_THICKNESS_GAUGE_RS232 - Cygnus Mini ROV Thickness Gauge on a connector that converts its RS485 to
477
+ * RS232, letting it be used on drones with no RS485, such as the X7.
478
+ */
479
+ GUEST_PORT_DEVICE_ID_CYGNUS_MINI_ROV_THICKNESS_GAUGE_RS232 = 49,
393
480
  UNRECOGNIZED = -1
394
481
  }
395
482
  export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
@@ -404,10 +491,43 @@ export declare enum GuestPortNumber {
404
491
  GUEST_PORT_NUMBER_PORT_2 = 2,
405
492
  /** GUEST_PORT_NUMBER_PORT_3 - Guest port 3. */
406
493
  GUEST_PORT_NUMBER_PORT_3 = 3,
494
+ /** GUEST_PORT_NUMBER_PORT_4 - Guest port 4. */
495
+ GUEST_PORT_NUMBER_PORT_4 = 4,
496
+ /** GUEST_PORT_NUMBER_PORT_5 - Guest port 5. */
497
+ GUEST_PORT_NUMBER_PORT_5 = 5,
498
+ /** GUEST_PORT_NUMBER_PORT_6 - Guest port 6. */
499
+ GUEST_PORT_NUMBER_PORT_6 = 6,
407
500
  UNRECOGNIZED = -1
408
501
  }
409
502
  export declare function guestPortNumberFromJSON(object: any): GuestPortNumber;
410
503
  export declare function guestPortNumberToJSON(object: GuestPortNumber): string;
504
+ /**
505
+ * Physical interfaces a guest port can provide.
506
+ *
507
+ * Used both for the interfaces a port provides and for the interfaces a
508
+ * device requires from the port it is connected to.
509
+ */
510
+ export declare enum GuestPortCapability {
511
+ /** GUEST_PORT_CAPABILITY_UNSPECIFIED - Unspecified. */
512
+ GUEST_PORT_CAPABILITY_UNSPECIFIED = 0,
513
+ /** GUEST_PORT_CAPABILITY_ETHERNET - Ethernet. */
514
+ GUEST_PORT_CAPABILITY_ETHERNET = 1,
515
+ /** GUEST_PORT_CAPABILITY_I2C - I2C. */
516
+ GUEST_PORT_CAPABILITY_I2C = 2,
517
+ /** GUEST_PORT_CAPABILITY_RS232 - RS232 serial. */
518
+ GUEST_PORT_CAPABILITY_RS232 = 3,
519
+ /** GUEST_PORT_CAPABILITY_RS485 - RS485 serial. */
520
+ GUEST_PORT_CAPABILITY_RS485 = 4,
521
+ /** GUEST_PORT_CAPABILITY_USB2 - USB 2.0. */
522
+ GUEST_PORT_CAPABILITY_USB2 = 5,
523
+ /** GUEST_PORT_CAPABILITY_PWM - PWM. */
524
+ GUEST_PORT_CAPABILITY_PWM = 6,
525
+ /** GUEST_PORT_CAPABILITY_ETHERNET_1G - Gigabit Ethernet. */
526
+ GUEST_PORT_CAPABILITY_ETHERNET_1G = 7,
527
+ UNRECOGNIZED = -1
528
+ }
529
+ export declare function guestPortCapabilityFromJSON(object: any): GuestPortCapability;
530
+ export declare function guestPortCapabilityToJSON(object: GuestPortCapability): string;
411
531
  /** List of navigation sensors that can be used by the position observer. */
412
532
  export declare enum NavigationSensorID {
413
533
  /** NAVIGATION_SENSOR_ID_UNSPECIFIED - Unspecified. */
@@ -475,6 +595,48 @@ export declare enum MultibeamFrequencyMode {
475
595
  }
476
596
  export declare function multibeamFrequencyModeFromJSON(object: any): MultibeamFrequencyMode;
477
597
  export declare function multibeamFrequencyModeToJSON(object: MultibeamFrequencyMode): string;
598
+ /** Thermal zone identifiers. */
599
+ export declare enum ThermalZoneId {
600
+ /** THERMAL_ZONE_ID_UNSPECIFIED - Unspecified thermal zone. */
601
+ THERMAL_ZONE_ID_UNSPECIFIED = 0,
602
+ /** THERMAL_ZONE_ID_TJ - Junction temperature (Tj). */
603
+ THERMAL_ZONE_ID_TJ = 1,
604
+ /** THERMAL_ZONE_ID_CANISTER - Canister temperature. */
605
+ THERMAL_ZONE_ID_CANISTER = 2,
606
+ /** THERMAL_ZONE_ID_CPU - CPU thermal zone. */
607
+ THERMAL_ZONE_ID_CPU = 3,
608
+ /** THERMAL_ZONE_ID_GPU - GPU thermal zone. */
609
+ THERMAL_ZONE_ID_GPU = 4,
610
+ /** THERMAL_ZONE_ID_CV0 - Vision accelerator 0 thermal zone. */
611
+ THERMAL_ZONE_ID_CV0 = 5,
612
+ /** THERMAL_ZONE_ID_CV1 - Vision accelerator 1 thermal zone. */
613
+ THERMAL_ZONE_ID_CV1 = 6,
614
+ /** THERMAL_ZONE_ID_CV2 - Vision accelerator 2 thermal zone. */
615
+ THERMAL_ZONE_ID_CV2 = 7,
616
+ /** THERMAL_ZONE_ID_SOC0 - SoC 0 thermal zone. */
617
+ THERMAL_ZONE_ID_SOC0 = 8,
618
+ /** THERMAL_ZONE_ID_SOC1 - SoC 1 thermal zone. */
619
+ THERMAL_ZONE_ID_SOC1 = 9,
620
+ /** THERMAL_ZONE_ID_SOC2 - SoC 2 thermal zone. */
621
+ THERMAL_ZONE_ID_SOC2 = 10,
622
+ UNRECOGNIZED = -1
623
+ }
624
+ export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
625
+ export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
626
+ /** Origin of an annotation. Mirrors the AnnotationSource enum in Blueye Cloud. */
627
+ export declare enum AnnotationSource {
628
+ /** ANNOTATION_SOURCE_UNSPECIFIED - Origin not specified. */
629
+ ANNOTATION_SOURCE_UNSPECIFIED = 0,
630
+ /** ANNOTATION_SOURCE_CLOUD - Created in Blueye Cloud after the dive. */
631
+ ANNOTATION_SOURCE_CLOUD = 1,
632
+ /** ANNOTATION_SOURCE_APP - Created in the app during the dive. */
633
+ ANNOTATION_SOURCE_APP = 2,
634
+ /** ANNOTATION_SOURCE_DRONE - Emitted by the drone itself. */
635
+ ANNOTATION_SOURCE_DRONE = 3,
636
+ UNRECOGNIZED = -1
637
+ }
638
+ export declare function annotationSourceFromJSON(object: any): AnnotationSource;
639
+ export declare function annotationSourceToJSON(object: AnnotationSource): string;
478
640
  /**
479
641
  * Wrapper message for each entry in the drone telemetry logfile.
480
642
  *
@@ -491,6 +653,89 @@ export interface BinlogRecord {
491
653
  /** Posix CLOCK_MONOTONIC timestamp. */
492
654
  clockMonotonic: Date | undefined;
493
655
  }
656
+ /**
657
+ * Log entry
658
+ *
659
+ * Used to store ROS log entries in the bez file
660
+ */
661
+ export interface LogEntry {
662
+ /** Timestamp of the log entry. */
663
+ timestamp: Date | undefined;
664
+ /** Name of the process that generated the log entry. */
665
+ processName: string;
666
+ /** Process ID of the log entry. */
667
+ processId: number;
668
+ /** Thread ID of the log entry. */
669
+ threadId: number;
670
+ /** Source of the log entry (specific class or named logger). */
671
+ source: string;
672
+ /** Log level, info, warning, error, etc. */
673
+ level: LogEntry_LogLevel;
674
+ /** Log message. */
675
+ message: string;
676
+ }
677
+ export declare enum LogEntry_LogLevel {
678
+ /** LOG_LEVEL_UNSPECIFIED - Unspecified log level. */
679
+ LOG_LEVEL_UNSPECIFIED = 0,
680
+ /** LOG_LEVEL_TRACE - Trace log level. */
681
+ LOG_LEVEL_TRACE = 1,
682
+ /** LOG_LEVEL_DEBUG - Debug log level. */
683
+ LOG_LEVEL_DEBUG = 2,
684
+ /** LOG_LEVEL_INFO - Info log level. */
685
+ LOG_LEVEL_INFO = 3,
686
+ /** LOG_LEVEL_WARNING - Warning log level. */
687
+ LOG_LEVEL_WARNING = 4,
688
+ /** LOG_LEVEL_ERROR - Error log level. */
689
+ LOG_LEVEL_ERROR = 5,
690
+ /** LOG_LEVEL_CRITICAL - Critical log level. */
691
+ LOG_LEVEL_CRITICAL = 6,
692
+ UNRECOGNIZED = -1
693
+ }
694
+ export declare function logEntry_LogLevelFromJSON(object: any): LogEntry_LogLevel;
695
+ export declare function logEntry_LogLevelToJSON(object: LogEntry_LogLevel): string;
696
+ export interface KernelLogEntry {
697
+ /** Log level, info, warning, error, etc. */
698
+ level: KernelLogEntry_KernelLogLevel;
699
+ /** Sequence number of the log entry. */
700
+ seqnum: number;
701
+ /** Timestamp of the log entry. */
702
+ timestamp: Date | undefined;
703
+ /** Log messages. */
704
+ messages: string[];
705
+ /** List of key-value pairs. */
706
+ fields: KernelLogEntry_KeyValuePair[];
707
+ }
708
+ /** Kernel log level. */
709
+ export declare enum KernelLogEntry_KernelLogLevel {
710
+ /** KERNEL_LOG_LEVEL_UNSPECIFIED - Unspecified log level. */
711
+ KERNEL_LOG_LEVEL_UNSPECIFIED = 0,
712
+ /** KERNEL_LOG_LEVEL_EMERG - Emergency log level. */
713
+ KERNEL_LOG_LEVEL_EMERG = 1,
714
+ /** KERNEL_LOG_LEVEL_ALERT - Alert log level. */
715
+ KERNEL_LOG_LEVEL_ALERT = 2,
716
+ /** KERNEL_LOG_LEVEL_CRIT - Critical log level. */
717
+ KERNEL_LOG_LEVEL_CRIT = 3,
718
+ /** KERNEL_LOG_LEVEL_ERR - Error log level. */
719
+ KERNEL_LOG_LEVEL_ERR = 4,
720
+ /** KERNEL_LOG_LEVEL_WARNING - Warning log level. */
721
+ KERNEL_LOG_LEVEL_WARNING = 5,
722
+ /** KERNEL_LOG_LEVEL_NOTICE - Notice log level. */
723
+ KERNEL_LOG_LEVEL_NOTICE = 6,
724
+ /** KERNEL_LOG_LEVEL_INFO - Informational log level. */
725
+ KERNEL_LOG_LEVEL_INFO = 7,
726
+ /** KERNEL_LOG_LEVEL_DEBUG - Debug log level. */
727
+ KERNEL_LOG_LEVEL_DEBUG = 8,
728
+ UNRECOGNIZED = -1
729
+ }
730
+ export declare function kernelLogEntry_KernelLogLevelFromJSON(object: any): KernelLogEntry_KernelLogLevel;
731
+ export declare function kernelLogEntry_KernelLogLevelToJSON(object: KernelLogEntry_KernelLogLevel): string;
732
+ /** Key-value pair used for structured logging. */
733
+ export interface KernelLogEntry_KeyValuePair {
734
+ /** Key of the key-value pair. */
735
+ key: string;
736
+ /** Value of the key-value pair. */
737
+ value: string;
738
+ }
494
739
  /** If you use both values at the same time they cancel each other out. */
495
740
  export interface MotionInput {
496
741
  /** Forward (positive) and backwards (negative) movement. (-1..1). */
@@ -525,6 +770,46 @@ export interface Lights {
525
770
  export interface Laser {
526
771
  /** Laser intensity, any value above 0 turns the laser on (0..1). */
527
772
  value: number;
773
+ /** Modulate the laser at 5Hz for tracking. Only available on Ultra. */
774
+ modulated: boolean;
775
+ }
776
+ /** Point in 2D space. */
777
+ export interface Point2D {
778
+ /** X coordinate of the point (px). */
779
+ x: number;
780
+ /** Y coordinate of the point (px). */
781
+ y: number;
782
+ }
783
+ /**
784
+ * Message representing the detection of scaling lasers in the main camera.
785
+ *
786
+ * The message contains the centroids of the detected dots, the distance between them in pixels,
787
+ * and the confidence of the detection. The dots are detected through temporal DFT analysis of
788
+ * 5 Hz laser modulation, isolating flickering pixels from the static scene background.
789
+ *
790
+ * Only available on Ultra.
791
+ */
792
+ export interface LaserDetection {
793
+ /** True if the laser is detected by the drone. */
794
+ detected: boolean;
795
+ /** First dot centroid (leftmost). */
796
+ dot1: Point2D | undefined;
797
+ /** Second dot centroid (rightmost). */
798
+ dot2: Point2D | undefined;
799
+ /** Distance between dots in pixels. */
800
+ pixelDistance: number;
801
+ /** Confidence of the detection (0..1). */
802
+ confidence: number;
803
+ /** Source frame width. */
804
+ imageWidth: number;
805
+ /** Source frame height. */
806
+ imageHeight: number;
807
+ /** Real world distance between the two laser dots (m). */
808
+ laserWidth: number;
809
+ /** Distance after lens undistortion (px). */
810
+ correctedPixelDistance: number;
811
+ /** Estimated subject distance (m). */
812
+ estimatedDistance: number;
528
813
  }
529
814
  /** Latitude and longitude position in WGS 84 decimal degrees format. */
530
815
  export interface LatLongPosition {
@@ -660,6 +945,12 @@ export interface RecordState {
660
945
  multibeamSeconds: number;
661
946
  /** Multibeam record fps. */
662
947
  multibeamFps: number;
948
+ /** Storage location used for main camera recording. */
949
+ mainStorageLocation: StorageLocation;
950
+ /** Storage location used for guestport camera recording. */
951
+ guestportStorageLocation: StorageLocation;
952
+ /** Storage location used for multibeam recording. */
953
+ multibeamStorageLocation: StorageLocation;
663
954
  }
664
955
  /** Time-lapse state published if time-lapse mission is running. */
665
956
  export interface TimeLapseState {
@@ -705,7 +996,7 @@ export interface WaterTemperature {
705
996
  /** Water temperature (°C). */
706
997
  value: number;
707
998
  }
708
- /** CPU temperature. */
999
+ /** CPU temperature (deprecated, use SystemPerformanceInfo.thermal_zones instead). */
709
1000
  export interface CPUTemperature {
710
1001
  /** CPU temperature (°C). */
711
1002
  value: number;
@@ -1127,7 +1418,7 @@ export interface DiveTime {
1127
1418
  /** Number of seconds the drone has been submerged. */
1128
1419
  value: number;
1129
1420
  }
1130
- /** Which cameras are supposed to be recording. */
1421
+ /** Which cameras or multibeam are supposed to be recording. */
1131
1422
  export interface RecordOn {
1132
1423
  /** Record the main camera. */
1133
1424
  main: boolean;
@@ -1143,6 +1434,65 @@ export interface StorageSpace {
1143
1434
  /** Available bytes of storage space (B). */
1144
1435
  freeSpace: number;
1145
1436
  }
1437
+ /** Storage partition. */
1438
+ export interface StoragePartition {
1439
+ /** The amount of storage space on the device. */
1440
+ storageSpace: StorageSpace | undefined;
1441
+ /** File system type of the removable storage device. */
1442
+ fileSystemType: string;
1443
+ /** Partition device path */
1444
+ devicePath: string;
1445
+ /** Mount path of the partition. */
1446
+ mountPath: string;
1447
+ /** Label of the partition. */
1448
+ label: string;
1449
+ }
1450
+ /** Removable storage device. */
1451
+ export interface RemovableStorageDevice {
1452
+ /** USB vendor name. */
1453
+ vendorName: string;
1454
+ /** Model name of the USB storage device. */
1455
+ modelName: string;
1456
+ /** Mount path of the storage device. */
1457
+ devicePath: string;
1458
+ /** Status of the storage device. */
1459
+ status: RemovableStorageDevice_Status;
1460
+ /** Any active error flags for the storage device. */
1461
+ errorFlags: RemovableStorageErrorFlags | undefined;
1462
+ /** List of partitions on the storage device. */
1463
+ partitions: StoragePartition[];
1464
+ }
1465
+ /** Overall status of the storage device. */
1466
+ export declare enum RemovableStorageDevice_Status {
1467
+ /** STATUS_UNSPECIFIED - Unspecified. */
1468
+ STATUS_UNSPECIFIED = 0,
1469
+ /** STATUS_READY - The storage device is valid and ready for use. */
1470
+ STATUS_READY = 1,
1471
+ /** STATUS_FORMATTING - The storage device is being formatted. */
1472
+ STATUS_FORMATTING = 2,
1473
+ /** STATUS_ERROR - The storage device is in an error state. */
1474
+ STATUS_ERROR = 3,
1475
+ /** STATUS_UNPLUGGED - The storage device is not present. */
1476
+ STATUS_UNPLUGGED = 4,
1477
+ UNRECOGNIZED = -1
1478
+ }
1479
+ export declare function removableStorageDevice_StatusFromJSON(object: any): RemovableStorageDevice_Status;
1480
+ export declare function removableStorageDevice_StatusToJSON(object: RemovableStorageDevice_Status): string;
1481
+ /** Error flags related to a removable storage device. */
1482
+ export interface RemovableStorageErrorFlags {
1483
+ /** Optional error message to give additional information from the drone to a client about active error flags. */
1484
+ errorMessage: string;
1485
+ /** Device is attached but no partitions are found. */
1486
+ noPartitionsFound: boolean;
1487
+ /** Multiple partitions are found. */
1488
+ multiplePartitionsFound: boolean;
1489
+ /** The wrong file system is found. */
1490
+ wrongFileSystemFound: boolean;
1491
+ /** The device is in read-only mode. */
1492
+ deviceIsReadOnly: boolean;
1493
+ /** Formatting of the device failed. */
1494
+ formattingFailed: boolean;
1495
+ }
1146
1496
  /** Compass calibration state. */
1147
1497
  export interface CalibrationState {
1148
1498
  /** Current calibration status. */
@@ -1165,7 +1515,7 @@ export interface CalibrationState {
1165
1515
  /**
1166
1516
  * Status of the compass calibration procedure.
1167
1517
  *
1168
- * When calibration is started, the status will indicate the active (upfacing) axis.
1518
+ * When calibration is started, the status will indicate the active (up facing) axis.
1169
1519
  */
1170
1520
  export declare enum CalibrationState_Status {
1171
1521
  /** STATUS_UNSPECIFIED - Unspecified status. */
@@ -1186,7 +1536,7 @@ export declare enum CalibrationState_Status {
1186
1536
  STATUS_CALIBRATING_Z_POSITIVE = 7,
1187
1537
  /** STATUS_CALIBRATING_Z_NEGATIVE - Compass is calibrating and the negative Z axis is active. */
1188
1538
  STATUS_CALIBRATING_Z_NEGATIVE = 8,
1189
- /** STATUS_CALIBRATING_THRUSTER - Compass is calibrating for thruster interferance. */
1539
+ /** STATUS_CALIBRATING_THRUSTER - Compass is calibrating for thruster interference. */
1190
1540
  STATUS_CALIBRATING_THRUSTER = 9,
1191
1541
  UNRECOGNIZED = -1
1192
1542
  }
@@ -1219,6 +1569,31 @@ export interface TiltVelocity {
1219
1569
  /**
1220
1570
  * Information about the drone.
1221
1571
  *
1572
+ * Information about a loaded computer vision model.
1573
+ */
1574
+ export interface CvModelInfo {
1575
+ /** Human-readable model name (from model_meta.json). */
1576
+ name: string;
1577
+ /** Type of CV model. */
1578
+ type: CvModelInfo_ModelType;
1579
+ /** Whether the model is currently running. */
1580
+ running: boolean;
1581
+ /** Execution provider (e.g. "cuda", "tensorrt"). */
1582
+ device: string;
1583
+ /** Package directory name (e.g. "tinyyolov2_package"). Stable identifier. */
1584
+ packageId: string;
1585
+ /** Class names the model can detect (indexed by class_id). */
1586
+ labels: string[];
1587
+ }
1588
+ export declare enum CvModelInfo_ModelType {
1589
+ MODEL_TYPE_UNSPECIFIED = 0,
1590
+ MODEL_TYPE_DETECTION = 1,
1591
+ MODEL_TYPE_SOT = 2,
1592
+ UNRECOGNIZED = -1
1593
+ }
1594
+ export declare function cvModelInfo_ModelTypeFromJSON(object: any): CvModelInfo_ModelType;
1595
+ export declare function cvModelInfo_ModelTypeToJSON(object: CvModelInfo_ModelType): string;
1596
+ /**
1222
1597
  * This message contains serial numbers and version information for
1223
1598
  * internal components in the drone. Primarily used for diagnostics, or to
1224
1599
  * determine the origin of a logfile.
@@ -1246,6 +1621,10 @@ export interface DroneInfo {
1246
1621
  gp: GuestPortInfo | undefined;
1247
1622
  /** Type of depth sensor that is connected to the drone. */
1248
1623
  depthSensor: PressureSensorType;
1624
+ /** List of loaded computer vision models. */
1625
+ cvModels: CvModelInfo[];
1626
+ /** How the drone is powered. */
1627
+ powerSource: PowerSource;
1249
1628
  }
1250
1629
  /** Known error states for the drone. */
1251
1630
  export interface ErrorFlags {
@@ -1271,30 +1650,72 @@ export interface ErrorFlags {
1271
1650
  gp2Read: boolean;
1272
1651
  /** Guest port 3 read error. */
1273
1652
  gp3Read: boolean;
1653
+ /** Guest port 4 read error. */
1654
+ gp4Read: boolean;
1655
+ /** Guest port 5 read error. */
1656
+ gp5Read: boolean;
1657
+ /** Guest port 6 read error. */
1658
+ gp6Read: boolean;
1274
1659
  /** Guest port 1 not flashed. */
1275
1660
  gp1NotFlashed: boolean;
1276
1661
  /** Guest port 2 not flashed. */
1277
1662
  gp2NotFlashed: boolean;
1278
1663
  /** Guest port 3 not flashed. */
1279
1664
  gp3NotFlashed: boolean;
1665
+ /** Guest port 4 not flashed. */
1666
+ gp4NotFlashed: boolean;
1667
+ /** Guest port 5 not flashed. */
1668
+ gp5NotFlashed: boolean;
1669
+ /** Guest port 6 not flashed. */
1670
+ gp6NotFlashed: boolean;
1280
1671
  /** Unknown device on guest port 1. */
1281
1672
  gp1UnknownDevice: boolean;
1282
1673
  /** Unknown device on guest port 2. */
1283
1674
  gp2UnknownDevice: boolean;
1284
1675
  /** Unknown device on guest port 3. */
1285
1676
  gp3UnknownDevice: boolean;
1677
+ /** Unknown device on guest port 4. */
1678
+ gp4UnknownDevice: boolean;
1679
+ /** Unknown device on guest port 5. */
1680
+ gp5UnknownDevice: boolean;
1681
+ /** Unknown device on guest port 6. */
1682
+ gp6UnknownDevice: boolean;
1286
1683
  /** Guest port 1 connection error. */
1287
1684
  gp1DeviceConnection: boolean;
1288
1685
  /** Guest port 2 connection error. */
1289
1686
  gp2DeviceConnection: boolean;
1290
1687
  /** Guest port 3 connection error. */
1291
1688
  gp3DeviceConnection: boolean;
1689
+ /** Guest port 4 connection error. */
1690
+ gp4DeviceConnection: boolean;
1691
+ /** Guest port 5 connection error. */
1692
+ gp5DeviceConnection: boolean;
1693
+ /** Guest port 6 connection error. */
1694
+ gp6DeviceConnection: boolean;
1292
1695
  /** Guest port 1 device error. */
1293
1696
  gp1Device: boolean;
1294
1697
  /** Guest port 2 device error. */
1295
1698
  gp2Device: boolean;
1296
1699
  /** Guest port 3 device error. */
1297
1700
  gp3Device: boolean;
1701
+ /** Guest port 4 device error. */
1702
+ gp4Device: boolean;
1703
+ /** Guest port 5 device error. */
1704
+ gp5Device: boolean;
1705
+ /** Guest port 6 device error. */
1706
+ gp6Device: boolean;
1707
+ /** Device on guest port 1 requires interfaces the port does not provide. */
1708
+ gp1IncompatibleDevice: boolean;
1709
+ /** Device on guest port 2 requires interfaces the port does not provide. */
1710
+ gp2IncompatibleDevice: boolean;
1711
+ /** Device on guest port 3 requires interfaces the port does not provide. */
1712
+ gp3IncompatibleDevice: boolean;
1713
+ /** Device on guest port 4 requires interfaces the port does not provide. */
1714
+ gp4IncompatibleDevice: boolean;
1715
+ /** Device on guest port 5 requires interfaces the port does not provide. */
1716
+ gp5IncompatibleDevice: boolean;
1717
+ /** Device on guest port 6 requires interfaces the port does not provide. */
1718
+ gp6IncompatibleDevice: boolean;
1298
1719
  /** Drone serial number not set. */
1299
1720
  droneSerialNotSet: boolean;
1300
1721
  /** Drone serial number error. */
@@ -1325,14 +1746,44 @@ export interface ErrorFlags {
1325
1746
  gpCurrentRead: boolean;
1326
1747
  /** Max GP current exceeded. */
1327
1748
  gpCurrent: boolean;
1328
- /** Max battery current exceeded on GP1. */
1749
+ /** Max battery current exceeded on guest port 1. */
1329
1750
  gp1BatCurrent: boolean;
1330
- /** Max battery current exceeded on GP2. */
1751
+ /** Max battery current exceeded on guest port 2. */
1331
1752
  gp2BatCurrent: boolean;
1332
- /** Max battery current exceeded on GP3. */
1753
+ /** Max battery current exceeded on guest port 3. */
1333
1754
  gp3BatCurrent: boolean;
1334
- /** Max 20V current exceeded on GP. */
1335
- gp20vCurrent: boolean;
1755
+ /** Max battery current exceeded on guest port 4. */
1756
+ gp4BatCurrent: boolean;
1757
+ /** Max battery current exceeded on guest port 5. */
1758
+ gp5BatCurrent: boolean;
1759
+ /** Max battery current exceeded on guest port 6. */
1760
+ gp6BatCurrent: boolean;
1761
+ /** Max 24V current exceeded on GP. Only present on X1/X3 (not X3 Ultra or X7). */
1762
+ gp24vCurrent: boolean;
1763
+ /** Max 24V current exceeded on guest port 1. */
1764
+ gp124vCurrent: boolean;
1765
+ /** Max 24V current exceeded on guest port 2. */
1766
+ gp224vCurrent: boolean;
1767
+ /** Max 24V current exceeded on guest port 3. */
1768
+ gp324vCurrent: boolean;
1769
+ /** Max 24V current exceeded on guest port 4. */
1770
+ gp424vCurrent: boolean;
1771
+ /** Max 24V current exceeded on guest port 5. */
1772
+ gp524vCurrent: boolean;
1773
+ /** Max 24V current exceeded on guest port 6. */
1774
+ gp624vCurrent: boolean;
1775
+ /** Max 5V current exceeded on guest port 1. */
1776
+ gp15vCurrent: boolean;
1777
+ /** Max 5V current exceeded on guest port 2. */
1778
+ gp25vCurrent: boolean;
1779
+ /** Max 5V current exceeded on guest port 3. */
1780
+ gp35vCurrent: boolean;
1781
+ /** Max 5V current exceeded on guest port 4. */
1782
+ gp45vCurrent: boolean;
1783
+ /** Max 5V current exceeded on guest port 5. */
1784
+ gp55vCurrent: boolean;
1785
+ /** Max 5V current exceeded on guest port 6. */
1786
+ gp65vCurrent: boolean;
1336
1787
  /** DVL is in thermal protection mode. */
1337
1788
  dvlThermalProtectionMode: boolean;
1338
1789
  /** GP protection has been triggered at boot or faulty DVL. */
@@ -1352,22 +1803,57 @@ export interface CameraParameters {
1352
1803
  mjpgBitrate: number;
1353
1804
  /** Shutter speed (1/10000 * s), -1 for automatic exposure. */
1354
1805
  exposure: number;
1355
- /** White balance temperature (2800..9300), -1 for automatic white balance. */
1806
+ /** White balance temp (Pioneer/Pro/X1/X3: 2800..9300, Ultra: 2300..15000), -1 for auto. */
1356
1807
  whiteBalance: number;
1357
- /** Hue (-40..40), 0 as default. */
1808
+ /** Hue (-40..40), 0 as default. Only available on Pioneer/Pro/X1/X3. */
1358
1809
  hue: number;
1359
- /** Iso gain (0..1). */
1810
+ /** Iso gain (0..1). Only available on Pioneer/Pro/X1/X3. */
1360
1811
  gain: number;
1812
+ /** Brightness (-10..10), 0 as default. Only available on Ultra */
1813
+ brightness: number;
1814
+ /** Contrast (-50..50), 0 as default. Only available on Ultra. */
1815
+ contrast: number;
1816
+ /** Saturation (0..50), 8 as default. Only available on Ultra. */
1817
+ saturation: number;
1818
+ /** Gamma (4..79), 22 as default. Only available on Ultra. */
1819
+ gamma: number;
1820
+ /** Sharpness (-20..20), -20 as default. Only available on Ultra. */
1821
+ sharpness: number;
1822
+ /** Backlight compensation (-150..150), 10 as default. Only available on Ultra. */
1823
+ backlightCompensation: number;
1824
+ /** Noise reduction (-20..20), -20 as default. Only available on Ultra. */
1825
+ denoise: number;
1826
+ /** Enable eHDR mode. Default true. Only available on Ultra. */
1827
+ ehdrEnabled: boolean;
1828
+ /** Minimum number of eHDR frames. (1..4), default 1. Only available on Ultra. */
1829
+ ehdrExposureMinNumber: number;
1830
+ /** Maximum number of eHDR frames. (1..4), default 2. Only on Ultra. Setting larger than 2 can reduce the framerate. */
1831
+ ehdrExposureMaxNumber: number;
1361
1832
  /** Stream, recording and image resolution (deprecated). */
1362
1833
  resolution: Resolution;
1363
1834
  /** Stream resolution. */
1364
1835
  streamResolution: Resolution;
1365
1836
  /** Recording and image resolution. */
1366
1837
  recordingResolution: Resolution;
1838
+ /** Streaming protocol. */
1839
+ streamingProtocol: StreamingProtocol;
1367
1840
  /** Stream and recording framerate. */
1368
1841
  framerate: Framerate;
1369
1842
  /** Which camera the parameters belong to. */
1370
1843
  camera: Camera;
1844
+ /**
1845
+ * Network MTU (Maximum Transmission Unit) size for video streaming in bytes (68..65535).
1846
+ * If 0 or unset, the system will use a default of 1400.
1847
+ * The Blueye App allows users to set values between 500 and 1460.
1848
+ */
1849
+ mtuSize: number;
1850
+ /** Recording video codec. If unset, uses platform default. */
1851
+ recordingCodec: RecordingCodec;
1852
+ /**
1853
+ * Recording bitrate in bits/sec. If 0 or unset, a default is computed based
1854
+ * on resolution, framerate, and encoding. Set explicitly to override.
1855
+ */
1856
+ recordingBitrate: number;
1371
1857
  }
1372
1858
  /**
1373
1859
  * Overlay parameters.
@@ -1457,6 +1943,13 @@ export interface GuestPortDevice {
1457
1943
  requiredBlunuxVersion: string;
1458
1944
  /** Detach status based on detection pin. */
1459
1945
  detachStatus: GuestPortDetachStatus;
1946
+ /** Interfaces the device requires from the port. */
1947
+ requiredCapabilities: GuestPortCapability[];
1948
+ /**
1949
+ * Ports on this drone where the device is fully supported. Computed by the
1950
+ * drone from the port capabilities and the device requirements.
1951
+ */
1952
+ compatibleGuestPorts: GuestPortNumber[];
1460
1953
  }
1461
1954
  /** List of guest port devices. */
1462
1955
  export interface GuestPortDeviceList {
@@ -1471,6 +1964,8 @@ export interface GuestPortConnectorInfo {
1471
1964
  error?: GuestPortError | undefined;
1472
1965
  /** Guest port the connector is connected to. */
1473
1966
  guestPortNumber: GuestPortNumber;
1967
+ /** Interfaces this port provides. */
1968
+ capabilities: GuestPortCapability[];
1474
1969
  }
1475
1970
  /** GuestPort information. */
1476
1971
  export interface GuestPortInfo {
@@ -1480,6 +1975,12 @@ export interface GuestPortInfo {
1480
1975
  gp2: GuestPortConnectorInfo | undefined;
1481
1976
  /** Information about guest port 3. */
1482
1977
  gp3: GuestPortConnectorInfo | undefined;
1978
+ /** Information about guest port 4. */
1979
+ gp4: GuestPortConnectorInfo | undefined;
1980
+ /** Information about guest port 5. */
1981
+ gp5: GuestPortConnectorInfo | undefined;
1982
+ /** Information about guest port 6. */
1983
+ gp6: GuestPortConnectorInfo | undefined;
1483
1984
  }
1484
1985
  /** GuestPort restart information. */
1485
1986
  export interface GuestPortRestartInfo {
@@ -1524,8 +2025,38 @@ export interface GuestPortCurrent {
1524
2025
  gp2Bat: number;
1525
2026
  /** Current on GP3 battery voltage (A). */
1526
2027
  gp3Bat: number;
1527
- /** Current on common 20V supply (A). */
1528
- gp20v: number;
2028
+ /** Current on common/input 24V supply (A). Only present on X1/X3 (not X3 Ultra or X7). */
2029
+ gp24v: number;
2030
+ /** Current on GP4 battery voltage (A). */
2031
+ gp4Bat: number;
2032
+ /** Current on GP5 battery voltage (A). */
2033
+ gp5Bat: number;
2034
+ /** Current on GP6 battery voltage (A). */
2035
+ gp6Bat: number;
2036
+ /** Current on GP1 24V supply (A). */
2037
+ gp124v: number;
2038
+ /** Current on GP2 24V supply (A). */
2039
+ gp224v: number;
2040
+ /** Current on GP3 24V supply (A). */
2041
+ gp324v: number;
2042
+ /** Current on GP4 24V supply (A). */
2043
+ gp424v: number;
2044
+ /** Current on GP5 24V supply (A). */
2045
+ gp524v: number;
2046
+ /** Current on GP6 24V supply (A). */
2047
+ gp624v: number;
2048
+ /** Current on GP1 5V supply (A). */
2049
+ gp15v: number;
2050
+ /** Current on GP2 5V supply (A). */
2051
+ gp25v: number;
2052
+ /** Current on GP3 5V supply (A). */
2053
+ gp35v: number;
2054
+ /** Current on GP4 5V supply (A). */
2055
+ gp45v: number;
2056
+ /** Current on GP5 5V supply (A). */
2057
+ gp55v: number;
2058
+ /** Current on GP6 5V supply (A). */
2059
+ gp65v: number;
1529
2060
  }
1530
2061
  /** Vector with 3 elements. */
1531
2062
  export interface Vector3 {
@@ -1593,8 +2124,7 @@ export interface MultibeamPing {
1593
2124
  /** Size in bytes of each row in the ping data image. */
1594
2125
  step: number;
1595
2126
  /**
1596
- * Bearing angle of each column of the sonar data
1597
- * (in 100th of a degree, multiply by 0.01 to get a value in degrees).
2127
+ * Bearing angle of each column of the sonar data in degrees.
1598
2128
  * The sonar image is not sampled uniformly in the bearing direction.
1599
2129
  */
1600
2130
  bearings: number[];
@@ -1604,6 +2134,16 @@ export interface MultibeamPing {
1604
2134
  deviceId: GuestPortDeviceID;
1605
2135
  /** Timestamp when the frame was generated. */
1606
2136
  frameGenerationTimestamp: Date | undefined;
2137
+ /** Heading (°). */
2138
+ heading: number;
2139
+ /** Pitch (°). */
2140
+ pitch: number;
2141
+ /** Roll (°). */
2142
+ roll: number;
2143
+ /** External temperature (°C). */
2144
+ temperature: number;
2145
+ /** External pressure (bar). */
2146
+ pressure: number;
1607
2147
  }
1608
2148
  /** Configuration message for sonar devices. */
1609
2149
  export interface MultibeamConfig {
@@ -1734,7 +2274,7 @@ export interface PersistentStorageSettings {
1734
2274
  accCalibration: boolean;
1735
2275
  }
1736
2276
  /**
1737
- * CPU information.
2277
+ * CPU information (deprecated, use SystemPerformanceInfo instead).
1738
2278
  *
1739
2279
  * Contains information about the CPU load and memory usage of the drone.
1740
2280
  */
@@ -1747,11 +2287,377 @@ export interface CPUInfo {
1747
2287
  mainQueueLoad: number;
1748
2288
  /** Guestport queue load (0..1). */
1749
2289
  guestportQueueLoad: number;
2290
+ /** Communication queue load (0..1). */
2291
+ commQueueLoad: number;
2292
+ }
2293
+ /** Per-core CPU utilization. */
2294
+ export interface CpuCoreLoad {
2295
+ /** Core index (0-based). */
2296
+ coreIndex: number;
2297
+ /** Core load (0..1). */
2298
+ load: number;
2299
+ /** Current clock frequency (MHz). */
2300
+ frequencyMhz: number;
2301
+ }
2302
+ /** GPU utilization and status. */
2303
+ export interface GpuInfo {
2304
+ /** GPU load (0..1). */
2305
+ load: number;
2306
+ /** Current GPU clock frequency (MHz). */
2307
+ frequencyMhz: number;
2308
+ }
2309
+ /**
2310
+ * Deep Learning Accelerator (DLA) utilization.
2311
+ *
2312
+ * Jetson Orin NX has two DLA engines used for inference offload.
2313
+ */
2314
+ export interface DlaInfo {
2315
+ /** DLA engine index (0-based). */
2316
+ engineIndex: number;
2317
+ /** DLA engine load (0..1). */
2318
+ load: number;
2319
+ /** Core clock frequency (MHz). 0 when disabled. */
2320
+ frequencyMhz: number;
2321
+ /** True when the DLA engine is actively processing. */
2322
+ enabled: boolean;
2323
+ /** Falcon microcontroller clock frequency (MHz). 0 when disabled. */
2324
+ falconFrequencyMhz: number;
2325
+ }
2326
+ /** System memory information. */
2327
+ export interface MemoryInfo {
2328
+ /** Total RAM (bytes). */
2329
+ totalBytes: number;
2330
+ /** Used RAM (bytes). */
2331
+ usedBytes: number;
2332
+ /** Cached RAM (bytes). */
2333
+ cachedBytes: number;
2334
+ /** Memory bus utilization (0..1). i.MX only. */
2335
+ busLoad: number;
2336
+ }
2337
+ /** Thermal zone reading. */
2338
+ export interface ThermalZone {
2339
+ /** Thermal zone identifier. */
2340
+ zone: ThermalZoneId;
2341
+ /** Temperature (°C). */
2342
+ temperature: number;
2343
+ }
2344
+ /** Video codec engine status. */
2345
+ export interface VideoCodecInfo {
2346
+ /** Jetson only (NVENC/NVDEC/NVJPG/VIC devfreq). */
2347
+ encoderActive: boolean;
2348
+ /** Video encoder clock frequency (MHz). */
2349
+ encoderFrequencyMhz: number;
2350
+ /** Video decoder (NVDEC) is active. */
2351
+ decoderActive: boolean;
2352
+ /** Video decoder clock frequency (MHz). */
2353
+ decoderFrequencyMhz: number;
2354
+ /** JPEG engine (NVJPG) is active. */
2355
+ nvjpgActive: boolean;
2356
+ /** JPEG engine clock frequency (MHz). */
2357
+ nvjpgFrequencyMhz: number;
2358
+ /** Video Image Compositor (VIC) is active. */
2359
+ vicActive: boolean;
2360
+ /** VIC clock frequency (MHz). */
2361
+ vicFrequencyMhz: number;
2362
+ /** i.MX only (CODA VPU). */
2363
+ vpuActive: boolean;
2364
+ /** VPU AXI clock frequency (MHz). */
2365
+ vpuFrequencyMhz: number;
2366
+ /** Cumulative VPU_CODEC_IRQ count. */
2367
+ vpuCodecIrqCount: number;
2368
+ /** Cumulative VPU_JPG_IRQ count. */
2369
+ vpuJpgIrqCount: number;
2370
+ /** Jetson only (host1x actmon engine utilization, 0..1). */
2371
+ encoderLoad: number;
2372
+ /** Video decoder (NVDEC) utilization (0..1). */
2373
+ decoderLoad: number;
2374
+ /** JPEG engine (NVJPG) utilization (0..1). */
2375
+ nvjpgLoad: number;
2376
+ /** Video Image Compositor (VIC) utilization (0..1). */
2377
+ vicLoad: number;
2378
+ }
2379
+ /**
2380
+ * NVMe SSD health, wear and identity (Jetson only; i.MX drones boot/store on
2381
+ * an SD card and have no NVMe device, so this message is omitted there).
2382
+ */
2383
+ export interface NvmeInfo {
2384
+ /** Tier 1 — health & safety. */
2385
+ compositeTemperature: number;
2386
+ /** NVMe critical-warning bitfield. */
2387
+ criticalWarning: number;
2388
+ /** Wear indicator (%, may exceed 100). */
2389
+ percentageUsed: number;
2390
+ /** Remaining spare capacity (%). */
2391
+ availableSpare: number;
2392
+ /** Spare alarm threshold (%). */
2393
+ availableSpareThreshold: number;
2394
+ /** Uncorrected data-integrity errors. */
2395
+ mediaErrors: number;
2396
+ /** Power-loss / unsafe shutdown count. */
2397
+ unsafeShutdowns: number;
2398
+ /** Tier 2 — thermal throttling. */
2399
+ warningTempTimeMin: number;
2400
+ /** Minutes above the critical temperature. */
2401
+ criticalTempTimeMin: number;
2402
+ /** Times entered light throttling. */
2403
+ thermalMgmtT1TransCount: number;
2404
+ /** Times entered heavy throttling. */
2405
+ thermalMgmtT2TransCount: number;
2406
+ /** Total seconds in light throttling. */
2407
+ thermalMgmtT1TotalTimeS: number;
2408
+ /** Total seconds in heavy throttling. */
2409
+ thermalMgmtT2TotalTimeS: number;
2410
+ /** Tier 3 — endurance / workload. */
2411
+ dataUnitsWrittenBytes: number;
2412
+ /** Host data read (B). */
2413
+ dataUnitsReadBytes: number;
2414
+ /** Host write command count. */
2415
+ hostWriteCommands: number;
2416
+ /** Host read command count. */
2417
+ hostReadCommands: number;
2418
+ /** Power-on hours. */
2419
+ powerOnHours: number;
2420
+ /** Power cycle count. */
2421
+ powerCycles: number;
2422
+ /** Controller busy time (min). */
2423
+ controllerBusyTimeMin: number;
2424
+ /** Error-log entry count. */
2425
+ numErrLogEntries: number;
2426
+ /** Tier 4 — identity & capacity. */
2427
+ model: string;
2428
+ /** Drive serial number. */
2429
+ serial: string;
2430
+ /** Firmware revision. */
2431
+ firmwareRev: string;
2432
+ /** Total drive capacity (B). Partition used/free is */
2433
+ capacityBytes: number;
2434
+ }
2435
+ /**
2436
+ * System performance information.
2437
+ *
2438
+ * Comprehensive performance metrics for the drone's compute platform.
2439
+ * Covers CPU, GPU, DLA, memory, thermals, video codec utilization and NVMe
2440
+ * SSD state. Fields not applicable to a platform are left at their
2441
+ * zero/empty defaults.
2442
+ */
2443
+ export interface SystemPerformanceInfo {
2444
+ /** Per-core CPU utilization. */
2445
+ cpuCores: CpuCoreLoad[];
2446
+ /** Mean CPU utilization across all cores (0..1). */
2447
+ cpuUtilization: number;
2448
+ /** GPU utilization. */
2449
+ gpu: GpuInfo | undefined;
2450
+ /** DLA engine utilization (Jetson only). */
2451
+ dlaEngines: DlaInfo[];
2452
+ /** RAM usage. */
2453
+ memory: MemoryInfo | undefined;
2454
+ /** All thermal zone readings. */
2455
+ thermalZones: ThermalZone[];
2456
+ /** Video encoder/decoder status. */
2457
+ videoCodec: VideoCodecInfo | undefined;
2458
+ /** Main queue load (0..1). */
2459
+ mainQueueLoad: number;
2460
+ /** Guestport queue load (0..1). */
2461
+ guestportQueueLoad: number;
2462
+ /** Communication queue load (0..1). */
2463
+ commQueueLoad: number;
2464
+ /** Camera queue load (0..1). */
2465
+ cameraQueueLoad: number;
2466
+ /** Overlay queue load (0..1). */
2467
+ overlayQueueLoad: number;
2468
+ /** Position observer queue load (0..1). */
2469
+ positionObserverQueueLoad: number;
2470
+ /** NVMe SSD health/identity (Jetson only). */
2471
+ nvme: NvmeInfo | undefined;
2472
+ }
2473
+ /**
2474
+ * Surface Unit battery information.
2475
+ *
2476
+ * This message is published by the Surface Unit, and re-published by
2477
+ * the drone over the communication protocol.
2478
+ */
2479
+ export interface SurfaceUnitBatteryInfo {
2480
+ /** Battery charge status. */
2481
+ status: SurfaceUnitBatteryInfo_ChargeStatus;
2482
+ /** Battery level (0..1). */
2483
+ level: number;
2484
+ }
2485
+ export declare enum SurfaceUnitBatteryInfo_ChargeStatus {
2486
+ CHARGE_STATUS_UNSPECIFIED = 0,
2487
+ CHARGE_STATUS_DISCHARGE = 1,
2488
+ CHARGE_STATUS_CHARGE = 2,
2489
+ CHARGE_STATUS_CHARGE_ERROR = 3,
2490
+ UNRECOGNIZED = -1
2491
+ }
2492
+ export declare function surfaceUnitBatteryInfo_ChargeStatusFromJSON(object: any): SurfaceUnitBatteryInfo_ChargeStatus;
2493
+ export declare function surfaceUnitBatteryInfo_ChargeStatusToJSON(object: SurfaceUnitBatteryInfo_ChargeStatus): string;
2494
+ /**
2495
+ * Surface Unit version information.
2496
+ *
2497
+ * This message is published by the Surface Unit, and re-published by
2498
+ * the drone over the communication protocol.
2499
+ */
2500
+ export interface SurfaceUnitVersionInfo {
2501
+ /** Surface Unit firmware version (x.y.z). */
2502
+ version: string;
2503
+ }
2504
+ /**
2505
+ * Bounding box for object detection.
2506
+ *
2507
+ * Coordinates are in pixels relative to the camera image,
2508
+ * where (x, y) is the top-left corner of the bounding box.
2509
+ */
2510
+ export interface BoundingBox {
2511
+ /** Horizontal offset of the top-left corner (px). */
2512
+ x: number;
2513
+ /** Vertical offset of the top-left corner (px). */
2514
+ y: number;
2515
+ /** Width of the bounding box (px). */
2516
+ width: number;
2517
+ /** Height of the bounding box (px). */
2518
+ height: number;
2519
+ }
2520
+ /**
2521
+ * RLE-encoded binary segmentation mask relative to the bounding box.
2522
+ *
2523
+ * The mask bitmap has dimensions (mask_width x mask_height) covering the
2524
+ * detection's bounding box area. The counts field stores run-length encoded
2525
+ * data as packed uint16 little-endian: alternating background/foreground
2526
+ * pixel runs starting with background.
2527
+ */
2528
+ export interface SegmentationMask {
2529
+ /** Width of the RLE bitmap. */
2530
+ maskWidth: number;
2531
+ /** Height of the RLE bitmap. */
2532
+ maskHeight: number;
2533
+ /** RLE counts as packed uint16 little-endian. */
2534
+ counts: Uint8Array;
2535
+ }
2536
+ /** A single object detection from a computer vision model. */
2537
+ export interface ObjectDetection {
2538
+ /** Bounding box of the detected object. */
2539
+ boundingBox: BoundingBox | undefined;
2540
+ /** Detection confidence score (0..1). */
2541
+ confidence: number;
2542
+ /** Numeric class identifier from the model. */
2543
+ classId: number;
2544
+ /** Human-readable class name. */
2545
+ className: string;
2546
+ /** Unique ID for tracking the same object across frames. */
2547
+ trackingId: number;
2548
+ /** Instance segmentation mask (absent if model has no segmentation). */
2549
+ mask: SegmentationMask | undefined;
2550
+ }
2551
+ /** A list of object detections from a single model for a single video frame. */
2552
+ export interface ModelDetections {
2553
+ /** List of detections in the frame. */
2554
+ detections: ObjectDetection[];
2555
+ /** Which camera the detections are from. */
2556
+ camera: Camera;
2557
+ /** Width of the source image (px). */
2558
+ imageWidth: number;
2559
+ /** Height of the source image (px). */
2560
+ imageHeight: number;
2561
+ /** Name of the computer vision model that produced the detections. */
2562
+ modelName: string;
2563
+ }
2564
+ /** Generic filter settings. */
2565
+ export interface FilterMessage {
2566
+ /** If the filter is enabled. */
2567
+ enabled: boolean;
2568
+ /** Intensity of the filter (0..1). */
2569
+ intensity: number;
2570
+ }
2571
+ /**
2572
+ * Digital pan, tilt, and zoom state for the main camera.
2573
+ *
2574
+ * Only supported on X3 Ultra. Controls digital (not mechanical) zoom.
2575
+ */
2576
+ export interface CameraPanTiltZoom {
2577
+ /** Horizontal pan (-1.0..1.0), where 0.0 is center. */
2578
+ pan: number;
2579
+ /** Vertical tilt (-1.0..1.0), where 0.0 is center. */
2580
+ tilt: number;
2581
+ /** Zoom level (0.0..1.0), where 0.0 is no zoom and 1.0 is maximum zoom. */
2582
+ zoom: number;
2583
+ }
2584
+ /**
2585
+ * Information about the operator controlling the drone.
2586
+ *
2587
+ * Used to identify who started a dive, for reporting and when importing
2588
+ * dives to Blueye Cloud.
2589
+ */
2590
+ export interface OperatorInfo {
2591
+ /** Full name of the operator. */
2592
+ name: string;
2593
+ /** E-mail address of the operator. */
2594
+ email: string;
2595
+ }
2596
+ /** Single-object tracking (SOT) state reported by the computer vision pipeline. */
2597
+ export interface SotState {
2598
+ /** Current tracking state. */
2599
+ state: SotState_State;
2600
+ /** Current tracked bounding box (valid when TRACKING). */
2601
+ boundingBox: BoundingBox | undefined;
2602
+ /** Width of the source frame in pixels. */
2603
+ imageWidth: number;
2604
+ /** Height of the source frame in pixels. */
2605
+ imageHeight: number;
2606
+ }
2607
+ /** Current state of the SOT tracker. */
2608
+ export declare enum SotState_State {
2609
+ /** STATE_UNSPECIFIED - Unspecified state. */
2610
+ STATE_UNSPECIFIED = 0,
2611
+ /** STATE_IDLE - No target selected, waiting for a target bounding box. */
2612
+ STATE_IDLE = 1,
2613
+ /** STATE_TRACKING - Actively tracking a target. */
2614
+ STATE_TRACKING = 2,
2615
+ /** STATE_LOST - Target was lost (tracker failed to follow the object). */
2616
+ STATE_LOST = 3,
2617
+ UNRECOGNIZED = -1
2618
+ }
2619
+ export declare function sotState_StateFromJSON(object: any): SotState_State;
2620
+ export declare function sotState_StateToJSON(object: SotState_State): string;
2621
+ /**
2622
+ * A single annotation added during a dive, e.g. by a diver tapping a type in the
2623
+ * app command palette, or emitted by the drone itself.
2624
+ *
2625
+ * Self-contained: it carries the type's display fields (name/icon/color) inline,
2626
+ * so the drone, any connected client, and the dive logfile can render it without
2627
+ * a separate catalog. The app keeps the full catalog locally (synced from
2628
+ * Blueye Cloud) to drive its palette, but only complete annotations go over the
2629
+ * wire. type_slug lets Blueye Cloud correlate the annotation to its type on import.
2630
+ *
2631
+ * The drone owns the timestamp: when this is logged the enclosing BinlogRecord
2632
+ * carries the time, like any other sample, so there is no time field here.
2633
+ */
2634
+ export interface Annotation {
2635
+ /** Stable type id for grouping / Cloud correlation. Empty for a free-form annotation. */
2636
+ typeSlug: string;
2637
+ /** Type display name, e.g. "Hazard". Snapshot of the type at creation time. */
2638
+ typeName: string;
2639
+ /** Font Awesome solid icon name, kebab-case (e.g. "triangle-exclamation"). */
2640
+ typeIcon: string;
2641
+ /** Type color, RGB hex incl. leading '#', 7 chars (e.g. "#DC2626"). */
2642
+ typeColor: string;
2643
+ /** Optional annotation title; Cloud falls back to type_name if empty. Max 200 chars. */
2644
+ title: string;
2645
+ /** Optional free-form note. Unbounded. */
2646
+ body: string;
2647
+ /** Optional span; omit for a point-in-time marker. */
2648
+ duration: Duration | undefined;
2649
+ /** Origin of the annotation; the app sets APP, the drone sets DRONE for its own. */
2650
+ source: AnnotationSource;
1750
2651
  }
1751
2652
  export declare const BinlogRecord: MessageFns<BinlogRecord>;
2653
+ export declare const LogEntry: MessageFns<LogEntry>;
2654
+ export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
2655
+ export declare const KernelLogEntry_KeyValuePair: MessageFns<KernelLogEntry_KeyValuePair>;
1752
2656
  export declare const MotionInput: MessageFns<MotionInput>;
1753
2657
  export declare const Lights: MessageFns<Lights>;
1754
2658
  export declare const Laser: MessageFns<Laser>;
2659
+ export declare const Point2D: MessageFns<Point2D>;
2660
+ export declare const LaserDetection: MessageFns<LaserDetection>;
1755
2661
  export declare const LatLongPosition: MessageFns<LatLongPosition>;
1756
2662
  export declare const ConnectionDuration: MessageFns<ConnectionDuration>;
1757
2663
  export declare const AutoHeadingState: MessageFns<AutoHeadingState>;
@@ -1800,11 +2706,15 @@ export declare const ControllerHealth: MessageFns<ControllerHealth>;
1800
2706
  export declare const DiveTime: MessageFns<DiveTime>;
1801
2707
  export declare const RecordOn: MessageFns<RecordOn>;
1802
2708
  export declare const StorageSpace: MessageFns<StorageSpace>;
2709
+ export declare const StoragePartition: MessageFns<StoragePartition>;
2710
+ export declare const RemovableStorageDevice: MessageFns<RemovableStorageDevice>;
2711
+ export declare const RemovableStorageErrorFlags: MessageFns<RemovableStorageErrorFlags>;
1803
2712
  export declare const CalibrationState: MessageFns<CalibrationState>;
1804
2713
  export declare const IperfStatus: MessageFns<IperfStatus>;
1805
2714
  export declare const NStreamers: MessageFns<NStreamers>;
1806
2715
  export declare const TiltAngle: MessageFns<TiltAngle>;
1807
2716
  export declare const TiltVelocity: MessageFns<TiltVelocity>;
2717
+ export declare const CvModelInfo: MessageFns<CvModelInfo>;
1808
2718
  export declare const DroneInfo: MessageFns<DroneInfo>;
1809
2719
  export declare const ErrorFlags: MessageFns<ErrorFlags>;
1810
2720
  export declare const CameraParameters: MessageFns<CameraParameters>;
@@ -1831,6 +2741,25 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
1831
2741
  export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
1832
2742
  export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
1833
2743
  export declare const CPUInfo: MessageFns<CPUInfo>;
2744
+ export declare const CpuCoreLoad: MessageFns<CpuCoreLoad>;
2745
+ export declare const GpuInfo: MessageFns<GpuInfo>;
2746
+ export declare const DlaInfo: MessageFns<DlaInfo>;
2747
+ export declare const MemoryInfo: MessageFns<MemoryInfo>;
2748
+ export declare const ThermalZone: MessageFns<ThermalZone>;
2749
+ export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
2750
+ export declare const NvmeInfo: MessageFns<NvmeInfo>;
2751
+ export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
2752
+ export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
2753
+ export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
2754
+ export declare const BoundingBox: MessageFns<BoundingBox>;
2755
+ export declare const SegmentationMask: MessageFns<SegmentationMask>;
2756
+ export declare const ObjectDetection: MessageFns<ObjectDetection>;
2757
+ export declare const ModelDetections: MessageFns<ModelDetections>;
2758
+ export declare const FilterMessage: MessageFns<FilterMessage>;
2759
+ export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
2760
+ export declare const OperatorInfo: MessageFns<OperatorInfo>;
2761
+ export declare const SotState: MessageFns<SotState>;
2762
+ export declare const Annotation: MessageFns<Annotation>;
1834
2763
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
1835
2764
  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 {} ? {
1836
2765
  [K in keyof T]?: DeepPartial<T[K]>;