@blueyerobotics/protocol-definitions 3.2.0-66350af4 → 3.2.0-6aa68244

package/dist/message_formats.d.ts

@@ -268,6 +268,18 @@ export declare enum StreamingProtocol {
 }
 export declare function streamingProtocolFromJSON(object: any): StreamingProtocol;
 export declare function streamingProtocolToJSON(object: StreamingProtocol): string;
+/** Recording video codec. */
+export declare enum RecordingCodec {
+    /** RECORDING_CODEC_UNSPECIFIED - Use platform default (H.264). */
+    RECORDING_CODEC_UNSPECIFIED = 0,
+    /** RECORDING_CODEC_H264 - H.264/AVC codec. Wider compatibility with players/editors. */
+    RECORDING_CODEC_H264 = 1,
+    /** RECORDING_CODEC_H265 - H.265/HEVC codec. Better compression, limited compatibility. Ultra only. */
+    RECORDING_CODEC_H265 = 2,
+    UNRECOGNIZED = -1
+}
+export declare function recordingCodecFromJSON(object: any): RecordingCodec;
+export declare function recordingCodecToJSON(object: RecordingCodec): string;
 /** Available temperature units. */
 export declare enum TemperatureUnit {
     /** TEMPERATURE_UNIT_UNSPECIFIED - Temperature unit not specified. */
@@ -521,6 +533,18 @@ export declare enum MultibeamFrequencyMode {
 }
 export declare function multibeamFrequencyModeFromJSON(object: any): MultibeamFrequencyMode;
 export declare function multibeamFrequencyModeToJSON(object: MultibeamFrequencyMode): string;
+/** Thermal zone identifiers. */
+export declare enum ThermalZoneId {
+    /** THERMAL_ZONE_ID_UNSPECIFIED - Unspecified thermal zone. */
+    THERMAL_ZONE_ID_UNSPECIFIED = 0,
+    /** THERMAL_ZONE_ID_TJ - Junction temperature (Tj). */
+    THERMAL_ZONE_ID_TJ = 1,
+    /** THERMAL_ZONE_ID_CANISTER - Canister temperature. */
+    THERMAL_ZONE_ID_CANISTER = 2,
+    UNRECOGNIZED = -1
+}
+export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
+export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
 /**
  * Wrapper message for each entry in the drone telemetry logfile.
  *
@@ -840,7 +864,7 @@ export interface WaterTemperature {
     /** Water temperature (°C). */
     value: number;
 }
-/** CPU temperature. */
+/** CPU temperature (deprecated, use SystemPerformanceInfo.thermal_zones instead). */
 export interface CPUTemperature {
     /** CPU temperature (°C). */
     value: number;
@@ -1590,6 +1614,13 @@ export interface CameraParameters {
      * The Blueye App allows users to set values between 500 and 1460.
      */
     mtuSize: number;
+    /** Recording video codec. If unset, uses platform default. */
+    recordingCodec: RecordingCodec;
+    /**
+     * Recording bitrate in bits/sec. If 0 or unset, a default is computed based
+     * on resolution, framerate, and encoding. Set explicitly to override.
+     */
+    recordingBitrate: number;
 }
 /**
  * Overlay parameters.
@@ -1955,7 +1986,7 @@ export interface PersistentStorageSettings {
     accCalibration: boolean;
 }
 /**
- * CPU information.
+ * CPU information (deprecated, use SystemPerformanceInfo instead).
  *
  * Contains information about the CPU load and memory usage of the drone.
  */
@@ -1971,6 +2002,119 @@ export interface CPUInfo {
     /** Communication queue load (0..1). */
     commQueueLoad: number;
 }
+/** Per-core CPU utilization. */
+export interface CpuCoreLoad {
+    /** Core index (0-based). */
+    coreIndex: number;
+    /** Core load (0..1). */
+    load: number;
+    /** Current clock frequency (MHz). */
+    frequencyMhz: number;
+}
+/** GPU utilization and status. */
+export interface GpuInfo {
+    /** GPU load (0..1). */
+    load: number;
+    /** Current GPU clock frequency (MHz). */
+    frequencyMhz: number;
+}
+/**
+ * Deep Learning Accelerator (DLA) utilization.
+ *
+ * Jetson Orin NX has two DLA engines used for inference offload.
+ */
+export interface DlaInfo {
+    /** DLA engine index (0-based). */
+    engineIndex: number;
+    /** DLA engine load (0..1). */
+    load: number;
+    /** Core clock frequency (MHz). 0 when disabled. */
+    frequencyMhz: number;
+    /** True when the DLA engine is actively processing. */
+    enabled: boolean;
+    /** Falcon microcontroller clock frequency (MHz). 0 when disabled. */
+    falconFrequencyMhz: number;
+}
+/** System memory information. */
+export interface MemoryInfo {
+    /** Total RAM (bytes). */
+    totalBytes: number;
+    /** Used RAM (bytes). */
+    usedBytes: number;
+    /** Cached RAM (bytes). */
+    cachedBytes: number;
+    /** Memory bus utilization (0..1). i.MX only. */
+    busLoad: number;
+}
+/** Thermal zone reading. */
+export interface ThermalZone {
+    /** Thermal zone identifier. */
+    zone: ThermalZoneId;
+    /** Temperature (°C). */
+    temperature: number;
+}
+/** Video codec engine status. */
+export interface VideoCodecInfo {
+    /** Jetson only (NVENC/NVDEC/NVJPG/VIC devfreq). */
+    encoderActive: boolean;
+    /** Video encoder clock frequency (MHz). */
+    encoderFrequencyMhz: number;
+    /** Video decoder (NVDEC) is active. */
+    decoderActive: boolean;
+    /** Video decoder clock frequency (MHz). */
+    decoderFrequencyMhz: number;
+    /** JPEG engine (NVJPG) is active. */
+    nvjpgActive: boolean;
+    /** JPEG engine clock frequency (MHz). */
+    nvjpgFrequencyMhz: number;
+    /** Video Image Compositor (VIC) is active. */
+    vicActive: boolean;
+    /** VIC clock frequency (MHz). */
+    vicFrequencyMhz: number;
+    /** i.MX only (CODA VPU). */
+    vpuActive: boolean;
+    /** VPU AXI clock frequency (MHz). */
+    vpuFrequencyMhz: number;
+    /** Cumulative VPU_CODEC_IRQ count. */
+    vpuCodecIrqCount: number;
+    /** Cumulative VPU_JPG_IRQ count. */
+    vpuJpgIrqCount: number;
+}
+/**
+ * System performance information.
+ *
+ * Comprehensive performance metrics for the drone's compute platform.
+ * Covers CPU, GPU, DLA, memory, thermals, and video codec utilization.
+ * Fields not applicable to a platform are left at their zero/empty defaults.
+ */
+export interface SystemPerformanceInfo {
+    /** Per-core CPU utilization. */
+    cpuCores: CpuCoreLoad[];
+    /** Mean CPU utilization across all cores (0..1). */
+    cpuUtilization: number;
+    /** GPU utilization. */
+    gpu: GpuInfo | undefined;
+    /** DLA engine utilization (Jetson only). */
+    dlaEngines: DlaInfo[];
+    /** RAM usage. */
+    memory: MemoryInfo | undefined;
+    /** All thermal zone readings. */
+    thermalZones: ThermalZone[];
+    /** Video encoder/decoder status. */
+    videoCodec: VideoCodecInfo | undefined;
+    /** Main queue load (0..1). */
+    mainQueueLoad: number;
+    /** Guestport queue load (0..1). */
+    guestportQueueLoad: number;
+    /** Communication queue load (0..1). */
+    commQueueLoad: number;
+    /** Camera queue load (0..1). */
+    cameraQueueLoad: number;
+    /** Overlay queue load (0..1). */
+    overlayQueueLoad: number;
+    /** Position observer queue load (0..1). */
+    positionObserverQueueLoad: number;
+}
 /**
  * Surface Unit battery information.
  *
@@ -2037,6 +2181,10 @@ export interface ObjectDetections {
     detections: ObjectDetection[];
     /** Which camera the detections are from. */
     camera: Camera;
+    /** Width of the source image (px). */
+    imageWidth: number;
+    /** Height of the source image (px). */
+    imageHeight: number;
 }
 /** Generic filter settings. */
 export interface FilterMessage {
@@ -2159,6 +2307,13 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
 export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
 export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
 export declare const CPUInfo: MessageFns<CPUInfo>;
+export declare const CpuCoreLoad: MessageFns<CpuCoreLoad>;
+export declare const GpuInfo: MessageFns<GpuInfo>;
+export declare const DlaInfo: MessageFns<DlaInfo>;
+export declare const MemoryInfo: MessageFns<MemoryInfo>;
+export declare const ThermalZone: MessageFns<ThermalZone>;
+export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
+export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
 export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
 export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
 export declare const BoundingBox: MessageFns<BoundingBox>;