@blueyerobotics/protocol-definitions 3.2.0-3beb942b → 3.2.0-3db90004

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;
@@ -208,6 +210,24 @@ export declare enum PressureSensorType {
208
210
  }
209
211
  export declare function pressureSensorTypeFromJSON(object: any): PressureSensorType;
210
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;
211
231
  /** Available camera resolutions. */
212
232
  export declare enum Resolution {
213
233
  /** RESOLUTION_UNSPECIFIED - Resolution not specified. */
@@ -220,11 +240,18 @@ export declare enum Resolution {
220
240
  RESOLUTION_FULLHD_1080P = 1,
221
241
  /** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
222
242
  RESOLUTION_UHD_4K = 3,
243
+ /** RESOLUTION_QHD_2K - 2K QHD (2560x1440, Only supported on X3 Ultra). */
244
+ RESOLUTION_QHD_2K = 5,
223
245
  UNRECOGNIZED = -1
224
246
  }
225
247
  export declare function resolutionFromJSON(object: any): Resolution;
226
248
  export declare function resolutionToJSON(object: Resolution): string;
227
- /** 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
+ */
228
255
  export declare enum Framerate {
229
256
  /** FRAMERATE_UNSPECIFIED - Framerate not specified. */
230
257
  FRAMERATE_UNSPECIFIED = 0,
@@ -232,6 +259,8 @@ export declare enum Framerate {
232
259
  FRAMERATE_FPS_30 = 1,
233
260
  /** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
234
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,
235
264
  UNRECOGNIZED = -1
236
265
  }
237
266
  export declare function framerateFromJSON(object: any): Framerate;
@@ -259,6 +288,18 @@ export declare enum StreamingProtocol {
259
288
  }
260
289
  export declare function streamingProtocolFromJSON(object: any): StreamingProtocol;
261
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;
262
303
  /** Available temperature units. */
263
304
  export declare enum TemperatureUnit {
264
305
  /** TEMPERATURE_UNIT_UNSPECIFIED - Temperature unit not specified. */
@@ -325,6 +366,8 @@ export declare enum FontSize {
325
366
  FONT_SIZE_PX35 = 5,
326
367
  /** FONT_SIZE_PX40 - 40 px. */
327
368
  FONT_SIZE_PX40 = 6,
369
+ /** FONT_SIZE_PX50 - 50 px. */
370
+ FONT_SIZE_PX50 = 7,
328
371
  UNRECOGNIZED = -1
329
372
  }
330
373
  export declare function fontSizeFromJSON(object: any): FontSize;
@@ -427,6 +470,13 @@ export declare enum GuestPortDeviceID {
427
470
  GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 = 46,
428
471
  /** GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT - Cerulean Omniscan 450 Compact. */
429
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,
430
480
  UNRECOGNIZED = -1
431
481
  }
432
482
  export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
@@ -441,10 +491,41 @@ export declare enum GuestPortNumber {
441
491
  GUEST_PORT_NUMBER_PORT_2 = 2,
442
492
  /** GUEST_PORT_NUMBER_PORT_3 - Guest port 3. */
443
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,
444
500
  UNRECOGNIZED = -1
445
501
  }
446
502
  export declare function guestPortNumberFromJSON(object: any): GuestPortNumber;
447
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
+ UNRECOGNIZED = -1
526
+ }
527
+ export declare function guestPortCapabilityFromJSON(object: any): GuestPortCapability;
528
+ export declare function guestPortCapabilityToJSON(object: GuestPortCapability): string;
448
529
  /** List of navigation sensors that can be used by the position observer. */
449
530
  export declare enum NavigationSensorID {
450
531
  /** NAVIGATION_SENSOR_ID_UNSPECIFIED - Unspecified. */
@@ -512,6 +593,48 @@ export declare enum MultibeamFrequencyMode {
512
593
  }
513
594
  export declare function multibeamFrequencyModeFromJSON(object: any): MultibeamFrequencyMode;
514
595
  export declare function multibeamFrequencyModeToJSON(object: MultibeamFrequencyMode): string;
596
+ /** Thermal zone identifiers. */
597
+ export declare enum ThermalZoneId {
598
+ /** THERMAL_ZONE_ID_UNSPECIFIED - Unspecified thermal zone. */
599
+ THERMAL_ZONE_ID_UNSPECIFIED = 0,
600
+ /** THERMAL_ZONE_ID_TJ - Junction temperature (Tj). */
601
+ THERMAL_ZONE_ID_TJ = 1,
602
+ /** THERMAL_ZONE_ID_CANISTER - Canister temperature. */
603
+ THERMAL_ZONE_ID_CANISTER = 2,
604
+ /** THERMAL_ZONE_ID_CPU - CPU thermal zone. */
605
+ THERMAL_ZONE_ID_CPU = 3,
606
+ /** THERMAL_ZONE_ID_GPU - GPU thermal zone. */
607
+ THERMAL_ZONE_ID_GPU = 4,
608
+ /** THERMAL_ZONE_ID_CV0 - Vision accelerator 0 thermal zone. */
609
+ THERMAL_ZONE_ID_CV0 = 5,
610
+ /** THERMAL_ZONE_ID_CV1 - Vision accelerator 1 thermal zone. */
611
+ THERMAL_ZONE_ID_CV1 = 6,
612
+ /** THERMAL_ZONE_ID_CV2 - Vision accelerator 2 thermal zone. */
613
+ THERMAL_ZONE_ID_CV2 = 7,
614
+ /** THERMAL_ZONE_ID_SOC0 - SoC 0 thermal zone. */
615
+ THERMAL_ZONE_ID_SOC0 = 8,
616
+ /** THERMAL_ZONE_ID_SOC1 - SoC 1 thermal zone. */
617
+ THERMAL_ZONE_ID_SOC1 = 9,
618
+ /** THERMAL_ZONE_ID_SOC2 - SoC 2 thermal zone. */
619
+ THERMAL_ZONE_ID_SOC2 = 10,
620
+ UNRECOGNIZED = -1
621
+ }
622
+ export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
623
+ export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
624
+ /** Origin of an annotation. Mirrors the AnnotationSource enum in Blueye Cloud. */
625
+ export declare enum AnnotationSource {
626
+ /** ANNOTATION_SOURCE_UNSPECIFIED - Origin not specified. */
627
+ ANNOTATION_SOURCE_UNSPECIFIED = 0,
628
+ /** ANNOTATION_SOURCE_CLOUD - Created in Blueye Cloud after the dive. */
629
+ ANNOTATION_SOURCE_CLOUD = 1,
630
+ /** ANNOTATION_SOURCE_APP - Created in the app during the dive. */
631
+ ANNOTATION_SOURCE_APP = 2,
632
+ /** ANNOTATION_SOURCE_DRONE - Emitted by the drone itself. */
633
+ ANNOTATION_SOURCE_DRONE = 3,
634
+ UNRECOGNIZED = -1
635
+ }
636
+ export declare function annotationSourceFromJSON(object: any): AnnotationSource;
637
+ export declare function annotationSourceToJSON(object: AnnotationSource): string;
515
638
  /**
516
639
  * Wrapper message for each entry in the drone telemetry logfile.
517
640
  *
@@ -645,6 +768,46 @@ export interface Lights {
645
768
  export interface Laser {
646
769
  /** Laser intensity, any value above 0 turns the laser on (0..1). */
647
770
  value: number;
771
+ /** Modulate the laser at 5Hz for tracking. Only available on Ultra. */
772
+ modulated: boolean;
773
+ }
774
+ /** Point in 2D space. */
775
+ export interface Point2D {
776
+ /** X coordinate of the point (px). */
777
+ x: number;
778
+ /** Y coordinate of the point (px). */
779
+ y: number;
780
+ }
781
+ /**
782
+ * Message representing the detection of scaling lasers in the main camera.
783
+ *
784
+ * The message contains the centroids of the detected dots, the distance between them in pixels,
785
+ * and the confidence of the detection. The dots are detected through temporal DFT analysis of
786
+ * 5 Hz laser modulation, isolating flickering pixels from the static scene background.
787
+ *
788
+ * Only available on Ultra.
789
+ */
790
+ export interface LaserDetection {
791
+ /** True if the laser is detected by the drone. */
792
+ detected: boolean;
793
+ /** First dot centroid (leftmost). */
794
+ dot1: Point2D | undefined;
795
+ /** Second dot centroid (rightmost). */
796
+ dot2: Point2D | undefined;
797
+ /** Distance between dots in pixels. */
798
+ pixelDistance: number;
799
+ /** Confidence of the detection (0..1). */
800
+ confidence: number;
801
+ /** Source frame width. */
802
+ imageWidth: number;
803
+ /** Source frame height. */
804
+ imageHeight: number;
805
+ /** Real world distance between the two laser dots (m). */
806
+ laserWidth: number;
807
+ /** Distance after lens undistortion (px). */
808
+ correctedPixelDistance: number;
809
+ /** Estimated subject distance (m). */
810
+ estimatedDistance: number;
648
811
  }
649
812
  /** Latitude and longitude position in WGS 84 decimal degrees format. */
650
813
  export interface LatLongPosition {
@@ -831,7 +994,7 @@ export interface WaterTemperature {
831
994
  /** Water temperature (°C). */
832
995
  value: number;
833
996
  }
834
- /** CPU temperature. */
997
+ /** CPU temperature (deprecated, use SystemPerformanceInfo.thermal_zones instead). */
835
998
  export interface CPUTemperature {
836
999
  /** CPU temperature (°C). */
837
1000
  value: number;
@@ -1404,6 +1567,31 @@ export interface TiltVelocity {
1404
1567
  /**
1405
1568
  * Information about the drone.
1406
1569
  *
1570
+ * Information about a loaded computer vision model.
1571
+ */
1572
+ export interface CvModelInfo {
1573
+ /** Human-readable model name (from model_meta.json). */
1574
+ name: string;
1575
+ /** Type of CV model. */
1576
+ type: CvModelInfo_ModelType;
1577
+ /** Whether the model is currently running. */
1578
+ running: boolean;
1579
+ /** Execution provider (e.g. "cuda", "tensorrt"). */
1580
+ device: string;
1581
+ /** Package directory name (e.g. "tinyyolov2_package"). Stable identifier. */
1582
+ packageId: string;
1583
+ /** Class names the model can detect (indexed by class_id). */
1584
+ labels: string[];
1585
+ }
1586
+ export declare enum CvModelInfo_ModelType {
1587
+ MODEL_TYPE_UNSPECIFIED = 0,
1588
+ MODEL_TYPE_DETECTION = 1,
1589
+ MODEL_TYPE_SOT = 2,
1590
+ UNRECOGNIZED = -1
1591
+ }
1592
+ export declare function cvModelInfo_ModelTypeFromJSON(object: any): CvModelInfo_ModelType;
1593
+ export declare function cvModelInfo_ModelTypeToJSON(object: CvModelInfo_ModelType): string;
1594
+ /**
1407
1595
  * This message contains serial numbers and version information for
1408
1596
  * internal components in the drone. Primarily used for diagnostics, or to
1409
1597
  * determine the origin of a logfile.
@@ -1431,6 +1619,10 @@ export interface DroneInfo {
1431
1619
  gp: GuestPortInfo | undefined;
1432
1620
  /** Type of depth sensor that is connected to the drone. */
1433
1621
  depthSensor: PressureSensorType;
1622
+ /** List of loaded computer vision models. */
1623
+ cvModels: CvModelInfo[];
1624
+ /** How the drone is powered. */
1625
+ powerSource: PowerSource;
1434
1626
  }
1435
1627
  /** Known error states for the drone. */
1436
1628
  export interface ErrorFlags {
@@ -1456,30 +1648,72 @@ export interface ErrorFlags {
1456
1648
  gp2Read: boolean;
1457
1649
  /** Guest port 3 read error. */
1458
1650
  gp3Read: boolean;
1651
+ /** Guest port 4 read error. */
1652
+ gp4Read: boolean;
1653
+ /** Guest port 5 read error. */
1654
+ gp5Read: boolean;
1655
+ /** Guest port 6 read error. */
1656
+ gp6Read: boolean;
1459
1657
  /** Guest port 1 not flashed. */
1460
1658
  gp1NotFlashed: boolean;
1461
1659
  /** Guest port 2 not flashed. */
1462
1660
  gp2NotFlashed: boolean;
1463
1661
  /** Guest port 3 not flashed. */
1464
1662
  gp3NotFlashed: boolean;
1663
+ /** Guest port 4 not flashed. */
1664
+ gp4NotFlashed: boolean;
1665
+ /** Guest port 5 not flashed. */
1666
+ gp5NotFlashed: boolean;
1667
+ /** Guest port 6 not flashed. */
1668
+ gp6NotFlashed: boolean;
1465
1669
  /** Unknown device on guest port 1. */
1466
1670
  gp1UnknownDevice: boolean;
1467
1671
  /** Unknown device on guest port 2. */
1468
1672
  gp2UnknownDevice: boolean;
1469
1673
  /** Unknown device on guest port 3. */
1470
1674
  gp3UnknownDevice: boolean;
1675
+ /** Unknown device on guest port 4. */
1676
+ gp4UnknownDevice: boolean;
1677
+ /** Unknown device on guest port 5. */
1678
+ gp5UnknownDevice: boolean;
1679
+ /** Unknown device on guest port 6. */
1680
+ gp6UnknownDevice: boolean;
1471
1681
  /** Guest port 1 connection error. */
1472
1682
  gp1DeviceConnection: boolean;
1473
1683
  /** Guest port 2 connection error. */
1474
1684
  gp2DeviceConnection: boolean;
1475
1685
  /** Guest port 3 connection error. */
1476
1686
  gp3DeviceConnection: boolean;
1687
+ /** Guest port 4 connection error. */
1688
+ gp4DeviceConnection: boolean;
1689
+ /** Guest port 5 connection error. */
1690
+ gp5DeviceConnection: boolean;
1691
+ /** Guest port 6 connection error. */
1692
+ gp6DeviceConnection: boolean;
1477
1693
  /** Guest port 1 device error. */
1478
1694
  gp1Device: boolean;
1479
1695
  /** Guest port 2 device error. */
1480
1696
  gp2Device: boolean;
1481
1697
  /** Guest port 3 device error. */
1482
1698
  gp3Device: boolean;
1699
+ /** Guest port 4 device error. */
1700
+ gp4Device: boolean;
1701
+ /** Guest port 5 device error. */
1702
+ gp5Device: boolean;
1703
+ /** Guest port 6 device error. */
1704
+ gp6Device: boolean;
1705
+ /** Device on guest port 1 requires interfaces the port does not provide. */
1706
+ gp1IncompatibleDevice: boolean;
1707
+ /** Device on guest port 2 requires interfaces the port does not provide. */
1708
+ gp2IncompatibleDevice: boolean;
1709
+ /** Device on guest port 3 requires interfaces the port does not provide. */
1710
+ gp3IncompatibleDevice: boolean;
1711
+ /** Device on guest port 4 requires interfaces the port does not provide. */
1712
+ gp4IncompatibleDevice: boolean;
1713
+ /** Device on guest port 5 requires interfaces the port does not provide. */
1714
+ gp5IncompatibleDevice: boolean;
1715
+ /** Device on guest port 6 requires interfaces the port does not provide. */
1716
+ gp6IncompatibleDevice: boolean;
1483
1717
  /** Drone serial number not set. */
1484
1718
  droneSerialNotSet: boolean;
1485
1719
  /** Drone serial number error. */
@@ -1510,14 +1744,44 @@ export interface ErrorFlags {
1510
1744
  gpCurrentRead: boolean;
1511
1745
  /** Max GP current exceeded. */
1512
1746
  gpCurrent: boolean;
1513
- /** Max battery current exceeded on GP1. */
1747
+ /** Max battery current exceeded on guest port 1. */
1514
1748
  gp1BatCurrent: boolean;
1515
- /** Max battery current exceeded on GP2. */
1749
+ /** Max battery current exceeded on guest port 2. */
1516
1750
  gp2BatCurrent: boolean;
1517
- /** Max battery current exceeded on GP3. */
1751
+ /** Max battery current exceeded on guest port 3. */
1518
1752
  gp3BatCurrent: boolean;
1519
- /** Max 20V current exceeded on GP. */
1520
- gp20vCurrent: boolean;
1753
+ /** Max battery current exceeded on guest port 4. */
1754
+ gp4BatCurrent: boolean;
1755
+ /** Max battery current exceeded on guest port 5. */
1756
+ gp5BatCurrent: boolean;
1757
+ /** Max battery current exceeded on guest port 6. */
1758
+ gp6BatCurrent: boolean;
1759
+ /** Max 24V current exceeded on GP. Only present on X1/X3 (not X3 Ultra or X7). */
1760
+ gp24vCurrent: boolean;
1761
+ /** Max 24V current exceeded on guest port 1. */
1762
+ gp124vCurrent: boolean;
1763
+ /** Max 24V current exceeded on guest port 2. */
1764
+ gp224vCurrent: boolean;
1765
+ /** Max 24V current exceeded on guest port 3. */
1766
+ gp324vCurrent: boolean;
1767
+ /** Max 24V current exceeded on guest port 4. */
1768
+ gp424vCurrent: boolean;
1769
+ /** Max 24V current exceeded on guest port 5. */
1770
+ gp524vCurrent: boolean;
1771
+ /** Max 24V current exceeded on guest port 6. */
1772
+ gp624vCurrent: boolean;
1773
+ /** Max 5V current exceeded on guest port 1. */
1774
+ gp15vCurrent: boolean;
1775
+ /** Max 5V current exceeded on guest port 2. */
1776
+ gp25vCurrent: boolean;
1777
+ /** Max 5V current exceeded on guest port 3. */
1778
+ gp35vCurrent: boolean;
1779
+ /** Max 5V current exceeded on guest port 4. */
1780
+ gp45vCurrent: boolean;
1781
+ /** Max 5V current exceeded on guest port 5. */
1782
+ gp55vCurrent: boolean;
1783
+ /** Max 5V current exceeded on guest port 6. */
1784
+ gp65vCurrent: boolean;
1521
1785
  /** DVL is in thermal protection mode. */
1522
1786
  dvlThermalProtectionMode: boolean;
1523
1787
  /** GP protection has been triggered at boot or faulty DVL. */
@@ -1581,6 +1845,13 @@ export interface CameraParameters {
1581
1845
  * The Blueye App allows users to set values between 500 and 1460.
1582
1846
  */
1583
1847
  mtuSize: number;
1848
+ /** Recording video codec. If unset, uses platform default. */
1849
+ recordingCodec: RecordingCodec;
1850
+ /**
1851
+ * Recording bitrate in bits/sec. If 0 or unset, a default is computed based
1852
+ * on resolution, framerate, and encoding. Set explicitly to override.
1853
+ */
1854
+ recordingBitrate: number;
1584
1855
  }
1585
1856
  /**
1586
1857
  * Overlay parameters.
@@ -1670,6 +1941,13 @@ export interface GuestPortDevice {
1670
1941
  requiredBlunuxVersion: string;
1671
1942
  /** Detach status based on detection pin. */
1672
1943
  detachStatus: GuestPortDetachStatus;
1944
+ /** Interfaces the device requires from the port. */
1945
+ requiredCapabilities: GuestPortCapability[];
1946
+ /**
1947
+ * Ports on this drone where the device is fully supported. Computed by the
1948
+ * drone from the port capabilities and the device requirements.
1949
+ */
1950
+ compatibleGuestPorts: GuestPortNumber[];
1673
1951
  }
1674
1952
  /** List of guest port devices. */
1675
1953
  export interface GuestPortDeviceList {
@@ -1684,6 +1962,8 @@ export interface GuestPortConnectorInfo {
1684
1962
  error?: GuestPortError | undefined;
1685
1963
  /** Guest port the connector is connected to. */
1686
1964
  guestPortNumber: GuestPortNumber;
1965
+ /** Interfaces this port provides. */
1966
+ capabilities: GuestPortCapability[];
1687
1967
  }
1688
1968
  /** GuestPort information. */
1689
1969
  export interface GuestPortInfo {
@@ -1693,6 +1973,12 @@ export interface GuestPortInfo {
1693
1973
  gp2: GuestPortConnectorInfo | undefined;
1694
1974
  /** Information about guest port 3. */
1695
1975
  gp3: GuestPortConnectorInfo | undefined;
1976
+ /** Information about guest port 4. */
1977
+ gp4: GuestPortConnectorInfo | undefined;
1978
+ /** Information about guest port 5. */
1979
+ gp5: GuestPortConnectorInfo | undefined;
1980
+ /** Information about guest port 6. */
1981
+ gp6: GuestPortConnectorInfo | undefined;
1696
1982
  }
1697
1983
  /** GuestPort restart information. */
1698
1984
  export interface GuestPortRestartInfo {
@@ -1737,8 +2023,38 @@ export interface GuestPortCurrent {
1737
2023
  gp2Bat: number;
1738
2024
  /** Current on GP3 battery voltage (A). */
1739
2025
  gp3Bat: number;
1740
- /** Current on common 20V supply (A). */
1741
- gp20v: number;
2026
+ /** Current on common/input 24V supply (A). Only present on X1/X3 (not X3 Ultra or X7). */
2027
+ gp24v: number;
2028
+ /** Current on GP4 battery voltage (A). */
2029
+ gp4Bat: number;
2030
+ /** Current on GP5 battery voltage (A). */
2031
+ gp5Bat: number;
2032
+ /** Current on GP6 battery voltage (A). */
2033
+ gp6Bat: number;
2034
+ /** Current on GP1 24V supply (A). */
2035
+ gp124v: number;
2036
+ /** Current on GP2 24V supply (A). */
2037
+ gp224v: number;
2038
+ /** Current on GP3 24V supply (A). */
2039
+ gp324v: number;
2040
+ /** Current on GP4 24V supply (A). */
2041
+ gp424v: number;
2042
+ /** Current on GP5 24V supply (A). */
2043
+ gp524v: number;
2044
+ /** Current on GP6 24V supply (A). */
2045
+ gp624v: number;
2046
+ /** Current on GP1 5V supply (A). */
2047
+ gp15v: number;
2048
+ /** Current on GP2 5V supply (A). */
2049
+ gp25v: number;
2050
+ /** Current on GP3 5V supply (A). */
2051
+ gp35v: number;
2052
+ /** Current on GP4 5V supply (A). */
2053
+ gp45v: number;
2054
+ /** Current on GP5 5V supply (A). */
2055
+ gp55v: number;
2056
+ /** Current on GP6 5V supply (A). */
2057
+ gp65v: number;
1742
2058
  }
1743
2059
  /** Vector with 3 elements. */
1744
2060
  export interface Vector3 {
@@ -1946,7 +2262,7 @@ export interface PersistentStorageSettings {
1946
2262
  accCalibration: boolean;
1947
2263
  }
1948
2264
  /**
1949
- * CPU information.
2265
+ * CPU information (deprecated, use SystemPerformanceInfo instead).
1950
2266
  *
1951
2267
  * Contains information about the CPU load and memory usage of the drone.
1952
2268
  */
@@ -1962,6 +2278,186 @@ export interface CPUInfo {
1962
2278
  /** Communication queue load (0..1). */
1963
2279
  commQueueLoad: number;
1964
2280
  }
2281
+ /** Per-core CPU utilization. */
2282
+ export interface CpuCoreLoad {
2283
+ /** Core index (0-based). */
2284
+ coreIndex: number;
2285
+ /** Core load (0..1). */
2286
+ load: number;
2287
+ /** Current clock frequency (MHz). */
2288
+ frequencyMhz: number;
2289
+ }
2290
+ /** GPU utilization and status. */
2291
+ export interface GpuInfo {
2292
+ /** GPU load (0..1). */
2293
+ load: number;
2294
+ /** Current GPU clock frequency (MHz). */
2295
+ frequencyMhz: number;
2296
+ }
2297
+ /**
2298
+ * Deep Learning Accelerator (DLA) utilization.
2299
+ *
2300
+ * Jetson Orin NX has two DLA engines used for inference offload.
2301
+ */
2302
+ export interface DlaInfo {
2303
+ /** DLA engine index (0-based). */
2304
+ engineIndex: number;
2305
+ /** DLA engine load (0..1). */
2306
+ load: number;
2307
+ /** Core clock frequency (MHz). 0 when disabled. */
2308
+ frequencyMhz: number;
2309
+ /** True when the DLA engine is actively processing. */
2310
+ enabled: boolean;
2311
+ /** Falcon microcontroller clock frequency (MHz). 0 when disabled. */
2312
+ falconFrequencyMhz: number;
2313
+ }
2314
+ /** System memory information. */
2315
+ export interface MemoryInfo {
2316
+ /** Total RAM (bytes). */
2317
+ totalBytes: number;
2318
+ /** Used RAM (bytes). */
2319
+ usedBytes: number;
2320
+ /** Cached RAM (bytes). */
2321
+ cachedBytes: number;
2322
+ /** Memory bus utilization (0..1). i.MX only. */
2323
+ busLoad: number;
2324
+ }
2325
+ /** Thermal zone reading. */
2326
+ export interface ThermalZone {
2327
+ /** Thermal zone identifier. */
2328
+ zone: ThermalZoneId;
2329
+ /** Temperature (°C). */
2330
+ temperature: number;
2331
+ }
2332
+ /** Video codec engine status. */
2333
+ export interface VideoCodecInfo {
2334
+ /** Jetson only (NVENC/NVDEC/NVJPG/VIC devfreq). */
2335
+ encoderActive: boolean;
2336
+ /** Video encoder clock frequency (MHz). */
2337
+ encoderFrequencyMhz: number;
2338
+ /** Video decoder (NVDEC) is active. */
2339
+ decoderActive: boolean;
2340
+ /** Video decoder clock frequency (MHz). */
2341
+ decoderFrequencyMhz: number;
2342
+ /** JPEG engine (NVJPG) is active. */
2343
+ nvjpgActive: boolean;
2344
+ /** JPEG engine clock frequency (MHz). */
2345
+ nvjpgFrequencyMhz: number;
2346
+ /** Video Image Compositor (VIC) is active. */
2347
+ vicActive: boolean;
2348
+ /** VIC clock frequency (MHz). */
2349
+ vicFrequencyMhz: number;
2350
+ /** i.MX only (CODA VPU). */
2351
+ vpuActive: boolean;
2352
+ /** VPU AXI clock frequency (MHz). */
2353
+ vpuFrequencyMhz: number;
2354
+ /** Cumulative VPU_CODEC_IRQ count. */
2355
+ vpuCodecIrqCount: number;
2356
+ /** Cumulative VPU_JPG_IRQ count. */
2357
+ vpuJpgIrqCount: number;
2358
+ /** Jetson only (host1x actmon engine utilization, 0..1). */
2359
+ encoderLoad: number;
2360
+ /** Video decoder (NVDEC) utilization (0..1). */
2361
+ decoderLoad: number;
2362
+ /** JPEG engine (NVJPG) utilization (0..1). */
2363
+ nvjpgLoad: number;
2364
+ /** Video Image Compositor (VIC) utilization (0..1). */
2365
+ vicLoad: number;
2366
+ }
2367
+ /**
2368
+ * NVMe SSD health, wear and identity (Jetson only; i.MX drones boot/store on
2369
+ * an SD card and have no NVMe device, so this message is omitted there).
2370
+ */
2371
+ export interface NvmeInfo {
2372
+ /** Tier 1 — health & safety. */
2373
+ compositeTemperature: number;
2374
+ /** NVMe critical-warning bitfield. */
2375
+ criticalWarning: number;
2376
+ /** Wear indicator (%, may exceed 100). */
2377
+ percentageUsed: number;
2378
+ /** Remaining spare capacity (%). */
2379
+ availableSpare: number;
2380
+ /** Spare alarm threshold (%). */
2381
+ availableSpareThreshold: number;
2382
+ /** Uncorrected data-integrity errors. */
2383
+ mediaErrors: number;
2384
+ /** Power-loss / unsafe shutdown count. */
2385
+ unsafeShutdowns: number;
2386
+ /** Tier 2 — thermal throttling. */
2387
+ warningTempTimeMin: number;
2388
+ /** Minutes above the critical temperature. */
2389
+ criticalTempTimeMin: number;
2390
+ /** Times entered light throttling. */
2391
+ thermalMgmtT1TransCount: number;
2392
+ /** Times entered heavy throttling. */
2393
+ thermalMgmtT2TransCount: number;
2394
+ /** Total seconds in light throttling. */
2395
+ thermalMgmtT1TotalTimeS: number;
2396
+ /** Total seconds in heavy throttling. */
2397
+ thermalMgmtT2TotalTimeS: number;
2398
+ /** Tier 3 — endurance / workload. */
2399
+ dataUnitsWrittenBytes: number;
2400
+ /** Host data read (B). */
2401
+ dataUnitsReadBytes: number;
2402
+ /** Host write command count. */
2403
+ hostWriteCommands: number;
2404
+ /** Host read command count. */
2405
+ hostReadCommands: number;
2406
+ /** Power-on hours. */
2407
+ powerOnHours: number;
2408
+ /** Power cycle count. */
2409
+ powerCycles: number;
2410
+ /** Controller busy time (min). */
2411
+ controllerBusyTimeMin: number;
2412
+ /** Error-log entry count. */
2413
+ numErrLogEntries: number;
2414
+ /** Tier 4 — identity & capacity. */
2415
+ model: string;
2416
+ /** Drive serial number. */
2417
+ serial: string;
2418
+ /** Firmware revision. */
2419
+ firmwareRev: string;
2420
+ /** Total drive capacity (B). Partition used/free is */
2421
+ capacityBytes: number;
2422
+ }
2423
+ /**
2424
+ * System performance information.
2425
+ *
2426
+ * Comprehensive performance metrics for the drone's compute platform.
2427
+ * Covers CPU, GPU, DLA, memory, thermals, video codec utilization and NVMe
2428
+ * SSD state. Fields not applicable to a platform are left at their
2429
+ * zero/empty defaults.
2430
+ */
2431
+ export interface SystemPerformanceInfo {
2432
+ /** Per-core CPU utilization. */
2433
+ cpuCores: CpuCoreLoad[];
2434
+ /** Mean CPU utilization across all cores (0..1). */
2435
+ cpuUtilization: number;
2436
+ /** GPU utilization. */
2437
+ gpu: GpuInfo | undefined;
2438
+ /** DLA engine utilization (Jetson only). */
2439
+ dlaEngines: DlaInfo[];
2440
+ /** RAM usage. */
2441
+ memory: MemoryInfo | undefined;
2442
+ /** All thermal zone readings. */
2443
+ thermalZones: ThermalZone[];
2444
+ /** Video encoder/decoder status. */
2445
+ videoCodec: VideoCodecInfo | undefined;
2446
+ /** Main queue load (0..1). */
2447
+ mainQueueLoad: number;
2448
+ /** Guestport queue load (0..1). */
2449
+ guestportQueueLoad: number;
2450
+ /** Communication queue load (0..1). */
2451
+ commQueueLoad: number;
2452
+ /** Camera queue load (0..1). */
2453
+ cameraQueueLoad: number;
2454
+ /** Overlay queue load (0..1). */
2455
+ overlayQueueLoad: number;
2456
+ /** Position observer queue load (0..1). */
2457
+ positionObserverQueueLoad: number;
2458
+ /** NVMe SSD health/identity (Jetson only). */
2459
+ nvme: NvmeInfo | undefined;
2460
+ }
1965
2461
  /**
1966
2462
  * Surface Unit battery information.
1967
2463
  *
@@ -1993,6 +2489,66 @@ export interface SurfaceUnitVersionInfo {
1993
2489
  /** Surface Unit firmware version (x.y.z). */
1994
2490
  version: string;
1995
2491
  }
2492
+ /**
2493
+ * Bounding box for object detection.
2494
+ *
2495
+ * Coordinates are in pixels relative to the camera image,
2496
+ * where (x, y) is the top-left corner of the bounding box.
2497
+ */
2498
+ export interface BoundingBox {
2499
+ /** Horizontal offset of the top-left corner (px). */
2500
+ x: number;
2501
+ /** Vertical offset of the top-left corner (px). */
2502
+ y: number;
2503
+ /** Width of the bounding box (px). */
2504
+ width: number;
2505
+ /** Height of the bounding box (px). */
2506
+ height: number;
2507
+ }
2508
+ /**
2509
+ * RLE-encoded binary segmentation mask relative to the bounding box.
2510
+ *
2511
+ * The mask bitmap has dimensions (mask_width x mask_height) covering the
2512
+ * detection's bounding box area. The counts field stores run-length encoded
2513
+ * data as packed uint16 little-endian: alternating background/foreground
2514
+ * pixel runs starting with background.
2515
+ */
2516
+ export interface SegmentationMask {
2517
+ /** Width of the RLE bitmap. */
2518
+ maskWidth: number;
2519
+ /** Height of the RLE bitmap. */
2520
+ maskHeight: number;
2521
+ /** RLE counts as packed uint16 little-endian. */
2522
+ counts: Uint8Array;
2523
+ }
2524
+ /** A single object detection from a computer vision model. */
2525
+ export interface ObjectDetection {
2526
+ /** Bounding box of the detected object. */
2527
+ boundingBox: BoundingBox | undefined;
2528
+ /** Detection confidence score (0..1). */
2529
+ confidence: number;
2530
+ /** Numeric class identifier from the model. */
2531
+ classId: number;
2532
+ /** Human-readable class name. */
2533
+ className: string;
2534
+ /** Unique ID for tracking the same object across frames. */
2535
+ trackingId: number;
2536
+ /** Instance segmentation mask (absent if model has no segmentation). */
2537
+ mask: SegmentationMask | undefined;
2538
+ }
2539
+ /** A list of object detections from a single model for a single video frame. */
2540
+ export interface ModelDetections {
2541
+ /** List of detections in the frame. */
2542
+ detections: ObjectDetection[];
2543
+ /** Which camera the detections are from. */
2544
+ camera: Camera;
2545
+ /** Width of the source image (px). */
2546
+ imageWidth: number;
2547
+ /** Height of the source image (px). */
2548
+ imageHeight: number;
2549
+ /** Name of the computer vision model that produced the detections. */
2550
+ modelName: string;
2551
+ }
1996
2552
  /** Generic filter settings. */
1997
2553
  export interface FilterMessage {
1998
2554
  /** If the filter is enabled. */
@@ -2000,6 +2556,87 @@ export interface FilterMessage {
2000
2556
  /** Intensity of the filter (0..1). */
2001
2557
  intensity: number;
2002
2558
  }
2559
+ /**
2560
+ * Digital pan, tilt, and zoom state for the main camera.
2561
+ *
2562
+ * Only supported on X3 Ultra. Controls digital (not mechanical) zoom.
2563
+ */
2564
+ export interface CameraPanTiltZoom {
2565
+ /** Horizontal pan (-1.0..1.0), where 0.0 is center. */
2566
+ pan: number;
2567
+ /** Vertical tilt (-1.0..1.0), where 0.0 is center. */
2568
+ tilt: number;
2569
+ /** Zoom level (0.0..1.0), where 0.0 is no zoom and 1.0 is maximum zoom. */
2570
+ zoom: number;
2571
+ }
2572
+ /**
2573
+ * Information about the operator controlling the drone.
2574
+ *
2575
+ * Used to identify who started a dive, for reporting and when importing
2576
+ * dives to Blueye Cloud.
2577
+ */
2578
+ export interface OperatorInfo {
2579
+ /** Full name of the operator. */
2580
+ name: string;
2581
+ /** E-mail address of the operator. */
2582
+ email: string;
2583
+ }
2584
+ /** Single-object tracking (SOT) state reported by the computer vision pipeline. */
2585
+ export interface SotState {
2586
+ /** Current tracking state. */
2587
+ state: SotState_State;
2588
+ /** Current tracked bounding box (valid when TRACKING). */
2589
+ boundingBox: BoundingBox | undefined;
2590
+ /** Width of the source frame in pixels. */
2591
+ imageWidth: number;
2592
+ /** Height of the source frame in pixels. */
2593
+ imageHeight: number;
2594
+ }
2595
+ /** Current state of the SOT tracker. */
2596
+ export declare enum SotState_State {
2597
+ /** STATE_UNSPECIFIED - Unspecified state. */
2598
+ STATE_UNSPECIFIED = 0,
2599
+ /** STATE_IDLE - No target selected, waiting for a target bounding box. */
2600
+ STATE_IDLE = 1,
2601
+ /** STATE_TRACKING - Actively tracking a target. */
2602
+ STATE_TRACKING = 2,
2603
+ /** STATE_LOST - Target was lost (tracker failed to follow the object). */
2604
+ STATE_LOST = 3,
2605
+ UNRECOGNIZED = -1
2606
+ }
2607
+ export declare function sotState_StateFromJSON(object: any): SotState_State;
2608
+ export declare function sotState_StateToJSON(object: SotState_State): string;
2609
+ /**
2610
+ * A single annotation added during a dive, e.g. by a diver tapping a type in the
2611
+ * app command palette, or emitted by the drone itself.
2612
+ *
2613
+ * Self-contained: it carries the type's display fields (name/icon/color) inline,
2614
+ * so the drone, any connected client, and the dive logfile can render it without
2615
+ * a separate catalog. The app keeps the full catalog locally (synced from
2616
+ * Blueye Cloud) to drive its palette, but only complete annotations go over the
2617
+ * wire. type_slug lets Blueye Cloud correlate the annotation to its type on import.
2618
+ *
2619
+ * The drone owns the timestamp: when this is logged the enclosing BinlogRecord
2620
+ * carries the time, like any other sample, so there is no time field here.
2621
+ */
2622
+ export interface Annotation {
2623
+ /** Stable type id for grouping / Cloud correlation. Empty for a free-form annotation. */
2624
+ typeSlug: string;
2625
+ /** Type display name, e.g. "Hazard". Snapshot of the type at creation time. */
2626
+ typeName: string;
2627
+ /** Font Awesome solid icon name, kebab-case (e.g. "triangle-exclamation"). */
2628
+ typeIcon: string;
2629
+ /** Type color, RGB hex incl. leading '#', 7 chars (e.g. "#DC2626"). */
2630
+ typeColor: string;
2631
+ /** Optional annotation title; Cloud falls back to type_name if empty. Max 200 chars. */
2632
+ title: string;
2633
+ /** Optional free-form note. Unbounded. */
2634
+ body: string;
2635
+ /** Optional span; omit for a point-in-time marker. */
2636
+ duration: Duration | undefined;
2637
+ /** Origin of the annotation; the app sets APP, the drone sets DRONE for its own. */
2638
+ source: AnnotationSource;
2639
+ }
2003
2640
  export declare const BinlogRecord: MessageFns<BinlogRecord>;
2004
2641
  export declare const LogEntry: MessageFns<LogEntry>;
2005
2642
  export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
@@ -2007,6 +2644,8 @@ export declare const KernelLogEntry_KeyValuePair: MessageFns<KernelLogEntry_KeyV
2007
2644
  export declare const MotionInput: MessageFns<MotionInput>;
2008
2645
  export declare const Lights: MessageFns<Lights>;
2009
2646
  export declare const Laser: MessageFns<Laser>;
2647
+ export declare const Point2D: MessageFns<Point2D>;
2648
+ export declare const LaserDetection: MessageFns<LaserDetection>;
2010
2649
  export declare const LatLongPosition: MessageFns<LatLongPosition>;
2011
2650
  export declare const ConnectionDuration: MessageFns<ConnectionDuration>;
2012
2651
  export declare const AutoHeadingState: MessageFns<AutoHeadingState>;
@@ -2063,6 +2702,7 @@ export declare const IperfStatus: MessageFns<IperfStatus>;
2063
2702
  export declare const NStreamers: MessageFns<NStreamers>;
2064
2703
  export declare const TiltAngle: MessageFns<TiltAngle>;
2065
2704
  export declare const TiltVelocity: MessageFns<TiltVelocity>;
2705
+ export declare const CvModelInfo: MessageFns<CvModelInfo>;
2066
2706
  export declare const DroneInfo: MessageFns<DroneInfo>;
2067
2707
  export declare const ErrorFlags: MessageFns<ErrorFlags>;
2068
2708
  export declare const CameraParameters: MessageFns<CameraParameters>;
@@ -2089,9 +2729,25 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
2089
2729
  export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
2090
2730
  export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
2091
2731
  export declare const CPUInfo: MessageFns<CPUInfo>;
2732
+ export declare const CpuCoreLoad: MessageFns<CpuCoreLoad>;
2733
+ export declare const GpuInfo: MessageFns<GpuInfo>;
2734
+ export declare const DlaInfo: MessageFns<DlaInfo>;
2735
+ export declare const MemoryInfo: MessageFns<MemoryInfo>;
2736
+ export declare const ThermalZone: MessageFns<ThermalZone>;
2737
+ export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
2738
+ export declare const NvmeInfo: MessageFns<NvmeInfo>;
2739
+ export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
2092
2740
  export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
2093
2741
  export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
2742
+ export declare const BoundingBox: MessageFns<BoundingBox>;
2743
+ export declare const SegmentationMask: MessageFns<SegmentationMask>;
2744
+ export declare const ObjectDetection: MessageFns<ObjectDetection>;
2745
+ export declare const ModelDetections: MessageFns<ModelDetections>;
2094
2746
  export declare const FilterMessage: MessageFns<FilterMessage>;
2747
+ export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
2748
+ export declare const OperatorInfo: MessageFns<OperatorInfo>;
2749
+ export declare const SotState: MessageFns<SotState>;
2750
+ export declare const Annotation: MessageFns<Annotation>;
2095
2751
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
2096
2752
  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 {} ? {
2097
2753
  [K in keyof T]?: DeepPartial<T[K]>;