@blueyerobotics/protocol-definitions 3.2.0-c785049b → 3.2.0-d3c78945
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/LICENSE +165 -0
- package/README.npm.md +40 -0
- package/dist/aquatroll.js +1 -1
- package/dist/control.d.ts +24 -2
- package/dist/control.js +175 -16
- package/dist/google/protobuf/any.js +1 -1
- package/dist/google/protobuf/duration.js +1 -1
- package/dist/google/protobuf/timestamp.js +1 -1
- package/dist/index.blueye.js +1 -1
- package/dist/index.blueye.protocol.js +1 -1
- package/dist/index.google.js +1 -1
- package/dist/index.google.protobuf.js +1 -1
- package/dist/index.js +1 -1
- package/dist/message_formats.d.ts +403 -15
- package/dist/message_formats.js +2417 -25
- package/dist/mission_planning.d.ts +54 -0
- package/dist/mission_planning.js +244 -2
- package/dist/req_rep.d.ts +22 -0
- package/dist/req_rep.js +192 -2
- package/dist/telemetry.d.ts +72 -2
- package/dist/telemetry.js +511 -6
- package/package.json +8 -6
|
@@ -154,6 +154,22 @@ export declare enum NotificationLevel {
|
|
|
154
154
|
}
|
|
155
155
|
export declare function notificationLevelFromJSON(object: any): NotificationLevel;
|
|
156
156
|
export declare function notificationLevelToJSON(object: NotificationLevel): string;
|
|
157
|
+
/**
|
|
158
|
+
* Storage location.
|
|
159
|
+
*
|
|
160
|
+
* Used to specify which storage location to use for recording photos and videos.
|
|
161
|
+
*/
|
|
162
|
+
export declare enum StorageLocation {
|
|
163
|
+
/** STORAGE_LOCATION_UNSPECIFIED - Unspecified. */
|
|
164
|
+
STORAGE_LOCATION_UNSPECIFIED = 0,
|
|
165
|
+
/** STORAGE_LOCATION_INTERNAL - Internal storage of the drone. */
|
|
166
|
+
STORAGE_LOCATION_INTERNAL = 1,
|
|
167
|
+
/** STORAGE_LOCATION_REMOVABLE - Removable storage device. */
|
|
168
|
+
STORAGE_LOCATION_REMOVABLE = 2,
|
|
169
|
+
UNRECOGNIZED = -1
|
|
170
|
+
}
|
|
171
|
+
export declare function storageLocationFromJSON(object: any): StorageLocation;
|
|
172
|
+
export declare function storageLocationToJSON(object: StorageLocation): string;
|
|
157
173
|
/** Drone models produced by Blueye. */
|
|
158
174
|
export declare enum Model {
|
|
159
175
|
/** MODEL_UNSPECIFIED - ModelName not specified. */
|
|
@@ -168,6 +184,8 @@ export declare enum Model {
|
|
|
168
184
|
MODEL_X3 = 3,
|
|
169
185
|
/** MODEL_X3_ULTRA - Blueye X3 Ultra. */
|
|
170
186
|
MODEL_X3_ULTRA = 6,
|
|
187
|
+
/** MODEL_X7 - Blueye X7. */
|
|
188
|
+
MODEL_X7 = 7,
|
|
171
189
|
/** MODEL_NEXT - Blueye ? */
|
|
172
190
|
MODEL_NEXT = 5,
|
|
173
191
|
UNRECOGNIZED = -1
|
|
@@ -194,24 +212,35 @@ export declare function pressureSensorTypeToJSON(object: PressureSensorType): st
|
|
|
194
212
|
export declare enum Resolution {
|
|
195
213
|
/** RESOLUTION_UNSPECIFIED - Resolution not specified. */
|
|
196
214
|
RESOLUTION_UNSPECIFIED = 0,
|
|
197
|
-
/**
|
|
198
|
-
|
|
199
|
-
/** RESOLUTION_HD_720P - 720p HD
|
|
215
|
+
/** RESOLUTION_VGA_480P - VGA (640x480). */
|
|
216
|
+
RESOLUTION_VGA_480P = 4,
|
|
217
|
+
/** RESOLUTION_HD_720P - 720p HD (1280x720). */
|
|
200
218
|
RESOLUTION_HD_720P = 2,
|
|
201
|
-
/**
|
|
219
|
+
/** RESOLUTION_FULLHD_1080P - 1080p Full HD (1920x1080). */
|
|
220
|
+
RESOLUTION_FULLHD_1080P = 1,
|
|
221
|
+
/** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
|
|
202
222
|
RESOLUTION_UHD_4K = 3,
|
|
223
|
+
/** RESOLUTION_QHD_2K - 2K QHD (2560x1440, Only supported on X3 Ultra). */
|
|
224
|
+
RESOLUTION_QHD_2K = 5,
|
|
203
225
|
UNRECOGNIZED = -1
|
|
204
226
|
}
|
|
205
227
|
export declare function resolutionFromJSON(object: any): Resolution;
|
|
206
228
|
export declare function resolutionToJSON(object: Resolution): string;
|
|
207
|
-
/**
|
|
229
|
+
/**
|
|
230
|
+
* Available camera frame rates.
|
|
231
|
+
*
|
|
232
|
+
* If the requested frame rate is higher than what is supported at the current resolution,
|
|
233
|
+
* the frame rate will be reduced while the resolution is respected.
|
|
234
|
+
*/
|
|
208
235
|
export declare enum Framerate {
|
|
209
236
|
/** FRAMERATE_UNSPECIFIED - Framerate not specified. */
|
|
210
237
|
FRAMERATE_UNSPECIFIED = 0,
|
|
211
238
|
/** FRAMERATE_FPS_30 - 30 frames per second. */
|
|
212
239
|
FRAMERATE_FPS_30 = 1,
|
|
213
|
-
/** FRAMERATE_FPS_25 - 25 frames per second. */
|
|
240
|
+
/** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
|
|
214
241
|
FRAMERATE_FPS_25 = 2,
|
|
242
|
+
/** FRAMERATE_FPS_60 - 60 frames per second. (Only supported on X3 Ultra at QHD, 1080p and 720p) */
|
|
243
|
+
FRAMERATE_FPS_60 = 3,
|
|
215
244
|
UNRECOGNIZED = -1
|
|
216
245
|
}
|
|
217
246
|
export declare function framerateFromJSON(object: any): Framerate;
|
|
@@ -228,6 +257,29 @@ export declare enum Camera {
|
|
|
228
257
|
}
|
|
229
258
|
export declare function cameraFromJSON(object: any): Camera;
|
|
230
259
|
export declare function cameraToJSON(object: Camera): string;
|
|
260
|
+
export declare enum StreamingProtocol {
|
|
261
|
+
/** STREAMING_PROTOCOL_UNSPECIFIED - Streaming protocol not specified. */
|
|
262
|
+
STREAMING_PROTOCOL_UNSPECIFIED = 0,
|
|
263
|
+
/** STREAMING_PROTOCOL_RTSP_H264 - RTSP streaming protocol using H264 codec. */
|
|
264
|
+
STREAMING_PROTOCOL_RTSP_H264 = 1,
|
|
265
|
+
/** STREAMING_PROTOCOL_RTSP_MJPEG - RTSP streaming protocol using MJPEG codec. No recording when activated. */
|
|
266
|
+
STREAMING_PROTOCOL_RTSP_MJPEG = 2,
|
|
267
|
+
UNRECOGNIZED = -1
|
|
268
|
+
}
|
|
269
|
+
export declare function streamingProtocolFromJSON(object: any): StreamingProtocol;
|
|
270
|
+
export declare function streamingProtocolToJSON(object: StreamingProtocol): string;
|
|
271
|
+
/** Recording video codec. */
|
|
272
|
+
export declare enum RecordingCodec {
|
|
273
|
+
/** RECORDING_CODEC_UNSPECIFIED - Use platform default (H.264). */
|
|
274
|
+
RECORDING_CODEC_UNSPECIFIED = 0,
|
|
275
|
+
/** RECORDING_CODEC_H264 - H.264/AVC codec. Wider compatibility with players/editors. */
|
|
276
|
+
RECORDING_CODEC_H264 = 1,
|
|
277
|
+
/** RECORDING_CODEC_H265 - H.265/HEVC codec. Better compression, limited compatibility. Ultra only. */
|
|
278
|
+
RECORDING_CODEC_H265 = 2,
|
|
279
|
+
UNRECOGNIZED = -1
|
|
280
|
+
}
|
|
281
|
+
export declare function recordingCodecFromJSON(object: any): RecordingCodec;
|
|
282
|
+
export declare function recordingCodecToJSON(object: RecordingCodec): string;
|
|
231
283
|
/** Available temperature units. */
|
|
232
284
|
export declare enum TemperatureUnit {
|
|
233
285
|
/** TEMPERATURE_UNIT_UNSPECIFIED - Temperature unit not specified. */
|
|
@@ -390,6 +442,12 @@ export declare enum GuestPortDeviceID {
|
|
|
390
442
|
GUEST_PORT_DEVICE_ID_WATERLINKED_SONAR_3D15 = 43,
|
|
391
443
|
/** GUEST_PORT_DEVICE_ID_CERULEAN_TRACKER_650 - Cerulean Tracker 650. */
|
|
392
444
|
GUEST_PORT_DEVICE_ID_CERULEAN_TRACKER_650 = 44,
|
|
445
|
+
/** GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE - Blueye External USB Storage. */
|
|
446
|
+
GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE = 45,
|
|
447
|
+
/** GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 - Blueye Multibeam Skid Servo V2. */
|
|
448
|
+
GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 = 46,
|
|
449
|
+
/** GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT - Cerulean Omniscan 450 Compact. */
|
|
450
|
+
GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT = 47,
|
|
393
451
|
UNRECOGNIZED = -1
|
|
394
452
|
}
|
|
395
453
|
export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
|
|
@@ -475,6 +533,18 @@ export declare enum MultibeamFrequencyMode {
|
|
|
475
533
|
}
|
|
476
534
|
export declare function multibeamFrequencyModeFromJSON(object: any): MultibeamFrequencyMode;
|
|
477
535
|
export declare function multibeamFrequencyModeToJSON(object: MultibeamFrequencyMode): string;
|
|
536
|
+
/** Thermal zone identifiers. */
|
|
537
|
+
export declare enum ThermalZoneId {
|
|
538
|
+
/** THERMAL_ZONE_ID_UNSPECIFIED - Unspecified thermal zone. */
|
|
539
|
+
THERMAL_ZONE_ID_UNSPECIFIED = 0,
|
|
540
|
+
/** THERMAL_ZONE_ID_TJ - Junction temperature (Tj). */
|
|
541
|
+
THERMAL_ZONE_ID_TJ = 1,
|
|
542
|
+
/** THERMAL_ZONE_ID_CANISTER - Canister temperature. */
|
|
543
|
+
THERMAL_ZONE_ID_CANISTER = 2,
|
|
544
|
+
UNRECOGNIZED = -1
|
|
545
|
+
}
|
|
546
|
+
export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
|
|
547
|
+
export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
|
|
478
548
|
/**
|
|
479
549
|
* Wrapper message for each entry in the drone telemetry logfile.
|
|
480
550
|
*
|
|
@@ -531,6 +601,49 @@ export declare enum LogEntry_LogLevel {
|
|
|
531
601
|
}
|
|
532
602
|
export declare function logEntry_LogLevelFromJSON(object: any): LogEntry_LogLevel;
|
|
533
603
|
export declare function logEntry_LogLevelToJSON(object: LogEntry_LogLevel): string;
|
|
604
|
+
export interface KernelLogEntry {
|
|
605
|
+
/** Log level, info, warning, error, etc. */
|
|
606
|
+
level: KernelLogEntry_KernelLogLevel;
|
|
607
|
+
/** Sequence number of the log entry. */
|
|
608
|
+
seqnum: number;
|
|
609
|
+
/** Timestamp of the log entry. */
|
|
610
|
+
timestamp: Date | undefined;
|
|
611
|
+
/** Log messages. */
|
|
612
|
+
messages: string[];
|
|
613
|
+
/** List of key-value pairs. */
|
|
614
|
+
fields: KernelLogEntry_KeyValuePair[];
|
|
615
|
+
}
|
|
616
|
+
/** Kernel log level. */
|
|
617
|
+
export declare enum KernelLogEntry_KernelLogLevel {
|
|
618
|
+
/** KERNEL_LOG_LEVEL_UNSPECIFIED - Unspecified log level. */
|
|
619
|
+
KERNEL_LOG_LEVEL_UNSPECIFIED = 0,
|
|
620
|
+
/** KERNEL_LOG_LEVEL_EMERG - Emergency log level. */
|
|
621
|
+
KERNEL_LOG_LEVEL_EMERG = 1,
|
|
622
|
+
/** KERNEL_LOG_LEVEL_ALERT - Alert log level. */
|
|
623
|
+
KERNEL_LOG_LEVEL_ALERT = 2,
|
|
624
|
+
/** KERNEL_LOG_LEVEL_CRIT - Critical log level. */
|
|
625
|
+
KERNEL_LOG_LEVEL_CRIT = 3,
|
|
626
|
+
/** KERNEL_LOG_LEVEL_ERR - Error log level. */
|
|
627
|
+
KERNEL_LOG_LEVEL_ERR = 4,
|
|
628
|
+
/** KERNEL_LOG_LEVEL_WARNING - Warning log level. */
|
|
629
|
+
KERNEL_LOG_LEVEL_WARNING = 5,
|
|
630
|
+
/** KERNEL_LOG_LEVEL_NOTICE - Notice log level. */
|
|
631
|
+
KERNEL_LOG_LEVEL_NOTICE = 6,
|
|
632
|
+
/** KERNEL_LOG_LEVEL_INFO - Informational log level. */
|
|
633
|
+
KERNEL_LOG_LEVEL_INFO = 7,
|
|
634
|
+
/** KERNEL_LOG_LEVEL_DEBUG - Debug log level. */
|
|
635
|
+
KERNEL_LOG_LEVEL_DEBUG = 8,
|
|
636
|
+
UNRECOGNIZED = -1
|
|
637
|
+
}
|
|
638
|
+
export declare function kernelLogEntry_KernelLogLevelFromJSON(object: any): KernelLogEntry_KernelLogLevel;
|
|
639
|
+
export declare function kernelLogEntry_KernelLogLevelToJSON(object: KernelLogEntry_KernelLogLevel): string;
|
|
640
|
+
/** Key-value pair used for structured logging. */
|
|
641
|
+
export interface KernelLogEntry_KeyValuePair {
|
|
642
|
+
/** Key of the key-value pair. */
|
|
643
|
+
key: string;
|
|
644
|
+
/** Value of the key-value pair. */
|
|
645
|
+
value: string;
|
|
646
|
+
}
|
|
534
647
|
/** If you use both values at the same time they cancel each other out. */
|
|
535
648
|
export interface MotionInput {
|
|
536
649
|
/** Forward (positive) and backwards (negative) movement. (-1..1). */
|
|
@@ -700,6 +813,12 @@ export interface RecordState {
|
|
|
700
813
|
multibeamSeconds: number;
|
|
701
814
|
/** Multibeam record fps. */
|
|
702
815
|
multibeamFps: number;
|
|
816
|
+
/** Storage location used for main camera recording. */
|
|
817
|
+
mainStorageLocation: StorageLocation;
|
|
818
|
+
/** Storage location used for guestport camera recording. */
|
|
819
|
+
guestportStorageLocation: StorageLocation;
|
|
820
|
+
/** Storage location used for multibeam recording. */
|
|
821
|
+
multibeamStorageLocation: StorageLocation;
|
|
703
822
|
}
|
|
704
823
|
/** Time-lapse state published if time-lapse mission is running. */
|
|
705
824
|
export interface TimeLapseState {
|
|
@@ -745,7 +864,7 @@ export interface WaterTemperature {
|
|
|
745
864
|
/** Water temperature (°C). */
|
|
746
865
|
value: number;
|
|
747
866
|
}
|
|
748
|
-
/** CPU temperature. */
|
|
867
|
+
/** CPU temperature (deprecated, use SystemPerformanceInfo.thermal_zones instead). */
|
|
749
868
|
export interface CPUTemperature {
|
|
750
869
|
/** CPU temperature (°C). */
|
|
751
870
|
value: number;
|
|
@@ -1167,7 +1286,7 @@ export interface DiveTime {
|
|
|
1167
1286
|
/** Number of seconds the drone has been submerged. */
|
|
1168
1287
|
value: number;
|
|
1169
1288
|
}
|
|
1170
|
-
/** Which cameras are supposed to be recording. */
|
|
1289
|
+
/** Which cameras or multibeam are supposed to be recording. */
|
|
1171
1290
|
export interface RecordOn {
|
|
1172
1291
|
/** Record the main camera. */
|
|
1173
1292
|
main: boolean;
|
|
@@ -1193,6 +1312,8 @@ export interface StoragePartition {
|
|
|
1193
1312
|
devicePath: string;
|
|
1194
1313
|
/** Mount path of the partition. */
|
|
1195
1314
|
mountPath: string;
|
|
1315
|
+
/** Label of the partition. */
|
|
1316
|
+
label: string;
|
|
1196
1317
|
}
|
|
1197
1318
|
/** Removable storage device. */
|
|
1198
1319
|
export interface RemovableStorageDevice {
|
|
@@ -1215,10 +1336,12 @@ export declare enum RemovableStorageDevice_Status {
|
|
|
1215
1336
|
STATUS_UNSPECIFIED = 0,
|
|
1216
1337
|
/** STATUS_READY - The storage device is valid and ready for use. */
|
|
1217
1338
|
STATUS_READY = 1,
|
|
1218
|
-
/** STATUS_FORMATTING - The storage device is being formatted */
|
|
1339
|
+
/** STATUS_FORMATTING - The storage device is being formatted. */
|
|
1219
1340
|
STATUS_FORMATTING = 2,
|
|
1220
1341
|
/** STATUS_ERROR - The storage device is in an error state. */
|
|
1221
1342
|
STATUS_ERROR = 3,
|
|
1343
|
+
/** STATUS_UNPLUGGED - The storage device is not present. */
|
|
1344
|
+
STATUS_UNPLUGGED = 4,
|
|
1222
1345
|
UNRECOGNIZED = -1
|
|
1223
1346
|
}
|
|
1224
1347
|
export declare function removableStorageDevice_StatusFromJSON(object: any): RemovableStorageDevice_Status;
|
|
@@ -1447,22 +1570,57 @@ export interface CameraParameters {
|
|
|
1447
1570
|
mjpgBitrate: number;
|
|
1448
1571
|
/** Shutter speed (1/10000 * s), -1 for automatic exposure. */
|
|
1449
1572
|
exposure: number;
|
|
1450
|
-
/** White balance
|
|
1573
|
+
/** White balance temp (Pioneer/Pro/X1/X3: 2800..9300, Ultra: 2300..15000), -1 for auto. */
|
|
1451
1574
|
whiteBalance: number;
|
|
1452
|
-
/** Hue (-40..40), 0 as default. */
|
|
1575
|
+
/** Hue (-40..40), 0 as default. Only available on Pioneer/Pro/X1/X3. */
|
|
1453
1576
|
hue: number;
|
|
1454
|
-
/** Iso gain (0..1). */
|
|
1577
|
+
/** Iso gain (0..1). Only available on Pioneer/Pro/X1/X3. */
|
|
1455
1578
|
gain: number;
|
|
1579
|
+
/** Brightness (-10..10), 0 as default. Only available on Ultra */
|
|
1580
|
+
brightness: number;
|
|
1581
|
+
/** Contrast (-50..50), 0 as default. Only available on Ultra. */
|
|
1582
|
+
contrast: number;
|
|
1583
|
+
/** Saturation (0..50), 8 as default. Only available on Ultra. */
|
|
1584
|
+
saturation: number;
|
|
1585
|
+
/** Gamma (4..79), 22 as default. Only available on Ultra. */
|
|
1586
|
+
gamma: number;
|
|
1587
|
+
/** Sharpness (-20..20), -20 as default. Only available on Ultra. */
|
|
1588
|
+
sharpness: number;
|
|
1589
|
+
/** Backlight compensation (-150..150), 10 as default. Only available on Ultra. */
|
|
1590
|
+
backlightCompensation: number;
|
|
1591
|
+
/** Noise reduction (-20..20), -20 as default. Only available on Ultra. */
|
|
1592
|
+
denoise: number;
|
|
1593
|
+
/** Enable eHDR mode. Default true. Only available on Ultra. */
|
|
1594
|
+
ehdrEnabled: boolean;
|
|
1595
|
+
/** Minimum number of eHDR frames. (1..4), default 1. Only available on Ultra. */
|
|
1596
|
+
ehdrExposureMinNumber: number;
|
|
1597
|
+
/** Maximum number of eHDR frames. (1..4), default 2. Only on Ultra. Setting larger than 2 can reduce the framerate. */
|
|
1598
|
+
ehdrExposureMaxNumber: number;
|
|
1456
1599
|
/** Stream, recording and image resolution (deprecated). */
|
|
1457
1600
|
resolution: Resolution;
|
|
1458
1601
|
/** Stream resolution. */
|
|
1459
1602
|
streamResolution: Resolution;
|
|
1460
1603
|
/** Recording and image resolution. */
|
|
1461
1604
|
recordingResolution: Resolution;
|
|
1605
|
+
/** Streaming protocol. */
|
|
1606
|
+
streamingProtocol: StreamingProtocol;
|
|
1462
1607
|
/** Stream and recording framerate. */
|
|
1463
1608
|
framerate: Framerate;
|
|
1464
1609
|
/** Which camera the parameters belong to. */
|
|
1465
1610
|
camera: Camera;
|
|
1611
|
+
/**
|
|
1612
|
+
* Network MTU (Maximum Transmission Unit) size for video streaming in bytes (68..65535).
|
|
1613
|
+
* If 0 or unset, the system will use a default of 1400.
|
|
1614
|
+
* The Blueye App allows users to set values between 500 and 1460.
|
|
1615
|
+
*/
|
|
1616
|
+
mtuSize: number;
|
|
1617
|
+
/** Recording video codec. If unset, uses platform default. */
|
|
1618
|
+
recordingCodec: RecordingCodec;
|
|
1619
|
+
/**
|
|
1620
|
+
* Recording bitrate in bits/sec. If 0 or unset, a default is computed based
|
|
1621
|
+
* on resolution, framerate, and encoding. Set explicitly to override.
|
|
1622
|
+
*/
|
|
1623
|
+
recordingBitrate: number;
|
|
1466
1624
|
}
|
|
1467
1625
|
/**
|
|
1468
1626
|
* Overlay parameters.
|
|
@@ -1688,8 +1846,7 @@ export interface MultibeamPing {
|
|
|
1688
1846
|
/** Size in bytes of each row in the ping data image. */
|
|
1689
1847
|
step: number;
|
|
1690
1848
|
/**
|
|
1691
|
-
* Bearing angle of each column of the sonar data
|
|
1692
|
-
* (in 100th of a degree, multiply by 0.01 to get a value in degrees).
|
|
1849
|
+
* Bearing angle of each column of the sonar data in degrees.
|
|
1693
1850
|
* The sonar image is not sampled uniformly in the bearing direction.
|
|
1694
1851
|
*/
|
|
1695
1852
|
bearings: number[];
|
|
@@ -1829,7 +1986,7 @@ export interface PersistentStorageSettings {
|
|
|
1829
1986
|
accCalibration: boolean;
|
|
1830
1987
|
}
|
|
1831
1988
|
/**
|
|
1832
|
-
* CPU information.
|
|
1989
|
+
* CPU information (deprecated, use SystemPerformanceInfo instead).
|
|
1833
1990
|
*
|
|
1834
1991
|
* Contains information about the CPU load and memory usage of the drone.
|
|
1835
1992
|
*/
|
|
@@ -1842,9 +1999,225 @@ export interface CPUInfo {
|
|
|
1842
1999
|
mainQueueLoad: number;
|
|
1843
2000
|
/** Guestport queue load (0..1). */
|
|
1844
2001
|
guestportQueueLoad: number;
|
|
2002
|
+
/** Communication queue load (0..1). */
|
|
2003
|
+
commQueueLoad: number;
|
|
2004
|
+
}
|
|
2005
|
+
/** Per-core CPU utilization. */
|
|
2006
|
+
export interface CpuCoreLoad {
|
|
2007
|
+
/** Core index (0-based). */
|
|
2008
|
+
coreIndex: number;
|
|
2009
|
+
/** Core load (0..1). */
|
|
2010
|
+
load: number;
|
|
2011
|
+
/** Current clock frequency (MHz). */
|
|
2012
|
+
frequencyMhz: number;
|
|
2013
|
+
}
|
|
2014
|
+
/** GPU utilization and status. */
|
|
2015
|
+
export interface GpuInfo {
|
|
2016
|
+
/** GPU load (0..1). */
|
|
2017
|
+
load: number;
|
|
2018
|
+
/** Current GPU clock frequency (MHz). */
|
|
2019
|
+
frequencyMhz: number;
|
|
2020
|
+
}
|
|
2021
|
+
/**
|
|
2022
|
+
* Deep Learning Accelerator (DLA) utilization.
|
|
2023
|
+
*
|
|
2024
|
+
* Jetson Orin NX has two DLA engines used for inference offload.
|
|
2025
|
+
*/
|
|
2026
|
+
export interface DlaInfo {
|
|
2027
|
+
/** DLA engine index (0-based). */
|
|
2028
|
+
engineIndex: number;
|
|
2029
|
+
/** DLA engine load (0..1). */
|
|
2030
|
+
load: number;
|
|
2031
|
+
/** Core clock frequency (MHz). 0 when disabled. */
|
|
2032
|
+
frequencyMhz: number;
|
|
2033
|
+
/** True when the DLA engine is actively processing. */
|
|
2034
|
+
enabled: boolean;
|
|
2035
|
+
/** Falcon microcontroller clock frequency (MHz). 0 when disabled. */
|
|
2036
|
+
falconFrequencyMhz: number;
|
|
2037
|
+
}
|
|
2038
|
+
/** System memory information. */
|
|
2039
|
+
export interface MemoryInfo {
|
|
2040
|
+
/** Total RAM (bytes). */
|
|
2041
|
+
totalBytes: number;
|
|
2042
|
+
/** Used RAM (bytes). */
|
|
2043
|
+
usedBytes: number;
|
|
2044
|
+
/** Cached RAM (bytes). */
|
|
2045
|
+
cachedBytes: number;
|
|
2046
|
+
/** Memory bus utilization (0..1). i.MX only. */
|
|
2047
|
+
busLoad: number;
|
|
2048
|
+
}
|
|
2049
|
+
/** Thermal zone reading. */
|
|
2050
|
+
export interface ThermalZone {
|
|
2051
|
+
/** Thermal zone identifier. */
|
|
2052
|
+
zone: ThermalZoneId;
|
|
2053
|
+
/** Temperature (°C). */
|
|
2054
|
+
temperature: number;
|
|
2055
|
+
}
|
|
2056
|
+
/** Video codec engine status. */
|
|
2057
|
+
export interface VideoCodecInfo {
|
|
2058
|
+
/** Jetson only (NVENC/NVDEC/NVJPG/VIC devfreq). */
|
|
2059
|
+
encoderActive: boolean;
|
|
2060
|
+
/** Video encoder clock frequency (MHz). */
|
|
2061
|
+
encoderFrequencyMhz: number;
|
|
2062
|
+
/** Video decoder (NVDEC) is active. */
|
|
2063
|
+
decoderActive: boolean;
|
|
2064
|
+
/** Video decoder clock frequency (MHz). */
|
|
2065
|
+
decoderFrequencyMhz: number;
|
|
2066
|
+
/** JPEG engine (NVJPG) is active. */
|
|
2067
|
+
nvjpgActive: boolean;
|
|
2068
|
+
/** JPEG engine clock frequency (MHz). */
|
|
2069
|
+
nvjpgFrequencyMhz: number;
|
|
2070
|
+
/** Video Image Compositor (VIC) is active. */
|
|
2071
|
+
vicActive: boolean;
|
|
2072
|
+
/** VIC clock frequency (MHz). */
|
|
2073
|
+
vicFrequencyMhz: number;
|
|
2074
|
+
/** i.MX only (CODA VPU). */
|
|
2075
|
+
vpuActive: boolean;
|
|
2076
|
+
/** VPU AXI clock frequency (MHz). */
|
|
2077
|
+
vpuFrequencyMhz: number;
|
|
2078
|
+
/** Cumulative VPU_CODEC_IRQ count. */
|
|
2079
|
+
vpuCodecIrqCount: number;
|
|
2080
|
+
/** Cumulative VPU_JPG_IRQ count. */
|
|
2081
|
+
vpuJpgIrqCount: number;
|
|
2082
|
+
}
|
|
2083
|
+
/**
|
|
2084
|
+
* System performance information.
|
|
2085
|
+
*
|
|
2086
|
+
* Comprehensive performance metrics for the drone's compute platform.
|
|
2087
|
+
* Covers CPU, GPU, DLA, memory, thermals, and video codec utilization.
|
|
2088
|
+
* Fields not applicable to a platform are left at their zero/empty defaults.
|
|
2089
|
+
*/
|
|
2090
|
+
export interface SystemPerformanceInfo {
|
|
2091
|
+
/** Per-core CPU utilization. */
|
|
2092
|
+
cpuCores: CpuCoreLoad[];
|
|
2093
|
+
/** Mean CPU utilization across all cores (0..1). */
|
|
2094
|
+
cpuUtilization: number;
|
|
2095
|
+
/** GPU utilization. */
|
|
2096
|
+
gpu: GpuInfo | undefined;
|
|
2097
|
+
/** DLA engine utilization (Jetson only). */
|
|
2098
|
+
dlaEngines: DlaInfo[];
|
|
2099
|
+
/** RAM usage. */
|
|
2100
|
+
memory: MemoryInfo | undefined;
|
|
2101
|
+
/** All thermal zone readings. */
|
|
2102
|
+
thermalZones: ThermalZone[];
|
|
2103
|
+
/** Video encoder/decoder status. */
|
|
2104
|
+
videoCodec: VideoCodecInfo | undefined;
|
|
2105
|
+
/** Main queue load (0..1). */
|
|
2106
|
+
mainQueueLoad: number;
|
|
2107
|
+
/** Guestport queue load (0..1). */
|
|
2108
|
+
guestportQueueLoad: number;
|
|
2109
|
+
/** Communication queue load (0..1). */
|
|
2110
|
+
commQueueLoad: number;
|
|
2111
|
+
/** Camera queue load (0..1). */
|
|
2112
|
+
cameraQueueLoad: number;
|
|
2113
|
+
/** Overlay queue load (0..1). */
|
|
2114
|
+
overlayQueueLoad: number;
|
|
2115
|
+
/** Position observer queue load (0..1). */
|
|
2116
|
+
positionObserverQueueLoad: number;
|
|
2117
|
+
}
|
|
2118
|
+
/**
|
|
2119
|
+
* Surface Unit battery information.
|
|
2120
|
+
*
|
|
2121
|
+
* This message is published by the Surface Unit, and re-published by
|
|
2122
|
+
* the drone over the communication protocol.
|
|
2123
|
+
*/
|
|
2124
|
+
export interface SurfaceUnitBatteryInfo {
|
|
2125
|
+
/** Battery charge status. */
|
|
2126
|
+
status: SurfaceUnitBatteryInfo_ChargeStatus;
|
|
2127
|
+
/** Battery level (0..1). */
|
|
2128
|
+
level: number;
|
|
2129
|
+
}
|
|
2130
|
+
export declare enum SurfaceUnitBatteryInfo_ChargeStatus {
|
|
2131
|
+
CHARGE_STATUS_UNSPECIFIED = 0,
|
|
2132
|
+
CHARGE_STATUS_DISCHARGE = 1,
|
|
2133
|
+
CHARGE_STATUS_CHARGE = 2,
|
|
2134
|
+
CHARGE_STATUS_CHARGE_ERROR = 3,
|
|
2135
|
+
UNRECOGNIZED = -1
|
|
2136
|
+
}
|
|
2137
|
+
export declare function surfaceUnitBatteryInfo_ChargeStatusFromJSON(object: any): SurfaceUnitBatteryInfo_ChargeStatus;
|
|
2138
|
+
export declare function surfaceUnitBatteryInfo_ChargeStatusToJSON(object: SurfaceUnitBatteryInfo_ChargeStatus): string;
|
|
2139
|
+
/**
|
|
2140
|
+
* Surface Unit version information.
|
|
2141
|
+
*
|
|
2142
|
+
* This message is published by the Surface Unit, and re-published by
|
|
2143
|
+
* the drone over the communication protocol.
|
|
2144
|
+
*/
|
|
2145
|
+
export interface SurfaceUnitVersionInfo {
|
|
2146
|
+
/** Surface Unit firmware version (x.y.z). */
|
|
2147
|
+
version: string;
|
|
2148
|
+
}
|
|
2149
|
+
/**
|
|
2150
|
+
* Bounding box for object detection.
|
|
2151
|
+
*
|
|
2152
|
+
* Coordinates are in pixels relative to the camera image,
|
|
2153
|
+
* where (x, y) is the top-left corner of the bounding box.
|
|
2154
|
+
*/
|
|
2155
|
+
export interface BoundingBox {
|
|
2156
|
+
/** Horizontal offset of the top-left corner (px). */
|
|
2157
|
+
x: number;
|
|
2158
|
+
/** Vertical offset of the top-left corner (px). */
|
|
2159
|
+
y: number;
|
|
2160
|
+
/** Width of the bounding box (px). */
|
|
2161
|
+
width: number;
|
|
2162
|
+
/** Height of the bounding box (px). */
|
|
2163
|
+
height: number;
|
|
2164
|
+
}
|
|
2165
|
+
/** A single object detection from a computer vision model. */
|
|
2166
|
+
export interface ObjectDetection {
|
|
2167
|
+
/** Bounding box of the detected object. */
|
|
2168
|
+
boundingBox: BoundingBox | undefined;
|
|
2169
|
+
/** Detection confidence score (0..1). */
|
|
2170
|
+
confidence: number;
|
|
2171
|
+
/** Numeric class identifier from the model. */
|
|
2172
|
+
classId: number;
|
|
2173
|
+
/** Human-readable class name. */
|
|
2174
|
+
className: string;
|
|
2175
|
+
/** Unique ID for tracking the same object across frames. */
|
|
2176
|
+
trackingId: number;
|
|
2177
|
+
}
|
|
2178
|
+
/** A list of object detections from a single video frame. */
|
|
2179
|
+
export interface ObjectDetections {
|
|
2180
|
+
/** List of detections in the frame. */
|
|
2181
|
+
detections: ObjectDetection[];
|
|
2182
|
+
/** Which camera the detections are from. */
|
|
2183
|
+
camera: Camera;
|
|
2184
|
+
}
|
|
2185
|
+
/** Generic filter settings. */
|
|
2186
|
+
export interface FilterMessage {
|
|
2187
|
+
/** If the filter is enabled. */
|
|
2188
|
+
enabled: boolean;
|
|
2189
|
+
/** Intensity of the filter (0..1). */
|
|
2190
|
+
intensity: number;
|
|
2191
|
+
}
|
|
2192
|
+
/**
|
|
2193
|
+
* Digital pan, tilt, and zoom state for the main camera.
|
|
2194
|
+
*
|
|
2195
|
+
* Only supported on X3 Ultra. Controls digital (not mechanical) zoom.
|
|
2196
|
+
*/
|
|
2197
|
+
export interface CameraPanTiltZoom {
|
|
2198
|
+
/** Horizontal pan (-1.0..1.0), where 0.0 is center. */
|
|
2199
|
+
pan: number;
|
|
2200
|
+
/** Vertical tilt (-1.0..1.0), where 0.0 is center. */
|
|
2201
|
+
tilt: number;
|
|
2202
|
+
/** Zoom level (0.0..1.0), where 0.0 is no zoom and 1.0 is maximum zoom. */
|
|
2203
|
+
zoom: number;
|
|
2204
|
+
}
|
|
2205
|
+
/**
|
|
2206
|
+
* Information about the operator controlling the drone.
|
|
2207
|
+
*
|
|
2208
|
+
* Used to identify who started a dive, for reporting and when importing
|
|
2209
|
+
* dives to Blueye Cloud.
|
|
2210
|
+
*/
|
|
2211
|
+
export interface OperatorInfo {
|
|
2212
|
+
/** Full name of the operator. */
|
|
2213
|
+
name: string;
|
|
2214
|
+
/** E-mail address of the operator. */
|
|
2215
|
+
email: string;
|
|
1845
2216
|
}
|
|
1846
2217
|
export declare const BinlogRecord: MessageFns<BinlogRecord>;
|
|
1847
2218
|
export declare const LogEntry: MessageFns<LogEntry>;
|
|
2219
|
+
export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
|
|
2220
|
+
export declare const KernelLogEntry_KeyValuePair: MessageFns<KernelLogEntry_KeyValuePair>;
|
|
1848
2221
|
export declare const MotionInput: MessageFns<MotionInput>;
|
|
1849
2222
|
export declare const Lights: MessageFns<Lights>;
|
|
1850
2223
|
export declare const Laser: MessageFns<Laser>;
|
|
@@ -1930,6 +2303,21 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
|
|
|
1930
2303
|
export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
|
|
1931
2304
|
export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
|
|
1932
2305
|
export declare const CPUInfo: MessageFns<CPUInfo>;
|
|
2306
|
+
export declare const CpuCoreLoad: MessageFns<CpuCoreLoad>;
|
|
2307
|
+
export declare const GpuInfo: MessageFns<GpuInfo>;
|
|
2308
|
+
export declare const DlaInfo: MessageFns<DlaInfo>;
|
|
2309
|
+
export declare const MemoryInfo: MessageFns<MemoryInfo>;
|
|
2310
|
+
export declare const ThermalZone: MessageFns<ThermalZone>;
|
|
2311
|
+
export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
|
|
2312
|
+
export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
|
|
2313
|
+
export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
|
|
2314
|
+
export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
|
|
2315
|
+
export declare const BoundingBox: MessageFns<BoundingBox>;
|
|
2316
|
+
export declare const ObjectDetection: MessageFns<ObjectDetection>;
|
|
2317
|
+
export declare const ObjectDetections: MessageFns<ObjectDetections>;
|
|
2318
|
+
export declare const FilterMessage: MessageFns<FilterMessage>;
|
|
2319
|
+
export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
|
|
2320
|
+
export declare const OperatorInfo: MessageFns<OperatorInfo>;
|
|
1933
2321
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
1934
2322
|
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 {} ? {
|
|
1935
2323
|
[K in keyof T]?: DeepPartial<T[K]>;
|