@blueyerobotics/protocol-definitions 3.3.0-1fa96b97 → 3.3.0-369b31cc
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/dist/message_formats.d.ts +129 -1
- package/dist/message_formats.js +852 -4
- package/dist/req_rep.d.ts +21 -1
- package/dist/req_rep.js +181 -0
- package/dist/telemetry.d.ts +7 -1
- package/dist/telemetry.js +55 -2
- package/package.json +1 -1
|
@@ -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;
|
|
@@ -552,6 +554,36 @@ export declare enum NavigationSensorID {
|
|
|
552
554
|
}
|
|
553
555
|
export declare function navigationSensorIDFromJSON(object: any): NavigationSensorID;
|
|
554
556
|
export declare function navigationSensorIDToJSON(object: NavigationSensorID): string;
|
|
557
|
+
/** Position fix mode reported by the NMEA GSA sentence. */
|
|
558
|
+
export declare enum GnssFixMode {
|
|
559
|
+
/** GNSS_FIX_MODE_UNSPECIFIED - No GSA sentence has been received. */
|
|
560
|
+
GNSS_FIX_MODE_UNSPECIFIED = 0,
|
|
561
|
+
/** GNSS_FIX_MODE_NO_FIX - The receiver has no position fix. */
|
|
562
|
+
GNSS_FIX_MODE_NO_FIX = 1,
|
|
563
|
+
/** GNSS_FIX_MODE_2D - Horizontal fix only, no usable altitude. */
|
|
564
|
+
GNSS_FIX_MODE_2D = 2,
|
|
565
|
+
/** GNSS_FIX_MODE_3D - Full three dimensional fix. */
|
|
566
|
+
GNSS_FIX_MODE_3D = 3,
|
|
567
|
+
UNRECOGNIZED = -1
|
|
568
|
+
}
|
|
569
|
+
export declare function gnssFixModeFromJSON(object: any): GnssFixMode;
|
|
570
|
+
export declare function gnssFixModeToJSON(object: GnssFixMode): string;
|
|
571
|
+
/** GNSS constellation a satellite belongs to. */
|
|
572
|
+
export declare enum GnssConstellation {
|
|
573
|
+
/** GNSS_CONSTELLATION_UNSPECIFIED - Unspecified. */
|
|
574
|
+
GNSS_CONSTELLATION_UNSPECIFIED = 0,
|
|
575
|
+
/** GNSS_CONSTELLATION_GPS - GPS. */
|
|
576
|
+
GNSS_CONSTELLATION_GPS = 1,
|
|
577
|
+
/** GNSS_CONSTELLATION_GLONASS - GLONASS. */
|
|
578
|
+
GNSS_CONSTELLATION_GLONASS = 2,
|
|
579
|
+
/** GNSS_CONSTELLATION_GALILEO - Galileo. */
|
|
580
|
+
GNSS_CONSTELLATION_GALILEO = 3,
|
|
581
|
+
/** GNSS_CONSTELLATION_BEIDOU - BeiDou. */
|
|
582
|
+
GNSS_CONSTELLATION_BEIDOU = 4,
|
|
583
|
+
UNRECOGNIZED = -1
|
|
584
|
+
}
|
|
585
|
+
export declare function gnssConstellationFromJSON(object: any): GnssConstellation;
|
|
586
|
+
export declare function gnssConstellationToJSON(object: GnssConstellation): string;
|
|
555
587
|
/** Status for guest port devices that can be attached and detached. */
|
|
556
588
|
export declare enum GuestPortDetachStatus {
|
|
557
589
|
/** GUEST_PORT_DETACH_STATUS_UNSPECIFIED - Unspecified (Default for non-detachable devices). */
|
|
@@ -752,7 +784,7 @@ export interface MotionInput {
|
|
|
752
784
|
roll: number;
|
|
753
785
|
/** Pitch down (negative) or up (positive). (-1..1). */
|
|
754
786
|
pitch: number;
|
|
755
|
-
/**
|
|
787
|
+
/** Clockwise (positive) and counter-clockwise (negative) rotation (-1..1). */
|
|
756
788
|
yaw: number;
|
|
757
789
|
/** Modifier used to reduce the speed of the motion (0..1). */
|
|
758
790
|
slow: number;
|
|
@@ -1902,6 +1934,8 @@ export interface ErrorFlags {
|
|
|
1902
1934
|
dvlThermalProtectionMode: boolean;
|
|
1903
1935
|
/** GP protection has been triggered at boot or faulty DVL. */
|
|
1904
1936
|
dvlNoPower: boolean;
|
|
1937
|
+
/** DVL firmware speaks a protocol version Blunux does not support. */
|
|
1938
|
+
dvlProtocolUnsupported: boolean;
|
|
1905
1939
|
/** USB disconnect. */
|
|
1906
1940
|
usbDisconnect: boolean;
|
|
1907
1941
|
/** Video URB error. */
|
|
@@ -2041,6 +2075,86 @@ export interface NavigationSensorStatus {
|
|
|
2041
2075
|
/** Global position from sensor. */
|
|
2042
2076
|
globalPosition: LatLongPosition | undefined;
|
|
2043
2077
|
}
|
|
2078
|
+
/** Satellite tracked by the Blueye GNSS receiver. */
|
|
2079
|
+
export interface GnssSatellite {
|
|
2080
|
+
/** Constellation the satellite belongs to. */
|
|
2081
|
+
constellation: GnssConstellation;
|
|
2082
|
+
/** Satellite id within the constellation. */
|
|
2083
|
+
satelliteId: number;
|
|
2084
|
+
/** Carrier to noise ratio (dB-Hz). */
|
|
2085
|
+
snr: number;
|
|
2086
|
+
/** Elevation above the horizon (°, 0..90), or -1 when the receiver did not report it. */
|
|
2087
|
+
elevation: number;
|
|
2088
|
+
/** Azimuth clockwise from true north (°, 0..359), or -1 when the receiver did not report it. */
|
|
2089
|
+
azimuth: number;
|
|
2090
|
+
/** Whether GSA lists the satellite as used in the fix. Only meaningful if is_used_in_fix_valid. */
|
|
2091
|
+
usedInFix: boolean;
|
|
2092
|
+
}
|
|
2093
|
+
/** Status of the onboard Blueye GNSS receiver and its driver. */
|
|
2094
|
+
export interface GnssStatus {
|
|
2095
|
+
/** True when the receiver is connected and producing NMEA sentences. */
|
|
2096
|
+
receiverConnected: boolean;
|
|
2097
|
+
/** NMEA GGA fix quality indicator (0 = no fix). */
|
|
2098
|
+
fixQuality: number;
|
|
2099
|
+
/** True when the receiver reports a usable position fix. */
|
|
2100
|
+
isValid: boolean;
|
|
2101
|
+
/** Number of satellites used in the position fix. */
|
|
2102
|
+
satellitesUsed: number;
|
|
2103
|
+
/** Satellites in the satellites list: those with a signal in the latest GSV burst. */
|
|
2104
|
+
satellitesTracked: number;
|
|
2105
|
+
/** Satellites predicted above the horizon, over all constellations; needs no signal. */
|
|
2106
|
+
satellitesInView: number;
|
|
2107
|
+
/** True when GSA could be attributed to a constellation, making used_in_fix usable. */
|
|
2108
|
+
isUsedInFixValid: boolean;
|
|
2109
|
+
/** Fix mode from GSA (2D/3D). */
|
|
2110
|
+
fixMode: GnssFixMode;
|
|
2111
|
+
/** Horizontal dilution of precision. */
|
|
2112
|
+
hdop: number;
|
|
2113
|
+
/** Position (3D) dilution of precision, from GSA. */
|
|
2114
|
+
pdop: number;
|
|
2115
|
+
/** Vertical dilution of precision, from GSA. */
|
|
2116
|
+
vdop: number;
|
|
2117
|
+
/** Reported global position. */
|
|
2118
|
+
globalPosition: LatLongPosition | undefined;
|
|
2119
|
+
/** Altitude above mean sea level (m), from GGA. */
|
|
2120
|
+
altitude: number;
|
|
2121
|
+
/** Standard deviation of the latitude (m). Meaningless unless is_accuracy_valid. */
|
|
2122
|
+
stddevLatitude: number;
|
|
2123
|
+
/** Standard deviation of the longitude (m). Meaningless unless is_accuracy_valid. */
|
|
2124
|
+
stddevLongitude: number;
|
|
2125
|
+
/** Standard deviation of the altitude (m). Meaningless unless is_accuracy_valid. */
|
|
2126
|
+
stddevAltitude: number;
|
|
2127
|
+
/** Semi-major axis of the horizontal error ellipse (m). */
|
|
2128
|
+
stddevSemiMajor: number;
|
|
2129
|
+
/** Semi-minor axis of the horizontal error ellipse (m). */
|
|
2130
|
+
stddevSemiMinor: number;
|
|
2131
|
+
/** Orientation of the semi-major axis, clockwise from true north (°). */
|
|
2132
|
+
errorEllipseOrientation: number;
|
|
2133
|
+
/** RMS of the range residuals (m), from GST. */
|
|
2134
|
+
rangeRms: number;
|
|
2135
|
+
/** True once the receiver has reported a GST sentence to derive the deviations from. */
|
|
2136
|
+
isAccuracyValid: boolean;
|
|
2137
|
+
/** Course over ground (°). Meaningless unless is_course_valid. */
|
|
2138
|
+
courseOverGround: number;
|
|
2139
|
+
/** True when the fix is valid and the receiver actually reported a course. */
|
|
2140
|
+
isCourseValid: boolean;
|
|
2141
|
+
/** Speed over ground (m/s). */
|
|
2142
|
+
speedOverGround: number;
|
|
2143
|
+
/** Age of the differential corrections (s), or -1 without DGPS/RTK. */
|
|
2144
|
+
differentialAge: number;
|
|
2145
|
+
/** Id of the station supplying the differential corrections, or -1 when absent. */
|
|
2146
|
+
differentialStation: number;
|
|
2147
|
+
/** Serial baud rate in use (bit/s). */
|
|
2148
|
+
baudRate: number;
|
|
2149
|
+
/** Times the driver has reconnected to the receiver since boot. */
|
|
2150
|
+
reconnectCount: number;
|
|
2151
|
+
/** Receive errors seen by the driver since boot. */
|
|
2152
|
+
receiveErrorCount: number;
|
|
2153
|
+
/** Time since the last NMEA sentence was received (s). */
|
|
2154
|
+
timeSinceLastSentence: number;
|
|
2155
|
+
/** Satellites currently tracked with signal strength. */
|
|
2156
|
+
satellites: GnssSatellite[];
|
|
2157
|
+
}
|
|
2044
2158
|
/** Information about a device connected to one of the guest ports. */
|
|
2045
2159
|
export interface GuestPortDevice {
|
|
2046
2160
|
/** Blueye device identifier. */
|
|
@@ -2337,6 +2451,17 @@ export interface MultibeamDiscovery {
|
|
|
2337
2451
|
/** Error flags specific for the connected multibeam device. */
|
|
2338
2452
|
errorFlags: MultibeamErrorFlags | undefined;
|
|
2339
2453
|
}
|
|
2454
|
+
/**
|
|
2455
|
+
* Color filter used to render the multibeam sonar fan.
|
|
2456
|
+
*
|
|
2457
|
+
* The fan renderer maps each echo intensity (0..255) to a color through this
|
|
2458
|
+
* lookup table. The drone keeps the last filter received in memory and applies
|
|
2459
|
+
* it to the sonar RTSP stream; grayscale is used until one is set.
|
|
2460
|
+
*/
|
|
2461
|
+
export interface MultibeamColorFilter {
|
|
2462
|
+
/** 768 bytes: 256 consecutive R,G,B triplets, indexed by echo intensity. */
|
|
2463
|
+
rgb: Uint8Array;
|
|
2464
|
+
}
|
|
2340
2465
|
/** Error flags for multibeam sonar devices. */
|
|
2341
2466
|
export interface MultibeamErrorFlags {
|
|
2342
2467
|
/**
|
|
@@ -2863,6 +2988,8 @@ export declare const ErrorFlags: MessageFns<ErrorFlags>;
|
|
|
2863
2988
|
export declare const CameraParameters: MessageFns<CameraParameters>;
|
|
2864
2989
|
export declare const OverlayParameters: MessageFns<OverlayParameters>;
|
|
2865
2990
|
export declare const NavigationSensorStatus: MessageFns<NavigationSensorStatus>;
|
|
2991
|
+
export declare const GnssSatellite: MessageFns<GnssSatellite>;
|
|
2992
|
+
export declare const GnssStatus: MessageFns<GnssStatus>;
|
|
2866
2993
|
export declare const GuestPortDevice: MessageFns<GuestPortDevice>;
|
|
2867
2994
|
export declare const GuestPortDeviceList: MessageFns<GuestPortDeviceList>;
|
|
2868
2995
|
export declare const GuestPortConnectorInfo: MessageFns<GuestPortConnectorInfo>;
|
|
@@ -2879,6 +3006,7 @@ export declare const MedusaSpectrometerData: MessageFns<MedusaSpectrometerData>;
|
|
|
2879
3006
|
export declare const MultibeamPing: MessageFns<MultibeamPing>;
|
|
2880
3007
|
export declare const MultibeamConfig: MessageFns<MultibeamConfig>;
|
|
2881
3008
|
export declare const MultibeamDiscovery: MessageFns<MultibeamDiscovery>;
|
|
3009
|
+
export declare const MultibeamColorFilter: MessageFns<MultibeamColorFilter>;
|
|
2882
3010
|
export declare const MultibeamErrorFlags: MessageFns<MultibeamErrorFlags>;
|
|
2883
3011
|
export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
|
|
2884
3012
|
export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
|