@blueyerobotics/protocol-definitions 3.2.0-a48e4638 → 3.2.0-a57cd215
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/control.d.ts +19 -1
- package/dist/control.js +135 -7
- package/dist/message_formats.d.ts +225 -4
- package/dist/message_formats.js +1525 -38
- package/dist/mission_planning.d.ts +54 -0
- package/dist/mission_planning.js +243 -1
- package/dist/telemetry.d.ts +40 -2
- package/dist/telemetry.js +226 -1
- package/package.json +1 -1
package/dist/control.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
|
|
2
2
|
import { SetAquaTrollConnectionStatus, SetAquaTrollParameterUnit } from "./aquatroll";
|
|
3
|
-
import { AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, ConnectionDuration, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, WaterDensity, WeatherVaningState } from "./message_formats";
|
|
3
|
+
import { AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, CameraPanTiltZoom, ConnectionDuration, FilterMessage, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, OperatorInfo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, WaterDensity, WeatherVaningState } from "./message_formats";
|
|
4
4
|
/**
|
|
5
5
|
* Control
|
|
6
6
|
*
|
|
@@ -200,6 +200,8 @@ export interface DeactivateMultibeamCtrl {
|
|
|
200
200
|
* at which point the user entered the dive view.
|
|
201
201
|
*/
|
|
202
202
|
export interface StartDiveCtrl {
|
|
203
|
+
/** Optional information about the operator who started the dive. */
|
|
204
|
+
operatorInfo: OperatorInfo | undefined;
|
|
203
205
|
}
|
|
204
206
|
/**
|
|
205
207
|
* Message sent when the user hits the end dive button in the app.
|
|
@@ -219,6 +221,20 @@ export interface EndDiveCtrl {
|
|
|
219
221
|
*/
|
|
220
222
|
export interface FormatRemovableStorageDeviceCtrl {
|
|
221
223
|
}
|
|
224
|
+
/** Message sent when the user wants to set turbidity filter settings. */
|
|
225
|
+
export interface SetTurbidityFilterCtrl {
|
|
226
|
+
/** Message with the turbidity filter settings to set. */
|
|
227
|
+
turbidityFilter: FilterMessage | undefined;
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
* Issue a command to set the digital pan, tilt, and zoom of the main camera.
|
|
231
|
+
*
|
|
232
|
+
* Only supported on X3 Ultra.
|
|
233
|
+
*/
|
|
234
|
+
export interface CameraPanTiltZoomCtrl {
|
|
235
|
+
/** The desired pan, tilt, and zoom state. */
|
|
236
|
+
cameraPanTiltZoom: CameraPanTiltZoom | undefined;
|
|
237
|
+
}
|
|
222
238
|
export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
|
|
223
239
|
export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
|
|
224
240
|
export declare const LightsCtrl: MessageFns<LightsCtrl>;
|
|
@@ -262,6 +278,8 @@ export declare const DeactivateMultibeamCtrl: MessageFns<DeactivateMultibeamCtrl
|
|
|
262
278
|
export declare const StartDiveCtrl: MessageFns<StartDiveCtrl>;
|
|
263
279
|
export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
|
|
264
280
|
export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
|
|
281
|
+
export declare const SetTurbidityFilterCtrl: MessageFns<SetTurbidityFilterCtrl>;
|
|
282
|
+
export declare const CameraPanTiltZoomCtrl: MessageFns<CameraPanTiltZoomCtrl>;
|
|
265
283
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
266
284
|
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 {} ? {
|
|
267
285
|
[K in keyof T]?: DeepPartial<T[K]>;
|
package/dist/control.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
// protoc v3.21.12
|
|
6
6
|
// source: control.proto
|
|
7
7
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
8
|
-
exports.FormatRemovableStorageDeviceCtrl = exports.EndDiveCtrl = exports.StartDiveCtrl = exports.DeactivateMultibeamCtrl = exports.ActivateMultibeamCtrl = exports.SetMultibeamConfigCtrl = exports.SetAquaTrollConnectionStatusCtrl = exports.SetAquaTrollParameterUnitCtrl = exports.RestartGuestPortsCtrl = exports.ActivateGuestPortsCtrl = exports.DeactivateGuestPortsCtrl = exports.MultibeamServoCtrl = exports.GenericServoCtrl = exports.GripperCtrl = exports.SystemTimeCtrl = exports.PingerConfigurationCtrl = exports.WaterDensityCtrl = exports.TiltStabilizationCtrl = exports.CalibrateDvlGyroCtrl = exports.ResetOdometerCtrl = exports.ResetPositionCtrl = exports.ClearMissionCtrl = exports.PauseMissionCtrl = exports.RunMissionCtrl = exports.AutoPilotHeaveCtrl = exports.AutoPilotSurgeYawCtrl = exports.WeatherVaningCtrl = exports.StationKeepingCtrl = exports.AutoAltitudeCtrl = exports.AutoDepthCtrl = exports.AutoHeadingCtrl = exports.FinishCalibrationCtrl = exports.CancelCalibrationCtrl = exports.StartCalibrationCtrl = exports.TakePictureCtrl = exports.RecordCtrl = exports.WatchdogCtrl = exports.PilotGPSPositionCtrl = exports.LaserCtrl = exports.GuestportLightsCtrl = exports.LightsCtrl = exports.TiltVelocityCtrl = exports.MotionInputCtrl = void 0;
|
|
8
|
+
exports.CameraPanTiltZoomCtrl = exports.SetTurbidityFilterCtrl = exports.FormatRemovableStorageDeviceCtrl = exports.EndDiveCtrl = exports.StartDiveCtrl = exports.DeactivateMultibeamCtrl = exports.ActivateMultibeamCtrl = exports.SetMultibeamConfigCtrl = exports.SetAquaTrollConnectionStatusCtrl = exports.SetAquaTrollParameterUnitCtrl = exports.RestartGuestPortsCtrl = exports.ActivateGuestPortsCtrl = exports.DeactivateGuestPortsCtrl = exports.MultibeamServoCtrl = exports.GenericServoCtrl = exports.GripperCtrl = exports.SystemTimeCtrl = exports.PingerConfigurationCtrl = exports.WaterDensityCtrl = exports.TiltStabilizationCtrl = exports.CalibrateDvlGyroCtrl = exports.ResetOdometerCtrl = exports.ResetPositionCtrl = exports.ClearMissionCtrl = exports.PauseMissionCtrl = exports.RunMissionCtrl = exports.AutoPilotHeaveCtrl = exports.AutoPilotSurgeYawCtrl = exports.WeatherVaningCtrl = exports.StationKeepingCtrl = exports.AutoAltitudeCtrl = exports.AutoDepthCtrl = exports.AutoHeadingCtrl = exports.FinishCalibrationCtrl = exports.CancelCalibrationCtrl = exports.StartCalibrationCtrl = exports.TakePictureCtrl = exports.RecordCtrl = exports.WatchdogCtrl = exports.PilotGPSPositionCtrl = exports.LaserCtrl = exports.GuestportLightsCtrl = exports.LightsCtrl = exports.TiltVelocityCtrl = exports.MotionInputCtrl = void 0;
|
|
9
9
|
/* eslint-disable */
|
|
10
10
|
const wire_1 = require("@bufbuild/protobuf/wire");
|
|
11
11
|
const aquatroll_1 = require("./aquatroll");
|
|
@@ -1999,10 +1999,13 @@ exports.DeactivateMultibeamCtrl = {
|
|
|
1999
1999
|
},
|
|
2000
2000
|
};
|
|
2001
2001
|
function createBaseStartDiveCtrl() {
|
|
2002
|
-
return {};
|
|
2002
|
+
return { operatorInfo: undefined };
|
|
2003
2003
|
}
|
|
2004
2004
|
exports.StartDiveCtrl = {
|
|
2005
|
-
encode(
|
|
2005
|
+
encode(message, writer = new wire_1.BinaryWriter()) {
|
|
2006
|
+
if (message.operatorInfo !== undefined) {
|
|
2007
|
+
message_formats_1.OperatorInfo.encode(message.operatorInfo, writer.uint32(10).fork()).join();
|
|
2008
|
+
}
|
|
2006
2009
|
return writer;
|
|
2007
2010
|
},
|
|
2008
2011
|
decode(input, length) {
|
|
@@ -2012,6 +2015,13 @@ exports.StartDiveCtrl = {
|
|
|
2012
2015
|
while (reader.pos < end) {
|
|
2013
2016
|
const tag = reader.uint32();
|
|
2014
2017
|
switch (tag >>> 3) {
|
|
2018
|
+
case 1: {
|
|
2019
|
+
if (tag !== 10) {
|
|
2020
|
+
break;
|
|
2021
|
+
}
|
|
2022
|
+
message.operatorInfo = message_formats_1.OperatorInfo.decode(reader, reader.uint32());
|
|
2023
|
+
continue;
|
|
2024
|
+
}
|
|
2015
2025
|
}
|
|
2016
2026
|
if ((tag & 7) === 4 || tag === 0) {
|
|
2017
2027
|
break;
|
|
@@ -2020,18 +2030,24 @@ exports.StartDiveCtrl = {
|
|
|
2020
2030
|
}
|
|
2021
2031
|
return message;
|
|
2022
2032
|
},
|
|
2023
|
-
fromJSON(
|
|
2024
|
-
return {};
|
|
2033
|
+
fromJSON(object) {
|
|
2034
|
+
return { operatorInfo: isSet(object.operatorInfo) ? message_formats_1.OperatorInfo.fromJSON(object.operatorInfo) : undefined };
|
|
2025
2035
|
},
|
|
2026
|
-
toJSON(
|
|
2036
|
+
toJSON(message) {
|
|
2027
2037
|
const obj = {};
|
|
2038
|
+
if (message.operatorInfo !== undefined) {
|
|
2039
|
+
obj.operatorInfo = message_formats_1.OperatorInfo.toJSON(message.operatorInfo);
|
|
2040
|
+
}
|
|
2028
2041
|
return obj;
|
|
2029
2042
|
},
|
|
2030
2043
|
create(base) {
|
|
2031
2044
|
return exports.StartDiveCtrl.fromPartial(base ?? {});
|
|
2032
2045
|
},
|
|
2033
|
-
fromPartial(
|
|
2046
|
+
fromPartial(object) {
|
|
2034
2047
|
const message = createBaseStartDiveCtrl();
|
|
2048
|
+
message.operatorInfo = (object.operatorInfo !== undefined && object.operatorInfo !== null)
|
|
2049
|
+
? message_formats_1.OperatorInfo.fromPartial(object.operatorInfo)
|
|
2050
|
+
: undefined;
|
|
2035
2051
|
return message;
|
|
2036
2052
|
},
|
|
2037
2053
|
};
|
|
@@ -2109,6 +2125,118 @@ exports.FormatRemovableStorageDeviceCtrl = {
|
|
|
2109
2125
|
return message;
|
|
2110
2126
|
},
|
|
2111
2127
|
};
|
|
2128
|
+
function createBaseSetTurbidityFilterCtrl() {
|
|
2129
|
+
return { turbidityFilter: undefined };
|
|
2130
|
+
}
|
|
2131
|
+
exports.SetTurbidityFilterCtrl = {
|
|
2132
|
+
encode(message, writer = new wire_1.BinaryWriter()) {
|
|
2133
|
+
if (message.turbidityFilter !== undefined) {
|
|
2134
|
+
message_formats_1.FilterMessage.encode(message.turbidityFilter, writer.uint32(10).fork()).join();
|
|
2135
|
+
}
|
|
2136
|
+
return writer;
|
|
2137
|
+
},
|
|
2138
|
+
decode(input, length) {
|
|
2139
|
+
const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
|
|
2140
|
+
const end = length === undefined ? reader.len : reader.pos + length;
|
|
2141
|
+
const message = createBaseSetTurbidityFilterCtrl();
|
|
2142
|
+
while (reader.pos < end) {
|
|
2143
|
+
const tag = reader.uint32();
|
|
2144
|
+
switch (tag >>> 3) {
|
|
2145
|
+
case 1: {
|
|
2146
|
+
if (tag !== 10) {
|
|
2147
|
+
break;
|
|
2148
|
+
}
|
|
2149
|
+
message.turbidityFilter = message_formats_1.FilterMessage.decode(reader, reader.uint32());
|
|
2150
|
+
continue;
|
|
2151
|
+
}
|
|
2152
|
+
}
|
|
2153
|
+
if ((tag & 7) === 4 || tag === 0) {
|
|
2154
|
+
break;
|
|
2155
|
+
}
|
|
2156
|
+
reader.skip(tag & 7);
|
|
2157
|
+
}
|
|
2158
|
+
return message;
|
|
2159
|
+
},
|
|
2160
|
+
fromJSON(object) {
|
|
2161
|
+
return {
|
|
2162
|
+
turbidityFilter: isSet(object.turbidityFilter) ? message_formats_1.FilterMessage.fromJSON(object.turbidityFilter) : undefined,
|
|
2163
|
+
};
|
|
2164
|
+
},
|
|
2165
|
+
toJSON(message) {
|
|
2166
|
+
const obj = {};
|
|
2167
|
+
if (message.turbidityFilter !== undefined) {
|
|
2168
|
+
obj.turbidityFilter = message_formats_1.FilterMessage.toJSON(message.turbidityFilter);
|
|
2169
|
+
}
|
|
2170
|
+
return obj;
|
|
2171
|
+
},
|
|
2172
|
+
create(base) {
|
|
2173
|
+
return exports.SetTurbidityFilterCtrl.fromPartial(base ?? {});
|
|
2174
|
+
},
|
|
2175
|
+
fromPartial(object) {
|
|
2176
|
+
const message = createBaseSetTurbidityFilterCtrl();
|
|
2177
|
+
message.turbidityFilter = (object.turbidityFilter !== undefined && object.turbidityFilter !== null)
|
|
2178
|
+
? message_formats_1.FilterMessage.fromPartial(object.turbidityFilter)
|
|
2179
|
+
: undefined;
|
|
2180
|
+
return message;
|
|
2181
|
+
},
|
|
2182
|
+
};
|
|
2183
|
+
function createBaseCameraPanTiltZoomCtrl() {
|
|
2184
|
+
return { cameraPanTiltZoom: undefined };
|
|
2185
|
+
}
|
|
2186
|
+
exports.CameraPanTiltZoomCtrl = {
|
|
2187
|
+
encode(message, writer = new wire_1.BinaryWriter()) {
|
|
2188
|
+
if (message.cameraPanTiltZoom !== undefined) {
|
|
2189
|
+
message_formats_1.CameraPanTiltZoom.encode(message.cameraPanTiltZoom, writer.uint32(10).fork()).join();
|
|
2190
|
+
}
|
|
2191
|
+
return writer;
|
|
2192
|
+
},
|
|
2193
|
+
decode(input, length) {
|
|
2194
|
+
const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
|
|
2195
|
+
const end = length === undefined ? reader.len : reader.pos + length;
|
|
2196
|
+
const message = createBaseCameraPanTiltZoomCtrl();
|
|
2197
|
+
while (reader.pos < end) {
|
|
2198
|
+
const tag = reader.uint32();
|
|
2199
|
+
switch (tag >>> 3) {
|
|
2200
|
+
case 1: {
|
|
2201
|
+
if (tag !== 10) {
|
|
2202
|
+
break;
|
|
2203
|
+
}
|
|
2204
|
+
message.cameraPanTiltZoom = message_formats_1.CameraPanTiltZoom.decode(reader, reader.uint32());
|
|
2205
|
+
continue;
|
|
2206
|
+
}
|
|
2207
|
+
}
|
|
2208
|
+
if ((tag & 7) === 4 || tag === 0) {
|
|
2209
|
+
break;
|
|
2210
|
+
}
|
|
2211
|
+
reader.skip(tag & 7);
|
|
2212
|
+
}
|
|
2213
|
+
return message;
|
|
2214
|
+
},
|
|
2215
|
+
fromJSON(object) {
|
|
2216
|
+
return {
|
|
2217
|
+
cameraPanTiltZoom: isSet(object.cameraPanTiltZoom)
|
|
2218
|
+
? message_formats_1.CameraPanTiltZoom.fromJSON(object.cameraPanTiltZoom)
|
|
2219
|
+
: undefined,
|
|
2220
|
+
};
|
|
2221
|
+
},
|
|
2222
|
+
toJSON(message) {
|
|
2223
|
+
const obj = {};
|
|
2224
|
+
if (message.cameraPanTiltZoom !== undefined) {
|
|
2225
|
+
obj.cameraPanTiltZoom = message_formats_1.CameraPanTiltZoom.toJSON(message.cameraPanTiltZoom);
|
|
2226
|
+
}
|
|
2227
|
+
return obj;
|
|
2228
|
+
},
|
|
2229
|
+
create(base) {
|
|
2230
|
+
return exports.CameraPanTiltZoomCtrl.fromPartial(base ?? {});
|
|
2231
|
+
},
|
|
2232
|
+
fromPartial(object) {
|
|
2233
|
+
const message = createBaseCameraPanTiltZoomCtrl();
|
|
2234
|
+
message.cameraPanTiltZoom = (object.cameraPanTiltZoom !== undefined && object.cameraPanTiltZoom !== null)
|
|
2235
|
+
? message_formats_1.CameraPanTiltZoom.fromPartial(object.cameraPanTiltZoom)
|
|
2236
|
+
: undefined;
|
|
2237
|
+
return message;
|
|
2238
|
+
},
|
|
2239
|
+
};
|
|
2112
2240
|
const gt = (() => {
|
|
2113
2241
|
if (typeof globalThis !== "undefined") {
|
|
2114
2242
|
return globalThis;
|
|
@@ -184,6 +184,8 @@ export declare enum Model {
|
|
|
184
184
|
MODEL_X3 = 3,
|
|
185
185
|
/** MODEL_X3_ULTRA - Blueye X3 Ultra. */
|
|
186
186
|
MODEL_X3_ULTRA = 6,
|
|
187
|
+
/** MODEL_X7 - Blueye X7. */
|
|
188
|
+
MODEL_X7 = 7,
|
|
187
189
|
/** MODEL_NEXT - Blueye ? */
|
|
188
190
|
MODEL_NEXT = 5,
|
|
189
191
|
UNRECOGNIZED = -1
|
|
@@ -218,11 +220,18 @@ export declare enum Resolution {
|
|
|
218
220
|
RESOLUTION_FULLHD_1080P = 1,
|
|
219
221
|
/** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
|
|
220
222
|
RESOLUTION_UHD_4K = 3,
|
|
223
|
+
/** RESOLUTION_QHD_2K - 2K QHD (2560x1440, Only supported on X3 Ultra). */
|
|
224
|
+
RESOLUTION_QHD_2K = 5,
|
|
221
225
|
UNRECOGNIZED = -1
|
|
222
226
|
}
|
|
223
227
|
export declare function resolutionFromJSON(object: any): Resolution;
|
|
224
228
|
export declare function resolutionToJSON(object: Resolution): string;
|
|
225
|
-
/**
|
|
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
|
+
*/
|
|
226
235
|
export declare enum Framerate {
|
|
227
236
|
/** FRAMERATE_UNSPECIFIED - Framerate not specified. */
|
|
228
237
|
FRAMERATE_UNSPECIFIED = 0,
|
|
@@ -230,6 +239,8 @@ export declare enum Framerate {
|
|
|
230
239
|
FRAMERATE_FPS_30 = 1,
|
|
231
240
|
/** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
|
|
232
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,
|
|
233
244
|
UNRECOGNIZED = -1
|
|
234
245
|
}
|
|
235
246
|
export declare function framerateFromJSON(object: any): Framerate;
|
|
@@ -510,6 +521,18 @@ export declare enum MultibeamFrequencyMode {
|
|
|
510
521
|
}
|
|
511
522
|
export declare function multibeamFrequencyModeFromJSON(object: any): MultibeamFrequencyMode;
|
|
512
523
|
export declare function multibeamFrequencyModeToJSON(object: MultibeamFrequencyMode): string;
|
|
524
|
+
/** Thermal zone identifiers. */
|
|
525
|
+
export declare enum ThermalZoneId {
|
|
526
|
+
/** THERMAL_ZONE_ID_UNSPECIFIED - Unspecified thermal zone. */
|
|
527
|
+
THERMAL_ZONE_ID_UNSPECIFIED = 0,
|
|
528
|
+
/** THERMAL_ZONE_ID_TJ - Junction temperature (Tj). */
|
|
529
|
+
THERMAL_ZONE_ID_TJ = 1,
|
|
530
|
+
/** THERMAL_ZONE_ID_CANISTER - Canister temperature. */
|
|
531
|
+
THERMAL_ZONE_ID_CANISTER = 2,
|
|
532
|
+
UNRECOGNIZED = -1
|
|
533
|
+
}
|
|
534
|
+
export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
|
|
535
|
+
export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
|
|
513
536
|
/**
|
|
514
537
|
* Wrapper message for each entry in the drone telemetry logfile.
|
|
515
538
|
*
|
|
@@ -829,7 +852,7 @@ export interface WaterTemperature {
|
|
|
829
852
|
/** Water temperature (°C). */
|
|
830
853
|
value: number;
|
|
831
854
|
}
|
|
832
|
-
/** CPU temperature. */
|
|
855
|
+
/** CPU temperature (deprecated, use SystemPerformanceInfo.thermal_zones instead). */
|
|
833
856
|
export interface CPUTemperature {
|
|
834
857
|
/** CPU temperature (°C). */
|
|
835
858
|
value: number;
|
|
@@ -1573,7 +1596,11 @@ export interface CameraParameters {
|
|
|
1573
1596
|
framerate: Framerate;
|
|
1574
1597
|
/** Which camera the parameters belong to. */
|
|
1575
1598
|
camera: Camera;
|
|
1576
|
-
/**
|
|
1599
|
+
/**
|
|
1600
|
+
* Network MTU (Maximum Transmission Unit) size for video streaming in bytes (68..65535).
|
|
1601
|
+
* If 0 or unset, the system will use a default of 1400.
|
|
1602
|
+
* The Blueye App allows users to set values between 500 and 1460.
|
|
1603
|
+
*/
|
|
1577
1604
|
mtuSize: number;
|
|
1578
1605
|
}
|
|
1579
1606
|
/**
|
|
@@ -1940,7 +1967,7 @@ export interface PersistentStorageSettings {
|
|
|
1940
1967
|
accCalibration: boolean;
|
|
1941
1968
|
}
|
|
1942
1969
|
/**
|
|
1943
|
-
* CPU information.
|
|
1970
|
+
* CPU information (deprecated, use SystemPerformanceInfo instead).
|
|
1944
1971
|
*
|
|
1945
1972
|
* Contains information about the CPU load and memory usage of the drone.
|
|
1946
1973
|
*/
|
|
@@ -1956,6 +1983,119 @@ export interface CPUInfo {
|
|
|
1956
1983
|
/** Communication queue load (0..1). */
|
|
1957
1984
|
commQueueLoad: number;
|
|
1958
1985
|
}
|
|
1986
|
+
/** Per-core CPU utilization. */
|
|
1987
|
+
export interface CpuCoreLoad {
|
|
1988
|
+
/** Core index (0-based). */
|
|
1989
|
+
coreIndex: number;
|
|
1990
|
+
/** Core load (0..1). */
|
|
1991
|
+
load: number;
|
|
1992
|
+
/** Current clock frequency (MHz). */
|
|
1993
|
+
frequencyMhz: number;
|
|
1994
|
+
}
|
|
1995
|
+
/** GPU utilization and status. */
|
|
1996
|
+
export interface GpuInfo {
|
|
1997
|
+
/** GPU load (0..1). */
|
|
1998
|
+
load: number;
|
|
1999
|
+
/** Current GPU clock frequency (MHz). */
|
|
2000
|
+
frequencyMhz: number;
|
|
2001
|
+
}
|
|
2002
|
+
/**
|
|
2003
|
+
* Deep Learning Accelerator (DLA) utilization.
|
|
2004
|
+
*
|
|
2005
|
+
* Jetson Orin NX has two DLA engines used for inference offload.
|
|
2006
|
+
*/
|
|
2007
|
+
export interface DlaInfo {
|
|
2008
|
+
/** DLA engine index (0-based). */
|
|
2009
|
+
engineIndex: number;
|
|
2010
|
+
/** DLA engine load (0..1). */
|
|
2011
|
+
load: number;
|
|
2012
|
+
/** Core clock frequency (MHz). 0 when disabled. */
|
|
2013
|
+
frequencyMhz: number;
|
|
2014
|
+
/** True when the DLA engine is actively processing. */
|
|
2015
|
+
enabled: boolean;
|
|
2016
|
+
/** Falcon microcontroller clock frequency (MHz). 0 when disabled. */
|
|
2017
|
+
falconFrequencyMhz: number;
|
|
2018
|
+
}
|
|
2019
|
+
/** System memory information. */
|
|
2020
|
+
export interface MemoryInfo {
|
|
2021
|
+
/** Total RAM (bytes). */
|
|
2022
|
+
totalBytes: number;
|
|
2023
|
+
/** Used RAM (bytes). */
|
|
2024
|
+
usedBytes: number;
|
|
2025
|
+
/** Cached RAM (bytes). */
|
|
2026
|
+
cachedBytes: number;
|
|
2027
|
+
/** Memory bus utilization (0..1). i.MX only. */
|
|
2028
|
+
busLoad: number;
|
|
2029
|
+
}
|
|
2030
|
+
/** Thermal zone reading. */
|
|
2031
|
+
export interface ThermalZone {
|
|
2032
|
+
/** Thermal zone identifier. */
|
|
2033
|
+
zone: ThermalZoneId;
|
|
2034
|
+
/** Temperature (°C). */
|
|
2035
|
+
temperature: number;
|
|
2036
|
+
}
|
|
2037
|
+
/** Video codec engine status. */
|
|
2038
|
+
export interface VideoCodecInfo {
|
|
2039
|
+
/** Jetson only (NVENC/NVDEC/NVJPG/VIC devfreq). */
|
|
2040
|
+
encoderActive: boolean;
|
|
2041
|
+
/** Video encoder clock frequency (MHz). */
|
|
2042
|
+
encoderFrequencyMhz: number;
|
|
2043
|
+
/** Video decoder (NVDEC) is active. */
|
|
2044
|
+
decoderActive: boolean;
|
|
2045
|
+
/** Video decoder clock frequency (MHz). */
|
|
2046
|
+
decoderFrequencyMhz: number;
|
|
2047
|
+
/** JPEG engine (NVJPG) is active. */
|
|
2048
|
+
nvjpgActive: boolean;
|
|
2049
|
+
/** JPEG engine clock frequency (MHz). */
|
|
2050
|
+
nvjpgFrequencyMhz: number;
|
|
2051
|
+
/** Video Image Compositor (VIC) is active. */
|
|
2052
|
+
vicActive: boolean;
|
|
2053
|
+
/** VIC clock frequency (MHz). */
|
|
2054
|
+
vicFrequencyMhz: number;
|
|
2055
|
+
/** i.MX only (CODA VPU). */
|
|
2056
|
+
vpuActive: boolean;
|
|
2057
|
+
/** VPU AXI clock frequency (MHz). */
|
|
2058
|
+
vpuFrequencyMhz: number;
|
|
2059
|
+
/** Cumulative VPU_CODEC_IRQ count. */
|
|
2060
|
+
vpuCodecIrqCount: number;
|
|
2061
|
+
/** Cumulative VPU_JPG_IRQ count. */
|
|
2062
|
+
vpuJpgIrqCount: number;
|
|
2063
|
+
}
|
|
2064
|
+
/**
|
|
2065
|
+
* System performance information.
|
|
2066
|
+
*
|
|
2067
|
+
* Comprehensive performance metrics for the drone's compute platform.
|
|
2068
|
+
* Covers CPU, GPU, DLA, memory, thermals, and video codec utilization.
|
|
2069
|
+
* Fields not applicable to a platform are left at their zero/empty defaults.
|
|
2070
|
+
*/
|
|
2071
|
+
export interface SystemPerformanceInfo {
|
|
2072
|
+
/** Per-core CPU utilization. */
|
|
2073
|
+
cpuCores: CpuCoreLoad[];
|
|
2074
|
+
/** Mean CPU utilization across all cores (0..1). */
|
|
2075
|
+
cpuUtilization: number;
|
|
2076
|
+
/** GPU utilization. */
|
|
2077
|
+
gpu: GpuInfo | undefined;
|
|
2078
|
+
/** DLA engine utilization (Jetson only). */
|
|
2079
|
+
dlaEngines: DlaInfo[];
|
|
2080
|
+
/** RAM usage. */
|
|
2081
|
+
memory: MemoryInfo | undefined;
|
|
2082
|
+
/** All thermal zone readings. */
|
|
2083
|
+
thermalZones: ThermalZone[];
|
|
2084
|
+
/** Video encoder/decoder status. */
|
|
2085
|
+
videoCodec: VideoCodecInfo | undefined;
|
|
2086
|
+
/** Main queue load (0..1). */
|
|
2087
|
+
mainQueueLoad: number;
|
|
2088
|
+
/** Guestport queue load (0..1). */
|
|
2089
|
+
guestportQueueLoad: number;
|
|
2090
|
+
/** Communication queue load (0..1). */
|
|
2091
|
+
commQueueLoad: number;
|
|
2092
|
+
/** Camera queue load (0..1). */
|
|
2093
|
+
cameraQueueLoad: number;
|
|
2094
|
+
/** Overlay queue load (0..1). */
|
|
2095
|
+
overlayQueueLoad: number;
|
|
2096
|
+
/** Position observer queue load (0..1). */
|
|
2097
|
+
positionObserverQueueLoad: number;
|
|
2098
|
+
}
|
|
1959
2099
|
/**
|
|
1960
2100
|
* Surface Unit battery information.
|
|
1961
2101
|
*
|
|
@@ -1987,6 +2127,74 @@ export interface SurfaceUnitVersionInfo {
|
|
|
1987
2127
|
/** Surface Unit firmware version (x.y.z). */
|
|
1988
2128
|
version: string;
|
|
1989
2129
|
}
|
|
2130
|
+
/**
|
|
2131
|
+
* Bounding box for object detection.
|
|
2132
|
+
*
|
|
2133
|
+
* Coordinates are in pixels relative to the camera image,
|
|
2134
|
+
* where (x, y) is the top-left corner of the bounding box.
|
|
2135
|
+
*/
|
|
2136
|
+
export interface BoundingBox {
|
|
2137
|
+
/** Horizontal offset of the top-left corner (px). */
|
|
2138
|
+
x: number;
|
|
2139
|
+
/** Vertical offset of the top-left corner (px). */
|
|
2140
|
+
y: number;
|
|
2141
|
+
/** Width of the bounding box (px). */
|
|
2142
|
+
width: number;
|
|
2143
|
+
/** Height of the bounding box (px). */
|
|
2144
|
+
height: number;
|
|
2145
|
+
}
|
|
2146
|
+
/** A single object detection from a computer vision model. */
|
|
2147
|
+
export interface ObjectDetection {
|
|
2148
|
+
/** Bounding box of the detected object. */
|
|
2149
|
+
boundingBox: BoundingBox | undefined;
|
|
2150
|
+
/** Detection confidence score (0..1). */
|
|
2151
|
+
confidence: number;
|
|
2152
|
+
/** Numeric class identifier from the model. */
|
|
2153
|
+
classId: number;
|
|
2154
|
+
/** Human-readable class name. */
|
|
2155
|
+
className: string;
|
|
2156
|
+
/** Unique ID for tracking the same object across frames. */
|
|
2157
|
+
trackingId: number;
|
|
2158
|
+
}
|
|
2159
|
+
/** A list of object detections from a single video frame. */
|
|
2160
|
+
export interface ObjectDetections {
|
|
2161
|
+
/** List of detections in the frame. */
|
|
2162
|
+
detections: ObjectDetection[];
|
|
2163
|
+
/** Which camera the detections are from. */
|
|
2164
|
+
camera: Camera;
|
|
2165
|
+
}
|
|
2166
|
+
/** Generic filter settings. */
|
|
2167
|
+
export interface FilterMessage {
|
|
2168
|
+
/** If the filter is enabled. */
|
|
2169
|
+
enabled: boolean;
|
|
2170
|
+
/** Intensity of the filter (0..1). */
|
|
2171
|
+
intensity: number;
|
|
2172
|
+
}
|
|
2173
|
+
/**
|
|
2174
|
+
* Digital pan, tilt, and zoom state for the main camera.
|
|
2175
|
+
*
|
|
2176
|
+
* Only supported on X3 Ultra. Controls digital (not mechanical) zoom.
|
|
2177
|
+
*/
|
|
2178
|
+
export interface CameraPanTiltZoom {
|
|
2179
|
+
/** Horizontal pan (-1.0..1.0), where 0.0 is center. */
|
|
2180
|
+
pan: number;
|
|
2181
|
+
/** Vertical tilt (-1.0..1.0), where 0.0 is center. */
|
|
2182
|
+
tilt: number;
|
|
2183
|
+
/** Zoom level (0.0..1.0), where 0.0 is no zoom and 1.0 is maximum zoom. */
|
|
2184
|
+
zoom: number;
|
|
2185
|
+
}
|
|
2186
|
+
/**
|
|
2187
|
+
* Information about the operator controlling the drone.
|
|
2188
|
+
*
|
|
2189
|
+
* Used to identify who started a dive, for reporting and when importing
|
|
2190
|
+
* dives to Blueye Cloud.
|
|
2191
|
+
*/
|
|
2192
|
+
export interface OperatorInfo {
|
|
2193
|
+
/** Full name of the operator. */
|
|
2194
|
+
name: string;
|
|
2195
|
+
/** E-mail address of the operator. */
|
|
2196
|
+
email: string;
|
|
2197
|
+
}
|
|
1990
2198
|
export declare const BinlogRecord: MessageFns<BinlogRecord>;
|
|
1991
2199
|
export declare const LogEntry: MessageFns<LogEntry>;
|
|
1992
2200
|
export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
|
|
@@ -2076,8 +2284,21 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
|
|
|
2076
2284
|
export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
|
|
2077
2285
|
export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
|
|
2078
2286
|
export declare const CPUInfo: MessageFns<CPUInfo>;
|
|
2287
|
+
export declare const CpuCoreLoad: MessageFns<CpuCoreLoad>;
|
|
2288
|
+
export declare const GpuInfo: MessageFns<GpuInfo>;
|
|
2289
|
+
export declare const DlaInfo: MessageFns<DlaInfo>;
|
|
2290
|
+
export declare const MemoryInfo: MessageFns<MemoryInfo>;
|
|
2291
|
+
export declare const ThermalZone: MessageFns<ThermalZone>;
|
|
2292
|
+
export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
|
|
2293
|
+
export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
|
|
2079
2294
|
export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
|
|
2080
2295
|
export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
|
|
2296
|
+
export declare const BoundingBox: MessageFns<BoundingBox>;
|
|
2297
|
+
export declare const ObjectDetection: MessageFns<ObjectDetection>;
|
|
2298
|
+
export declare const ObjectDetections: MessageFns<ObjectDetections>;
|
|
2299
|
+
export declare const FilterMessage: MessageFns<FilterMessage>;
|
|
2300
|
+
export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
|
|
2301
|
+
export declare const OperatorInfo: MessageFns<OperatorInfo>;
|
|
2081
2302
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
2082
2303
|
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 {} ? {
|
|
2083
2304
|
[K in keyof T]?: DeepPartial<T[K]>;
|