@blueyerobotics/protocol-definitions 3.2.0-457224af → 3.2.0-469f6b07
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/control.d.ts +50 -2
- package/dist/control.js +235 -1
- package/dist/message_formats.d.ts +431 -12
- package/dist/message_formats.js +2833 -181
- package/dist/req_rep.d.ts +14 -0
- package/dist/req_rep.js +120 -1
- package/dist/telemetry.d.ts +56 -5
- package/dist/telemetry.js +238 -17
- package/package.json +1 -1
|
@@ -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. */
|
|
@@ -346,6 +366,8 @@ export declare enum FontSize {
|
|
|
346
366
|
FONT_SIZE_PX35 = 5,
|
|
347
367
|
/** FONT_SIZE_PX40 - 40 px. */
|
|
348
368
|
FONT_SIZE_PX40 = 6,
|
|
369
|
+
/** FONT_SIZE_PX50 - 50 px. */
|
|
370
|
+
FONT_SIZE_PX50 = 7,
|
|
349
371
|
UNRECOGNIZED = -1
|
|
350
372
|
}
|
|
351
373
|
export declare function fontSizeFromJSON(object: any): FontSize;
|
|
@@ -464,10 +486,41 @@ export declare enum GuestPortNumber {
|
|
|
464
486
|
GUEST_PORT_NUMBER_PORT_2 = 2,
|
|
465
487
|
/** GUEST_PORT_NUMBER_PORT_3 - Guest port 3. */
|
|
466
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,
|
|
467
495
|
UNRECOGNIZED = -1
|
|
468
496
|
}
|
|
469
497
|
export declare function guestPortNumberFromJSON(object: any): GuestPortNumber;
|
|
470
498
|
export declare function guestPortNumberToJSON(object: GuestPortNumber): string;
|
|
499
|
+
/**
|
|
500
|
+
* Physical interfaces a guest port can provide.
|
|
501
|
+
*
|
|
502
|
+
* Used both for the interfaces a port provides and for the interfaces a
|
|
503
|
+
* device requires from the port it is connected to.
|
|
504
|
+
*/
|
|
505
|
+
export declare enum GuestPortCapability {
|
|
506
|
+
/** GUEST_PORT_CAPABILITY_UNSPECIFIED - Unspecified. */
|
|
507
|
+
GUEST_PORT_CAPABILITY_UNSPECIFIED = 0,
|
|
508
|
+
/** GUEST_PORT_CAPABILITY_ETHERNET - Ethernet. */
|
|
509
|
+
GUEST_PORT_CAPABILITY_ETHERNET = 1,
|
|
510
|
+
/** GUEST_PORT_CAPABILITY_I2C - I2C. */
|
|
511
|
+
GUEST_PORT_CAPABILITY_I2C = 2,
|
|
512
|
+
/** GUEST_PORT_CAPABILITY_RS232 - RS232 serial. */
|
|
513
|
+
GUEST_PORT_CAPABILITY_RS232 = 3,
|
|
514
|
+
/** GUEST_PORT_CAPABILITY_RS485 - RS485 serial. */
|
|
515
|
+
GUEST_PORT_CAPABILITY_RS485 = 4,
|
|
516
|
+
/** GUEST_PORT_CAPABILITY_USB2 - USB 2.0. */
|
|
517
|
+
GUEST_PORT_CAPABILITY_USB2 = 5,
|
|
518
|
+
/** GUEST_PORT_CAPABILITY_PWM - PWM. */
|
|
519
|
+
GUEST_PORT_CAPABILITY_PWM = 6,
|
|
520
|
+
UNRECOGNIZED = -1
|
|
521
|
+
}
|
|
522
|
+
export declare function guestPortCapabilityFromJSON(object: any): GuestPortCapability;
|
|
523
|
+
export declare function guestPortCapabilityToJSON(object: GuestPortCapability): string;
|
|
471
524
|
/** List of navigation sensors that can be used by the position observer. */
|
|
472
525
|
export declare enum NavigationSensorID {
|
|
473
526
|
/** NAVIGATION_SENSOR_ID_UNSPECIFIED - Unspecified. */
|
|
@@ -543,10 +596,40 @@ export declare enum ThermalZoneId {
|
|
|
543
596
|
THERMAL_ZONE_ID_TJ = 1,
|
|
544
597
|
/** THERMAL_ZONE_ID_CANISTER - Canister temperature. */
|
|
545
598
|
THERMAL_ZONE_ID_CANISTER = 2,
|
|
599
|
+
/** THERMAL_ZONE_ID_CPU - CPU thermal zone. */
|
|
600
|
+
THERMAL_ZONE_ID_CPU = 3,
|
|
601
|
+
/** THERMAL_ZONE_ID_GPU - GPU thermal zone. */
|
|
602
|
+
THERMAL_ZONE_ID_GPU = 4,
|
|
603
|
+
/** THERMAL_ZONE_ID_CV0 - Vision accelerator 0 thermal zone. */
|
|
604
|
+
THERMAL_ZONE_ID_CV0 = 5,
|
|
605
|
+
/** THERMAL_ZONE_ID_CV1 - Vision accelerator 1 thermal zone. */
|
|
606
|
+
THERMAL_ZONE_ID_CV1 = 6,
|
|
607
|
+
/** THERMAL_ZONE_ID_CV2 - Vision accelerator 2 thermal zone. */
|
|
608
|
+
THERMAL_ZONE_ID_CV2 = 7,
|
|
609
|
+
/** THERMAL_ZONE_ID_SOC0 - SoC 0 thermal zone. */
|
|
610
|
+
THERMAL_ZONE_ID_SOC0 = 8,
|
|
611
|
+
/** THERMAL_ZONE_ID_SOC1 - SoC 1 thermal zone. */
|
|
612
|
+
THERMAL_ZONE_ID_SOC1 = 9,
|
|
613
|
+
/** THERMAL_ZONE_ID_SOC2 - SoC 2 thermal zone. */
|
|
614
|
+
THERMAL_ZONE_ID_SOC2 = 10,
|
|
546
615
|
UNRECOGNIZED = -1
|
|
547
616
|
}
|
|
548
617
|
export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
|
|
549
618
|
export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
|
|
619
|
+
/** Origin of an annotation. Mirrors the AnnotationSource enum in Blueye Cloud. */
|
|
620
|
+
export declare enum AnnotationSource {
|
|
621
|
+
/** ANNOTATION_SOURCE_UNSPECIFIED - Origin not specified. */
|
|
622
|
+
ANNOTATION_SOURCE_UNSPECIFIED = 0,
|
|
623
|
+
/** ANNOTATION_SOURCE_CLOUD - Created in Blueye Cloud after the dive. */
|
|
624
|
+
ANNOTATION_SOURCE_CLOUD = 1,
|
|
625
|
+
/** ANNOTATION_SOURCE_APP - Created in the app during the dive. */
|
|
626
|
+
ANNOTATION_SOURCE_APP = 2,
|
|
627
|
+
/** ANNOTATION_SOURCE_DRONE - Emitted by the drone itself. */
|
|
628
|
+
ANNOTATION_SOURCE_DRONE = 3,
|
|
629
|
+
UNRECOGNIZED = -1
|
|
630
|
+
}
|
|
631
|
+
export declare function annotationSourceFromJSON(object: any): AnnotationSource;
|
|
632
|
+
export declare function annotationSourceToJSON(object: AnnotationSource): string;
|
|
550
633
|
/**
|
|
551
634
|
* Wrapper message for each entry in the drone telemetry logfile.
|
|
552
635
|
*
|
|
@@ -680,6 +763,46 @@ export interface Lights {
|
|
|
680
763
|
export interface Laser {
|
|
681
764
|
/** Laser intensity, any value above 0 turns the laser on (0..1). */
|
|
682
765
|
value: number;
|
|
766
|
+
/** Modulate the laser at 5Hz for tracking. Only available on Ultra. */
|
|
767
|
+
modulated: boolean;
|
|
768
|
+
}
|
|
769
|
+
/** Point in 2D space. */
|
|
770
|
+
export interface Point2D {
|
|
771
|
+
/** X coordinate of the point (px). */
|
|
772
|
+
x: number;
|
|
773
|
+
/** Y coordinate of the point (px). */
|
|
774
|
+
y: number;
|
|
775
|
+
}
|
|
776
|
+
/**
|
|
777
|
+
* Message representing the detection of scaling lasers in the main camera.
|
|
778
|
+
*
|
|
779
|
+
* The message contains the centroids of the detected dots, the distance between them in pixels,
|
|
780
|
+
* and the confidence of the detection. The dots are detected through temporal DFT analysis of
|
|
781
|
+
* 5 Hz laser modulation, isolating flickering pixels from the static scene background.
|
|
782
|
+
*
|
|
783
|
+
* Only available on Ultra.
|
|
784
|
+
*/
|
|
785
|
+
export interface LaserDetection {
|
|
786
|
+
/** True if the laser is detected by the drone. */
|
|
787
|
+
detected: boolean;
|
|
788
|
+
/** First dot centroid (leftmost). */
|
|
789
|
+
dot1: Point2D | undefined;
|
|
790
|
+
/** Second dot centroid (rightmost). */
|
|
791
|
+
dot2: Point2D | undefined;
|
|
792
|
+
/** Distance between dots in pixels. */
|
|
793
|
+
pixelDistance: number;
|
|
794
|
+
/** Confidence of the detection (0..1). */
|
|
795
|
+
confidence: number;
|
|
796
|
+
/** Source frame width. */
|
|
797
|
+
imageWidth: number;
|
|
798
|
+
/** Source frame height. */
|
|
799
|
+
imageHeight: number;
|
|
800
|
+
/** Real world distance between the two laser dots (m). */
|
|
801
|
+
laserWidth: number;
|
|
802
|
+
/** Distance after lens undistortion (px). */
|
|
803
|
+
correctedPixelDistance: number;
|
|
804
|
+
/** Estimated subject distance (m). */
|
|
805
|
+
estimatedDistance: number;
|
|
683
806
|
}
|
|
684
807
|
/** Latitude and longitude position in WGS 84 decimal degrees format. */
|
|
685
808
|
export interface LatLongPosition {
|
|
@@ -1439,6 +1562,31 @@ export interface TiltVelocity {
|
|
|
1439
1562
|
/**
|
|
1440
1563
|
* Information about the drone.
|
|
1441
1564
|
*
|
|
1565
|
+
* Information about a loaded computer vision model.
|
|
1566
|
+
*/
|
|
1567
|
+
export interface CvModelInfo {
|
|
1568
|
+
/** Human-readable model name (from model_meta.json). */
|
|
1569
|
+
name: string;
|
|
1570
|
+
/** Type of CV model. */
|
|
1571
|
+
type: CvModelInfo_ModelType;
|
|
1572
|
+
/** Whether the model is currently running. */
|
|
1573
|
+
running: boolean;
|
|
1574
|
+
/** Execution provider (e.g. "cuda", "tensorrt"). */
|
|
1575
|
+
device: string;
|
|
1576
|
+
/** Package directory name (e.g. "tinyyolov2_package"). Stable identifier. */
|
|
1577
|
+
packageId: string;
|
|
1578
|
+
/** Class names the model can detect (indexed by class_id). */
|
|
1579
|
+
labels: string[];
|
|
1580
|
+
}
|
|
1581
|
+
export declare enum CvModelInfo_ModelType {
|
|
1582
|
+
MODEL_TYPE_UNSPECIFIED = 0,
|
|
1583
|
+
MODEL_TYPE_DETECTION = 1,
|
|
1584
|
+
MODEL_TYPE_SOT = 2,
|
|
1585
|
+
UNRECOGNIZED = -1
|
|
1586
|
+
}
|
|
1587
|
+
export declare function cvModelInfo_ModelTypeFromJSON(object: any): CvModelInfo_ModelType;
|
|
1588
|
+
export declare function cvModelInfo_ModelTypeToJSON(object: CvModelInfo_ModelType): string;
|
|
1589
|
+
/**
|
|
1442
1590
|
* This message contains serial numbers and version information for
|
|
1443
1591
|
* internal components in the drone. Primarily used for diagnostics, or to
|
|
1444
1592
|
* determine the origin of a logfile.
|
|
@@ -1466,6 +1614,10 @@ export interface DroneInfo {
|
|
|
1466
1614
|
gp: GuestPortInfo | undefined;
|
|
1467
1615
|
/** Type of depth sensor that is connected to the drone. */
|
|
1468
1616
|
depthSensor: PressureSensorType;
|
|
1617
|
+
/** List of loaded computer vision models. */
|
|
1618
|
+
cvModels: CvModelInfo[];
|
|
1619
|
+
/** How the drone is powered. */
|
|
1620
|
+
powerSource: PowerSource;
|
|
1469
1621
|
}
|
|
1470
1622
|
/** Known error states for the drone. */
|
|
1471
1623
|
export interface ErrorFlags {
|
|
@@ -1491,30 +1643,72 @@ export interface ErrorFlags {
|
|
|
1491
1643
|
gp2Read: boolean;
|
|
1492
1644
|
/** Guest port 3 read error. */
|
|
1493
1645
|
gp3Read: boolean;
|
|
1646
|
+
/** Guest port 4 read error. */
|
|
1647
|
+
gp4Read: boolean;
|
|
1648
|
+
/** Guest port 5 read error. */
|
|
1649
|
+
gp5Read: boolean;
|
|
1650
|
+
/** Guest port 6 read error. */
|
|
1651
|
+
gp6Read: boolean;
|
|
1494
1652
|
/** Guest port 1 not flashed. */
|
|
1495
1653
|
gp1NotFlashed: boolean;
|
|
1496
1654
|
/** Guest port 2 not flashed. */
|
|
1497
1655
|
gp2NotFlashed: boolean;
|
|
1498
1656
|
/** Guest port 3 not flashed. */
|
|
1499
1657
|
gp3NotFlashed: boolean;
|
|
1658
|
+
/** Guest port 4 not flashed. */
|
|
1659
|
+
gp4NotFlashed: boolean;
|
|
1660
|
+
/** Guest port 5 not flashed. */
|
|
1661
|
+
gp5NotFlashed: boolean;
|
|
1662
|
+
/** Guest port 6 not flashed. */
|
|
1663
|
+
gp6NotFlashed: boolean;
|
|
1500
1664
|
/** Unknown device on guest port 1. */
|
|
1501
1665
|
gp1UnknownDevice: boolean;
|
|
1502
1666
|
/** Unknown device on guest port 2. */
|
|
1503
1667
|
gp2UnknownDevice: boolean;
|
|
1504
1668
|
/** Unknown device on guest port 3. */
|
|
1505
1669
|
gp3UnknownDevice: boolean;
|
|
1670
|
+
/** Unknown device on guest port 4. */
|
|
1671
|
+
gp4UnknownDevice: boolean;
|
|
1672
|
+
/** Unknown device on guest port 5. */
|
|
1673
|
+
gp5UnknownDevice: boolean;
|
|
1674
|
+
/** Unknown device on guest port 6. */
|
|
1675
|
+
gp6UnknownDevice: boolean;
|
|
1506
1676
|
/** Guest port 1 connection error. */
|
|
1507
1677
|
gp1DeviceConnection: boolean;
|
|
1508
1678
|
/** Guest port 2 connection error. */
|
|
1509
1679
|
gp2DeviceConnection: boolean;
|
|
1510
1680
|
/** Guest port 3 connection error. */
|
|
1511
1681
|
gp3DeviceConnection: boolean;
|
|
1682
|
+
/** Guest port 4 connection error. */
|
|
1683
|
+
gp4DeviceConnection: boolean;
|
|
1684
|
+
/** Guest port 5 connection error. */
|
|
1685
|
+
gp5DeviceConnection: boolean;
|
|
1686
|
+
/** Guest port 6 connection error. */
|
|
1687
|
+
gp6DeviceConnection: boolean;
|
|
1512
1688
|
/** Guest port 1 device error. */
|
|
1513
1689
|
gp1Device: boolean;
|
|
1514
1690
|
/** Guest port 2 device error. */
|
|
1515
1691
|
gp2Device: boolean;
|
|
1516
1692
|
/** Guest port 3 device error. */
|
|
1517
1693
|
gp3Device: boolean;
|
|
1694
|
+
/** Guest port 4 device error. */
|
|
1695
|
+
gp4Device: boolean;
|
|
1696
|
+
/** Guest port 5 device error. */
|
|
1697
|
+
gp5Device: boolean;
|
|
1698
|
+
/** Guest port 6 device error. */
|
|
1699
|
+
gp6Device: boolean;
|
|
1700
|
+
/** Device on guest port 1 requires interfaces the port does not provide. */
|
|
1701
|
+
gp1IncompatibleDevice: boolean;
|
|
1702
|
+
/** Device on guest port 2 requires interfaces the port does not provide. */
|
|
1703
|
+
gp2IncompatibleDevice: boolean;
|
|
1704
|
+
/** Device on guest port 3 requires interfaces the port does not provide. */
|
|
1705
|
+
gp3IncompatibleDevice: boolean;
|
|
1706
|
+
/** Device on guest port 4 requires interfaces the port does not provide. */
|
|
1707
|
+
gp4IncompatibleDevice: boolean;
|
|
1708
|
+
/** Device on guest port 5 requires interfaces the port does not provide. */
|
|
1709
|
+
gp5IncompatibleDevice: boolean;
|
|
1710
|
+
/** Device on guest port 6 requires interfaces the port does not provide. */
|
|
1711
|
+
gp6IncompatibleDevice: boolean;
|
|
1518
1712
|
/** Drone serial number not set. */
|
|
1519
1713
|
droneSerialNotSet: boolean;
|
|
1520
1714
|
/** Drone serial number error. */
|
|
@@ -1545,14 +1739,44 @@ export interface ErrorFlags {
|
|
|
1545
1739
|
gpCurrentRead: boolean;
|
|
1546
1740
|
/** Max GP current exceeded. */
|
|
1547
1741
|
gpCurrent: boolean;
|
|
1548
|
-
/** Max battery current exceeded on
|
|
1742
|
+
/** Max battery current exceeded on guest port 1. */
|
|
1549
1743
|
gp1BatCurrent: boolean;
|
|
1550
|
-
/** Max battery current exceeded on
|
|
1744
|
+
/** Max battery current exceeded on guest port 2. */
|
|
1551
1745
|
gp2BatCurrent: boolean;
|
|
1552
|
-
/** Max battery current exceeded on
|
|
1746
|
+
/** Max battery current exceeded on guest port 3. */
|
|
1553
1747
|
gp3BatCurrent: boolean;
|
|
1554
|
-
/** Max
|
|
1555
|
-
|
|
1748
|
+
/** Max battery current exceeded on guest port 4. */
|
|
1749
|
+
gp4BatCurrent: boolean;
|
|
1750
|
+
/** Max battery current exceeded on guest port 5. */
|
|
1751
|
+
gp5BatCurrent: boolean;
|
|
1752
|
+
/** Max battery current exceeded on guest port 6. */
|
|
1753
|
+
gp6BatCurrent: boolean;
|
|
1754
|
+
/** Max 24V current exceeded on GP. Only present on X1/X3 (not X3 Ultra or X7). */
|
|
1755
|
+
gp24vCurrent: boolean;
|
|
1756
|
+
/** Max 24V current exceeded on guest port 1. */
|
|
1757
|
+
gp124vCurrent: boolean;
|
|
1758
|
+
/** Max 24V current exceeded on guest port 2. */
|
|
1759
|
+
gp224vCurrent: boolean;
|
|
1760
|
+
/** Max 24V current exceeded on guest port 3. */
|
|
1761
|
+
gp324vCurrent: boolean;
|
|
1762
|
+
/** Max 24V current exceeded on guest port 4. */
|
|
1763
|
+
gp424vCurrent: boolean;
|
|
1764
|
+
/** Max 24V current exceeded on guest port 5. */
|
|
1765
|
+
gp524vCurrent: boolean;
|
|
1766
|
+
/** Max 24V current exceeded on guest port 6. */
|
|
1767
|
+
gp624vCurrent: boolean;
|
|
1768
|
+
/** Max 5V current exceeded on guest port 1. */
|
|
1769
|
+
gp15vCurrent: boolean;
|
|
1770
|
+
/** Max 5V current exceeded on guest port 2. */
|
|
1771
|
+
gp25vCurrent: boolean;
|
|
1772
|
+
/** Max 5V current exceeded on guest port 3. */
|
|
1773
|
+
gp35vCurrent: boolean;
|
|
1774
|
+
/** Max 5V current exceeded on guest port 4. */
|
|
1775
|
+
gp45vCurrent: boolean;
|
|
1776
|
+
/** Max 5V current exceeded on guest port 5. */
|
|
1777
|
+
gp55vCurrent: boolean;
|
|
1778
|
+
/** Max 5V current exceeded on guest port 6. */
|
|
1779
|
+
gp65vCurrent: boolean;
|
|
1556
1780
|
/** DVL is in thermal protection mode. */
|
|
1557
1781
|
dvlThermalProtectionMode: boolean;
|
|
1558
1782
|
/** GP protection has been triggered at boot or faulty DVL. */
|
|
@@ -1712,6 +1936,13 @@ export interface GuestPortDevice {
|
|
|
1712
1936
|
requiredBlunuxVersion: string;
|
|
1713
1937
|
/** Detach status based on detection pin. */
|
|
1714
1938
|
detachStatus: GuestPortDetachStatus;
|
|
1939
|
+
/** Interfaces the device requires from the port. */
|
|
1940
|
+
requiredCapabilities: GuestPortCapability[];
|
|
1941
|
+
/**
|
|
1942
|
+
* Ports on this drone where the device is fully supported. Computed by the
|
|
1943
|
+
* drone from the port capabilities and the device requirements.
|
|
1944
|
+
*/
|
|
1945
|
+
compatibleGuestPorts: GuestPortNumber[];
|
|
1715
1946
|
}
|
|
1716
1947
|
/** List of guest port devices. */
|
|
1717
1948
|
export interface GuestPortDeviceList {
|
|
@@ -1726,6 +1957,8 @@ export interface GuestPortConnectorInfo {
|
|
|
1726
1957
|
error?: GuestPortError | undefined;
|
|
1727
1958
|
/** Guest port the connector is connected to. */
|
|
1728
1959
|
guestPortNumber: GuestPortNumber;
|
|
1960
|
+
/** Interfaces this port provides. */
|
|
1961
|
+
capabilities: GuestPortCapability[];
|
|
1729
1962
|
}
|
|
1730
1963
|
/** GuestPort information. */
|
|
1731
1964
|
export interface GuestPortInfo {
|
|
@@ -1735,6 +1968,12 @@ export interface GuestPortInfo {
|
|
|
1735
1968
|
gp2: GuestPortConnectorInfo | undefined;
|
|
1736
1969
|
/** Information about guest port 3. */
|
|
1737
1970
|
gp3: GuestPortConnectorInfo | undefined;
|
|
1971
|
+
/** Information about guest port 4. */
|
|
1972
|
+
gp4: GuestPortConnectorInfo | undefined;
|
|
1973
|
+
/** Information about guest port 5. */
|
|
1974
|
+
gp5: GuestPortConnectorInfo | undefined;
|
|
1975
|
+
/** Information about guest port 6. */
|
|
1976
|
+
gp6: GuestPortConnectorInfo | undefined;
|
|
1738
1977
|
}
|
|
1739
1978
|
/** GuestPort restart information. */
|
|
1740
1979
|
export interface GuestPortRestartInfo {
|
|
@@ -1779,8 +2018,38 @@ export interface GuestPortCurrent {
|
|
|
1779
2018
|
gp2Bat: number;
|
|
1780
2019
|
/** Current on GP3 battery voltage (A). */
|
|
1781
2020
|
gp3Bat: number;
|
|
1782
|
-
/** Current on common
|
|
1783
|
-
|
|
2021
|
+
/** Current on common/input 24V supply (A). Only present on X1/X3 (not X3 Ultra or X7). */
|
|
2022
|
+
gp24v: number;
|
|
2023
|
+
/** Current on GP4 battery voltage (A). */
|
|
2024
|
+
gp4Bat: number;
|
|
2025
|
+
/** Current on GP5 battery voltage (A). */
|
|
2026
|
+
gp5Bat: number;
|
|
2027
|
+
/** Current on GP6 battery voltage (A). */
|
|
2028
|
+
gp6Bat: number;
|
|
2029
|
+
/** Current on GP1 24V supply (A). */
|
|
2030
|
+
gp124v: number;
|
|
2031
|
+
/** Current on GP2 24V supply (A). */
|
|
2032
|
+
gp224v: number;
|
|
2033
|
+
/** Current on GP3 24V supply (A). */
|
|
2034
|
+
gp324v: number;
|
|
2035
|
+
/** Current on GP4 24V supply (A). */
|
|
2036
|
+
gp424v: number;
|
|
2037
|
+
/** Current on GP5 24V supply (A). */
|
|
2038
|
+
gp524v: number;
|
|
2039
|
+
/** Current on GP6 24V supply (A). */
|
|
2040
|
+
gp624v: number;
|
|
2041
|
+
/** Current on GP1 5V supply (A). */
|
|
2042
|
+
gp15v: number;
|
|
2043
|
+
/** Current on GP2 5V supply (A). */
|
|
2044
|
+
gp25v: number;
|
|
2045
|
+
/** Current on GP3 5V supply (A). */
|
|
2046
|
+
gp35v: number;
|
|
2047
|
+
/** Current on GP4 5V supply (A). */
|
|
2048
|
+
gp45v: number;
|
|
2049
|
+
/** Current on GP5 5V supply (A). */
|
|
2050
|
+
gp55v: number;
|
|
2051
|
+
/** Current on GP6 5V supply (A). */
|
|
2052
|
+
gp65v: number;
|
|
1784
2053
|
}
|
|
1785
2054
|
/** Vector with 3 elements. */
|
|
1786
2055
|
export interface Vector3 {
|
|
@@ -2081,13 +2350,78 @@ export interface VideoCodecInfo {
|
|
|
2081
2350
|
vpuCodecIrqCount: number;
|
|
2082
2351
|
/** Cumulative VPU_JPG_IRQ count. */
|
|
2083
2352
|
vpuJpgIrqCount: number;
|
|
2353
|
+
/** Jetson only (host1x actmon engine utilization, 0..1). */
|
|
2354
|
+
encoderLoad: number;
|
|
2355
|
+
/** Video decoder (NVDEC) utilization (0..1). */
|
|
2356
|
+
decoderLoad: number;
|
|
2357
|
+
/** JPEG engine (NVJPG) utilization (0..1). */
|
|
2358
|
+
nvjpgLoad: number;
|
|
2359
|
+
/** Video Image Compositor (VIC) utilization (0..1). */
|
|
2360
|
+
vicLoad: number;
|
|
2361
|
+
}
|
|
2362
|
+
/**
|
|
2363
|
+
* NVMe SSD health, wear and identity (Jetson only; i.MX drones boot/store on
|
|
2364
|
+
* an SD card and have no NVMe device, so this message is omitted there).
|
|
2365
|
+
*/
|
|
2366
|
+
export interface NvmeInfo {
|
|
2367
|
+
/** Tier 1 — health & safety. */
|
|
2368
|
+
compositeTemperature: number;
|
|
2369
|
+
/** NVMe critical-warning bitfield. */
|
|
2370
|
+
criticalWarning: number;
|
|
2371
|
+
/** Wear indicator (%, may exceed 100). */
|
|
2372
|
+
percentageUsed: number;
|
|
2373
|
+
/** Remaining spare capacity (%). */
|
|
2374
|
+
availableSpare: number;
|
|
2375
|
+
/** Spare alarm threshold (%). */
|
|
2376
|
+
availableSpareThreshold: number;
|
|
2377
|
+
/** Uncorrected data-integrity errors. */
|
|
2378
|
+
mediaErrors: number;
|
|
2379
|
+
/** Power-loss / unsafe shutdown count. */
|
|
2380
|
+
unsafeShutdowns: number;
|
|
2381
|
+
/** Tier 2 — thermal throttling. */
|
|
2382
|
+
warningTempTimeMin: number;
|
|
2383
|
+
/** Minutes above the critical temperature. */
|
|
2384
|
+
criticalTempTimeMin: number;
|
|
2385
|
+
/** Times entered light throttling. */
|
|
2386
|
+
thermalMgmtT1TransCount: number;
|
|
2387
|
+
/** Times entered heavy throttling. */
|
|
2388
|
+
thermalMgmtT2TransCount: number;
|
|
2389
|
+
/** Total seconds in light throttling. */
|
|
2390
|
+
thermalMgmtT1TotalTimeS: number;
|
|
2391
|
+
/** Total seconds in heavy throttling. */
|
|
2392
|
+
thermalMgmtT2TotalTimeS: number;
|
|
2393
|
+
/** Tier 3 — endurance / workload. */
|
|
2394
|
+
dataUnitsWrittenBytes: number;
|
|
2395
|
+
/** Host data read (B). */
|
|
2396
|
+
dataUnitsReadBytes: number;
|
|
2397
|
+
/** Host write command count. */
|
|
2398
|
+
hostWriteCommands: number;
|
|
2399
|
+
/** Host read command count. */
|
|
2400
|
+
hostReadCommands: number;
|
|
2401
|
+
/** Power-on hours. */
|
|
2402
|
+
powerOnHours: number;
|
|
2403
|
+
/** Power cycle count. */
|
|
2404
|
+
powerCycles: number;
|
|
2405
|
+
/** Controller busy time (min). */
|
|
2406
|
+
controllerBusyTimeMin: number;
|
|
2407
|
+
/** Error-log entry count. */
|
|
2408
|
+
numErrLogEntries: number;
|
|
2409
|
+
/** Tier 4 — identity & capacity. */
|
|
2410
|
+
model: string;
|
|
2411
|
+
/** Drive serial number. */
|
|
2412
|
+
serial: string;
|
|
2413
|
+
/** Firmware revision. */
|
|
2414
|
+
firmwareRev: string;
|
|
2415
|
+
/** Total drive capacity (B). Partition used/free is */
|
|
2416
|
+
capacityBytes: number;
|
|
2084
2417
|
}
|
|
2085
2418
|
/**
|
|
2086
2419
|
* System performance information.
|
|
2087
2420
|
*
|
|
2088
2421
|
* Comprehensive performance metrics for the drone's compute platform.
|
|
2089
|
-
* Covers CPU, GPU, DLA, memory, thermals,
|
|
2090
|
-
* Fields not applicable to a platform are left at their
|
|
2422
|
+
* Covers CPU, GPU, DLA, memory, thermals, video codec utilization and NVMe
|
|
2423
|
+
* SSD state. Fields not applicable to a platform are left at their
|
|
2424
|
+
* zero/empty defaults.
|
|
2091
2425
|
*/
|
|
2092
2426
|
export interface SystemPerformanceInfo {
|
|
2093
2427
|
/** Per-core CPU utilization. */
|
|
@@ -2116,6 +2450,8 @@ export interface SystemPerformanceInfo {
|
|
|
2116
2450
|
overlayQueueLoad: number;
|
|
2117
2451
|
/** Position observer queue load (0..1). */
|
|
2118
2452
|
positionObserverQueueLoad: number;
|
|
2453
|
+
/** NVMe SSD health/identity (Jetson only). */
|
|
2454
|
+
nvme: NvmeInfo | undefined;
|
|
2119
2455
|
}
|
|
2120
2456
|
/**
|
|
2121
2457
|
* Surface Unit battery information.
|
|
@@ -2164,6 +2500,22 @@ export interface BoundingBox {
|
|
|
2164
2500
|
/** Height of the bounding box (px). */
|
|
2165
2501
|
height: number;
|
|
2166
2502
|
}
|
|
2503
|
+
/**
|
|
2504
|
+
* RLE-encoded binary segmentation mask relative to the bounding box.
|
|
2505
|
+
*
|
|
2506
|
+
* The mask bitmap has dimensions (mask_width x mask_height) covering the
|
|
2507
|
+
* detection's bounding box area. The counts field stores run-length encoded
|
|
2508
|
+
* data as packed uint16 little-endian: alternating background/foreground
|
|
2509
|
+
* pixel runs starting with background.
|
|
2510
|
+
*/
|
|
2511
|
+
export interface SegmentationMask {
|
|
2512
|
+
/** Width of the RLE bitmap. */
|
|
2513
|
+
maskWidth: number;
|
|
2514
|
+
/** Height of the RLE bitmap. */
|
|
2515
|
+
maskHeight: number;
|
|
2516
|
+
/** RLE counts as packed uint16 little-endian. */
|
|
2517
|
+
counts: Uint8Array;
|
|
2518
|
+
}
|
|
2167
2519
|
/** A single object detection from a computer vision model. */
|
|
2168
2520
|
export interface ObjectDetection {
|
|
2169
2521
|
/** Bounding box of the detected object. */
|
|
@@ -2176,9 +2528,11 @@ export interface ObjectDetection {
|
|
|
2176
2528
|
className: string;
|
|
2177
2529
|
/** Unique ID for tracking the same object across frames. */
|
|
2178
2530
|
trackingId: number;
|
|
2531
|
+
/** Instance segmentation mask (absent if model has no segmentation). */
|
|
2532
|
+
mask: SegmentationMask | undefined;
|
|
2179
2533
|
}
|
|
2180
|
-
/** A list of object detections from a single video frame. */
|
|
2181
|
-
export interface
|
|
2534
|
+
/** A list of object detections from a single model for a single video frame. */
|
|
2535
|
+
export interface ModelDetections {
|
|
2182
2536
|
/** List of detections in the frame. */
|
|
2183
2537
|
detections: ObjectDetection[];
|
|
2184
2538
|
/** Which camera the detections are from. */
|
|
@@ -2187,6 +2541,8 @@ export interface ObjectDetections {
|
|
|
2187
2541
|
imageWidth: number;
|
|
2188
2542
|
/** Height of the source image (px). */
|
|
2189
2543
|
imageHeight: number;
|
|
2544
|
+
/** Name of the computer vision model that produced the detections. */
|
|
2545
|
+
modelName: string;
|
|
2190
2546
|
}
|
|
2191
2547
|
/** Generic filter settings. */
|
|
2192
2548
|
export interface FilterMessage {
|
|
@@ -2220,6 +2576,62 @@ export interface OperatorInfo {
|
|
|
2220
2576
|
/** E-mail address of the operator. */
|
|
2221
2577
|
email: string;
|
|
2222
2578
|
}
|
|
2579
|
+
/** Single-object tracking (SOT) state reported by the computer vision pipeline. */
|
|
2580
|
+
export interface SotState {
|
|
2581
|
+
/** Current tracking state. */
|
|
2582
|
+
state: SotState_State;
|
|
2583
|
+
/** Current tracked bounding box (valid when TRACKING). */
|
|
2584
|
+
boundingBox: BoundingBox | undefined;
|
|
2585
|
+
/** Width of the source frame in pixels. */
|
|
2586
|
+
imageWidth: number;
|
|
2587
|
+
/** Height of the source frame in pixels. */
|
|
2588
|
+
imageHeight: number;
|
|
2589
|
+
}
|
|
2590
|
+
/** Current state of the SOT tracker. */
|
|
2591
|
+
export declare enum SotState_State {
|
|
2592
|
+
/** STATE_UNSPECIFIED - Unspecified state. */
|
|
2593
|
+
STATE_UNSPECIFIED = 0,
|
|
2594
|
+
/** STATE_IDLE - No target selected, waiting for a target bounding box. */
|
|
2595
|
+
STATE_IDLE = 1,
|
|
2596
|
+
/** STATE_TRACKING - Actively tracking a target. */
|
|
2597
|
+
STATE_TRACKING = 2,
|
|
2598
|
+
/** STATE_LOST - Target was lost (tracker failed to follow the object). */
|
|
2599
|
+
STATE_LOST = 3,
|
|
2600
|
+
UNRECOGNIZED = -1
|
|
2601
|
+
}
|
|
2602
|
+
export declare function sotState_StateFromJSON(object: any): SotState_State;
|
|
2603
|
+
export declare function sotState_StateToJSON(object: SotState_State): string;
|
|
2604
|
+
/**
|
|
2605
|
+
* A single annotation added during a dive, e.g. by a diver tapping a type in the
|
|
2606
|
+
* app command palette, or emitted by the drone itself.
|
|
2607
|
+
*
|
|
2608
|
+
* Self-contained: it carries the type's display fields (name/icon/color) inline,
|
|
2609
|
+
* so the drone, any connected client, and the dive logfile can render it without
|
|
2610
|
+
* a separate catalog. The app keeps the full catalog locally (synced from
|
|
2611
|
+
* Blueye Cloud) to drive its palette, but only complete annotations go over the
|
|
2612
|
+
* wire. type_slug lets Blueye Cloud correlate the annotation to its type on import.
|
|
2613
|
+
*
|
|
2614
|
+
* The drone owns the timestamp: when this is logged the enclosing BinlogRecord
|
|
2615
|
+
* carries the time, like any other sample, so there is no time field here.
|
|
2616
|
+
*/
|
|
2617
|
+
export interface Annotation {
|
|
2618
|
+
/** Stable type id for grouping / Cloud correlation. Empty for a free-form annotation. */
|
|
2619
|
+
typeSlug: string;
|
|
2620
|
+
/** Type display name, e.g. "Hazard". Snapshot of the type at creation time. */
|
|
2621
|
+
typeName: string;
|
|
2622
|
+
/** Font Awesome solid icon name, kebab-case (e.g. "triangle-exclamation"). */
|
|
2623
|
+
typeIcon: string;
|
|
2624
|
+
/** Type color, RGB hex incl. leading '#', 7 chars (e.g. "#DC2626"). */
|
|
2625
|
+
typeColor: string;
|
|
2626
|
+
/** Optional annotation title; Cloud falls back to type_name if empty. Max 200 chars. */
|
|
2627
|
+
title: string;
|
|
2628
|
+
/** Optional free-form note. Unbounded. */
|
|
2629
|
+
body: string;
|
|
2630
|
+
/** Optional span; omit for a point-in-time marker. */
|
|
2631
|
+
duration: Duration | undefined;
|
|
2632
|
+
/** Origin of the annotation; the app sets APP, the drone sets DRONE for its own. */
|
|
2633
|
+
source: AnnotationSource;
|
|
2634
|
+
}
|
|
2223
2635
|
export declare const BinlogRecord: MessageFns<BinlogRecord>;
|
|
2224
2636
|
export declare const LogEntry: MessageFns<LogEntry>;
|
|
2225
2637
|
export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
|
|
@@ -2227,6 +2639,8 @@ export declare const KernelLogEntry_KeyValuePair: MessageFns<KernelLogEntry_KeyV
|
|
|
2227
2639
|
export declare const MotionInput: MessageFns<MotionInput>;
|
|
2228
2640
|
export declare const Lights: MessageFns<Lights>;
|
|
2229
2641
|
export declare const Laser: MessageFns<Laser>;
|
|
2642
|
+
export declare const Point2D: MessageFns<Point2D>;
|
|
2643
|
+
export declare const LaserDetection: MessageFns<LaserDetection>;
|
|
2230
2644
|
export declare const LatLongPosition: MessageFns<LatLongPosition>;
|
|
2231
2645
|
export declare const ConnectionDuration: MessageFns<ConnectionDuration>;
|
|
2232
2646
|
export declare const AutoHeadingState: MessageFns<AutoHeadingState>;
|
|
@@ -2283,6 +2697,7 @@ export declare const IperfStatus: MessageFns<IperfStatus>;
|
|
|
2283
2697
|
export declare const NStreamers: MessageFns<NStreamers>;
|
|
2284
2698
|
export declare const TiltAngle: MessageFns<TiltAngle>;
|
|
2285
2699
|
export declare const TiltVelocity: MessageFns<TiltVelocity>;
|
|
2700
|
+
export declare const CvModelInfo: MessageFns<CvModelInfo>;
|
|
2286
2701
|
export declare const DroneInfo: MessageFns<DroneInfo>;
|
|
2287
2702
|
export declare const ErrorFlags: MessageFns<ErrorFlags>;
|
|
2288
2703
|
export declare const CameraParameters: MessageFns<CameraParameters>;
|
|
@@ -2315,15 +2730,19 @@ export declare const DlaInfo: MessageFns<DlaInfo>;
|
|
|
2315
2730
|
export declare const MemoryInfo: MessageFns<MemoryInfo>;
|
|
2316
2731
|
export declare const ThermalZone: MessageFns<ThermalZone>;
|
|
2317
2732
|
export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
|
|
2733
|
+
export declare const NvmeInfo: MessageFns<NvmeInfo>;
|
|
2318
2734
|
export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
|
|
2319
2735
|
export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
|
|
2320
2736
|
export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
|
|
2321
2737
|
export declare const BoundingBox: MessageFns<BoundingBox>;
|
|
2738
|
+
export declare const SegmentationMask: MessageFns<SegmentationMask>;
|
|
2322
2739
|
export declare const ObjectDetection: MessageFns<ObjectDetection>;
|
|
2323
|
-
export declare const
|
|
2740
|
+
export declare const ModelDetections: MessageFns<ModelDetections>;
|
|
2324
2741
|
export declare const FilterMessage: MessageFns<FilterMessage>;
|
|
2325
2742
|
export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
|
|
2326
2743
|
export declare const OperatorInfo: MessageFns<OperatorInfo>;
|
|
2744
|
+
export declare const SotState: MessageFns<SotState>;
|
|
2745
|
+
export declare const Annotation: MessageFns<Annotation>;
|
|
2327
2746
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
2328
2747
|
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 {} ? {
|
|
2329
2748
|
[K in keyof T]?: DeepPartial<T[K]>;
|