@blueyerobotics/protocol-definitions 3.2.0-10007c3e → 3.2.0-18bcac11
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 +27 -1
- package/dist/control.js +209 -7
- package/dist/message_formats.d.ts +249 -3
- package/dist/message_formats.js +1659 -38
- package/dist/mission_planning.d.ts +54 -0
- package/dist/mission_planning.js +243 -1
- package/dist/req_rep.d.ts +10 -0
- package/dist/req_rep.js +89 -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,26 @@ 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
|
+
}
|
|
238
|
+
/** Message sent to start streaming log entries to the client. */
|
|
239
|
+
export interface StartLogStreamingCtrl {
|
|
240
|
+
}
|
|
241
|
+
/** Message sent to stop streaming log entries to the client. */
|
|
242
|
+
export interface StopLogStreamingCtrl {
|
|
243
|
+
}
|
|
222
244
|
export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
|
|
223
245
|
export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
|
|
224
246
|
export declare const LightsCtrl: MessageFns<LightsCtrl>;
|
|
@@ -262,6 +284,10 @@ export declare const DeactivateMultibeamCtrl: MessageFns<DeactivateMultibeamCtrl
|
|
|
262
284
|
export declare const StartDiveCtrl: MessageFns<StartDiveCtrl>;
|
|
263
285
|
export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
|
|
264
286
|
export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
|
|
287
|
+
export declare const SetTurbidityFilterCtrl: MessageFns<SetTurbidityFilterCtrl>;
|
|
288
|
+
export declare const CameraPanTiltZoomCtrl: MessageFns<CameraPanTiltZoomCtrl>;
|
|
289
|
+
export declare const StartLogStreamingCtrl: MessageFns<StartLogStreamingCtrl>;
|
|
290
|
+
export declare const StopLogStreamingCtrl: MessageFns<StopLogStreamingCtrl>;
|
|
265
291
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
266
292
|
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
293
|
[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.StopLogStreamingCtrl = exports.StartLogStreamingCtrl = 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,192 @@ 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
|
+
};
|
|
2240
|
+
function createBaseStartLogStreamingCtrl() {
|
|
2241
|
+
return {};
|
|
2242
|
+
}
|
|
2243
|
+
exports.StartLogStreamingCtrl = {
|
|
2244
|
+
encode(_, writer = new wire_1.BinaryWriter()) {
|
|
2245
|
+
return writer;
|
|
2246
|
+
},
|
|
2247
|
+
decode(input, length) {
|
|
2248
|
+
const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
|
|
2249
|
+
const end = length === undefined ? reader.len : reader.pos + length;
|
|
2250
|
+
const message = createBaseStartLogStreamingCtrl();
|
|
2251
|
+
while (reader.pos < end) {
|
|
2252
|
+
const tag = reader.uint32();
|
|
2253
|
+
switch (tag >>> 3) {
|
|
2254
|
+
}
|
|
2255
|
+
if ((tag & 7) === 4 || tag === 0) {
|
|
2256
|
+
break;
|
|
2257
|
+
}
|
|
2258
|
+
reader.skip(tag & 7);
|
|
2259
|
+
}
|
|
2260
|
+
return message;
|
|
2261
|
+
},
|
|
2262
|
+
fromJSON(_) {
|
|
2263
|
+
return {};
|
|
2264
|
+
},
|
|
2265
|
+
toJSON(_) {
|
|
2266
|
+
const obj = {};
|
|
2267
|
+
return obj;
|
|
2268
|
+
},
|
|
2269
|
+
create(base) {
|
|
2270
|
+
return exports.StartLogStreamingCtrl.fromPartial(base ?? {});
|
|
2271
|
+
},
|
|
2272
|
+
fromPartial(_) {
|
|
2273
|
+
const message = createBaseStartLogStreamingCtrl();
|
|
2274
|
+
return message;
|
|
2275
|
+
},
|
|
2276
|
+
};
|
|
2277
|
+
function createBaseStopLogStreamingCtrl() {
|
|
2278
|
+
return {};
|
|
2279
|
+
}
|
|
2280
|
+
exports.StopLogStreamingCtrl = {
|
|
2281
|
+
encode(_, writer = new wire_1.BinaryWriter()) {
|
|
2282
|
+
return writer;
|
|
2283
|
+
},
|
|
2284
|
+
decode(input, length) {
|
|
2285
|
+
const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
|
|
2286
|
+
const end = length === undefined ? reader.len : reader.pos + length;
|
|
2287
|
+
const message = createBaseStopLogStreamingCtrl();
|
|
2288
|
+
while (reader.pos < end) {
|
|
2289
|
+
const tag = reader.uint32();
|
|
2290
|
+
switch (tag >>> 3) {
|
|
2291
|
+
}
|
|
2292
|
+
if ((tag & 7) === 4 || tag === 0) {
|
|
2293
|
+
break;
|
|
2294
|
+
}
|
|
2295
|
+
reader.skip(tag & 7);
|
|
2296
|
+
}
|
|
2297
|
+
return message;
|
|
2298
|
+
},
|
|
2299
|
+
fromJSON(_) {
|
|
2300
|
+
return {};
|
|
2301
|
+
},
|
|
2302
|
+
toJSON(_) {
|
|
2303
|
+
const obj = {};
|
|
2304
|
+
return obj;
|
|
2305
|
+
},
|
|
2306
|
+
create(base) {
|
|
2307
|
+
return exports.StopLogStreamingCtrl.fromPartial(base ?? {});
|
|
2308
|
+
},
|
|
2309
|
+
fromPartial(_) {
|
|
2310
|
+
const message = createBaseStopLogStreamingCtrl();
|
|
2311
|
+
return message;
|
|
2312
|
+
},
|
|
2313
|
+
};
|
|
2112
2314
|
const gt = (() => {
|
|
2113
2315
|
if (typeof globalThis !== "undefined") {
|
|
2114
2316
|
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;
|
|
@@ -257,6 +268,18 @@ export declare enum StreamingProtocol {
|
|
|
257
268
|
}
|
|
258
269
|
export declare function streamingProtocolFromJSON(object: any): StreamingProtocol;
|
|
259
270
|
export declare function streamingProtocolToJSON(object: StreamingProtocol): string;
|
|
271
|
+
/** Recording video codec. */
|
|
272
|
+
export declare enum RecordingCodec {
|
|
273
|
+
/** RECORDING_CODEC_UNSPECIFIED - Use platform default (H.264). */
|
|
274
|
+
RECORDING_CODEC_UNSPECIFIED = 0,
|
|
275
|
+
/** RECORDING_CODEC_H264 - H.264/AVC codec. Wider compatibility with players/editors. */
|
|
276
|
+
RECORDING_CODEC_H264 = 1,
|
|
277
|
+
/** RECORDING_CODEC_H265 - H.265/HEVC codec. Better compression, limited compatibility. Ultra only. */
|
|
278
|
+
RECORDING_CODEC_H265 = 2,
|
|
279
|
+
UNRECOGNIZED = -1
|
|
280
|
+
}
|
|
281
|
+
export declare function recordingCodecFromJSON(object: any): RecordingCodec;
|
|
282
|
+
export declare function recordingCodecToJSON(object: RecordingCodec): string;
|
|
260
283
|
/** Available temperature units. */
|
|
261
284
|
export declare enum TemperatureUnit {
|
|
262
285
|
/** TEMPERATURE_UNIT_UNSPECIFIED - Temperature unit not specified. */
|
|
@@ -323,6 +346,8 @@ export declare enum FontSize {
|
|
|
323
346
|
FONT_SIZE_PX35 = 5,
|
|
324
347
|
/** FONT_SIZE_PX40 - 40 px. */
|
|
325
348
|
FONT_SIZE_PX40 = 6,
|
|
349
|
+
/** FONT_SIZE_PX50 - 50 px. */
|
|
350
|
+
FONT_SIZE_PX50 = 7,
|
|
326
351
|
UNRECOGNIZED = -1
|
|
327
352
|
}
|
|
328
353
|
export declare function fontSizeFromJSON(object: any): FontSize;
|
|
@@ -425,6 +450,8 @@ export declare enum GuestPortDeviceID {
|
|
|
425
450
|
GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V2 = 46,
|
|
426
451
|
/** GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT - Cerulean Omniscan 450 Compact. */
|
|
427
452
|
GUEST_PORT_DEVICE_ID_CERULEAN_OMNISCAN_450_COMPACT = 47,
|
|
453
|
+
/** GUEST_PORT_DEVICE_ID_BLUEYE_SCALING_LASER - Blueye Scaling Laser. */
|
|
454
|
+
GUEST_PORT_DEVICE_ID_BLUEYE_SCALING_LASER = 48,
|
|
428
455
|
UNRECOGNIZED = -1
|
|
429
456
|
}
|
|
430
457
|
export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
|
|
@@ -510,6 +537,18 @@ export declare enum MultibeamFrequencyMode {
|
|
|
510
537
|
}
|
|
511
538
|
export declare function multibeamFrequencyModeFromJSON(object: any): MultibeamFrequencyMode;
|
|
512
539
|
export declare function multibeamFrequencyModeToJSON(object: MultibeamFrequencyMode): string;
|
|
540
|
+
/** Thermal zone identifiers. */
|
|
541
|
+
export declare enum ThermalZoneId {
|
|
542
|
+
/** THERMAL_ZONE_ID_UNSPECIFIED - Unspecified thermal zone. */
|
|
543
|
+
THERMAL_ZONE_ID_UNSPECIFIED = 0,
|
|
544
|
+
/** THERMAL_ZONE_ID_TJ - Junction temperature (Tj). */
|
|
545
|
+
THERMAL_ZONE_ID_TJ = 1,
|
|
546
|
+
/** THERMAL_ZONE_ID_CANISTER - Canister temperature. */
|
|
547
|
+
THERMAL_ZONE_ID_CANISTER = 2,
|
|
548
|
+
UNRECOGNIZED = -1
|
|
549
|
+
}
|
|
550
|
+
export declare function thermalZoneIdFromJSON(object: any): ThermalZoneId;
|
|
551
|
+
export declare function thermalZoneIdToJSON(object: ThermalZoneId): string;
|
|
513
552
|
/**
|
|
514
553
|
* Wrapper message for each entry in the drone telemetry logfile.
|
|
515
554
|
*
|
|
@@ -829,7 +868,7 @@ export interface WaterTemperature {
|
|
|
829
868
|
/** Water temperature (°C). */
|
|
830
869
|
value: number;
|
|
831
870
|
}
|
|
832
|
-
/** CPU temperature. */
|
|
871
|
+
/** CPU temperature (deprecated, use SystemPerformanceInfo.thermal_zones instead). */
|
|
833
872
|
export interface CPUTemperature {
|
|
834
873
|
/** CPU temperature (°C). */
|
|
835
874
|
value: number;
|
|
@@ -1579,6 +1618,13 @@ export interface CameraParameters {
|
|
|
1579
1618
|
* The Blueye App allows users to set values between 500 and 1460.
|
|
1580
1619
|
*/
|
|
1581
1620
|
mtuSize: number;
|
|
1621
|
+
/** Recording video codec. If unset, uses platform default. */
|
|
1622
|
+
recordingCodec: RecordingCodec;
|
|
1623
|
+
/**
|
|
1624
|
+
* Recording bitrate in bits/sec. If 0 or unset, a default is computed based
|
|
1625
|
+
* on resolution, framerate, and encoding. Set explicitly to override.
|
|
1626
|
+
*/
|
|
1627
|
+
recordingBitrate: number;
|
|
1582
1628
|
}
|
|
1583
1629
|
/**
|
|
1584
1630
|
* Overlay parameters.
|
|
@@ -1944,7 +1990,7 @@ export interface PersistentStorageSettings {
|
|
|
1944
1990
|
accCalibration: boolean;
|
|
1945
1991
|
}
|
|
1946
1992
|
/**
|
|
1947
|
-
* CPU information.
|
|
1993
|
+
* CPU information (deprecated, use SystemPerformanceInfo instead).
|
|
1948
1994
|
*
|
|
1949
1995
|
* Contains information about the CPU load and memory usage of the drone.
|
|
1950
1996
|
*/
|
|
@@ -1960,6 +2006,119 @@ export interface CPUInfo {
|
|
|
1960
2006
|
/** Communication queue load (0..1). */
|
|
1961
2007
|
commQueueLoad: number;
|
|
1962
2008
|
}
|
|
2009
|
+
/** Per-core CPU utilization. */
|
|
2010
|
+
export interface CpuCoreLoad {
|
|
2011
|
+
/** Core index (0-based). */
|
|
2012
|
+
coreIndex: number;
|
|
2013
|
+
/** Core load (0..1). */
|
|
2014
|
+
load: number;
|
|
2015
|
+
/** Current clock frequency (MHz). */
|
|
2016
|
+
frequencyMhz: number;
|
|
2017
|
+
}
|
|
2018
|
+
/** GPU utilization and status. */
|
|
2019
|
+
export interface GpuInfo {
|
|
2020
|
+
/** GPU load (0..1). */
|
|
2021
|
+
load: number;
|
|
2022
|
+
/** Current GPU clock frequency (MHz). */
|
|
2023
|
+
frequencyMhz: number;
|
|
2024
|
+
}
|
|
2025
|
+
/**
|
|
2026
|
+
* Deep Learning Accelerator (DLA) utilization.
|
|
2027
|
+
*
|
|
2028
|
+
* Jetson Orin NX has two DLA engines used for inference offload.
|
|
2029
|
+
*/
|
|
2030
|
+
export interface DlaInfo {
|
|
2031
|
+
/** DLA engine index (0-based). */
|
|
2032
|
+
engineIndex: number;
|
|
2033
|
+
/** DLA engine load (0..1). */
|
|
2034
|
+
load: number;
|
|
2035
|
+
/** Core clock frequency (MHz). 0 when disabled. */
|
|
2036
|
+
frequencyMhz: number;
|
|
2037
|
+
/** True when the DLA engine is actively processing. */
|
|
2038
|
+
enabled: boolean;
|
|
2039
|
+
/** Falcon microcontroller clock frequency (MHz). 0 when disabled. */
|
|
2040
|
+
falconFrequencyMhz: number;
|
|
2041
|
+
}
|
|
2042
|
+
/** System memory information. */
|
|
2043
|
+
export interface MemoryInfo {
|
|
2044
|
+
/** Total RAM (bytes). */
|
|
2045
|
+
totalBytes: number;
|
|
2046
|
+
/** Used RAM (bytes). */
|
|
2047
|
+
usedBytes: number;
|
|
2048
|
+
/** Cached RAM (bytes). */
|
|
2049
|
+
cachedBytes: number;
|
|
2050
|
+
/** Memory bus utilization (0..1). i.MX only. */
|
|
2051
|
+
busLoad: number;
|
|
2052
|
+
}
|
|
2053
|
+
/** Thermal zone reading. */
|
|
2054
|
+
export interface ThermalZone {
|
|
2055
|
+
/** Thermal zone identifier. */
|
|
2056
|
+
zone: ThermalZoneId;
|
|
2057
|
+
/** Temperature (°C). */
|
|
2058
|
+
temperature: number;
|
|
2059
|
+
}
|
|
2060
|
+
/** Video codec engine status. */
|
|
2061
|
+
export interface VideoCodecInfo {
|
|
2062
|
+
/** Jetson only (NVENC/NVDEC/NVJPG/VIC devfreq). */
|
|
2063
|
+
encoderActive: boolean;
|
|
2064
|
+
/** Video encoder clock frequency (MHz). */
|
|
2065
|
+
encoderFrequencyMhz: number;
|
|
2066
|
+
/** Video decoder (NVDEC) is active. */
|
|
2067
|
+
decoderActive: boolean;
|
|
2068
|
+
/** Video decoder clock frequency (MHz). */
|
|
2069
|
+
decoderFrequencyMhz: number;
|
|
2070
|
+
/** JPEG engine (NVJPG) is active. */
|
|
2071
|
+
nvjpgActive: boolean;
|
|
2072
|
+
/** JPEG engine clock frequency (MHz). */
|
|
2073
|
+
nvjpgFrequencyMhz: number;
|
|
2074
|
+
/** Video Image Compositor (VIC) is active. */
|
|
2075
|
+
vicActive: boolean;
|
|
2076
|
+
/** VIC clock frequency (MHz). */
|
|
2077
|
+
vicFrequencyMhz: number;
|
|
2078
|
+
/** i.MX only (CODA VPU). */
|
|
2079
|
+
vpuActive: boolean;
|
|
2080
|
+
/** VPU AXI clock frequency (MHz). */
|
|
2081
|
+
vpuFrequencyMhz: number;
|
|
2082
|
+
/** Cumulative VPU_CODEC_IRQ count. */
|
|
2083
|
+
vpuCodecIrqCount: number;
|
|
2084
|
+
/** Cumulative VPU_JPG_IRQ count. */
|
|
2085
|
+
vpuJpgIrqCount: number;
|
|
2086
|
+
}
|
|
2087
|
+
/**
|
|
2088
|
+
* System performance information.
|
|
2089
|
+
*
|
|
2090
|
+
* Comprehensive performance metrics for the drone's compute platform.
|
|
2091
|
+
* Covers CPU, GPU, DLA, memory, thermals, and video codec utilization.
|
|
2092
|
+
* Fields not applicable to a platform are left at their zero/empty defaults.
|
|
2093
|
+
*/
|
|
2094
|
+
export interface SystemPerformanceInfo {
|
|
2095
|
+
/** Per-core CPU utilization. */
|
|
2096
|
+
cpuCores: CpuCoreLoad[];
|
|
2097
|
+
/** Mean CPU utilization across all cores (0..1). */
|
|
2098
|
+
cpuUtilization: number;
|
|
2099
|
+
/** GPU utilization. */
|
|
2100
|
+
gpu: GpuInfo | undefined;
|
|
2101
|
+
/** DLA engine utilization (Jetson only). */
|
|
2102
|
+
dlaEngines: DlaInfo[];
|
|
2103
|
+
/** RAM usage. */
|
|
2104
|
+
memory: MemoryInfo | undefined;
|
|
2105
|
+
/** All thermal zone readings. */
|
|
2106
|
+
thermalZones: ThermalZone[];
|
|
2107
|
+
/** Video encoder/decoder status. */
|
|
2108
|
+
videoCodec: VideoCodecInfo | undefined;
|
|
2109
|
+
/** Main queue load (0..1). */
|
|
2110
|
+
mainQueueLoad: number;
|
|
2111
|
+
/** Guestport queue load (0..1). */
|
|
2112
|
+
guestportQueueLoad: number;
|
|
2113
|
+
/** Communication queue load (0..1). */
|
|
2114
|
+
commQueueLoad: number;
|
|
2115
|
+
/** Camera queue load (0..1). */
|
|
2116
|
+
cameraQueueLoad: number;
|
|
2117
|
+
/** Overlay queue load (0..1). */
|
|
2118
|
+
overlayQueueLoad: number;
|
|
2119
|
+
/** Position observer queue load (0..1). */
|
|
2120
|
+
positionObserverQueueLoad: number;
|
|
2121
|
+
}
|
|
1963
2122
|
/**
|
|
1964
2123
|
* Surface Unit battery information.
|
|
1965
2124
|
*
|
|
@@ -1991,6 +2150,80 @@ export interface SurfaceUnitVersionInfo {
|
|
|
1991
2150
|
/** Surface Unit firmware version (x.y.z). */
|
|
1992
2151
|
version: string;
|
|
1993
2152
|
}
|
|
2153
|
+
/**
|
|
2154
|
+
* Bounding box for object detection.
|
|
2155
|
+
*
|
|
2156
|
+
* Coordinates are in pixels relative to the camera image,
|
|
2157
|
+
* where (x, y) is the top-left corner of the bounding box.
|
|
2158
|
+
*/
|
|
2159
|
+
export interface BoundingBox {
|
|
2160
|
+
/** Horizontal offset of the top-left corner (px). */
|
|
2161
|
+
x: number;
|
|
2162
|
+
/** Vertical offset of the top-left corner (px). */
|
|
2163
|
+
y: number;
|
|
2164
|
+
/** Width of the bounding box (px). */
|
|
2165
|
+
width: number;
|
|
2166
|
+
/** Height of the bounding box (px). */
|
|
2167
|
+
height: number;
|
|
2168
|
+
}
|
|
2169
|
+
/** A single object detection from a computer vision model. */
|
|
2170
|
+
export interface ObjectDetection {
|
|
2171
|
+
/** Bounding box of the detected object. */
|
|
2172
|
+
boundingBox: BoundingBox | undefined;
|
|
2173
|
+
/** Detection confidence score (0..1). */
|
|
2174
|
+
confidence: number;
|
|
2175
|
+
/** Numeric class identifier from the model. */
|
|
2176
|
+
classId: number;
|
|
2177
|
+
/** Human-readable class name. */
|
|
2178
|
+
className: string;
|
|
2179
|
+
/** Unique ID for tracking the same object across frames. */
|
|
2180
|
+
trackingId: number;
|
|
2181
|
+
}
|
|
2182
|
+
/** A list of object detections from a single model for a single video frame. */
|
|
2183
|
+
export interface ModelDetections {
|
|
2184
|
+
/** List of detections in the frame. */
|
|
2185
|
+
detections: ObjectDetection[];
|
|
2186
|
+
/** Which camera the detections are from. */
|
|
2187
|
+
camera: Camera;
|
|
2188
|
+
/** Width of the source image (px). */
|
|
2189
|
+
imageWidth: number;
|
|
2190
|
+
/** Height of the source image (px). */
|
|
2191
|
+
imageHeight: number;
|
|
2192
|
+
/** Name of the computer vision model that produced the detections. */
|
|
2193
|
+
modelName: string;
|
|
2194
|
+
}
|
|
2195
|
+
/** Generic filter settings. */
|
|
2196
|
+
export interface FilterMessage {
|
|
2197
|
+
/** If the filter is enabled. */
|
|
2198
|
+
enabled: boolean;
|
|
2199
|
+
/** Intensity of the filter (0..1). */
|
|
2200
|
+
intensity: number;
|
|
2201
|
+
}
|
|
2202
|
+
/**
|
|
2203
|
+
* Digital pan, tilt, and zoom state for the main camera.
|
|
2204
|
+
*
|
|
2205
|
+
* Only supported on X3 Ultra. Controls digital (not mechanical) zoom.
|
|
2206
|
+
*/
|
|
2207
|
+
export interface CameraPanTiltZoom {
|
|
2208
|
+
/** Horizontal pan (-1.0..1.0), where 0.0 is center. */
|
|
2209
|
+
pan: number;
|
|
2210
|
+
/** Vertical tilt (-1.0..1.0), where 0.0 is center. */
|
|
2211
|
+
tilt: number;
|
|
2212
|
+
/** Zoom level (0.0..1.0), where 0.0 is no zoom and 1.0 is maximum zoom. */
|
|
2213
|
+
zoom: number;
|
|
2214
|
+
}
|
|
2215
|
+
/**
|
|
2216
|
+
* Information about the operator controlling the drone.
|
|
2217
|
+
*
|
|
2218
|
+
* Used to identify who started a dive, for reporting and when importing
|
|
2219
|
+
* dives to Blueye Cloud.
|
|
2220
|
+
*/
|
|
2221
|
+
export interface OperatorInfo {
|
|
2222
|
+
/** Full name of the operator. */
|
|
2223
|
+
name: string;
|
|
2224
|
+
/** E-mail address of the operator. */
|
|
2225
|
+
email: string;
|
|
2226
|
+
}
|
|
1994
2227
|
export declare const BinlogRecord: MessageFns<BinlogRecord>;
|
|
1995
2228
|
export declare const LogEntry: MessageFns<LogEntry>;
|
|
1996
2229
|
export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
|
|
@@ -2080,8 +2313,21 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
|
|
|
2080
2313
|
export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
|
|
2081
2314
|
export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
|
|
2082
2315
|
export declare const CPUInfo: MessageFns<CPUInfo>;
|
|
2316
|
+
export declare const CpuCoreLoad: MessageFns<CpuCoreLoad>;
|
|
2317
|
+
export declare const GpuInfo: MessageFns<GpuInfo>;
|
|
2318
|
+
export declare const DlaInfo: MessageFns<DlaInfo>;
|
|
2319
|
+
export declare const MemoryInfo: MessageFns<MemoryInfo>;
|
|
2320
|
+
export declare const ThermalZone: MessageFns<ThermalZone>;
|
|
2321
|
+
export declare const VideoCodecInfo: MessageFns<VideoCodecInfo>;
|
|
2322
|
+
export declare const SystemPerformanceInfo: MessageFns<SystemPerformanceInfo>;
|
|
2083
2323
|
export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
|
|
2084
2324
|
export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
|
|
2325
|
+
export declare const BoundingBox: MessageFns<BoundingBox>;
|
|
2326
|
+
export declare const ObjectDetection: MessageFns<ObjectDetection>;
|
|
2327
|
+
export declare const ModelDetections: MessageFns<ModelDetections>;
|
|
2328
|
+
export declare const FilterMessage: MessageFns<FilterMessage>;
|
|
2329
|
+
export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
|
|
2330
|
+
export declare const OperatorInfo: MessageFns<OperatorInfo>;
|
|
2085
2331
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
2086
2332
|
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 {} ? {
|
|
2087
2333
|
[K in keyof T]?: DeepPartial<T[K]>;
|