@blueyerobotics/protocol-definitions 3.3.0-991d560c → 3.3.0-ba79714d

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.
@@ -138,6 +138,8 @@ export declare enum NotificationType {
138
138
  NOTIFICATION_TYPE_DVL_THERMAL_PROTECTION_MODE_DETECTED = 32,
139
139
  /** NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED - Video partition not mounted. */
140
140
  NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED = 33,
141
+ /** NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED - DVL firmware speaks a protocol version Blunux does not support. */
142
+ NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED = 34,
141
143
  UNRECOGNIZED = -1
142
144
  }
143
145
  export declare function notificationTypeFromJSON(object: any): NotificationType;
@@ -352,7 +354,10 @@ export declare function thicknessUnitFromJSON(object: any): ThicknessUnit;
352
354
  export declare function thicknessUnitToJSON(object: ThicknessUnit): string;
353
355
  /** Available font sizes for overlay text elements. */
354
356
  export declare enum FontSize {
355
- /** FONT_SIZE_UNSPECIFIED - Font size not specified. */
357
+ /**
358
+ * FONT_SIZE_UNSPECIFIED - Font size and margins derived from the recording resolution (Blunux >= 5.2).
359
+ * Older firmware defaults to 25px.
360
+ */
356
361
  FONT_SIZE_UNSPECIFIED = 0,
357
362
  /** FONT_SIZE_PX15 - 15 px. */
358
363
  FONT_SIZE_PX15 = 1,
@@ -479,6 +484,8 @@ export declare enum GuestPortDeviceID {
479
484
  GUEST_PORT_DEVICE_ID_CYGNUS_MINI_ROV_THICKNESS_GAUGE_RS232 = 49,
480
485
  /** GUEST_PORT_DEVICE_ID_WATERLINKED_DVL_A100 - Waterlinked DVL A100. */
481
486
  GUEST_PORT_DEVICE_ID_WATERLINKED_DVL_A100 = 50,
487
+ /** GUEST_PORT_DEVICE_ID_OUTLAND_TECHNOLOGY_MP200 - Outland Technology MP-200 Manipulator. */
488
+ GUEST_PORT_DEVICE_ID_OUTLAND_TECHNOLOGY_MP200 = 51,
482
489
  UNRECOGNIZED = -1
483
490
  }
484
491
  export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
@@ -552,6 +559,36 @@ export declare enum NavigationSensorID {
552
559
  }
553
560
  export declare function navigationSensorIDFromJSON(object: any): NavigationSensorID;
554
561
  export declare function navigationSensorIDToJSON(object: NavigationSensorID): string;
562
+ /** Position fix mode reported by the NMEA GSA sentence. */
563
+ export declare enum GnssFixMode {
564
+ /** GNSS_FIX_MODE_UNSPECIFIED - No GSA sentence has been received. */
565
+ GNSS_FIX_MODE_UNSPECIFIED = 0,
566
+ /** GNSS_FIX_MODE_NO_FIX - The receiver has no position fix. */
567
+ GNSS_FIX_MODE_NO_FIX = 1,
568
+ /** GNSS_FIX_MODE_2D - Horizontal fix only, no usable altitude. */
569
+ GNSS_FIX_MODE_2D = 2,
570
+ /** GNSS_FIX_MODE_3D - Full three dimensional fix. */
571
+ GNSS_FIX_MODE_3D = 3,
572
+ UNRECOGNIZED = -1
573
+ }
574
+ export declare function gnssFixModeFromJSON(object: any): GnssFixMode;
575
+ export declare function gnssFixModeToJSON(object: GnssFixMode): string;
576
+ /** GNSS constellation a satellite belongs to. */
577
+ export declare enum GnssConstellation {
578
+ /** GNSS_CONSTELLATION_UNSPECIFIED - Unspecified. */
579
+ GNSS_CONSTELLATION_UNSPECIFIED = 0,
580
+ /** GNSS_CONSTELLATION_GPS - GPS. */
581
+ GNSS_CONSTELLATION_GPS = 1,
582
+ /** GNSS_CONSTELLATION_GLONASS - GLONASS. */
583
+ GNSS_CONSTELLATION_GLONASS = 2,
584
+ /** GNSS_CONSTELLATION_GALILEO - Galileo. */
585
+ GNSS_CONSTELLATION_GALILEO = 3,
586
+ /** GNSS_CONSTELLATION_BEIDOU - BeiDou. */
587
+ GNSS_CONSTELLATION_BEIDOU = 4,
588
+ UNRECOGNIZED = -1
589
+ }
590
+ export declare function gnssConstellationFromJSON(object: any): GnssConstellation;
591
+ export declare function gnssConstellationToJSON(object: GnssConstellation): string;
555
592
  /** Status for guest port devices that can be attached and detached. */
556
593
  export declare enum GuestPortDetachStatus {
557
594
  /** GUEST_PORT_DETACH_STATUS_UNSPECIFIED - Unspecified (Default for non-detachable devices). */
@@ -752,7 +789,7 @@ export interface MotionInput {
752
789
  roll: number;
753
790
  /** Pitch down (negative) or up (positive). (-1..1). */
754
791
  pitch: number;
755
- /** Left (positive) and right (negative) movement (-1..1). */
792
+ /** Clockwise (positive) and counter-clockwise (negative) rotation (-1..1). */
756
793
  yaw: number;
757
794
  /** Modifier used to reduce the speed of the motion (0..1). */
758
795
  slow: number;
@@ -1085,6 +1122,20 @@ export interface CanisterHumidity {
1085
1122
  /** Air humidity (%). */
1086
1123
  humidity: number;
1087
1124
  }
1125
+ /** Sensor readings inside the X7 power canister. */
1126
+ export interface PowerCanister {
1127
+ /** Front ESC board; absent when no recent reading is available. */
1128
+ frontEsc: PowerCanister_Sensors | undefined;
1129
+ /** Rear ESC board; absent when no recent reading is available. */
1130
+ rearEsc: PowerCanister_Sensors | undefined;
1131
+ }
1132
+ /** Sensor readings from an ESC board. */
1133
+ export interface PowerCanister_Sensors {
1134
+ /** Temperature (°C). */
1135
+ temperature: number;
1136
+ /** Relative humidity (%). */
1137
+ humidity: number;
1138
+ }
1088
1139
  /** Essential battery information. */
1089
1140
  export interface Battery {
1090
1141
  /** Battery voltage (V). */
@@ -1902,12 +1953,22 @@ export interface ErrorFlags {
1902
1953
  dvlThermalProtectionMode: boolean;
1903
1954
  /** GP protection has been triggered at boot or faulty DVL. */
1904
1955
  dvlNoPower: boolean;
1956
+ /** DVL firmware speaks a protocol version Blunux does not support. */
1957
+ dvlProtocolUnsupported: boolean;
1905
1958
  /** USB disconnect. */
1906
1959
  usbDisconnect: boolean;
1907
1960
  /** Video URB error. */
1908
1961
  videoUrbError: boolean;
1909
1962
  /** Hardware not supported on current blunux version. */
1910
1963
  hardwareNotSupported: boolean;
1964
+ /** MPU 1 unavailable at observer startup. */
1965
+ imu1: boolean;
1966
+ /** MPU 2 unavailable at observer startup. */
1967
+ imu2: boolean;
1968
+ /** HP IMU unavailable on X3 Ultra or X7. */
1969
+ imuHp: boolean;
1970
+ /** No attitude source: manual body-frame control only. */
1971
+ imuAttitude: boolean;
1911
1972
  }
1912
1973
  /** Camera parameters. */
1913
1974
  export interface CameraParameters {
@@ -2007,11 +2068,14 @@ export interface OverlayParameters {
2007
2068
  thicknessUnit: ThicknessUnit;
2008
2069
  /** Timezone offset from UTC (min). */
2009
2070
  timezoneOffset: number;
2010
- /** Horizontal margins of text elements (px). */
2071
+ /** Horizontal margins of text elements (px). Ignored when font_size is FONT_SIZE_UNSPECIFIED (Blunux >= 5.2). */
2011
2072
  marginWidth: number;
2012
- /** Vertical margins of text elements (px). */
2073
+ /** Vertical margins of text elements (px). Ignored when font_size is FONT_SIZE_UNSPECIFIED (Blunux >= 5.2). */
2013
2074
  marginHeight: number;
2014
- /** Font size of text elements. */
2075
+ /**
2076
+ * Font size of text elements. FONT_SIZE_UNSPECIFIED derives font size and margins from the
2077
+ * recording resolution (Blunux >= 5.2). Older firmware defaults to 25px.
2078
+ */
2015
2079
  fontSize: FontSize;
2016
2080
  /** Optional title. */
2017
2081
  title: string;
@@ -2041,6 +2105,86 @@ export interface NavigationSensorStatus {
2041
2105
  /** Global position from sensor. */
2042
2106
  globalPosition: LatLongPosition | undefined;
2043
2107
  }
2108
+ /** Satellite tracked by the Blueye GNSS receiver. */
2109
+ export interface GnssSatellite {
2110
+ /** Constellation the satellite belongs to. */
2111
+ constellation: GnssConstellation;
2112
+ /** Satellite id within the constellation. */
2113
+ satelliteId: number;
2114
+ /** Carrier to noise ratio (dB-Hz). */
2115
+ snr: number;
2116
+ /** Elevation above the horizon (°, 0..90), or -1 when the receiver did not report it. */
2117
+ elevation: number;
2118
+ /** Azimuth clockwise from true north (°, 0..359), or -1 when the receiver did not report it. */
2119
+ azimuth: number;
2120
+ /** Whether GSA lists the satellite as used in the fix. Only meaningful if is_used_in_fix_valid. */
2121
+ usedInFix: boolean;
2122
+ }
2123
+ /** Status of the onboard Blueye GNSS receiver and its driver. */
2124
+ export interface GnssStatus {
2125
+ /** True when the receiver is connected and producing NMEA sentences. */
2126
+ receiverConnected: boolean;
2127
+ /** NMEA GGA fix quality indicator (0 = no fix). */
2128
+ fixQuality: number;
2129
+ /** True when the receiver reports a usable position fix. */
2130
+ isValid: boolean;
2131
+ /** Number of satellites used in the position fix. */
2132
+ satellitesUsed: number;
2133
+ /** Satellites in the satellites list: those with a signal in the latest GSV burst. */
2134
+ satellitesTracked: number;
2135
+ /** Satellites predicted above the horizon, over all constellations; needs no signal. */
2136
+ satellitesInView: number;
2137
+ /** True when GSA could be attributed to a constellation, making used_in_fix usable. */
2138
+ isUsedInFixValid: boolean;
2139
+ /** Fix mode from GSA (2D/3D). */
2140
+ fixMode: GnssFixMode;
2141
+ /** Horizontal dilution of precision. */
2142
+ hdop: number;
2143
+ /** Position (3D) dilution of precision, from GSA. */
2144
+ pdop: number;
2145
+ /** Vertical dilution of precision, from GSA. */
2146
+ vdop: number;
2147
+ /** Reported global position. */
2148
+ globalPosition: LatLongPosition | undefined;
2149
+ /** Altitude above mean sea level (m), from GGA. */
2150
+ altitude: number;
2151
+ /** Standard deviation of the latitude (m). Meaningless unless is_accuracy_valid. */
2152
+ stddevLatitude: number;
2153
+ /** Standard deviation of the longitude (m). Meaningless unless is_accuracy_valid. */
2154
+ stddevLongitude: number;
2155
+ /** Standard deviation of the altitude (m). Meaningless unless is_accuracy_valid. */
2156
+ stddevAltitude: number;
2157
+ /** Semi-major axis of the horizontal error ellipse (m). */
2158
+ stddevSemiMajor: number;
2159
+ /** Semi-minor axis of the horizontal error ellipse (m). */
2160
+ stddevSemiMinor: number;
2161
+ /** Orientation of the semi-major axis, clockwise from true north (°). */
2162
+ errorEllipseOrientation: number;
2163
+ /** RMS of the range residuals (m), from GST. */
2164
+ rangeRms: number;
2165
+ /** True once the receiver has reported a GST sentence to derive the deviations from. */
2166
+ isAccuracyValid: boolean;
2167
+ /** Course over ground (°). Meaningless unless is_course_valid. */
2168
+ courseOverGround: number;
2169
+ /** True when the fix is valid and the receiver actually reported a course. */
2170
+ isCourseValid: boolean;
2171
+ /** Speed over ground (m/s). */
2172
+ speedOverGround: number;
2173
+ /** Age of the differential corrections (s), or -1 without DGPS/RTK. */
2174
+ differentialAge: number;
2175
+ /** Id of the station supplying the differential corrections, or -1 when absent. */
2176
+ differentialStation: number;
2177
+ /** Serial baud rate in use (bit/s). */
2178
+ baudRate: number;
2179
+ /** Times the driver has reconnected to the receiver since boot. */
2180
+ reconnectCount: number;
2181
+ /** Receive errors seen by the driver since boot. */
2182
+ receiveErrorCount: number;
2183
+ /** Time since the last NMEA sentence was received (s). */
2184
+ timeSinceLastSentence: number;
2185
+ /** Satellites currently tracked with signal strength. */
2186
+ satellites: GnssSatellite[];
2187
+ }
2044
2188
  /** Information about a device connected to one of the guest ports. */
2045
2189
  export interface GuestPortDevice {
2046
2190
  /** Blueye device identifier. */
@@ -2337,6 +2481,17 @@ export interface MultibeamDiscovery {
2337
2481
  /** Error flags specific for the connected multibeam device. */
2338
2482
  errorFlags: MultibeamErrorFlags | undefined;
2339
2483
  }
2484
+ /**
2485
+ * Color filter used to render the multibeam sonar fan.
2486
+ *
2487
+ * The fan renderer maps each echo intensity (0..255) to a color through this
2488
+ * lookup table. The drone keeps the last filter received in memory and applies
2489
+ * it to the sonar RTSP stream; grayscale is used until one is set.
2490
+ */
2491
+ export interface MultibeamColorFilter {
2492
+ /** 768 bytes: 256 consecutive R,G,B triplets, indexed by echo intensity. */
2493
+ rgb: Uint8Array;
2494
+ }
2340
2495
  /** Error flags for multibeam sonar devices. */
2341
2496
  export interface MultibeamErrorFlags {
2342
2497
  /**
@@ -2632,12 +2787,19 @@ export interface BoundingBox {
2632
2787
  height: number;
2633
2788
  }
2634
2789
  /**
2635
- * RLE-encoded binary segmentation mask relative to the bounding box.
2790
+ * RLE-encoded binary segmentation mask with its own anchor box.
2636
2791
  *
2637
2792
  * The mask bitmap has dimensions (mask_width x mask_height) covering the
2638
- * detection's bounding box area. The counts field stores run-length encoded
2639
- * data as packed uint16 little-endian: alternating background/foreground
2640
- * pixel runs starting with background.
2793
+ * mask_box region of the camera image. The counts field stores run-length
2794
+ * encoded data as packed uint16 little-endian: alternating
2795
+ * background/foreground pixel runs starting with background. Runs longer
2796
+ * than 65535 pixels are split by inserting a zero-length run of the
2797
+ * opposite class (e.g. 70000 becomes 65535, 0, 4465), so decoders need no
2798
+ * special handling — a zero-length run just toggles the class.
2799
+ *
2800
+ * Scale the mask to mask_box, not to the detection's bounding_box: the
2801
+ * bounding box may be smoothed by tracking, while mask_box is pinned to the
2802
+ * raw detection position, so the mask stays on the actual object pixels.
2641
2803
  */
2642
2804
  export interface SegmentationMask {
2643
2805
  /** Width of the RLE bitmap. */
@@ -2646,10 +2808,12 @@ export interface SegmentationMask {
2646
2808
  maskHeight: number;
2647
2809
  /** RLE counts as packed uint16 little-endian. */
2648
2810
  counts: Uint8Array;
2811
+ /** Image region the mask bitmap covers (raw detection position, never smoothed). */
2812
+ maskBox: BoundingBox | undefined;
2649
2813
  }
2650
2814
  /** A single object detection from a computer vision model. */
2651
2815
  export interface ObjectDetection {
2652
- /** Bounding box of the detected object. */
2816
+ /** Bounding box of the detected object (may be smoothed by tracking). */
2653
2817
  boundingBox: BoundingBox | undefined;
2654
2818
  /** Detection confidence score (0..1). */
2655
2819
  confidence: number;
@@ -2814,6 +2978,8 @@ export declare const WaterTemperature: MessageFns<WaterTemperature>;
2814
2978
  export declare const CPUTemperature: MessageFns<CPUTemperature>;
2815
2979
  export declare const CanisterTemperature: MessageFns<CanisterTemperature>;
2816
2980
  export declare const CanisterHumidity: MessageFns<CanisterHumidity>;
2981
+ export declare const PowerCanister: MessageFns<PowerCanister>;
2982
+ export declare const PowerCanister_Sensors: MessageFns<PowerCanister_Sensors>;
2817
2983
  export declare const Battery: MessageFns<Battery>;
2818
2984
  export declare const BatteryBQ40Z50: MessageFns<BatteryBQ40Z50>;
2819
2985
  export declare const BatteryBQ40Z50_Voltage: MessageFns<BatteryBQ40Z50_Voltage>;
@@ -2854,6 +3020,8 @@ export declare const ErrorFlags: MessageFns<ErrorFlags>;
2854
3020
  export declare const CameraParameters: MessageFns<CameraParameters>;
2855
3021
  export declare const OverlayParameters: MessageFns<OverlayParameters>;
2856
3022
  export declare const NavigationSensorStatus: MessageFns<NavigationSensorStatus>;
3023
+ export declare const GnssSatellite: MessageFns<GnssSatellite>;
3024
+ export declare const GnssStatus: MessageFns<GnssStatus>;
2857
3025
  export declare const GuestPortDevice: MessageFns<GuestPortDevice>;
2858
3026
  export declare const GuestPortDeviceList: MessageFns<GuestPortDeviceList>;
2859
3027
  export declare const GuestPortConnectorInfo: MessageFns<GuestPortConnectorInfo>;
@@ -2870,6 +3038,7 @@ export declare const MedusaSpectrometerData: MessageFns<MedusaSpectrometerData>;
2870
3038
  export declare const MultibeamPing: MessageFns<MultibeamPing>;
2871
3039
  export declare const MultibeamConfig: MessageFns<MultibeamConfig>;
2872
3040
  export declare const MultibeamDiscovery: MessageFns<MultibeamDiscovery>;
3041
+ export declare const MultibeamColorFilter: MessageFns<MultibeamColorFilter>;
2873
3042
  export declare const MultibeamErrorFlags: MessageFns<MultibeamErrorFlags>;
2874
3043
  export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
2875
3044
  export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;