@blueyerobotics/protocol-definitions 3.2.0-0f78a956 → 3.2.0-13a0ac0d
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 +51 -2
- package/dist/control.js +371 -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 +486 -15
- package/dist/message_formats.js +3008 -124
- package/dist/mission_planning.d.ts +54 -0
- package/dist/mission_planning.js +244 -2
- package/dist/req_rep.d.ts +32 -0
- package/dist/req_rep.js +280 -2
- package/dist/telemetry.d.ts +83 -2
- package/dist/telemetry.js +564 -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. */
|
|
@@ -294,6 +346,8 @@ export declare enum FontSize {
|
|
|
294
346
|
FONT_SIZE_PX35 = 5,
|
|
295
347
|
/** FONT_SIZE_PX40 - 40 px. */
|
|
296
348
|
FONT_SIZE_PX40 = 6,
|
|
349
|
+
/** FONT_SIZE_PX50 - 50 px. */
|
|
350
|
+
FONT_SIZE_PX50 = 7,
|
|
297
351
|
UNRECOGNIZED = -1
|
|
298
352
|
}
|
|
299
353
|
export declare function fontSizeFromJSON(object: any): FontSize;
|
|
@@ -390,6 +444,14 @@ export declare enum GuestPortDeviceID {
|
|
|
390
444
|
GUEST_PORT_DEVICE_ID_WATERLINKED_SONAR_3D15 = 43,
|
|
391
445
|
/** GUEST_PORT_DEVICE_ID_CERULEAN_TRACKER_650 - Cerulean Tracker 650. */
|
|
392
446
|
GUEST_PORT_DEVICE_ID_CERULEAN_TRACKER_650 = 44,
|
|
447
|
+
/** GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE - Blueye External USB Storage. */
|
|
448
|
+
GUEST_PORT_DEVICE_ID_BLUEYE_EXTERNAL_USB_STORAGE = 45,
|
|
449
|
+
/** GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 - Blueye Multibeam Skid Servo V2. */
|
|
450
|
+
GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 = 46,
|
|
451
|
+
/** GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT - Cerulean Omniscan 450 Compact. */
|
|
452
|
+
GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT = 47,
|
|
453
|
+
/** GUEST_PORT_DEVICE_ID_BLUEYE_SCALING_LASER - Blueye Scaling Laser. */
|
|
454
|
+
GUEST_PORT_DEVICE_ID_BLUEYE_SCALING_LASER = 48,
|
|
393
455
|
UNRECOGNIZED = -1
|
|
394
456
|
}
|
|
395
457
|
export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
|
|
@@ -475,6 +537,18 @@ export declare enum MultibeamFrequencyMode {
|
|
|
475
537
|
}
|
|
476
538
|
export declare function multibeamFrequencyModeFromJSON(object: any): MultibeamFrequencyMode;
|
|
477
539
|
export declare function multibeamFrequencyModeToJSON(object: MultibeamFrequencyMode): string;
|
|
540
|
+
/** Thermal zone identifiers. */
|
|
541
|
+
export declare enum ThermalZoneId {
|
|
542
|
+
/** THERMAL_ZONE_ID_UNSPECIFIED - Unspecified thermal zone. */
|
|
543
|
+
THERMAL_ZONE_ID_UNSPECIFIED = 0,
|
|
544
|
+
/** THERMAL_ZONE_ID_TJ - Junction temperature (Tj). */
|
|
545
|
+
THERMAL_ZONE_ID_TJ = 1,
|
|
546
|
+
/** THERMAL_ZONE_ID_CANISTER - Canister temperature. */
|
|
547
|
+
THERMAL_ZONE_ID_CANISTER = 2,
|
|
548
|
+
UNRECOGNIZED = -1
|
|
549
|
+
}
|
|
550
|
+
export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
|
|
551
|
+
export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
|
|
478
552
|
/**
|
|
479
553
|
* Wrapper message for each entry in the drone telemetry logfile.
|
|
480
554
|
*
|
|
@@ -531,6 +605,49 @@ export declare enum LogEntry_LogLevel {
|
|
|
531
605
|
}
|
|
532
606
|
export declare function logEntry_LogLevelFromJSON(object: any): LogEntry_LogLevel;
|
|
533
607
|
export declare function logEntry_LogLevelToJSON(object: LogEntry_LogLevel): string;
|
|
608
|
+
export interface KernelLogEntry {
|
|
609
|
+
/** Log level, info, warning, error, etc. */
|
|
610
|
+
level: KernelLogEntry_KernelLogLevel;
|
|
611
|
+
/** Sequence number of the log entry. */
|
|
612
|
+
seqnum: number;
|
|
613
|
+
/** Timestamp of the log entry. */
|
|
614
|
+
timestamp: Date | undefined;
|
|
615
|
+
/** Log messages. */
|
|
616
|
+
messages: string[];
|
|
617
|
+
/** List of key-value pairs. */
|
|
618
|
+
fields: KernelLogEntry_KeyValuePair[];
|
|
619
|
+
}
|
|
620
|
+
/** Kernel log level. */
|
|
621
|
+
export declare enum KernelLogEntry_KernelLogLevel {
|
|
622
|
+
/** KERNEL_LOG_LEVEL_UNSPECIFIED - Unspecified log level. */
|
|
623
|
+
KERNEL_LOG_LEVEL_UNSPECIFIED = 0,
|
|
624
|
+
/** KERNEL_LOG_LEVEL_EMERG - Emergency log level. */
|
|
625
|
+
KERNEL_LOG_LEVEL_EMERG = 1,
|
|
626
|
+
/** KERNEL_LOG_LEVEL_ALERT - Alert log level. */
|
|
627
|
+
KERNEL_LOG_LEVEL_ALERT = 2,
|
|
628
|
+
/** KERNEL_LOG_LEVEL_CRIT - Critical log level. */
|
|
629
|
+
KERNEL_LOG_LEVEL_CRIT = 3,
|
|
630
|
+
/** KERNEL_LOG_LEVEL_ERR - Error log level. */
|
|
631
|
+
KERNEL_LOG_LEVEL_ERR = 4,
|
|
632
|
+
/** KERNEL_LOG_LEVEL_WARNING - Warning log level. */
|
|
633
|
+
KERNEL_LOG_LEVEL_WARNING = 5,
|
|
634
|
+
/** KERNEL_LOG_LEVEL_NOTICE - Notice log level. */
|
|
635
|
+
KERNEL_LOG_LEVEL_NOTICE = 6,
|
|
636
|
+
/** KERNEL_LOG_LEVEL_INFO - Informational log level. */
|
|
637
|
+
KERNEL_LOG_LEVEL_INFO = 7,
|
|
638
|
+
/** KERNEL_LOG_LEVEL_DEBUG - Debug log level. */
|
|
639
|
+
KERNEL_LOG_LEVEL_DEBUG = 8,
|
|
640
|
+
UNRECOGNIZED = -1
|
|
641
|
+
}
|
|
642
|
+
export declare function kernelLogEntry_KernelLogLevelFromJSON(object: any): KernelLogEntry_KernelLogLevel;
|
|
643
|
+
export declare function kernelLogEntry_KernelLogLevelToJSON(object: KernelLogEntry_KernelLogLevel): string;
|
|
644
|
+
/** Key-value pair used for structured logging. */
|
|
645
|
+
export interface KernelLogEntry_KeyValuePair {
|
|
646
|
+
/** Key of the key-value pair. */
|
|
647
|
+
key: string;
|
|
648
|
+
/** Value of the key-value pair. */
|
|
649
|
+
value: string;
|
|
650
|
+
}
|
|
534
651
|
/** If you use both values at the same time they cancel each other out. */
|
|
535
652
|
export interface MotionInput {
|
|
536
653
|
/** Forward (positive) and backwards (negative) movement. (-1..1). */
|
|
@@ -700,6 +817,12 @@ export interface RecordState {
|
|
|
700
817
|
multibeamSeconds: number;
|
|
701
818
|
/** Multibeam record fps. */
|
|
702
819
|
multibeamFps: number;
|
|
820
|
+
/** Storage location used for main camera recording. */
|
|
821
|
+
mainStorageLocation: StorageLocation;
|
|
822
|
+
/** Storage location used for guestport camera recording. */
|
|
823
|
+
guestportStorageLocation: StorageLocation;
|
|
824
|
+
/** Storage location used for multibeam recording. */
|
|
825
|
+
multibeamStorageLocation: StorageLocation;
|
|
703
826
|
}
|
|
704
827
|
/** Time-lapse state published if time-lapse mission is running. */
|
|
705
828
|
export interface TimeLapseState {
|
|
@@ -745,7 +868,7 @@ export interface WaterTemperature {
|
|
|
745
868
|
/** Water temperature (°C). */
|
|
746
869
|
value: number;
|
|
747
870
|
}
|
|
748
|
-
/** CPU temperature. */
|
|
871
|
+
/** CPU temperature (deprecated, use SystemPerformanceInfo.thermal_zones instead). */
|
|
749
872
|
export interface CPUTemperature {
|
|
750
873
|
/** CPU temperature (°C). */
|
|
751
874
|
value: number;
|
|
@@ -1167,7 +1290,7 @@ export interface DiveTime {
|
|
|
1167
1290
|
/** Number of seconds the drone has been submerged. */
|
|
1168
1291
|
value: number;
|
|
1169
1292
|
}
|
|
1170
|
-
/** Which cameras are supposed to be recording. */
|
|
1293
|
+
/** Which cameras or multibeam are supposed to be recording. */
|
|
1171
1294
|
export interface RecordOn {
|
|
1172
1295
|
/** Record the main camera. */
|
|
1173
1296
|
main: boolean;
|
|
@@ -1193,6 +1316,8 @@ export interface StoragePartition {
|
|
|
1193
1316
|
devicePath: string;
|
|
1194
1317
|
/** Mount path of the partition. */
|
|
1195
1318
|
mountPath: string;
|
|
1319
|
+
/** Label of the partition. */
|
|
1320
|
+
label: string;
|
|
1196
1321
|
}
|
|
1197
1322
|
/** Removable storage device. */
|
|
1198
1323
|
export interface RemovableStorageDevice {
|
|
@@ -1215,10 +1340,12 @@ export declare enum RemovableStorageDevice_Status {
|
|
|
1215
1340
|
STATUS_UNSPECIFIED = 0,
|
|
1216
1341
|
/** STATUS_READY - The storage device is valid and ready for use. */
|
|
1217
1342
|
STATUS_READY = 1,
|
|
1218
|
-
/** STATUS_FORMATTING - The storage device is being formatted */
|
|
1343
|
+
/** STATUS_FORMATTING - The storage device is being formatted. */
|
|
1219
1344
|
STATUS_FORMATTING = 2,
|
|
1220
1345
|
/** STATUS_ERROR - The storage device is in an error state. */
|
|
1221
1346
|
STATUS_ERROR = 3,
|
|
1347
|
+
/** STATUS_UNPLUGGED - The storage device is not present. */
|
|
1348
|
+
STATUS_UNPLUGGED = 4,
|
|
1222
1349
|
UNRECOGNIZED = -1
|
|
1223
1350
|
}
|
|
1224
1351
|
export declare function removableStorageDevice_StatusFromJSON(object: any): RemovableStorageDevice_Status;
|
|
@@ -1314,6 +1441,31 @@ export interface TiltVelocity {
|
|
|
1314
1441
|
/**
|
|
1315
1442
|
* Information about the drone.
|
|
1316
1443
|
*
|
|
1444
|
+
* Information about a loaded computer vision model.
|
|
1445
|
+
*/
|
|
1446
|
+
export interface CvModelInfo {
|
|
1447
|
+
/** Human-readable model name (from model_meta.json). */
|
|
1448
|
+
name: string;
|
|
1449
|
+
/** Type of CV model. */
|
|
1450
|
+
type: CvModelInfo_ModelType;
|
|
1451
|
+
/** Whether the model is currently running. */
|
|
1452
|
+
running: boolean;
|
|
1453
|
+
/** Execution provider (e.g. "cuda", "tensorrt"). */
|
|
1454
|
+
device: string;
|
|
1455
|
+
/** Package directory name (e.g. "tinyyolov2_package"). Stable identifier. */
|
|
1456
|
+
packageId: string;
|
|
1457
|
+
/** Class names the model can detect (indexed by class_id). */
|
|
1458
|
+
labels: string[];
|
|
1459
|
+
}
|
|
1460
|
+
export declare enum CvModelInfo_ModelType {
|
|
1461
|
+
MODEL_TYPE_UNSPECIFIED = 0,
|
|
1462
|
+
MODEL_TYPE_DETECTION = 1,
|
|
1463
|
+
MODEL_TYPE_SOT = 2,
|
|
1464
|
+
UNRECOGNIZED = -1
|
|
1465
|
+
}
|
|
1466
|
+
export declare function cvModelInfo_ModelTypeFromJSON(object: any): CvModelInfo_ModelType;
|
|
1467
|
+
export declare function cvModelInfo_ModelTypeToJSON(object: CvModelInfo_ModelType): string;
|
|
1468
|
+
/**
|
|
1317
1469
|
* This message contains serial numbers and version information for
|
|
1318
1470
|
* internal components in the drone. Primarily used for diagnostics, or to
|
|
1319
1471
|
* determine the origin of a logfile.
|
|
@@ -1341,6 +1493,8 @@ export interface DroneInfo {
|
|
|
1341
1493
|
gp: GuestPortInfo | undefined;
|
|
1342
1494
|
/** Type of depth sensor that is connected to the drone. */
|
|
1343
1495
|
depthSensor: PressureSensorType;
|
|
1496
|
+
/** List of loaded computer vision models. */
|
|
1497
|
+
cvModels: CvModelInfo[];
|
|
1344
1498
|
}
|
|
1345
1499
|
/** Known error states for the drone. */
|
|
1346
1500
|
export interface ErrorFlags {
|
|
@@ -1447,22 +1601,57 @@ export interface CameraParameters {
|
|
|
1447
1601
|
mjpgBitrate: number;
|
|
1448
1602
|
/** Shutter speed (1/10000 * s), -1 for automatic exposure. */
|
|
1449
1603
|
exposure: number;
|
|
1450
|
-
/** White balance
|
|
1604
|
+
/** White balance temp (Pioneer/Pro/X1/X3: 2800..9300, Ultra: 2300..15000), -1 for auto. */
|
|
1451
1605
|
whiteBalance: number;
|
|
1452
|
-
/** Hue (-40..40), 0 as default. */
|
|
1606
|
+
/** Hue (-40..40), 0 as default. Only available on Pioneer/Pro/X1/X3. */
|
|
1453
1607
|
hue: number;
|
|
1454
|
-
/** Iso gain (0..1). */
|
|
1608
|
+
/** Iso gain (0..1). Only available on Pioneer/Pro/X1/X3. */
|
|
1455
1609
|
gain: number;
|
|
1610
|
+
/** Brightness (-10..10), 0 as default. Only available on Ultra */
|
|
1611
|
+
brightness: number;
|
|
1612
|
+
/** Contrast (-50..50), 0 as default. Only available on Ultra. */
|
|
1613
|
+
contrast: number;
|
|
1614
|
+
/** Saturation (0..50), 8 as default. Only available on Ultra. */
|
|
1615
|
+
saturation: number;
|
|
1616
|
+
/** Gamma (4..79), 22 as default. Only available on Ultra. */
|
|
1617
|
+
gamma: number;
|
|
1618
|
+
/** Sharpness (-20..20), -20 as default. Only available on Ultra. */
|
|
1619
|
+
sharpness: number;
|
|
1620
|
+
/** Backlight compensation (-150..150), 10 as default. Only available on Ultra. */
|
|
1621
|
+
backlightCompensation: number;
|
|
1622
|
+
/** Noise reduction (-20..20), -20 as default. Only available on Ultra. */
|
|
1623
|
+
denoise: number;
|
|
1624
|
+
/** Enable eHDR mode. Default true. Only available on Ultra. */
|
|
1625
|
+
ehdrEnabled: boolean;
|
|
1626
|
+
/** Minimum number of eHDR frames. (1..4), default 1. Only available on Ultra. */
|
|
1627
|
+
ehdrExposureMinNumber: number;
|
|
1628
|
+
/** Maximum number of eHDR frames. (1..4), default 2. Only on Ultra. Setting larger than 2 can reduce the framerate. */
|
|
1629
|
+
ehdrExposureMaxNumber: number;
|
|
1456
1630
|
/** Stream, recording and image resolution (deprecated). */
|
|
1457
1631
|
resolution: Resolution;
|
|
1458
1632
|
/** Stream resolution. */
|
|
1459
1633
|
streamResolution: Resolution;
|
|
1460
1634
|
/** Recording and image resolution. */
|
|
1461
1635
|
recordingResolution: Resolution;
|
|
1636
|
+
/** Streaming protocol. */
|
|
1637
|
+
streamingProtocol: StreamingProtocol;
|
|
1462
1638
|
/** Stream and recording framerate. */
|
|
1463
1639
|
framerate: Framerate;
|
|
1464
1640
|
/** Which camera the parameters belong to. */
|
|
1465
1641
|
camera: Camera;
|
|
1642
|
+
/**
|
|
1643
|
+
* Network MTU (Maximum Transmission Unit) size for video streaming in bytes (68..65535).
|
|
1644
|
+
* If 0 or unset, the system will use a default of 1400.
|
|
1645
|
+
* The Blueye App allows users to set values between 500 and 1460.
|
|
1646
|
+
*/
|
|
1647
|
+
mtuSize: number;
|
|
1648
|
+
/** Recording video codec. If unset, uses platform default. */
|
|
1649
|
+
recordingCodec: RecordingCodec;
|
|
1650
|
+
/**
|
|
1651
|
+
* Recording bitrate in bits/sec. If 0 or unset, a default is computed based
|
|
1652
|
+
* on resolution, framerate, and encoding. Set explicitly to override.
|
|
1653
|
+
*/
|
|
1654
|
+
recordingBitrate: number;
|
|
1466
1655
|
}
|
|
1467
1656
|
/**
|
|
1468
1657
|
* Overlay parameters.
|
|
@@ -1688,8 +1877,7 @@ export interface MultibeamPing {
|
|
|
1688
1877
|
/** Size in bytes of each row in the ping data image. */
|
|
1689
1878
|
step: number;
|
|
1690
1879
|
/**
|
|
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).
|
|
1880
|
+
* Bearing angle of each column of the sonar data in degrees.
|
|
1693
1881
|
* The sonar image is not sampled uniformly in the bearing direction.
|
|
1694
1882
|
*/
|
|
1695
1883
|
bearings: number[];
|
|
@@ -1829,7 +2017,7 @@ export interface PersistentStorageSettings {
|
|
|
1829
2017
|
accCalibration: boolean;
|
|
1830
2018
|
}
|
|
1831
2019
|
/**
|
|
1832
|
-
* CPU information.
|
|
2020
|
+
* CPU information (deprecated, use SystemPerformanceInfo instead).
|
|
1833
2021
|
*
|
|
1834
2022
|
* Contains information about the CPU load and memory usage of the drone.
|
|
1835
2023
|
*/
|
|
@@ -1842,9 +2030,274 @@ export interface CPUInfo {
|
|
|
1842
2030
|
mainQueueLoad: number;
|
|
1843
2031
|
/** Guestport queue load (0..1). */
|
|
1844
2032
|
guestportQueueLoad: number;
|
|
2033
|
+
/** Communication queue load (0..1). */
|
|
2034
|
+
commQueueLoad: number;
|
|
2035
|
+
}
|
|
2036
|
+
/** Per-core CPU utilization. */
|
|
2037
|
+
export interface CpuCoreLoad {
|
|
2038
|
+
/** Core index (0-based). */
|
|
2039
|
+
coreIndex: number;
|
|
2040
|
+
/** Core load (0..1). */
|
|
2041
|
+
load: number;
|
|
2042
|
+
/** Current clock frequency (MHz). */
|
|
2043
|
+
frequencyMhz: number;
|
|
2044
|
+
}
|
|
2045
|
+
/** GPU utilization and status. */
|
|
2046
|
+
export interface GpuInfo {
|
|
2047
|
+
/** GPU load (0..1). */
|
|
2048
|
+
load: number;
|
|
2049
|
+
/** Current GPU clock frequency (MHz). */
|
|
2050
|
+
frequencyMhz: number;
|
|
2051
|
+
}
|
|
2052
|
+
/**
|
|
2053
|
+
* Deep Learning Accelerator (DLA) utilization.
|
|
2054
|
+
*
|
|
2055
|
+
* Jetson Orin NX has two DLA engines used for inference offload.
|
|
2056
|
+
*/
|
|
2057
|
+
export interface DlaInfo {
|
|
2058
|
+
/** DLA engine index (0-based). */
|
|
2059
|
+
engineIndex: number;
|
|
2060
|
+
/** DLA engine load (0..1). */
|
|
2061
|
+
load: number;
|
|
2062
|
+
/** Core clock frequency (MHz). 0 when disabled. */
|
|
2063
|
+
frequencyMhz: number;
|
|
2064
|
+
/** True when the DLA engine is actively processing. */
|
|
2065
|
+
enabled: boolean;
|
|
2066
|
+
/** Falcon microcontroller clock frequency (MHz). 0 when disabled. */
|
|
2067
|
+
falconFrequencyMhz: number;
|
|
2068
|
+
}
|
|
2069
|
+
/** System memory information. */
|
|
2070
|
+
export interface MemoryInfo {
|
|
2071
|
+
/** Total RAM (bytes). */
|
|
2072
|
+
totalBytes: number;
|
|
2073
|
+
/** Used RAM (bytes). */
|
|
2074
|
+
usedBytes: number;
|
|
2075
|
+
/** Cached RAM (bytes). */
|
|
2076
|
+
cachedBytes: number;
|
|
2077
|
+
/** Memory bus utilization (0..1). i.MX only. */
|
|
2078
|
+
busLoad: number;
|
|
2079
|
+
}
|
|
2080
|
+
/** Thermal zone reading. */
|
|
2081
|
+
export interface ThermalZone {
|
|
2082
|
+
/** Thermal zone identifier. */
|
|
2083
|
+
zone: ThermalZoneId;
|
|
2084
|
+
/** Temperature (°C). */
|
|
2085
|
+
temperature: number;
|
|
2086
|
+
}
|
|
2087
|
+
/** Video codec engine status. */
|
|
2088
|
+
export interface VideoCodecInfo {
|
|
2089
|
+
/** Jetson only (NVENC/NVDEC/NVJPG/VIC devfreq). */
|
|
2090
|
+
encoderActive: boolean;
|
|
2091
|
+
/** Video encoder clock frequency (MHz). */
|
|
2092
|
+
encoderFrequencyMhz: number;
|
|
2093
|
+
/** Video decoder (NVDEC) is active. */
|
|
2094
|
+
decoderActive: boolean;
|
|
2095
|
+
/** Video decoder clock frequency (MHz). */
|
|
2096
|
+
decoderFrequencyMhz: number;
|
|
2097
|
+
/** JPEG engine (NVJPG) is active. */
|
|
2098
|
+
nvjpgActive: boolean;
|
|
2099
|
+
/** JPEG engine clock frequency (MHz). */
|
|
2100
|
+
nvjpgFrequencyMhz: number;
|
|
2101
|
+
/** Video Image Compositor (VIC) is active. */
|
|
2102
|
+
vicActive: boolean;
|
|
2103
|
+
/** VIC clock frequency (MHz). */
|
|
2104
|
+
vicFrequencyMhz: number;
|
|
2105
|
+
/** i.MX only (CODA VPU). */
|
|
2106
|
+
vpuActive: boolean;
|
|
2107
|
+
/** VPU AXI clock frequency (MHz). */
|
|
2108
|
+
vpuFrequencyMhz: number;
|
|
2109
|
+
/** Cumulative VPU_CODEC_IRQ count. */
|
|
2110
|
+
vpuCodecIrqCount: number;
|
|
2111
|
+
/** Cumulative VPU_JPG_IRQ count. */
|
|
2112
|
+
vpuJpgIrqCount: number;
|
|
2113
|
+
}
|
|
2114
|
+
/**
|
|
2115
|
+
* System performance information.
|
|
2116
|
+
*
|
|
2117
|
+
* Comprehensive performance metrics for the drone's compute platform.
|
|
2118
|
+
* Covers CPU, GPU, DLA, memory, thermals, and video codec utilization.
|
|
2119
|
+
* Fields not applicable to a platform are left at their zero/empty defaults.
|
|
2120
|
+
*/
|
|
2121
|
+
export interface SystemPerformanceInfo {
|
|
2122
|
+
/** Per-core CPU utilization. */
|
|
2123
|
+
cpuCores: CpuCoreLoad[];
|
|
2124
|
+
/** Mean CPU utilization across all cores (0..1). */
|
|
2125
|
+
cpuUtilization: number;
|
|
2126
|
+
/** GPU utilization. */
|
|
2127
|
+
gpu: GpuInfo | undefined;
|
|
2128
|
+
/** DLA engine utilization (Jetson only). */
|
|
2129
|
+
dlaEngines: DlaInfo[];
|
|
2130
|
+
/** RAM usage. */
|
|
2131
|
+
memory: MemoryInfo | undefined;
|
|
2132
|
+
/** All thermal zone readings. */
|
|
2133
|
+
thermalZones: ThermalZone[];
|
|
2134
|
+
/** Video encoder/decoder status. */
|
|
2135
|
+
videoCodec: VideoCodecInfo | undefined;
|
|
2136
|
+
/** Main queue load (0..1). */
|
|
2137
|
+
mainQueueLoad: number;
|
|
2138
|
+
/** Guestport queue load (0..1). */
|
|
2139
|
+
guestportQueueLoad: number;
|
|
2140
|
+
/** Communication queue load (0..1). */
|
|
2141
|
+
commQueueLoad: number;
|
|
2142
|
+
/** Camera queue load (0..1). */
|
|
2143
|
+
cameraQueueLoad: number;
|
|
2144
|
+
/** Overlay queue load (0..1). */
|
|
2145
|
+
overlayQueueLoad: number;
|
|
2146
|
+
/** Position observer queue load (0..1). */
|
|
2147
|
+
positionObserverQueueLoad: number;
|
|
2148
|
+
}
|
|
2149
|
+
/**
|
|
2150
|
+
* Surface Unit battery information.
|
|
2151
|
+
*
|
|
2152
|
+
* This message is published by the Surface Unit, and re-published by
|
|
2153
|
+
* the drone over the communication protocol.
|
|
2154
|
+
*/
|
|
2155
|
+
export interface SurfaceUnitBatteryInfo {
|
|
2156
|
+
/** Battery charge status. */
|
|
2157
|
+
status: SurfaceUnitBatteryInfo_ChargeStatus;
|
|
2158
|
+
/** Battery level (0..1). */
|
|
2159
|
+
level: number;
|
|
2160
|
+
}
|
|
2161
|
+
export declare enum SurfaceUnitBatteryInfo_ChargeStatus {
|
|
2162
|
+
CHARGE_STATUS_UNSPECIFIED = 0,
|
|
2163
|
+
CHARGE_STATUS_DISCHARGE = 1,
|
|
2164
|
+
CHARGE_STATUS_CHARGE = 2,
|
|
2165
|
+
CHARGE_STATUS_CHARGE_ERROR = 3,
|
|
2166
|
+
UNRECOGNIZED = -1
|
|
2167
|
+
}
|
|
2168
|
+
export declare function surfaceUnitBatteryInfo_ChargeStatusFromJSON(object: any): SurfaceUnitBatteryInfo_ChargeStatus;
|
|
2169
|
+
export declare function surfaceUnitBatteryInfo_ChargeStatusToJSON(object: SurfaceUnitBatteryInfo_ChargeStatus): string;
|
|
2170
|
+
/**
|
|
2171
|
+
* Surface Unit version information.
|
|
2172
|
+
*
|
|
2173
|
+
* This message is published by the Surface Unit, and re-published by
|
|
2174
|
+
* the drone over the communication protocol.
|
|
2175
|
+
*/
|
|
2176
|
+
export interface SurfaceUnitVersionInfo {
|
|
2177
|
+
/** Surface Unit firmware version (x.y.z). */
|
|
2178
|
+
version: string;
|
|
2179
|
+
}
|
|
2180
|
+
/**
|
|
2181
|
+
* Bounding box for object detection.
|
|
2182
|
+
*
|
|
2183
|
+
* Coordinates are in pixels relative to the camera image,
|
|
2184
|
+
* where (x, y) is the top-left corner of the bounding box.
|
|
2185
|
+
*/
|
|
2186
|
+
export interface BoundingBox {
|
|
2187
|
+
/** Horizontal offset of the top-left corner (px). */
|
|
2188
|
+
x: number;
|
|
2189
|
+
/** Vertical offset of the top-left corner (px). */
|
|
2190
|
+
y: number;
|
|
2191
|
+
/** Width of the bounding box (px). */
|
|
2192
|
+
width: number;
|
|
2193
|
+
/** Height of the bounding box (px). */
|
|
2194
|
+
height: number;
|
|
2195
|
+
}
|
|
2196
|
+
/**
|
|
2197
|
+
* RLE-encoded binary segmentation mask relative to the bounding box.
|
|
2198
|
+
*
|
|
2199
|
+
* The mask bitmap has dimensions (mask_width x mask_height) covering the
|
|
2200
|
+
* detection's bounding box area. The counts field stores run-length encoded
|
|
2201
|
+
* data as packed uint16 little-endian: alternating background/foreground
|
|
2202
|
+
* pixel runs starting with background.
|
|
2203
|
+
*/
|
|
2204
|
+
export interface SegmentationMask {
|
|
2205
|
+
/** Width of the RLE bitmap. */
|
|
2206
|
+
maskWidth: number;
|
|
2207
|
+
/** Height of the RLE bitmap. */
|
|
2208
|
+
maskHeight: number;
|
|
2209
|
+
/** RLE counts as packed uint16 little-endian. */
|
|
2210
|
+
counts: Uint8Array;
|
|
2211
|
+
}
|
|
2212
|
+
/** A single object detection from a computer vision model. */
|
|
2213
|
+
export interface ObjectDetection {
|
|
2214
|
+
/** Bounding box of the detected object. */
|
|
2215
|
+
boundingBox: BoundingBox | undefined;
|
|
2216
|
+
/** Detection confidence score (0..1). */
|
|
2217
|
+
confidence: number;
|
|
2218
|
+
/** Numeric class identifier from the model. */
|
|
2219
|
+
classId: number;
|
|
2220
|
+
/** Human-readable class name. */
|
|
2221
|
+
className: string;
|
|
2222
|
+
/** Unique ID for tracking the same object across frames. */
|
|
2223
|
+
trackingId: number;
|
|
2224
|
+
/** Instance segmentation mask (absent if model has no segmentation). */
|
|
2225
|
+
mask: SegmentationMask | undefined;
|
|
2226
|
+
}
|
|
2227
|
+
/** A list of object detections from a single model for a single video frame. */
|
|
2228
|
+
export interface ModelDetections {
|
|
2229
|
+
/** List of detections in the frame. */
|
|
2230
|
+
detections: ObjectDetection[];
|
|
2231
|
+
/** Which camera the detections are from. */
|
|
2232
|
+
camera: Camera;
|
|
2233
|
+
/** Width of the source image (px). */
|
|
2234
|
+
imageWidth: number;
|
|
2235
|
+
/** Height of the source image (px). */
|
|
2236
|
+
imageHeight: number;
|
|
2237
|
+
/** Name of the computer vision model that produced the detections. */
|
|
2238
|
+
modelName: string;
|
|
2239
|
+
}
|
|
2240
|
+
/** Generic filter settings. */
|
|
2241
|
+
export interface FilterMessage {
|
|
2242
|
+
/** If the filter is enabled. */
|
|
2243
|
+
enabled: boolean;
|
|
2244
|
+
/** Intensity of the filter (0..1). */
|
|
2245
|
+
intensity: number;
|
|
2246
|
+
}
|
|
2247
|
+
/**
|
|
2248
|
+
* Digital pan, tilt, and zoom state for the main camera.
|
|
2249
|
+
*
|
|
2250
|
+
* Only supported on X3 Ultra. Controls digital (not mechanical) zoom.
|
|
2251
|
+
*/
|
|
2252
|
+
export interface CameraPanTiltZoom {
|
|
2253
|
+
/** Horizontal pan (-1.0..1.0), where 0.0 is center. */
|
|
2254
|
+
pan: number;
|
|
2255
|
+
/** Vertical tilt (-1.0..1.0), where 0.0 is center. */
|
|
2256
|
+
tilt: number;
|
|
2257
|
+
/** Zoom level (0.0..1.0), where 0.0 is no zoom and 1.0 is maximum zoom. */
|
|
2258
|
+
zoom: number;
|
|
2259
|
+
}
|
|
2260
|
+
/**
|
|
2261
|
+
* Information about the operator controlling the drone.
|
|
2262
|
+
*
|
|
2263
|
+
* Used to identify who started a dive, for reporting and when importing
|
|
2264
|
+
* dives to Blueye Cloud.
|
|
2265
|
+
*/
|
|
2266
|
+
export interface OperatorInfo {
|
|
2267
|
+
/** Full name of the operator. */
|
|
2268
|
+
name: string;
|
|
2269
|
+
/** E-mail address of the operator. */
|
|
2270
|
+
email: string;
|
|
2271
|
+
}
|
|
2272
|
+
/** Single-object tracking (SOT) state reported by the computer vision pipeline. */
|
|
2273
|
+
export interface SotState {
|
|
2274
|
+
/** Current tracking state. */
|
|
2275
|
+
state: SotState_State;
|
|
2276
|
+
/** Current tracked bounding box (valid when TRACKING). */
|
|
2277
|
+
boundingBox: BoundingBox | undefined;
|
|
2278
|
+
/** Width of the source frame in pixels. */
|
|
2279
|
+
imageWidth: number;
|
|
2280
|
+
/** Height of the source frame in pixels. */
|
|
2281
|
+
imageHeight: number;
|
|
2282
|
+
}
|
|
2283
|
+
/** Current state of the SOT tracker. */
|
|
2284
|
+
export declare enum SotState_State {
|
|
2285
|
+
/** STATE_UNSPECIFIED - Unspecified state. */
|
|
2286
|
+
STATE_UNSPECIFIED = 0,
|
|
2287
|
+
/** STATE_IDLE - No target selected, waiting for a target bounding box. */
|
|
2288
|
+
STATE_IDLE = 1,
|
|
2289
|
+
/** STATE_TRACKING - Actively tracking a target. */
|
|
2290
|
+
STATE_TRACKING = 2,
|
|
2291
|
+
/** STATE_LOST - Target was lost (tracker failed to follow the object). */
|
|
2292
|
+
STATE_LOST = 3,
|
|
2293
|
+
UNRECOGNIZED = -1
|
|
1845
2294
|
}
|
|
2295
|
+
export declare function sotState_StateFromJSON(object: any): SotState_State;
|
|
2296
|
+
export declare function sotState_StateToJSON(object: SotState_State): string;
|
|
1846
2297
|
export declare const BinlogRecord: MessageFns<BinlogRecord>;
|
|
1847
2298
|
export declare const LogEntry: MessageFns<LogEntry>;
|
|
2299
|
+
export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
|
|
2300
|
+
export declare const KernelLogEntry_KeyValuePair: MessageFns<KernelLogEntry_KeyValuePair>;
|
|
1848
2301
|
export declare const MotionInput: MessageFns<MotionInput>;
|
|
1849
2302
|
export declare const Lights: MessageFns<Lights>;
|
|
1850
2303
|
export declare const Laser: MessageFns<Laser>;
|
|
@@ -1904,6 +2357,7 @@ export declare const IperfStatus: MessageFns<IperfStatus>;
|
|
|
1904
2357
|
export declare const NStreamers: MessageFns<NStreamers>;
|
|
1905
2358
|
export declare const TiltAngle: MessageFns<TiltAngle>;
|
|
1906
2359
|
export declare const TiltVelocity: MessageFns<TiltVelocity>;
|
|
2360
|
+
export declare const CvModelInfo: MessageFns<CvModelInfo>;
|
|
1907
2361
|
export declare const DroneInfo: MessageFns<DroneInfo>;
|
|
1908
2362
|
export declare const ErrorFlags: MessageFns<ErrorFlags>;
|
|
1909
2363
|
export declare const CameraParameters: MessageFns<CameraParameters>;
|
|
@@ -1930,6 +2384,23 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
|
|
|
1930
2384
|
export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
|
|
1931
2385
|
export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
|
|
1932
2386
|
export declare const CPUInfo: MessageFns<CPUInfo>;
|
|
2387
|
+
export declare const CpuCoreLoad: MessageFns<CpuCoreLoad>;
|
|
2388
|
+
export declare const GpuInfo: MessageFns<GpuInfo>;
|
|
2389
|
+
export declare const DlaInfo: MessageFns<DlaInfo>;
|
|
2390
|
+
export declare const MemoryInfo: MessageFns<MemoryInfo>;
|
|
2391
|
+
export declare const ThermalZone: MessageFns<ThermalZone>;
|
|
2392
|
+
export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
|
|
2393
|
+
export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
|
|
2394
|
+
export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
|
|
2395
|
+
export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
|
|
2396
|
+
export declare const BoundingBox: MessageFns<BoundingBox>;
|
|
2397
|
+
export declare const SegmentationMask: MessageFns<SegmentationMask>;
|
|
2398
|
+
export declare const ObjectDetection: MessageFns<ObjectDetection>;
|
|
2399
|
+
export declare const ModelDetections: MessageFns<ModelDetections>;
|
|
2400
|
+
export declare const FilterMessage: MessageFns<FilterMessage>;
|
|
2401
|
+
export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
|
|
2402
|
+
export declare const OperatorInfo: MessageFns<OperatorInfo>;
|
|
2403
|
+
export declare const SotState: MessageFns<SotState>;
|
|
1933
2404
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
1934
2405
|
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
2406
|
[K in keyof T]?: DeepPartial<T[K]>;
|