@blueyerobotics/protocol-definitions 3.2.0-db84868b → 3.2.0-dc69375e
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 +45 -2
- package/dist/control.js +166 -1
- package/dist/message_formats.d.ts +382 -10
- package/dist/message_formats.js +2278 -85
- package/dist/telemetry.d.ts +40 -2
- package/dist/telemetry.js +154 -5
- package/package.json +1 -1
|
@@ -210,6 +210,24 @@ export declare enum PressureSensorType {
|
|
|
210
210
|
}
|
|
211
211
|
export declare function pressureSensorTypeFromJSON(object: any): PressureSensorType;
|
|
212
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;
|
|
213
231
|
/** Available camera resolutions. */
|
|
214
232
|
export declare enum Resolution {
|
|
215
233
|
/** RESOLUTION_UNSPECIFIED - Resolution not specified. */
|
|
@@ -454,6 +472,11 @@ export declare enum GuestPortDeviceID {
|
|
|
454
472
|
GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT = 47,
|
|
455
473
|
/** GUEST_PORT_DEVICE_ID_BLUEYE_SCALING_LASER - Blueye Scaling Laser. */
|
|
456
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,
|
|
457
480
|
UNRECOGNIZED = -1
|
|
458
481
|
}
|
|
459
482
|
export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
|
|
@@ -468,10 +491,43 @@ export declare enum GuestPortNumber {
|
|
|
468
491
|
GUEST_PORT_NUMBER_PORT_2 = 2,
|
|
469
492
|
/** GUEST_PORT_NUMBER_PORT_3 - Guest port 3. */
|
|
470
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,
|
|
471
500
|
UNRECOGNIZED = -1
|
|
472
501
|
}
|
|
473
502
|
export declare function guestPortNumberFromJSON(object: any): GuestPortNumber;
|
|
474
503
|
export declare function guestPortNumberToJSON(object: GuestPortNumber): string;
|
|
504
|
+
/**
|
|
505
|
+
* Physical interfaces a guest port can provide.
|
|
506
|
+
*
|
|
507
|
+
* Used both for the interfaces a port provides and for the interfaces a
|
|
508
|
+
* device requires from the port it is connected to.
|
|
509
|
+
*/
|
|
510
|
+
export declare enum GuestPortCapability {
|
|
511
|
+
/** GUEST_PORT_CAPABILITY_UNSPECIFIED - Unspecified. */
|
|
512
|
+
GUEST_PORT_CAPABILITY_UNSPECIFIED = 0,
|
|
513
|
+
/** GUEST_PORT_CAPABILITY_ETHERNET - Ethernet. */
|
|
514
|
+
GUEST_PORT_CAPABILITY_ETHERNET = 1,
|
|
515
|
+
/** GUEST_PORT_CAPABILITY_I2C - I2C. */
|
|
516
|
+
GUEST_PORT_CAPABILITY_I2C = 2,
|
|
517
|
+
/** GUEST_PORT_CAPABILITY_RS232 - RS232 serial. */
|
|
518
|
+
GUEST_PORT_CAPABILITY_RS232 = 3,
|
|
519
|
+
/** GUEST_PORT_CAPABILITY_RS485 - RS485 serial. */
|
|
520
|
+
GUEST_PORT_CAPABILITY_RS485 = 4,
|
|
521
|
+
/** GUEST_PORT_CAPABILITY_USB2 - USB 2.0. */
|
|
522
|
+
GUEST_PORT_CAPABILITY_USB2 = 5,
|
|
523
|
+
/** GUEST_PORT_CAPABILITY_PWM - PWM. */
|
|
524
|
+
GUEST_PORT_CAPABILITY_PWM = 6,
|
|
525
|
+
/** GUEST_PORT_CAPABILITY_ETHERNET_1G - Gigabit Ethernet. */
|
|
526
|
+
GUEST_PORT_CAPABILITY_ETHERNET_1G = 7,
|
|
527
|
+
UNRECOGNIZED = -1
|
|
528
|
+
}
|
|
529
|
+
export declare function guestPortCapabilityFromJSON(object: any): GuestPortCapability;
|
|
530
|
+
export declare function guestPortCapabilityToJSON(object: GuestPortCapability): string;
|
|
475
531
|
/** List of navigation sensors that can be used by the position observer. */
|
|
476
532
|
export declare enum NavigationSensorID {
|
|
477
533
|
/** NAVIGATION_SENSOR_ID_UNSPECIFIED - Unspecified. */
|
|
@@ -567,6 +623,20 @@ export declare enum ThermalZoneId {
|
|
|
567
623
|
}
|
|
568
624
|
export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
|
|
569
625
|
export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
|
|
626
|
+
/** Origin of an annotation. Mirrors the AnnotationSource enum in Blueye Cloud. */
|
|
627
|
+
export declare enum AnnotationSource {
|
|
628
|
+
/** ANNOTATION_SOURCE_UNSPECIFIED - Origin not specified. */
|
|
629
|
+
ANNOTATION_SOURCE_UNSPECIFIED = 0,
|
|
630
|
+
/** ANNOTATION_SOURCE_CLOUD - Created in Blueye Cloud after the dive. */
|
|
631
|
+
ANNOTATION_SOURCE_CLOUD = 1,
|
|
632
|
+
/** ANNOTATION_SOURCE_APP - Created in the app during the dive. */
|
|
633
|
+
ANNOTATION_SOURCE_APP = 2,
|
|
634
|
+
/** ANNOTATION_SOURCE_DRONE - Emitted by the drone itself. */
|
|
635
|
+
ANNOTATION_SOURCE_DRONE = 3,
|
|
636
|
+
UNRECOGNIZED = -1
|
|
637
|
+
}
|
|
638
|
+
export declare function annotationSourceFromJSON(object: any): AnnotationSource;
|
|
639
|
+
export declare function annotationSourceToJSON(object: AnnotationSource): string;
|
|
570
640
|
/**
|
|
571
641
|
* Wrapper message for each entry in the drone telemetry logfile.
|
|
572
642
|
*
|
|
@@ -788,6 +858,66 @@ export interface AutoPilotHeaveState {
|
|
|
788
858
|
/** If auto pilot heave is enabled. */
|
|
789
859
|
enabled: boolean;
|
|
790
860
|
}
|
|
861
|
+
/**
|
|
862
|
+
* Spotlight mode parameters.
|
|
863
|
+
*
|
|
864
|
+
* Vision-based mode that keeps the tracked object centred in the frame
|
|
865
|
+
* while the pilot flies around it. Currently carries no parameters.
|
|
866
|
+
*
|
|
867
|
+
* Automatically controlled: yaw (horizontal centring) and depth
|
|
868
|
+
* (vertical centring).
|
|
869
|
+
* Pilot controlled: surge and sway.
|
|
870
|
+
*/
|
|
871
|
+
export interface SpotlightState {
|
|
872
|
+
}
|
|
873
|
+
/**
|
|
874
|
+
* Active track mode parameters.
|
|
875
|
+
*
|
|
876
|
+
* Vision-based mode that follows the tracked object, keeping it centred
|
|
877
|
+
* and at a constant apparent size in the frame. Currently carries no
|
|
878
|
+
* parameters.
|
|
879
|
+
*
|
|
880
|
+
* Automatically controlled: yaw (horizontal centring), depth (vertical
|
|
881
|
+
* centring), and surge (distance keeping).
|
|
882
|
+
* Pilot controlled: sway.
|
|
883
|
+
*/
|
|
884
|
+
export interface ActiveTrackState {
|
|
885
|
+
}
|
|
886
|
+
/**
|
|
887
|
+
* Orbit mode parameters.
|
|
888
|
+
*
|
|
889
|
+
* Vision-based mode that circles the tracked object while keeping it
|
|
890
|
+
* centred in the frame.
|
|
891
|
+
*
|
|
892
|
+
* Automatically controlled: yaw (horizontal centring), depth (vertical
|
|
893
|
+
* centring), surge (distance keeping), and sway (tangential motion at
|
|
894
|
+
* the commanded angular rate). No degree of freedom is pilot controlled
|
|
895
|
+
* while orbit is active.
|
|
896
|
+
*/
|
|
897
|
+
export interface OrbitState {
|
|
898
|
+
/** Orbit angular rate (deg/s); positive orbits clockwise seen from above. Must be non-zero. */
|
|
899
|
+
rate: number;
|
|
900
|
+
}
|
|
901
|
+
/**
|
|
902
|
+
* The active vision-based tracking mode.
|
|
903
|
+
*
|
|
904
|
+
* The modes are mutually exclusive, which the oneof encodes: at most one
|
|
905
|
+
* mode is set at a time, and no field set means no vision tracking mode
|
|
906
|
+
* is active.
|
|
907
|
+
*
|
|
908
|
+
* Each mode's message documents which degrees of freedom it controls
|
|
909
|
+
* automatically; any degree of freedom not listed as automatic remains
|
|
910
|
+
* under pilot control. Pilot input on an automatically controlled degree
|
|
911
|
+
* of freedom is ignored while the mode is active.
|
|
912
|
+
*/
|
|
913
|
+
export interface VisionTrackingState {
|
|
914
|
+
/** Spotlight mode is active. */
|
|
915
|
+
spotlight?: SpotlightState | undefined;
|
|
916
|
+
/** Active track mode is active. */
|
|
917
|
+
activeTrack?: ActiveTrackState | undefined;
|
|
918
|
+
/** Orbit mode is active, at the reported angular rate. */
|
|
919
|
+
orbit?: OrbitState | undefined;
|
|
920
|
+
}
|
|
791
921
|
/** Control mode from drone supervisor */
|
|
792
922
|
export interface ControlMode {
|
|
793
923
|
/** If auto depth is enabled. */
|
|
@@ -804,6 +934,8 @@ export interface ControlMode {
|
|
|
804
934
|
autoPilotSurgeYaw: boolean;
|
|
805
935
|
/** If auto pilot heave is enabled. */
|
|
806
936
|
autoPilotHeave: boolean;
|
|
937
|
+
/** The active vision-based tracking mode, if any. */
|
|
938
|
+
visionTracking: VisionTrackingState | undefined;
|
|
807
939
|
}
|
|
808
940
|
/**
|
|
809
941
|
* Tilt stabilization state.
|
|
@@ -1553,6 +1685,8 @@ export interface DroneInfo {
|
|
|
1553
1685
|
depthSensor: PressureSensorType;
|
|
1554
1686
|
/** List of loaded computer vision models. */
|
|
1555
1687
|
cvModels: CvModelInfo[];
|
|
1688
|
+
/** How the drone is powered. */
|
|
1689
|
+
powerSource: PowerSource;
|
|
1556
1690
|
}
|
|
1557
1691
|
/** Known error states for the drone. */
|
|
1558
1692
|
export interface ErrorFlags {
|
|
@@ -1578,30 +1712,72 @@ export interface ErrorFlags {
|
|
|
1578
1712
|
gp2Read: boolean;
|
|
1579
1713
|
/** Guest port 3 read error. */
|
|
1580
1714
|
gp3Read: boolean;
|
|
1715
|
+
/** Guest port 4 read error. */
|
|
1716
|
+
gp4Read: boolean;
|
|
1717
|
+
/** Guest port 5 read error. */
|
|
1718
|
+
gp5Read: boolean;
|
|
1719
|
+
/** Guest port 6 read error. */
|
|
1720
|
+
gp6Read: boolean;
|
|
1581
1721
|
/** Guest port 1 not flashed. */
|
|
1582
1722
|
gp1NotFlashed: boolean;
|
|
1583
1723
|
/** Guest port 2 not flashed. */
|
|
1584
1724
|
gp2NotFlashed: boolean;
|
|
1585
1725
|
/** Guest port 3 not flashed. */
|
|
1586
1726
|
gp3NotFlashed: boolean;
|
|
1727
|
+
/** Guest port 4 not flashed. */
|
|
1728
|
+
gp4NotFlashed: boolean;
|
|
1729
|
+
/** Guest port 5 not flashed. */
|
|
1730
|
+
gp5NotFlashed: boolean;
|
|
1731
|
+
/** Guest port 6 not flashed. */
|
|
1732
|
+
gp6NotFlashed: boolean;
|
|
1587
1733
|
/** Unknown device on guest port 1. */
|
|
1588
1734
|
gp1UnknownDevice: boolean;
|
|
1589
1735
|
/** Unknown device on guest port 2. */
|
|
1590
1736
|
gp2UnknownDevice: boolean;
|
|
1591
1737
|
/** Unknown device on guest port 3. */
|
|
1592
1738
|
gp3UnknownDevice: boolean;
|
|
1739
|
+
/** Unknown device on guest port 4. */
|
|
1740
|
+
gp4UnknownDevice: boolean;
|
|
1741
|
+
/** Unknown device on guest port 5. */
|
|
1742
|
+
gp5UnknownDevice: boolean;
|
|
1743
|
+
/** Unknown device on guest port 6. */
|
|
1744
|
+
gp6UnknownDevice: boolean;
|
|
1593
1745
|
/** Guest port 1 connection error. */
|
|
1594
1746
|
gp1DeviceConnection: boolean;
|
|
1595
1747
|
/** Guest port 2 connection error. */
|
|
1596
1748
|
gp2DeviceConnection: boolean;
|
|
1597
1749
|
/** Guest port 3 connection error. */
|
|
1598
1750
|
gp3DeviceConnection: boolean;
|
|
1751
|
+
/** Guest port 4 connection error. */
|
|
1752
|
+
gp4DeviceConnection: boolean;
|
|
1753
|
+
/** Guest port 5 connection error. */
|
|
1754
|
+
gp5DeviceConnection: boolean;
|
|
1755
|
+
/** Guest port 6 connection error. */
|
|
1756
|
+
gp6DeviceConnection: boolean;
|
|
1599
1757
|
/** Guest port 1 device error. */
|
|
1600
1758
|
gp1Device: boolean;
|
|
1601
1759
|
/** Guest port 2 device error. */
|
|
1602
1760
|
gp2Device: boolean;
|
|
1603
1761
|
/** Guest port 3 device error. */
|
|
1604
1762
|
gp3Device: boolean;
|
|
1763
|
+
/** Guest port 4 device error. */
|
|
1764
|
+
gp4Device: boolean;
|
|
1765
|
+
/** Guest port 5 device error. */
|
|
1766
|
+
gp5Device: boolean;
|
|
1767
|
+
/** Guest port 6 device error. */
|
|
1768
|
+
gp6Device: boolean;
|
|
1769
|
+
/** Device on guest port 1 requires interfaces the port does not provide. */
|
|
1770
|
+
gp1IncompatibleDevice: boolean;
|
|
1771
|
+
/** Device on guest port 2 requires interfaces the port does not provide. */
|
|
1772
|
+
gp2IncompatibleDevice: boolean;
|
|
1773
|
+
/** Device on guest port 3 requires interfaces the port does not provide. */
|
|
1774
|
+
gp3IncompatibleDevice: boolean;
|
|
1775
|
+
/** Device on guest port 4 requires interfaces the port does not provide. */
|
|
1776
|
+
gp4IncompatibleDevice: boolean;
|
|
1777
|
+
/** Device on guest port 5 requires interfaces the port does not provide. */
|
|
1778
|
+
gp5IncompatibleDevice: boolean;
|
|
1779
|
+
/** Device on guest port 6 requires interfaces the port does not provide. */
|
|
1780
|
+
gp6IncompatibleDevice: boolean;
|
|
1605
1781
|
/** Drone serial number not set. */
|
|
1606
1782
|
droneSerialNotSet: boolean;
|
|
1607
1783
|
/** Drone serial number error. */
|
|
@@ -1632,14 +1808,44 @@ export interface ErrorFlags {
|
|
|
1632
1808
|
gpCurrentRead: boolean;
|
|
1633
1809
|
/** Max GP current exceeded. */
|
|
1634
1810
|
gpCurrent: boolean;
|
|
1635
|
-
/** Max battery current exceeded on
|
|
1811
|
+
/** Max battery current exceeded on guest port 1. */
|
|
1636
1812
|
gp1BatCurrent: boolean;
|
|
1637
|
-
/** Max battery current exceeded on
|
|
1813
|
+
/** Max battery current exceeded on guest port 2. */
|
|
1638
1814
|
gp2BatCurrent: boolean;
|
|
1639
|
-
/** Max battery current exceeded on
|
|
1815
|
+
/** Max battery current exceeded on guest port 3. */
|
|
1640
1816
|
gp3BatCurrent: boolean;
|
|
1641
|
-
/** Max
|
|
1642
|
-
|
|
1817
|
+
/** Max battery current exceeded on guest port 4. */
|
|
1818
|
+
gp4BatCurrent: boolean;
|
|
1819
|
+
/** Max battery current exceeded on guest port 5. */
|
|
1820
|
+
gp5BatCurrent: boolean;
|
|
1821
|
+
/** Max battery current exceeded on guest port 6. */
|
|
1822
|
+
gp6BatCurrent: boolean;
|
|
1823
|
+
/** Max 24V current exceeded on GP. Only present on X1/X3 (not X3 Ultra or X7). */
|
|
1824
|
+
gp24vCurrent: boolean;
|
|
1825
|
+
/** Max 24V current exceeded on guest port 1. */
|
|
1826
|
+
gp124vCurrent: boolean;
|
|
1827
|
+
/** Max 24V current exceeded on guest port 2. */
|
|
1828
|
+
gp224vCurrent: boolean;
|
|
1829
|
+
/** Max 24V current exceeded on guest port 3. */
|
|
1830
|
+
gp324vCurrent: boolean;
|
|
1831
|
+
/** Max 24V current exceeded on guest port 4. */
|
|
1832
|
+
gp424vCurrent: boolean;
|
|
1833
|
+
/** Max 24V current exceeded on guest port 5. */
|
|
1834
|
+
gp524vCurrent: boolean;
|
|
1835
|
+
/** Max 24V current exceeded on guest port 6. */
|
|
1836
|
+
gp624vCurrent: boolean;
|
|
1837
|
+
/** Max 5V current exceeded on guest port 1. */
|
|
1838
|
+
gp15vCurrent: boolean;
|
|
1839
|
+
/** Max 5V current exceeded on guest port 2. */
|
|
1840
|
+
gp25vCurrent: boolean;
|
|
1841
|
+
/** Max 5V current exceeded on guest port 3. */
|
|
1842
|
+
gp35vCurrent: boolean;
|
|
1843
|
+
/** Max 5V current exceeded on guest port 4. */
|
|
1844
|
+
gp45vCurrent: boolean;
|
|
1845
|
+
/** Max 5V current exceeded on guest port 5. */
|
|
1846
|
+
gp55vCurrent: boolean;
|
|
1847
|
+
/** Max 5V current exceeded on guest port 6. */
|
|
1848
|
+
gp65vCurrent: boolean;
|
|
1643
1849
|
/** DVL is in thermal protection mode. */
|
|
1644
1850
|
dvlThermalProtectionMode: boolean;
|
|
1645
1851
|
/** GP protection has been triggered at boot or faulty DVL. */
|
|
@@ -1799,6 +2005,13 @@ export interface GuestPortDevice {
|
|
|
1799
2005
|
requiredBlunuxVersion: string;
|
|
1800
2006
|
/** Detach status based on detection pin. */
|
|
1801
2007
|
detachStatus: GuestPortDetachStatus;
|
|
2008
|
+
/** Interfaces the device requires from the port. */
|
|
2009
|
+
requiredCapabilities: GuestPortCapability[];
|
|
2010
|
+
/**
|
|
2011
|
+
* Ports on this drone where the device is fully supported. Computed by the
|
|
2012
|
+
* drone from the port capabilities and the device requirements.
|
|
2013
|
+
*/
|
|
2014
|
+
compatibleGuestPorts: GuestPortNumber[];
|
|
1802
2015
|
}
|
|
1803
2016
|
/** List of guest port devices. */
|
|
1804
2017
|
export interface GuestPortDeviceList {
|
|
@@ -1813,6 +2026,8 @@ export interface GuestPortConnectorInfo {
|
|
|
1813
2026
|
error?: GuestPortError | undefined;
|
|
1814
2027
|
/** Guest port the connector is connected to. */
|
|
1815
2028
|
guestPortNumber: GuestPortNumber;
|
|
2029
|
+
/** Interfaces this port provides. */
|
|
2030
|
+
capabilities: GuestPortCapability[];
|
|
1816
2031
|
}
|
|
1817
2032
|
/** GuestPort information. */
|
|
1818
2033
|
export interface GuestPortInfo {
|
|
@@ -1822,6 +2037,12 @@ export interface GuestPortInfo {
|
|
|
1822
2037
|
gp2: GuestPortConnectorInfo | undefined;
|
|
1823
2038
|
/** Information about guest port 3. */
|
|
1824
2039
|
gp3: GuestPortConnectorInfo | undefined;
|
|
2040
|
+
/** Information about guest port 4. */
|
|
2041
|
+
gp4: GuestPortConnectorInfo | undefined;
|
|
2042
|
+
/** Information about guest port 5. */
|
|
2043
|
+
gp5: GuestPortConnectorInfo | undefined;
|
|
2044
|
+
/** Information about guest port 6. */
|
|
2045
|
+
gp6: GuestPortConnectorInfo | undefined;
|
|
1825
2046
|
}
|
|
1826
2047
|
/** GuestPort restart information. */
|
|
1827
2048
|
export interface GuestPortRestartInfo {
|
|
@@ -1866,8 +2087,38 @@ export interface GuestPortCurrent {
|
|
|
1866
2087
|
gp2Bat: number;
|
|
1867
2088
|
/** Current on GP3 battery voltage (A). */
|
|
1868
2089
|
gp3Bat: number;
|
|
1869
|
-
/** Current on common
|
|
1870
|
-
|
|
2090
|
+
/** Current on common/input 24V supply (A). Only present on X1/X3 (not X3 Ultra or X7). */
|
|
2091
|
+
gp24v: number;
|
|
2092
|
+
/** Current on GP4 battery voltage (A). */
|
|
2093
|
+
gp4Bat: number;
|
|
2094
|
+
/** Current on GP5 battery voltage (A). */
|
|
2095
|
+
gp5Bat: number;
|
|
2096
|
+
/** Current on GP6 battery voltage (A). */
|
|
2097
|
+
gp6Bat: number;
|
|
2098
|
+
/** Current on GP1 24V supply (A). */
|
|
2099
|
+
gp124v: number;
|
|
2100
|
+
/** Current on GP2 24V supply (A). */
|
|
2101
|
+
gp224v: number;
|
|
2102
|
+
/** Current on GP3 24V supply (A). */
|
|
2103
|
+
gp324v: number;
|
|
2104
|
+
/** Current on GP4 24V supply (A). */
|
|
2105
|
+
gp424v: number;
|
|
2106
|
+
/** Current on GP5 24V supply (A). */
|
|
2107
|
+
gp524v: number;
|
|
2108
|
+
/** Current on GP6 24V supply (A). */
|
|
2109
|
+
gp624v: number;
|
|
2110
|
+
/** Current on GP1 5V supply (A). */
|
|
2111
|
+
gp15v: number;
|
|
2112
|
+
/** Current on GP2 5V supply (A). */
|
|
2113
|
+
gp25v: number;
|
|
2114
|
+
/** Current on GP3 5V supply (A). */
|
|
2115
|
+
gp35v: number;
|
|
2116
|
+
/** Current on GP4 5V supply (A). */
|
|
2117
|
+
gp45v: number;
|
|
2118
|
+
/** Current on GP5 5V supply (A). */
|
|
2119
|
+
gp55v: number;
|
|
2120
|
+
/** Current on GP6 5V supply (A). */
|
|
2121
|
+
gp65v: number;
|
|
1871
2122
|
}
|
|
1872
2123
|
/** Vector with 3 elements. */
|
|
1873
2124
|
export interface Vector3 {
|
|
@@ -1945,6 +2196,16 @@ export interface MultibeamPing {
|
|
|
1945
2196
|
deviceId: GuestPortDeviceID;
|
|
1946
2197
|
/** Timestamp when the frame was generated. */
|
|
1947
2198
|
frameGenerationTimestamp: Date | undefined;
|
|
2199
|
+
/** Heading (°). */
|
|
2200
|
+
heading: number;
|
|
2201
|
+
/** Pitch (°). */
|
|
2202
|
+
pitch: number;
|
|
2203
|
+
/** Roll (°). */
|
|
2204
|
+
roll: number;
|
|
2205
|
+
/** External temperature (°C). */
|
|
2206
|
+
temperature: number;
|
|
2207
|
+
/** External pressure (bar). */
|
|
2208
|
+
pressure: number;
|
|
1948
2209
|
}
|
|
1949
2210
|
/** Configuration message for sonar devices. */
|
|
1950
2211
|
export interface MultibeamConfig {
|
|
@@ -2177,12 +2438,69 @@ export interface VideoCodecInfo {
|
|
|
2177
2438
|
/** Video Image Compositor (VIC) utilization (0..1). */
|
|
2178
2439
|
vicLoad: number;
|
|
2179
2440
|
}
|
|
2441
|
+
/**
|
|
2442
|
+
* NVMe SSD health, wear and identity (Jetson only; i.MX drones boot/store on
|
|
2443
|
+
* an SD card and have no NVMe device, so this message is omitted there).
|
|
2444
|
+
*/
|
|
2445
|
+
export interface NvmeInfo {
|
|
2446
|
+
/** Tier 1 — health & safety. */
|
|
2447
|
+
compositeTemperature: number;
|
|
2448
|
+
/** NVMe critical-warning bitfield. */
|
|
2449
|
+
criticalWarning: number;
|
|
2450
|
+
/** Wear indicator (%, may exceed 100). */
|
|
2451
|
+
percentageUsed: number;
|
|
2452
|
+
/** Remaining spare capacity (%). */
|
|
2453
|
+
availableSpare: number;
|
|
2454
|
+
/** Spare alarm threshold (%). */
|
|
2455
|
+
availableSpareThreshold: number;
|
|
2456
|
+
/** Uncorrected data-integrity errors. */
|
|
2457
|
+
mediaErrors: number;
|
|
2458
|
+
/** Power-loss / unsafe shutdown count. */
|
|
2459
|
+
unsafeShutdowns: number;
|
|
2460
|
+
/** Tier 2 — thermal throttling. */
|
|
2461
|
+
warningTempTimeMin: number;
|
|
2462
|
+
/** Minutes above the critical temperature. */
|
|
2463
|
+
criticalTempTimeMin: number;
|
|
2464
|
+
/** Times entered light throttling. */
|
|
2465
|
+
thermalMgmtT1TransCount: number;
|
|
2466
|
+
/** Times entered heavy throttling. */
|
|
2467
|
+
thermalMgmtT2TransCount: number;
|
|
2468
|
+
/** Total seconds in light throttling. */
|
|
2469
|
+
thermalMgmtT1TotalTimeS: number;
|
|
2470
|
+
/** Total seconds in heavy throttling. */
|
|
2471
|
+
thermalMgmtT2TotalTimeS: number;
|
|
2472
|
+
/** Tier 3 — endurance / workload. */
|
|
2473
|
+
dataUnitsWrittenBytes: number;
|
|
2474
|
+
/** Host data read (B). */
|
|
2475
|
+
dataUnitsReadBytes: number;
|
|
2476
|
+
/** Host write command count. */
|
|
2477
|
+
hostWriteCommands: number;
|
|
2478
|
+
/** Host read command count. */
|
|
2479
|
+
hostReadCommands: number;
|
|
2480
|
+
/** Power-on hours. */
|
|
2481
|
+
powerOnHours: number;
|
|
2482
|
+
/** Power cycle count. */
|
|
2483
|
+
powerCycles: number;
|
|
2484
|
+
/** Controller busy time (min). */
|
|
2485
|
+
controllerBusyTimeMin: number;
|
|
2486
|
+
/** Error-log entry count. */
|
|
2487
|
+
numErrLogEntries: number;
|
|
2488
|
+
/** Tier 4 — identity & capacity. */
|
|
2489
|
+
model: string;
|
|
2490
|
+
/** Drive serial number. */
|
|
2491
|
+
serial: string;
|
|
2492
|
+
/** Firmware revision. */
|
|
2493
|
+
firmwareRev: string;
|
|
2494
|
+
/** Total drive capacity (B). Partition used/free is */
|
|
2495
|
+
capacityBytes: number;
|
|
2496
|
+
}
|
|
2180
2497
|
/**
|
|
2181
2498
|
* System performance information.
|
|
2182
2499
|
*
|
|
2183
2500
|
* Comprehensive performance metrics for the drone's compute platform.
|
|
2184
|
-
* Covers CPU, GPU, DLA, memory, thermals,
|
|
2185
|
-
* Fields not applicable to a platform are left at their
|
|
2501
|
+
* Covers CPU, GPU, DLA, memory, thermals, video codec utilization and NVMe
|
|
2502
|
+
* SSD state. Fields not applicable to a platform are left at their
|
|
2503
|
+
* zero/empty defaults.
|
|
2186
2504
|
*/
|
|
2187
2505
|
export interface SystemPerformanceInfo {
|
|
2188
2506
|
/** Per-core CPU utilization. */
|
|
@@ -2211,6 +2529,8 @@ export interface SystemPerformanceInfo {
|
|
|
2211
2529
|
overlayQueueLoad: number;
|
|
2212
2530
|
/** Position observer queue load (0..1). */
|
|
2213
2531
|
positionObserverQueueLoad: number;
|
|
2532
|
+
/** NVMe SSD health/identity (Jetson only). */
|
|
2533
|
+
nvme: NvmeInfo | undefined;
|
|
2214
2534
|
}
|
|
2215
2535
|
/**
|
|
2216
2536
|
* Surface Unit battery information.
|
|
@@ -2335,7 +2655,12 @@ export interface OperatorInfo {
|
|
|
2335
2655
|
/** E-mail address of the operator. */
|
|
2336
2656
|
email: string;
|
|
2337
2657
|
}
|
|
2338
|
-
/**
|
|
2658
|
+
/**
|
|
2659
|
+
* Single-object tracking (SOT) state reported by the computer vision pipeline.
|
|
2660
|
+
*
|
|
2661
|
+
* The velocity fields are Kalman filter estimates expressed in the CV frame
|
|
2662
|
+
* coordinate space (image_width x image_height pixels).
|
|
2663
|
+
*/
|
|
2339
2664
|
export interface SotState {
|
|
2340
2665
|
/** Current tracking state. */
|
|
2341
2666
|
state: SotState_State;
|
|
@@ -2345,6 +2670,16 @@ export interface SotState {
|
|
|
2345
2670
|
imageWidth: number;
|
|
2346
2671
|
/** Height of the source frame in pixels. */
|
|
2347
2672
|
imageHeight: number;
|
|
2673
|
+
/** Tracker confidence of the last model update (0..1). 0 while coasting and when LOST. */
|
|
2674
|
+
confidence: number;
|
|
2675
|
+
/** Kalman velocity estimate of the bounding box centre, horizontal (px/s). */
|
|
2676
|
+
vx: number;
|
|
2677
|
+
/** Kalman velocity estimate of the bounding box centre, vertical (px/s). */
|
|
2678
|
+
vy: number;
|
|
2679
|
+
/** Kalman rate of change of the bounding box area, width * height (px²/s). */
|
|
2680
|
+
vs: number;
|
|
2681
|
+
/** Kalman rate of change of the bounding box aspect ratio, width / height (1/s). */
|
|
2682
|
+
vr: number;
|
|
2348
2683
|
}
|
|
2349
2684
|
/** Current state of the SOT tracker. */
|
|
2350
2685
|
export declare enum SotState_State {
|
|
@@ -2360,6 +2695,37 @@ export declare enum SotState_State {
|
|
|
2360
2695
|
}
|
|
2361
2696
|
export declare function sotState_StateFromJSON(object: any): SotState_State;
|
|
2362
2697
|
export declare function sotState_StateToJSON(object: SotState_State): string;
|
|
2698
|
+
/**
|
|
2699
|
+
* A single annotation added during a dive, e.g. by a diver tapping a type in the
|
|
2700
|
+
* app command palette, or emitted by the drone itself.
|
|
2701
|
+
*
|
|
2702
|
+
* Self-contained: it carries the type's display fields (name/icon/color) inline,
|
|
2703
|
+
* so the drone, any connected client, and the dive logfile can render it without
|
|
2704
|
+
* a separate catalog. The app keeps the full catalog locally (synced from
|
|
2705
|
+
* Blueye Cloud) to drive its palette, but only complete annotations go over the
|
|
2706
|
+
* wire. type_slug lets Blueye Cloud correlate the annotation to its type on import.
|
|
2707
|
+
*
|
|
2708
|
+
* The drone owns the timestamp: when this is logged the enclosing BinlogRecord
|
|
2709
|
+
* carries the time, like any other sample, so there is no time field here.
|
|
2710
|
+
*/
|
|
2711
|
+
export interface Annotation {
|
|
2712
|
+
/** Stable type id for grouping / Cloud correlation. Empty for a free-form annotation. */
|
|
2713
|
+
typeSlug: string;
|
|
2714
|
+
/** Type display name, e.g. "Hazard". Snapshot of the type at creation time. */
|
|
2715
|
+
typeName: string;
|
|
2716
|
+
/** Font Awesome solid icon name, kebab-case (e.g. "triangle-exclamation"). */
|
|
2717
|
+
typeIcon: string;
|
|
2718
|
+
/** Type color, RGB hex incl. leading '#', 7 chars (e.g. "#DC2626"). */
|
|
2719
|
+
typeColor: string;
|
|
2720
|
+
/** Optional annotation title; Cloud falls back to type_name if empty. Max 200 chars. */
|
|
2721
|
+
title: string;
|
|
2722
|
+
/** Optional free-form note. Unbounded. */
|
|
2723
|
+
body: string;
|
|
2724
|
+
/** Optional span; omit for a point-in-time marker. */
|
|
2725
|
+
duration: Duration | undefined;
|
|
2726
|
+
/** Origin of the annotation; the app sets APP, the drone sets DRONE for its own. */
|
|
2727
|
+
source: AnnotationSource;
|
|
2728
|
+
}
|
|
2363
2729
|
export declare const BinlogRecord: MessageFns<BinlogRecord>;
|
|
2364
2730
|
export declare const LogEntry: MessageFns<LogEntry>;
|
|
2365
2731
|
export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
|
|
@@ -2378,6 +2744,10 @@ export declare const StationKeepingState: MessageFns<StationKeepingState>;
|
|
|
2378
2744
|
export declare const WeatherVaningState: MessageFns<WeatherVaningState>;
|
|
2379
2745
|
export declare const AutoPilotSurgeYawState: MessageFns<AutoPilotSurgeYawState>;
|
|
2380
2746
|
export declare const AutoPilotHeaveState: MessageFns<AutoPilotHeaveState>;
|
|
2747
|
+
export declare const SpotlightState: MessageFns<SpotlightState>;
|
|
2748
|
+
export declare const ActiveTrackState: MessageFns<ActiveTrackState>;
|
|
2749
|
+
export declare const OrbitState: MessageFns<OrbitState>;
|
|
2750
|
+
export declare const VisionTrackingState: MessageFns<VisionTrackingState>;
|
|
2381
2751
|
export declare const ControlMode: MessageFns<ControlMode>;
|
|
2382
2752
|
export declare const TiltStabilizationState: MessageFns<TiltStabilizationState>;
|
|
2383
2753
|
export declare const SystemTime: MessageFns<SystemTime>;
|
|
@@ -2458,6 +2828,7 @@ export declare const DlaInfo: MessageFns<DlaInfo>;
|
|
|
2458
2828
|
export declare const MemoryInfo: MessageFns<MemoryInfo>;
|
|
2459
2829
|
export declare const ThermalZone: MessageFns<ThermalZone>;
|
|
2460
2830
|
export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
|
|
2831
|
+
export declare const NvmeInfo: MessageFns<NvmeInfo>;
|
|
2461
2832
|
export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
|
|
2462
2833
|
export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
|
|
2463
2834
|
export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
|
|
@@ -2469,6 +2840,7 @@ export declare const FilterMessage: MessageFns<FilterMessage>;
|
|
|
2469
2840
|
export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
|
|
2470
2841
|
export declare const OperatorInfo: MessageFns<OperatorInfo>;
|
|
2471
2842
|
export declare const SotState: MessageFns<SotState>;
|
|
2843
|
+
export declare const Annotation: MessageFns<Annotation>;
|
|
2472
2844
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
2473
2845
|
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 {} ? {
|
|
2474
2846
|
[K in keyof T]?: DeepPartial<T[K]>;
|