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