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