@blueyerobotics/protocol-definitions 3.2.0-9c4aad9c → 3.2.0-9cd842f0

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;
@@ -184,6 +186,8 @@ export declare enum Model {
184
186
  MODEL_X3 = 3,
185
187
  /** MODEL_X3_ULTRA - Blueye X3 Ultra. */
186
188
  MODEL_X3_ULTRA = 6,
189
+ /** MODEL_X7 - Blueye X7. */
190
+ MODEL_X7 = 7,
187
191
  /** MODEL_NEXT - Blueye ? */
188
192
  MODEL_NEXT = 5,
189
193
  UNRECOGNIZED = -1
@@ -206,6 +210,24 @@ export declare enum PressureSensorType {
206
210
  }
207
211
  export declare function pressureSensorTypeFromJSON(object: any): PressureSensorType;
208
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;
209
231
  /** Available camera resolutions. */
210
232
  export declare enum Resolution {
211
233
  /** RESOLUTION_UNSPECIFIED - Resolution not specified. */
@@ -218,11 +240,18 @@ export declare enum Resolution {
218
240
  RESOLUTION_FULLHD_1080P = 1,
219
241
  /** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
220
242
  RESOLUTION_UHD_4K = 3,
243
+ /** RESOLUTION_QHD_2K - 2K QHD (2560x1440, Only supported on X3 Ultra). */
244
+ RESOLUTION_QHD_2K = 5,
221
245
  UNRECOGNIZED = -1
222
246
  }
223
247
  export declare function resolutionFromJSON(object: any): Resolution;
224
248
  export declare function resolutionToJSON(object: Resolution): string;
225
- /** 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
+ */
226
255
  export declare enum Framerate {
227
256
  /** FRAMERATE_UNSPECIFIED - Framerate not specified. */
228
257
  FRAMERATE_UNSPECIFIED = 0,
@@ -230,6 +259,8 @@ export declare enum Framerate {
230
259
  FRAMERATE_FPS_30 = 1,
231
260
  /** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
232
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,
233
264
  UNRECOGNIZED = -1
234
265
  }
235
266
  export declare function framerateFromJSON(object: any): Framerate;
@@ -257,6 +288,18 @@ export declare enum StreamingProtocol {
257
288
  }
258
289
  export declare function streamingProtocolFromJSON(object: any): StreamingProtocol;
259
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;
260
303
  /** Available temperature units. */
261
304
  export declare enum TemperatureUnit {
262
305
  /** TEMPERATURE_UNIT_UNSPECIFIED - Temperature unit not specified. */
@@ -323,6 +366,8 @@ export declare enum FontSize {
323
366
  FONT_SIZE_PX35 = 5,
324
367
  /** FONT_SIZE_PX40 - 40 px. */
325
368
  FONT_SIZE_PX40 = 6,
369
+ /** FONT_SIZE_PX50 - 50 px. */
370
+ FONT_SIZE_PX50 = 7,
326
371
  UNRECOGNIZED = -1
327
372
  }
328
373
  export declare function fontSizeFromJSON(object: any): FontSize;
@@ -423,6 +468,10 @@ export declare enum GuestPortDeviceID {
423
468
  GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE = 45,
424
469
  /** GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 - Blueye Multibeam Skid Servo V2. */
425
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,
426
475
  UNRECOGNIZED = -1
427
476
  }
428
477
  export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
@@ -437,6 +486,12 @@ export declare enum GuestPortNumber {
437
486
  GUEST_PORT_NUMBER_PORT_2 = 2,
438
487
  /** GUEST_PORT_NUMBER_PORT_3 - Guest port 3. */
439
488
  GUEST_PORT_NUMBER_PORT_3 = 3,
489
+ /** GUEST_PORT_NUMBER_PORT_4 - Guest port 4. */
490
+ GUEST_PORT_NUMBER_PORT_4 = 4,
491
+ /** GUEST_PORT_NUMBER_PORT_5 - Guest port 5. */
492
+ GUEST_PORT_NUMBER_PORT_5 = 5,
493
+ /** GUEST_PORT_NUMBER_PORT_6 - Guest port 6. */
494
+ GUEST_PORT_NUMBER_PORT_6 = 6,
440
495
  UNRECOGNIZED = -1
441
496
  }
442
497
  export declare function guestPortNumberFromJSON(object: any): GuestPortNumber;
@@ -508,6 +563,48 @@ export declare enum MultibeamFrequencyMode {
508
563
  }
509
564
  export declare function multibeamFrequencyModeFromJSON(object: any): MultibeamFrequencyMode;
510
565
  export declare function multibeamFrequencyModeToJSON(object: MultibeamFrequencyMode): string;
566
+ /** Thermal zone identifiers. */
567
+ export declare enum ThermalZoneId {
568
+ /** THERMAL_ZONE_ID_UNSPECIFIED - Unspecified thermal zone. */
569
+ THERMAL_ZONE_ID_UNSPECIFIED = 0,
570
+ /** THERMAL_ZONE_ID_TJ - Junction temperature (Tj). */
571
+ THERMAL_ZONE_ID_TJ = 1,
572
+ /** THERMAL_ZONE_ID_CANISTER - Canister temperature. */
573
+ THERMAL_ZONE_ID_CANISTER = 2,
574
+ /** THERMAL_ZONE_ID_CPU - CPU thermal zone. */
575
+ THERMAL_ZONE_ID_CPU = 3,
576
+ /** THERMAL_ZONE_ID_GPU - GPU thermal zone. */
577
+ THERMAL_ZONE_ID_GPU = 4,
578
+ /** THERMAL_ZONE_ID_CV0 - Vision accelerator 0 thermal zone. */
579
+ THERMAL_ZONE_ID_CV0 = 5,
580
+ /** THERMAL_ZONE_ID_CV1 - Vision accelerator 1 thermal zone. */
581
+ THERMAL_ZONE_ID_CV1 = 6,
582
+ /** THERMAL_ZONE_ID_CV2 - Vision accelerator 2 thermal zone. */
583
+ THERMAL_ZONE_ID_CV2 = 7,
584
+ /** THERMAL_ZONE_ID_SOC0 - SoC 0 thermal zone. */
585
+ THERMAL_ZONE_ID_SOC0 = 8,
586
+ /** THERMAL_ZONE_ID_SOC1 - SoC 1 thermal zone. */
587
+ THERMAL_ZONE_ID_SOC1 = 9,
588
+ /** THERMAL_ZONE_ID_SOC2 - SoC 2 thermal zone. */
589
+ THERMAL_ZONE_ID_SOC2 = 10,
590
+ UNRECOGNIZED = -1
591
+ }
592
+ export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
593
+ export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
594
+ /** Origin of an annotation. Mirrors the AnnotationSource enum in Blueye Cloud. */
595
+ export declare enum AnnotationSource {
596
+ /** ANNOTATION_SOURCE_UNSPECIFIED - Origin not specified. */
597
+ ANNOTATION_SOURCE_UNSPECIFIED = 0,
598
+ /** ANNOTATION_SOURCE_CLOUD - Created in Blueye Cloud after the dive. */
599
+ ANNOTATION_SOURCE_CLOUD = 1,
600
+ /** ANNOTATION_SOURCE_APP - Created in the app during the dive. */
601
+ ANNOTATION_SOURCE_APP = 2,
602
+ /** ANNOTATION_SOURCE_DRONE - Emitted by the drone itself. */
603
+ ANNOTATION_SOURCE_DRONE = 3,
604
+ UNRECOGNIZED = -1
605
+ }
606
+ export declare function annotationSourceFromJSON(object: any): AnnotationSource;
607
+ export declare function annotationSourceToJSON(object: AnnotationSource): string;
511
608
  /**
512
609
  * Wrapper message for each entry in the drone telemetry logfile.
513
610
  *
@@ -641,6 +738,46 @@ export interface Lights {
641
738
  export interface Laser {
642
739
  /** Laser intensity, any value above 0 turns the laser on (0..1). */
643
740
  value: number;
741
+ /** Modulate the laser at 5Hz for tracking. Only available on Ultra. */
742
+ modulated: boolean;
743
+ }
744
+ /** Point in 2D space. */
745
+ export interface Point2D {
746
+ /** X coordinate of the point (px). */
747
+ x: number;
748
+ /** Y coordinate of the point (px). */
749
+ y: number;
750
+ }
751
+ /**
752
+ * Message representing the detection of scaling lasers in the main camera.
753
+ *
754
+ * The message contains the centroids of the detected dots, the distance between them in pixels,
755
+ * and the confidence of the detection. The dots are detected through temporal DFT analysis of
756
+ * 5 Hz laser modulation, isolating flickering pixels from the static scene background.
757
+ *
758
+ * Only available on Ultra.
759
+ */
760
+ export interface LaserDetection {
761
+ /** True if the laser is detected by the drone. */
762
+ detected: boolean;
763
+ /** First dot centroid (leftmost). */
764
+ dot1: Point2D | undefined;
765
+ /** Second dot centroid (rightmost). */
766
+ dot2: Point2D | undefined;
767
+ /** Distance between dots in pixels. */
768
+ pixelDistance: number;
769
+ /** Confidence of the detection (0..1). */
770
+ confidence: number;
771
+ /** Source frame width. */
772
+ imageWidth: number;
773
+ /** Source frame height. */
774
+ imageHeight: number;
775
+ /** Real world distance between the two laser dots (m). */
776
+ laserWidth: number;
777
+ /** Distance after lens undistortion (px). */
778
+ correctedPixelDistance: number;
779
+ /** Estimated subject distance (m). */
780
+ estimatedDistance: number;
644
781
  }
645
782
  /** Latitude and longitude position in WGS 84 decimal degrees format. */
646
783
  export interface LatLongPosition {
@@ -776,8 +913,12 @@ export interface RecordState {
776
913
  multibeamSeconds: number;
777
914
  /** Multibeam record fps. */
778
915
  multibeamFps: number;
779
- /** Storage location used for recording. */
780
- storageLocation: StorageLocation;
916
+ /** Storage location used for main camera recording. */
917
+ mainStorageLocation: StorageLocation;
918
+ /** Storage location used for guestport camera recording. */
919
+ guestportStorageLocation: StorageLocation;
920
+ /** Storage location used for multibeam recording. */
921
+ multibeamStorageLocation: StorageLocation;
781
922
  }
782
923
  /** Time-lapse state published if time-lapse mission is running. */
783
924
  export interface TimeLapseState {
@@ -823,7 +964,7 @@ export interface WaterTemperature {
823
964
  /** Water temperature (°C). */
824
965
  value: number;
825
966
  }
826
- /** CPU temperature. */
967
+ /** CPU temperature (deprecated, use SystemPerformanceInfo.thermal_zones instead). */
827
968
  export interface CPUTemperature {
828
969
  /** CPU temperature (°C). */
829
970
  value: number;
@@ -1295,10 +1436,12 @@ export declare enum RemovableStorageDevice_Status {
1295
1436
  STATUS_UNSPECIFIED = 0,
1296
1437
  /** STATUS_READY - The storage device is valid and ready for use. */
1297
1438
  STATUS_READY = 1,
1298
- /** STATUS_FORMATTING - The storage device is being formatted */
1439
+ /** STATUS_FORMATTING - The storage device is being formatted. */
1299
1440
  STATUS_FORMATTING = 2,
1300
1441
  /** STATUS_ERROR - The storage device is in an error state. */
1301
1442
  STATUS_ERROR = 3,
1443
+ /** STATUS_UNPLUGGED - The storage device is not present. */
1444
+ STATUS_UNPLUGGED = 4,
1302
1445
  UNRECOGNIZED = -1
1303
1446
  }
1304
1447
  export declare function removableStorageDevice_StatusFromJSON(object: any): RemovableStorageDevice_Status;
@@ -1394,6 +1537,31 @@ export interface TiltVelocity {
1394
1537
  /**
1395
1538
  * Information about the drone.
1396
1539
  *
1540
+ * Information about a loaded computer vision model.
1541
+ */
1542
+ export interface CvModelInfo {
1543
+ /** Human-readable model name (from model_meta.json). */
1544
+ name: string;
1545
+ /** Type of CV model. */
1546
+ type: CvModelInfo_ModelType;
1547
+ /** Whether the model is currently running. */
1548
+ running: boolean;
1549
+ /** Execution provider (e.g. "cuda", "tensorrt"). */
1550
+ device: string;
1551
+ /** Package directory name (e.g. "tinyyolov2_package"). Stable identifier. */
1552
+ packageId: string;
1553
+ /** Class names the model can detect (indexed by class_id). */
1554
+ labels: string[];
1555
+ }
1556
+ export declare enum CvModelInfo_ModelType {
1557
+ MODEL_TYPE_UNSPECIFIED = 0,
1558
+ MODEL_TYPE_DETECTION = 1,
1559
+ MODEL_TYPE_SOT = 2,
1560
+ UNRECOGNIZED = -1
1561
+ }
1562
+ export declare function cvModelInfo_ModelTypeFromJSON(object: any): CvModelInfo_ModelType;
1563
+ export declare function cvModelInfo_ModelTypeToJSON(object: CvModelInfo_ModelType): string;
1564
+ /**
1397
1565
  * This message contains serial numbers and version information for
1398
1566
  * internal components in the drone. Primarily used for diagnostics, or to
1399
1567
  * determine the origin of a logfile.
@@ -1421,6 +1589,10 @@ export interface DroneInfo {
1421
1589
  gp: GuestPortInfo | undefined;
1422
1590
  /** Type of depth sensor that is connected to the drone. */
1423
1591
  depthSensor: PressureSensorType;
1592
+ /** List of loaded computer vision models. */
1593
+ cvModels: CvModelInfo[];
1594
+ /** How the drone is powered. */
1595
+ powerSource: PowerSource;
1424
1596
  }
1425
1597
  /** Known error states for the drone. */
1426
1598
  export interface ErrorFlags {
@@ -1446,30 +1618,60 @@ export interface ErrorFlags {
1446
1618
  gp2Read: boolean;
1447
1619
  /** Guest port 3 read error. */
1448
1620
  gp3Read: boolean;
1621
+ /** Guest port 4 read error. */
1622
+ gp4Read: boolean;
1623
+ /** Guest port 5 read error. */
1624
+ gp5Read: boolean;
1625
+ /** Guest port 6 read error. */
1626
+ gp6Read: boolean;
1449
1627
  /** Guest port 1 not flashed. */
1450
1628
  gp1NotFlashed: boolean;
1451
1629
  /** Guest port 2 not flashed. */
1452
1630
  gp2NotFlashed: boolean;
1453
1631
  /** Guest port 3 not flashed. */
1454
1632
  gp3NotFlashed: boolean;
1633
+ /** Guest port 4 not flashed. */
1634
+ gp4NotFlashed: boolean;
1635
+ /** Guest port 5 not flashed. */
1636
+ gp5NotFlashed: boolean;
1637
+ /** Guest port 6 not flashed. */
1638
+ gp6NotFlashed: boolean;
1455
1639
  /** Unknown device on guest port 1. */
1456
1640
  gp1UnknownDevice: boolean;
1457
1641
  /** Unknown device on guest port 2. */
1458
1642
  gp2UnknownDevice: boolean;
1459
1643
  /** Unknown device on guest port 3. */
1460
1644
  gp3UnknownDevice: boolean;
1645
+ /** Unknown device on guest port 4. */
1646
+ gp4UnknownDevice: boolean;
1647
+ /** Unknown device on guest port 5. */
1648
+ gp5UnknownDevice: boolean;
1649
+ /** Unknown device on guest port 6. */
1650
+ gp6UnknownDevice: boolean;
1461
1651
  /** Guest port 1 connection error. */
1462
1652
  gp1DeviceConnection: boolean;
1463
1653
  /** Guest port 2 connection error. */
1464
1654
  gp2DeviceConnection: boolean;
1465
1655
  /** Guest port 3 connection error. */
1466
1656
  gp3DeviceConnection: boolean;
1657
+ /** Guest port 4 connection error. */
1658
+ gp4DeviceConnection: boolean;
1659
+ /** Guest port 5 connection error. */
1660
+ gp5DeviceConnection: boolean;
1661
+ /** Guest port 6 connection error. */
1662
+ gp6DeviceConnection: boolean;
1467
1663
  /** Guest port 1 device error. */
1468
1664
  gp1Device: boolean;
1469
1665
  /** Guest port 2 device error. */
1470
1666
  gp2Device: boolean;
1471
1667
  /** Guest port 3 device error. */
1472
1668
  gp3Device: boolean;
1669
+ /** Guest port 4 device error. */
1670
+ gp4Device: boolean;
1671
+ /** Guest port 5 device error. */
1672
+ gp5Device: boolean;
1673
+ /** Guest port 6 device error. */
1674
+ gp6Device: boolean;
1473
1675
  /** Drone serial number not set. */
1474
1676
  droneSerialNotSet: boolean;
1475
1677
  /** Drone serial number error. */
@@ -1500,14 +1702,44 @@ export interface ErrorFlags {
1500
1702
  gpCurrentRead: boolean;
1501
1703
  /** Max GP current exceeded. */
1502
1704
  gpCurrent: boolean;
1503
- /** Max battery current exceeded on GP1. */
1705
+ /** Max battery current exceeded on guest port 1. */
1504
1706
  gp1BatCurrent: boolean;
1505
- /** Max battery current exceeded on GP2. */
1707
+ /** Max battery current exceeded on guest port 2. */
1506
1708
  gp2BatCurrent: boolean;
1507
- /** Max battery current exceeded on GP3. */
1709
+ /** Max battery current exceeded on guest port 3. */
1508
1710
  gp3BatCurrent: boolean;
1509
- /** Max 20V current exceeded on GP. */
1510
- gp20vCurrent: boolean;
1711
+ /** Max battery current exceeded on guest port 4. */
1712
+ gp4BatCurrent: boolean;
1713
+ /** Max battery current exceeded on guest port 5. */
1714
+ gp5BatCurrent: boolean;
1715
+ /** Max battery current exceeded on guest port 6. */
1716
+ gp6BatCurrent: boolean;
1717
+ /** Max 24V current exceeded on GP. Only present on X1/X3 (not X3 Ultra or X7). */
1718
+ gp24vCurrent: boolean;
1719
+ /** Max 24V current exceeded on guest port 1. */
1720
+ gp124vCurrent: boolean;
1721
+ /** Max 24V current exceeded on guest port 2. */
1722
+ gp224vCurrent: boolean;
1723
+ /** Max 24V current exceeded on guest port 3. */
1724
+ gp324vCurrent: boolean;
1725
+ /** Max 24V current exceeded on guest port 4. */
1726
+ gp424vCurrent: boolean;
1727
+ /** Max 24V current exceeded on guest port 5. */
1728
+ gp524vCurrent: boolean;
1729
+ /** Max 24V current exceeded on guest port 6. */
1730
+ gp624vCurrent: boolean;
1731
+ /** Max 5V current exceeded on guest port 1. */
1732
+ gp15vCurrent: boolean;
1733
+ /** Max 5V current exceeded on guest port 2. */
1734
+ gp25vCurrent: boolean;
1735
+ /** Max 5V current exceeded on guest port 3. */
1736
+ gp35vCurrent: boolean;
1737
+ /** Max 5V current exceeded on guest port 4. */
1738
+ gp45vCurrent: boolean;
1739
+ /** Max 5V current exceeded on guest port 5. */
1740
+ gp55vCurrent: boolean;
1741
+ /** Max 5V current exceeded on guest port 6. */
1742
+ gp65vCurrent: boolean;
1511
1743
  /** DVL is in thermal protection mode. */
1512
1744
  dvlThermalProtectionMode: boolean;
1513
1745
  /** GP protection has been triggered at boot or faulty DVL. */
@@ -1565,6 +1797,19 @@ export interface CameraParameters {
1565
1797
  framerate: Framerate;
1566
1798
  /** Which camera the parameters belong to. */
1567
1799
  camera: Camera;
1800
+ /**
1801
+ * Network MTU (Maximum Transmission Unit) size for video streaming in bytes (68..65535).
1802
+ * If 0 or unset, the system will use a default of 1400.
1803
+ * The Blueye App allows users to set values between 500 and 1460.
1804
+ */
1805
+ mtuSize: number;
1806
+ /** Recording video codec. If unset, uses platform default. */
1807
+ recordingCodec: RecordingCodec;
1808
+ /**
1809
+ * Recording bitrate in bits/sec. If 0 or unset, a default is computed based
1810
+ * on resolution, framerate, and encoding. Set explicitly to override.
1811
+ */
1812
+ recordingBitrate: number;
1568
1813
  }
1569
1814
  /**
1570
1815
  * Overlay parameters.
@@ -1677,6 +1922,12 @@ export interface GuestPortInfo {
1677
1922
  gp2: GuestPortConnectorInfo | undefined;
1678
1923
  /** Information about guest port 3. */
1679
1924
  gp3: GuestPortConnectorInfo | undefined;
1925
+ /** Information about guest port 4. */
1926
+ gp4: GuestPortConnectorInfo | undefined;
1927
+ /** Information about guest port 5. */
1928
+ gp5: GuestPortConnectorInfo | undefined;
1929
+ /** Information about guest port 6. */
1930
+ gp6: GuestPortConnectorInfo | undefined;
1680
1931
  }
1681
1932
  /** GuestPort restart information. */
1682
1933
  export interface GuestPortRestartInfo {
@@ -1721,8 +1972,38 @@ export interface GuestPortCurrent {
1721
1972
  gp2Bat: number;
1722
1973
  /** Current on GP3 battery voltage (A). */
1723
1974
  gp3Bat: number;
1724
- /** Current on common 20V supply (A). */
1725
- gp20v: number;
1975
+ /** Current on common/input 24V supply (A). Only present on X1/X3 (not X3 Ultra or X7). */
1976
+ gp24v: number;
1977
+ /** Current on GP4 battery voltage (A). */
1978
+ gp4Bat: number;
1979
+ /** Current on GP5 battery voltage (A). */
1980
+ gp5Bat: number;
1981
+ /** Current on GP6 battery voltage (A). */
1982
+ gp6Bat: number;
1983
+ /** Current on GP1 24V supply (A). */
1984
+ gp124v: number;
1985
+ /** Current on GP2 24V supply (A). */
1986
+ gp224v: number;
1987
+ /** Current on GP3 24V supply (A). */
1988
+ gp324v: number;
1989
+ /** Current on GP4 24V supply (A). */
1990
+ gp424v: number;
1991
+ /** Current on GP5 24V supply (A). */
1992
+ gp524v: number;
1993
+ /** Current on GP6 24V supply (A). */
1994
+ gp624v: number;
1995
+ /** Current on GP1 5V supply (A). */
1996
+ gp15v: number;
1997
+ /** Current on GP2 5V supply (A). */
1998
+ gp25v: number;
1999
+ /** Current on GP3 5V supply (A). */
2000
+ gp35v: number;
2001
+ /** Current on GP4 5V supply (A). */
2002
+ gp45v: number;
2003
+ /** Current on GP5 5V supply (A). */
2004
+ gp55v: number;
2005
+ /** Current on GP6 5V supply (A). */
2006
+ gp65v: number;
1726
2007
  }
1727
2008
  /** Vector with 3 elements. */
1728
2009
  export interface Vector3 {
@@ -1930,7 +2211,7 @@ export interface PersistentStorageSettings {
1930
2211
  accCalibration: boolean;
1931
2212
  }
1932
2213
  /**
1933
- * CPU information.
2214
+ * CPU information (deprecated, use SystemPerformanceInfo instead).
1934
2215
  *
1935
2216
  * Contains information about the CPU load and memory usage of the drone.
1936
2217
  */
@@ -1946,6 +2227,186 @@ export interface CPUInfo {
1946
2227
  /** Communication queue load (0..1). */
1947
2228
  commQueueLoad: number;
1948
2229
  }
2230
+ /** Per-core CPU utilization. */
2231
+ export interface CpuCoreLoad {
2232
+ /** Core index (0-based). */
2233
+ coreIndex: number;
2234
+ /** Core load (0..1). */
2235
+ load: number;
2236
+ /** Current clock frequency (MHz). */
2237
+ frequencyMhz: number;
2238
+ }
2239
+ /** GPU utilization and status. */
2240
+ export interface GpuInfo {
2241
+ /** GPU load (0..1). */
2242
+ load: number;
2243
+ /** Current GPU clock frequency (MHz). */
2244
+ frequencyMhz: number;
2245
+ }
2246
+ /**
2247
+ * Deep Learning Accelerator (DLA) utilization.
2248
+ *
2249
+ * Jetson Orin NX has two DLA engines used for inference offload.
2250
+ */
2251
+ export interface DlaInfo {
2252
+ /** DLA engine index (0-based). */
2253
+ engineIndex: number;
2254
+ /** DLA engine load (0..1). */
2255
+ load: number;
2256
+ /** Core clock frequency (MHz). 0 when disabled. */
2257
+ frequencyMhz: number;
2258
+ /** True when the DLA engine is actively processing. */
2259
+ enabled: boolean;
2260
+ /** Falcon microcontroller clock frequency (MHz). 0 when disabled. */
2261
+ falconFrequencyMhz: number;
2262
+ }
2263
+ /** System memory information. */
2264
+ export interface MemoryInfo {
2265
+ /** Total RAM (bytes). */
2266
+ totalBytes: number;
2267
+ /** Used RAM (bytes). */
2268
+ usedBytes: number;
2269
+ /** Cached RAM (bytes). */
2270
+ cachedBytes: number;
2271
+ /** Memory bus utilization (0..1). i.MX only. */
2272
+ busLoad: number;
2273
+ }
2274
+ /** Thermal zone reading. */
2275
+ export interface ThermalZone {
2276
+ /** Thermal zone identifier. */
2277
+ zone: ThermalZoneId;
2278
+ /** Temperature (°C). */
2279
+ temperature: number;
2280
+ }
2281
+ /** Video codec engine status. */
2282
+ export interface VideoCodecInfo {
2283
+ /** Jetson only (NVENC/NVDEC/NVJPG/VIC devfreq). */
2284
+ encoderActive: boolean;
2285
+ /** Video encoder clock frequency (MHz). */
2286
+ encoderFrequencyMhz: number;
2287
+ /** Video decoder (NVDEC) is active. */
2288
+ decoderActive: boolean;
2289
+ /** Video decoder clock frequency (MHz). */
2290
+ decoderFrequencyMhz: number;
2291
+ /** JPEG engine (NVJPG) is active. */
2292
+ nvjpgActive: boolean;
2293
+ /** JPEG engine clock frequency (MHz). */
2294
+ nvjpgFrequencyMhz: number;
2295
+ /** Video Image Compositor (VIC) is active. */
2296
+ vicActive: boolean;
2297
+ /** VIC clock frequency (MHz). */
2298
+ vicFrequencyMhz: number;
2299
+ /** i.MX only (CODA VPU). */
2300
+ vpuActive: boolean;
2301
+ /** VPU AXI clock frequency (MHz). */
2302
+ vpuFrequencyMhz: number;
2303
+ /** Cumulative VPU_CODEC_IRQ count. */
2304
+ vpuCodecIrqCount: number;
2305
+ /** Cumulative VPU_JPG_IRQ count. */
2306
+ vpuJpgIrqCount: number;
2307
+ /** Jetson only (host1x actmon engine utilization, 0..1). */
2308
+ encoderLoad: number;
2309
+ /** Video decoder (NVDEC) utilization (0..1). */
2310
+ decoderLoad: number;
2311
+ /** JPEG engine (NVJPG) utilization (0..1). */
2312
+ nvjpgLoad: number;
2313
+ /** Video Image Compositor (VIC) utilization (0..1). */
2314
+ vicLoad: number;
2315
+ }
2316
+ /**
2317
+ * NVMe SSD health, wear and identity (Jetson only; i.MX drones boot/store on
2318
+ * an SD card and have no NVMe device, so this message is omitted there).
2319
+ */
2320
+ export interface NvmeInfo {
2321
+ /** Tier 1 — health & safety. */
2322
+ compositeTemperature: number;
2323
+ /** NVMe critical-warning bitfield. */
2324
+ criticalWarning: number;
2325
+ /** Wear indicator (%, may exceed 100). */
2326
+ percentageUsed: number;
2327
+ /** Remaining spare capacity (%). */
2328
+ availableSpare: number;
2329
+ /** Spare alarm threshold (%). */
2330
+ availableSpareThreshold: number;
2331
+ /** Uncorrected data-integrity errors. */
2332
+ mediaErrors: number;
2333
+ /** Power-loss / unsafe shutdown count. */
2334
+ unsafeShutdowns: number;
2335
+ /** Tier 2 — thermal throttling. */
2336
+ warningTempTimeMin: number;
2337
+ /** Minutes above the critical temperature. */
2338
+ criticalTempTimeMin: number;
2339
+ /** Times entered light throttling. */
2340
+ thermalMgmtT1TransCount: number;
2341
+ /** Times entered heavy throttling. */
2342
+ thermalMgmtT2TransCount: number;
2343
+ /** Total seconds in light throttling. */
2344
+ thermalMgmtT1TotalTimeS: number;
2345
+ /** Total seconds in heavy throttling. */
2346
+ thermalMgmtT2TotalTimeS: number;
2347
+ /** Tier 3 — endurance / workload. */
2348
+ dataUnitsWrittenBytes: number;
2349
+ /** Host data read (B). */
2350
+ dataUnitsReadBytes: number;
2351
+ /** Host write command count. */
2352
+ hostWriteCommands: number;
2353
+ /** Host read command count. */
2354
+ hostReadCommands: number;
2355
+ /** Power-on hours. */
2356
+ powerOnHours: number;
2357
+ /** Power cycle count. */
2358
+ powerCycles: number;
2359
+ /** Controller busy time (min). */
2360
+ controllerBusyTimeMin: number;
2361
+ /** Error-log entry count. */
2362
+ numErrLogEntries: number;
2363
+ /** Tier 4 — identity & capacity. */
2364
+ model: string;
2365
+ /** Drive serial number. */
2366
+ serial: string;
2367
+ /** Firmware revision. */
2368
+ firmwareRev: string;
2369
+ /** Total drive capacity (B). Partition used/free is */
2370
+ capacityBytes: number;
2371
+ }
2372
+ /**
2373
+ * System performance information.
2374
+ *
2375
+ * Comprehensive performance metrics for the drone's compute platform.
2376
+ * Covers CPU, GPU, DLA, memory, thermals, video codec utilization and NVMe
2377
+ * SSD state. Fields not applicable to a platform are left at their
2378
+ * zero/empty defaults.
2379
+ */
2380
+ export interface SystemPerformanceInfo {
2381
+ /** Per-core CPU utilization. */
2382
+ cpuCores: CpuCoreLoad[];
2383
+ /** Mean CPU utilization across all cores (0..1). */
2384
+ cpuUtilization: number;
2385
+ /** GPU utilization. */
2386
+ gpu: GpuInfo | undefined;
2387
+ /** DLA engine utilization (Jetson only). */
2388
+ dlaEngines: DlaInfo[];
2389
+ /** RAM usage. */
2390
+ memory: MemoryInfo | undefined;
2391
+ /** All thermal zone readings. */
2392
+ thermalZones: ThermalZone[];
2393
+ /** Video encoder/decoder status. */
2394
+ videoCodec: VideoCodecInfo | undefined;
2395
+ /** Main queue load (0..1). */
2396
+ mainQueueLoad: number;
2397
+ /** Guestport queue load (0..1). */
2398
+ guestportQueueLoad: number;
2399
+ /** Communication queue load (0..1). */
2400
+ commQueueLoad: number;
2401
+ /** Camera queue load (0..1). */
2402
+ cameraQueueLoad: number;
2403
+ /** Overlay queue load (0..1). */
2404
+ overlayQueueLoad: number;
2405
+ /** Position observer queue load (0..1). */
2406
+ positionObserverQueueLoad: number;
2407
+ /** NVMe SSD health/identity (Jetson only). */
2408
+ nvme: NvmeInfo | undefined;
2409
+ }
1949
2410
  /**
1950
2411
  * Surface Unit battery information.
1951
2412
  *
@@ -1977,6 +2438,154 @@ export interface SurfaceUnitVersionInfo {
1977
2438
  /** Surface Unit firmware version (x.y.z). */
1978
2439
  version: string;
1979
2440
  }
2441
+ /**
2442
+ * Bounding box for object detection.
2443
+ *
2444
+ * Coordinates are in pixels relative to the camera image,
2445
+ * where (x, y) is the top-left corner of the bounding box.
2446
+ */
2447
+ export interface BoundingBox {
2448
+ /** Horizontal offset of the top-left corner (px). */
2449
+ x: number;
2450
+ /** Vertical offset of the top-left corner (px). */
2451
+ y: number;
2452
+ /** Width of the bounding box (px). */
2453
+ width: number;
2454
+ /** Height of the bounding box (px). */
2455
+ height: number;
2456
+ }
2457
+ /**
2458
+ * RLE-encoded binary segmentation mask relative to the bounding box.
2459
+ *
2460
+ * The mask bitmap has dimensions (mask_width x mask_height) covering the
2461
+ * detection's bounding box area. The counts field stores run-length encoded
2462
+ * data as packed uint16 little-endian: alternating background/foreground
2463
+ * pixel runs starting with background.
2464
+ */
2465
+ export interface SegmentationMask {
2466
+ /** Width of the RLE bitmap. */
2467
+ maskWidth: number;
2468
+ /** Height of the RLE bitmap. */
2469
+ maskHeight: number;
2470
+ /** RLE counts as packed uint16 little-endian. */
2471
+ counts: Uint8Array;
2472
+ }
2473
+ /** A single object detection from a computer vision model. */
2474
+ export interface ObjectDetection {
2475
+ /** Bounding box of the detected object. */
2476
+ boundingBox: BoundingBox | undefined;
2477
+ /** Detection confidence score (0..1). */
2478
+ confidence: number;
2479
+ /** Numeric class identifier from the model. */
2480
+ classId: number;
2481
+ /** Human-readable class name. */
2482
+ className: string;
2483
+ /** Unique ID for tracking the same object across frames. */
2484
+ trackingId: number;
2485
+ /** Instance segmentation mask (absent if model has no segmentation). */
2486
+ mask: SegmentationMask | undefined;
2487
+ }
2488
+ /** A list of object detections from a single model for a single video frame. */
2489
+ export interface ModelDetections {
2490
+ /** List of detections in the frame. */
2491
+ detections: ObjectDetection[];
2492
+ /** Which camera the detections are from. */
2493
+ camera: Camera;
2494
+ /** Width of the source image (px). */
2495
+ imageWidth: number;
2496
+ /** Height of the source image (px). */
2497
+ imageHeight: number;
2498
+ /** Name of the computer vision model that produced the detections. */
2499
+ modelName: string;
2500
+ }
2501
+ /** Generic filter settings. */
2502
+ export interface FilterMessage {
2503
+ /** If the filter is enabled. */
2504
+ enabled: boolean;
2505
+ /** Intensity of the filter (0..1). */
2506
+ intensity: number;
2507
+ }
2508
+ /**
2509
+ * Digital pan, tilt, and zoom state for the main camera.
2510
+ *
2511
+ * Only supported on X3 Ultra. Controls digital (not mechanical) zoom.
2512
+ */
2513
+ export interface CameraPanTiltZoom {
2514
+ /** Horizontal pan (-1.0..1.0), where 0.0 is center. */
2515
+ pan: number;
2516
+ /** Vertical tilt (-1.0..1.0), where 0.0 is center. */
2517
+ tilt: number;
2518
+ /** Zoom level (0.0..1.0), where 0.0 is no zoom and 1.0 is maximum zoom. */
2519
+ zoom: number;
2520
+ }
2521
+ /**
2522
+ * Information about the operator controlling the drone.
2523
+ *
2524
+ * Used to identify who started a dive, for reporting and when importing
2525
+ * dives to Blueye Cloud.
2526
+ */
2527
+ export interface OperatorInfo {
2528
+ /** Full name of the operator. */
2529
+ name: string;
2530
+ /** E-mail address of the operator. */
2531
+ email: string;
2532
+ }
2533
+ /** Single-object tracking (SOT) state reported by the computer vision pipeline. */
2534
+ export interface SotState {
2535
+ /** Current tracking state. */
2536
+ state: SotState_State;
2537
+ /** Current tracked bounding box (valid when TRACKING). */
2538
+ boundingBox: BoundingBox | undefined;
2539
+ /** Width of the source frame in pixels. */
2540
+ imageWidth: number;
2541
+ /** Height of the source frame in pixels. */
2542
+ imageHeight: number;
2543
+ }
2544
+ /** Current state of the SOT tracker. */
2545
+ export declare enum SotState_State {
2546
+ /** STATE_UNSPECIFIED - Unspecified state. */
2547
+ STATE_UNSPECIFIED = 0,
2548
+ /** STATE_IDLE - No target selected, waiting for a target bounding box. */
2549
+ STATE_IDLE = 1,
2550
+ /** STATE_TRACKING - Actively tracking a target. */
2551
+ STATE_TRACKING = 2,
2552
+ /** STATE_LOST - Target was lost (tracker failed to follow the object). */
2553
+ STATE_LOST = 3,
2554
+ UNRECOGNIZED = -1
2555
+ }
2556
+ export declare function sotState_StateFromJSON(object: any): SotState_State;
2557
+ export declare function sotState_StateToJSON(object: SotState_State): string;
2558
+ /**
2559
+ * A single annotation added during a dive, e.g. by a diver tapping a type in the
2560
+ * app command palette, or emitted by the drone itself.
2561
+ *
2562
+ * Self-contained: it carries the type's display fields (name/icon/color) inline,
2563
+ * so the drone, any connected client, and the dive logfile can render it without
2564
+ * a separate catalog. The app keeps the full catalog locally (synced from
2565
+ * Blueye Cloud) to drive its palette, but only complete annotations go over the
2566
+ * wire. type_slug lets Blueye Cloud correlate the annotation to its type on import.
2567
+ *
2568
+ * The drone owns the timestamp: when this is logged the enclosing BinlogRecord
2569
+ * carries the time, like any other sample, so there is no time field here.
2570
+ */
2571
+ export interface Annotation {
2572
+ /** Stable type id for grouping / Cloud correlation. Empty for a free-form annotation. */
2573
+ typeSlug: string;
2574
+ /** Type display name, e.g. "Hazard". Snapshot of the type at creation time. */
2575
+ typeName: string;
2576
+ /** Font Awesome solid icon name, kebab-case (e.g. "triangle-exclamation"). */
2577
+ typeIcon: string;
2578
+ /** Type color, RGB hex incl. leading '#', 7 chars (e.g. "#DC2626"). */
2579
+ typeColor: string;
2580
+ /** Optional annotation title; Cloud falls back to type_name if empty. Max 200 chars. */
2581
+ title: string;
2582
+ /** Optional free-form note. Unbounded. */
2583
+ body: string;
2584
+ /** Optional span; omit for a point-in-time marker. */
2585
+ duration: Duration | undefined;
2586
+ /** Origin of the annotation; the app sets APP, the drone sets DRONE for its own. */
2587
+ source: AnnotationSource;
2588
+ }
1980
2589
  export declare const BinlogRecord: MessageFns<BinlogRecord>;
1981
2590
  export declare const LogEntry: MessageFns<LogEntry>;
1982
2591
  export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
@@ -1984,6 +2593,8 @@ export declare const KernelLogEntry_KeyValuePair: MessageFns<KernelLogEntry_KeyV
1984
2593
  export declare const MotionInput: MessageFns<MotionInput>;
1985
2594
  export declare const Lights: MessageFns<Lights>;
1986
2595
  export declare const Laser: MessageFns<Laser>;
2596
+ export declare const Point2D: MessageFns<Point2D>;
2597
+ export declare const LaserDetection: MessageFns<LaserDetection>;
1987
2598
  export declare const LatLongPosition: MessageFns<LatLongPosition>;
1988
2599
  export declare const ConnectionDuration: MessageFns<ConnectionDuration>;
1989
2600
  export declare const AutoHeadingState: MessageFns<AutoHeadingState>;
@@ -2040,6 +2651,7 @@ export declare const IperfStatus: MessageFns<IperfStatus>;
2040
2651
  export declare const NStreamers: MessageFns<NStreamers>;
2041
2652
  export declare const TiltAngle: MessageFns<TiltAngle>;
2042
2653
  export declare const TiltVelocity: MessageFns<TiltVelocity>;
2654
+ export declare const CvModelInfo: MessageFns<CvModelInfo>;
2043
2655
  export declare const DroneInfo: MessageFns<DroneInfo>;
2044
2656
  export declare const ErrorFlags: MessageFns<ErrorFlags>;
2045
2657
  export declare const CameraParameters: MessageFns<CameraParameters>;
@@ -2066,8 +2678,25 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
2066
2678
  export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
2067
2679
  export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
2068
2680
  export declare const CPUInfo: MessageFns<CPUInfo>;
2681
+ export declare const CpuCoreLoad: MessageFns<CpuCoreLoad>;
2682
+ export declare const GpuInfo: MessageFns<GpuInfo>;
2683
+ export declare const DlaInfo: MessageFns<DlaInfo>;
2684
+ export declare const MemoryInfo: MessageFns<MemoryInfo>;
2685
+ export declare const ThermalZone: MessageFns<ThermalZone>;
2686
+ export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
2687
+ export declare const NvmeInfo: MessageFns<NvmeInfo>;
2688
+ export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
2069
2689
  export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
2070
2690
  export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
2691
+ export declare const BoundingBox: MessageFns<BoundingBox>;
2692
+ export declare const SegmentationMask: MessageFns<SegmentationMask>;
2693
+ export declare const ObjectDetection: MessageFns<ObjectDetection>;
2694
+ export declare const ModelDetections: MessageFns<ModelDetections>;
2695
+ export declare const FilterMessage: MessageFns<FilterMessage>;
2696
+ export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
2697
+ export declare const OperatorInfo: MessageFns<OperatorInfo>;
2698
+ export declare const SotState: MessageFns<SotState>;
2699
+ export declare const Annotation: MessageFns<Annotation>;
2071
2700
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
2072
2701
  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 {} ? {
2073
2702
  [K in keyof T]?: DeepPartial<T[K]>;