@blueyerobotics/protocol-definitions 3.2.0-457224af → 3.2.0-469f6b07
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 +50 -2
- package/dist/control.js +235 -1
- package/dist/message_formats.d.ts +431 -12
- package/dist/message_formats.js +2833 -181
- package/dist/req_rep.d.ts +14 -0
- package/dist/req_rep.js +120 -1
- package/dist/telemetry.d.ts +56 -5
- package/dist/telemetry.js +238 -17
- package/package.json +1 -1
package/dist/req_rep.d.ts
CHANGED
|
@@ -171,6 +171,18 @@ export interface SetPubFrequencyRep {
|
|
|
171
171
|
/** True if message name valid and frequency successfully updated. */
|
|
172
172
|
success: boolean;
|
|
173
173
|
}
|
|
174
|
+
/** Request to update the logging frequency */
|
|
175
|
+
export interface SetLogFrequencyReq {
|
|
176
|
+
/** Message name, f. ex. "AttitudeTel" */
|
|
177
|
+
messageType: string;
|
|
178
|
+
/** Logging frequency (max 100 Hz). */
|
|
179
|
+
frequency: number;
|
|
180
|
+
}
|
|
181
|
+
/** Response after updating logging frequency */
|
|
182
|
+
export interface SetLogFrequencyRep {
|
|
183
|
+
/** True if message name valid and frequency successfully updated. */
|
|
184
|
+
success: boolean;
|
|
185
|
+
}
|
|
174
186
|
/** Request to get latest telemetry data */
|
|
175
187
|
export interface GetTelemetryReq {
|
|
176
188
|
/** Message name, f. ex. "AttitudeTel". */
|
|
@@ -265,6 +277,8 @@ export declare const SetHeadingModeReq: MessageFns<SetHeadingModeReq>;
|
|
|
265
277
|
export declare const SetHeadingModeRep: MessageFns<SetHeadingModeRep>;
|
|
266
278
|
export declare const SetPubFrequencyReq: MessageFns<SetPubFrequencyReq>;
|
|
267
279
|
export declare const SetPubFrequencyRep: MessageFns<SetPubFrequencyRep>;
|
|
280
|
+
export declare const SetLogFrequencyReq: MessageFns<SetLogFrequencyReq>;
|
|
281
|
+
export declare const SetLogFrequencyRep: MessageFns<SetLogFrequencyRep>;
|
|
268
282
|
export declare const GetTelemetryReq: MessageFns<GetTelemetryReq>;
|
|
269
283
|
export declare const GetTelemetryRep: MessageFns<GetTelemetryRep>;
|
|
270
284
|
export declare const SetPersistentStorageSettingsReq: MessageFns<SetPersistentStorageSettingsReq>;
|
package/dist/req_rep.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
// protoc v3.21.12
|
|
6
6
|
// source: req_rep.proto
|
|
7
7
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
8
|
-
exports.GetLogStreamingStatusRep = exports.GetLogStreamingStatusReq = exports.GetIperfStatusRep = exports.GetIperfStatusReq = exports.SetIperfStatusRep = exports.SetIperfStatusReq = exports.FlashEscSettingsRep = exports.FlashEscSettingsReq = exports.GetPersistentStorageSettingsRep = exports.GetPersistentStorageSettingsReq = exports.SetPersistentStorageSettingsRep = exports.SetPersistentStorageSettingsReq = exports.GetTelemetryRep = exports.GetTelemetryReq = exports.SetPubFrequencyRep = exports.SetPubFrequencyReq = exports.SetHeadingModeRep = exports.SetHeadingModeReq = exports.SetInstructionUpdateRep = exports.SetInstructionUpdateReq = exports.GetMissionRep = exports.GetMissionReq = exports.SetMissionRep = exports.SetMissionReq = exports.GetBatteryRep = exports.GetBatteryReq = exports.DisconnectClientRep = exports.DisconnectClientReq = exports.ConnectClientRep = exports.ConnectClientReq = exports.SetThicknessGaugeParametersRep = exports.SetThicknessGaugeParametersReq = exports.PingRep = exports.PingReq = exports.SyncTimeRep = exports.SyncTimeReq = exports.GetCameraParametersRep = exports.GetCameraParametersReq = exports.SetCameraParametersRep = exports.SetCameraParametersReq = exports.GetOverlayParametersRep = exports.GetOverlayParametersReq = exports.SetOverlayParametersRep = exports.SetOverlayParametersReq = void 0;
|
|
8
|
+
exports.GetLogStreamingStatusRep = exports.GetLogStreamingStatusReq = exports.GetIperfStatusRep = exports.GetIperfStatusReq = exports.SetIperfStatusRep = exports.SetIperfStatusReq = exports.FlashEscSettingsRep = exports.FlashEscSettingsReq = exports.GetPersistentStorageSettingsRep = exports.GetPersistentStorageSettingsReq = exports.SetPersistentStorageSettingsRep = exports.SetPersistentStorageSettingsReq = exports.GetTelemetryRep = exports.GetTelemetryReq = exports.SetLogFrequencyRep = exports.SetLogFrequencyReq = exports.SetPubFrequencyRep = exports.SetPubFrequencyReq = exports.SetHeadingModeRep = exports.SetHeadingModeReq = exports.SetInstructionUpdateRep = exports.SetInstructionUpdateReq = exports.GetMissionRep = exports.GetMissionReq = exports.SetMissionRep = exports.SetMissionReq = exports.GetBatteryRep = exports.GetBatteryReq = exports.DisconnectClientRep = exports.DisconnectClientReq = exports.ConnectClientRep = exports.ConnectClientReq = exports.SetThicknessGaugeParametersRep = exports.SetThicknessGaugeParametersReq = exports.PingRep = exports.PingReq = exports.SyncTimeRep = exports.SyncTimeReq = exports.GetCameraParametersRep = exports.GetCameraParametersReq = exports.SetCameraParametersRep = exports.SetCameraParametersReq = exports.GetOverlayParametersRep = exports.GetOverlayParametersReq = exports.SetOverlayParametersRep = exports.SetOverlayParametersReq = void 0;
|
|
9
9
|
/* eslint-disable */
|
|
10
10
|
const wire_1 = require("@bufbuild/protobuf/wire");
|
|
11
11
|
const any_1 = require("./google/protobuf/any");
|
|
@@ -1489,6 +1489,125 @@ exports.SetPubFrequencyRep = {
|
|
|
1489
1489
|
return message;
|
|
1490
1490
|
},
|
|
1491
1491
|
};
|
|
1492
|
+
function createBaseSetLogFrequencyReq() {
|
|
1493
|
+
return { messageType: "", frequency: 0 };
|
|
1494
|
+
}
|
|
1495
|
+
exports.SetLogFrequencyReq = {
|
|
1496
|
+
encode(message, writer = new wire_1.BinaryWriter()) {
|
|
1497
|
+
if (message.messageType !== "") {
|
|
1498
|
+
writer.uint32(10).string(message.messageType);
|
|
1499
|
+
}
|
|
1500
|
+
if (message.frequency !== 0) {
|
|
1501
|
+
writer.uint32(21).float(message.frequency);
|
|
1502
|
+
}
|
|
1503
|
+
return writer;
|
|
1504
|
+
},
|
|
1505
|
+
decode(input, length) {
|
|
1506
|
+
const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
|
|
1507
|
+
const end = length === undefined ? reader.len : reader.pos + length;
|
|
1508
|
+
const message = createBaseSetLogFrequencyReq();
|
|
1509
|
+
while (reader.pos < end) {
|
|
1510
|
+
const tag = reader.uint32();
|
|
1511
|
+
switch (tag >>> 3) {
|
|
1512
|
+
case 1: {
|
|
1513
|
+
if (tag !== 10) {
|
|
1514
|
+
break;
|
|
1515
|
+
}
|
|
1516
|
+
message.messageType = reader.string();
|
|
1517
|
+
continue;
|
|
1518
|
+
}
|
|
1519
|
+
case 2: {
|
|
1520
|
+
if (tag !== 21) {
|
|
1521
|
+
break;
|
|
1522
|
+
}
|
|
1523
|
+
message.frequency = reader.float();
|
|
1524
|
+
continue;
|
|
1525
|
+
}
|
|
1526
|
+
}
|
|
1527
|
+
if ((tag & 7) === 4 || tag === 0) {
|
|
1528
|
+
break;
|
|
1529
|
+
}
|
|
1530
|
+
reader.skip(tag & 7);
|
|
1531
|
+
}
|
|
1532
|
+
return message;
|
|
1533
|
+
},
|
|
1534
|
+
fromJSON(object) {
|
|
1535
|
+
return {
|
|
1536
|
+
messageType: isSet(object.messageType) ? gt.String(object.messageType) : "",
|
|
1537
|
+
frequency: isSet(object.frequency) ? gt.Number(object.frequency) : 0,
|
|
1538
|
+
};
|
|
1539
|
+
},
|
|
1540
|
+
toJSON(message) {
|
|
1541
|
+
const obj = {};
|
|
1542
|
+
if (message.messageType !== "") {
|
|
1543
|
+
obj.messageType = message.messageType;
|
|
1544
|
+
}
|
|
1545
|
+
if (message.frequency !== 0) {
|
|
1546
|
+
obj.frequency = message.frequency;
|
|
1547
|
+
}
|
|
1548
|
+
return obj;
|
|
1549
|
+
},
|
|
1550
|
+
create(base) {
|
|
1551
|
+
return exports.SetLogFrequencyReq.fromPartial(base ?? {});
|
|
1552
|
+
},
|
|
1553
|
+
fromPartial(object) {
|
|
1554
|
+
const message = createBaseSetLogFrequencyReq();
|
|
1555
|
+
message.messageType = object.messageType ?? "";
|
|
1556
|
+
message.frequency = object.frequency ?? 0;
|
|
1557
|
+
return message;
|
|
1558
|
+
},
|
|
1559
|
+
};
|
|
1560
|
+
function createBaseSetLogFrequencyRep() {
|
|
1561
|
+
return { success: false };
|
|
1562
|
+
}
|
|
1563
|
+
exports.SetLogFrequencyRep = {
|
|
1564
|
+
encode(message, writer = new wire_1.BinaryWriter()) {
|
|
1565
|
+
if (message.success !== false) {
|
|
1566
|
+
writer.uint32(8).bool(message.success);
|
|
1567
|
+
}
|
|
1568
|
+
return writer;
|
|
1569
|
+
},
|
|
1570
|
+
decode(input, length) {
|
|
1571
|
+
const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
|
|
1572
|
+
const end = length === undefined ? reader.len : reader.pos + length;
|
|
1573
|
+
const message = createBaseSetLogFrequencyRep();
|
|
1574
|
+
while (reader.pos < end) {
|
|
1575
|
+
const tag = reader.uint32();
|
|
1576
|
+
switch (tag >>> 3) {
|
|
1577
|
+
case 1: {
|
|
1578
|
+
if (tag !== 8) {
|
|
1579
|
+
break;
|
|
1580
|
+
}
|
|
1581
|
+
message.success = reader.bool();
|
|
1582
|
+
continue;
|
|
1583
|
+
}
|
|
1584
|
+
}
|
|
1585
|
+
if ((tag & 7) === 4 || tag === 0) {
|
|
1586
|
+
break;
|
|
1587
|
+
}
|
|
1588
|
+
reader.skip(tag & 7);
|
|
1589
|
+
}
|
|
1590
|
+
return message;
|
|
1591
|
+
},
|
|
1592
|
+
fromJSON(object) {
|
|
1593
|
+
return { success: isSet(object.success) ? gt.Boolean(object.success) : false };
|
|
1594
|
+
},
|
|
1595
|
+
toJSON(message) {
|
|
1596
|
+
const obj = {};
|
|
1597
|
+
if (message.success !== false) {
|
|
1598
|
+
obj.success = message.success;
|
|
1599
|
+
}
|
|
1600
|
+
return obj;
|
|
1601
|
+
},
|
|
1602
|
+
create(base) {
|
|
1603
|
+
return exports.SetLogFrequencyRep.fromPartial(base ?? {});
|
|
1604
|
+
},
|
|
1605
|
+
fromPartial(object) {
|
|
1606
|
+
const message = createBaseSetLogFrequencyRep();
|
|
1607
|
+
message.success = object.success ?? false;
|
|
1608
|
+
return message;
|
|
1609
|
+
},
|
|
1610
|
+
};
|
|
1492
1611
|
function createBaseGetTelemetryReq() {
|
|
1493
1612
|
return { messageType: "" };
|
|
1494
1613
|
}
|
package/dist/telemetry.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
|
|
2
2
|
import { AquaTrollProbeMetadata, AquaTrollSensorMetadataArray, AquaTrollSensorParametersArray } from "./aquatroll";
|
|
3
|
-
import { Altitude, Attitude, Battery, BatteryBQ40Z50, CalibrationState, CameraPanTiltZoom, CanisterHumidity, CanisterTemperature, ConnectedClient, ControlForce, ControllerHealth, ControlMode, CpProbe, CPUInfo, CPUTemperature, Depth, DiveTime, DroneInfo, DvlVelocity, ErrorFlags, FilterMessage, ForwardDistance, GenericServo, GuestPortCurrent, Imu, IperfStatus, KernelLogEntry, Laser, LatLongPosition, Lights, LogEntry, MagneticDeclination, MedusaSpectrometerData, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers,
|
|
3
|
+
import { Altitude, Annotation, Attitude, Battery, BatteryBQ40Z50, CalibrationState, CameraPanTiltZoom, CanisterHumidity, CanisterTemperature, ConnectedClient, ControlForce, ControllerHealth, ControlMode, CpProbe, CPUInfo, CPUTemperature, Depth, DiveTime, DroneInfo, DvlVelocity, ErrorFlags, FilterMessage, ForwardDistance, GenericServo, GuestPortCurrent, Imu, IperfStatus, KernelLogEntry, Laser, LaserDetection, LatLongPosition, Lights, LogEntry, MagneticDeclination, MedusaSpectrometerData, ModelDetections, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers, PositionEstimate, RecordState, Reference, RemovableStorageDevice, SotState, StorageSpace, SurfaceUnitBatteryInfo, SurfaceUnitVersionInfo, SystemPerformanceInfo, SystemTime, ThicknessGauge, TiltAngle, TiltStabilizationState, TimeLapseState, WaterTemperature } from "./message_formats";
|
|
4
4
|
import { MissionStatus, ReferenceAutoPilot } from "./mission_planning";
|
|
5
5
|
/**
|
|
6
6
|
* Telemetry
|
|
@@ -86,6 +86,8 @@ export interface GuestPortLightsTel {
|
|
|
86
86
|
export interface LaserTel {
|
|
87
87
|
/** Laser status. */
|
|
88
88
|
laser: Laser | undefined;
|
|
89
|
+
/** Detection of the laser by the computer vision pipeline. Only */
|
|
90
|
+
laserDetection: LaserDetection | undefined;
|
|
89
91
|
}
|
|
90
92
|
/** Pilot position (originating from device GPS) for logging. */
|
|
91
93
|
export interface PilotGPSPositionTel {
|
|
@@ -102,18 +104,32 @@ export interface TimeLapseStateTel {
|
|
|
102
104
|
/** Time-lapse state. */
|
|
103
105
|
timeLapseState: TimeLapseState | undefined;
|
|
104
106
|
}
|
|
105
|
-
/**
|
|
107
|
+
/**
|
|
108
|
+
* Receive essential information about the battery status.
|
|
109
|
+
*
|
|
110
|
+
* On models with two batteries running in parallel (e.g. the X7), second_battery
|
|
111
|
+
* holds the essential information for the second battery. When only a single
|
|
112
|
+
* battery is used, second_battery is undefined (not set).
|
|
113
|
+
*/
|
|
106
114
|
export interface BatteryTel {
|
|
107
115
|
/** Essential battery information. */
|
|
108
116
|
battery: Battery | undefined;
|
|
117
|
+
/** Second battery, when present. Not set if only one battery is used. */
|
|
118
|
+
secondBattery: Battery | undefined;
|
|
109
119
|
}
|
|
110
120
|
/**
|
|
111
121
|
* Receive detailed information about a battery using the
|
|
112
122
|
* BQ40Z50 battery management system.
|
|
123
|
+
*
|
|
124
|
+
* On models with two batteries running in parallel (e.g. the X7), second_battery
|
|
125
|
+
* holds the detailed information for the second battery. When only a single
|
|
126
|
+
* battery is used, second_battery is undefined (not set).
|
|
113
127
|
*/
|
|
114
128
|
export interface BatteryBQ40Z50Tel {
|
|
115
129
|
/** Detailed battery information. */
|
|
116
130
|
battery: BatteryBQ40Z50 | undefined;
|
|
131
|
+
/** Second battery, when present. Not set if only one battery is used. */
|
|
132
|
+
secondBattery: BatteryBQ40Z50 | undefined;
|
|
117
133
|
}
|
|
118
134
|
/** Receive the dive time of the drone. */
|
|
119
135
|
export interface DiveTimeTel {
|
|
@@ -329,10 +345,10 @@ export interface LogEntryTel {
|
|
|
329
345
|
/** Kernel log entry. */
|
|
330
346
|
kernel?: KernelLogEntry | undefined;
|
|
331
347
|
}
|
|
332
|
-
/** Object detections from
|
|
348
|
+
/** Object detections from all active computer vision models. */
|
|
333
349
|
export interface ObjectDetectionsTel {
|
|
334
|
-
/**
|
|
335
|
-
|
|
350
|
+
/** Per-model detection results. */
|
|
351
|
+
modelDetections: ModelDetections[];
|
|
336
352
|
}
|
|
337
353
|
/**
|
|
338
354
|
* Turbidity filter settings telemetry message.
|
|
@@ -343,6 +359,15 @@ export interface TurbidityFilterTel {
|
|
|
343
359
|
/** Turbidity filter settings. */
|
|
344
360
|
turbidityFilter: FilterMessage | undefined;
|
|
345
361
|
}
|
|
362
|
+
/**
|
|
363
|
+
* Color correction settings telemetry message.
|
|
364
|
+
*
|
|
365
|
+
* Message is published when the filter settings are changed.
|
|
366
|
+
*/
|
|
367
|
+
export interface ColorCorrectionTel {
|
|
368
|
+
/** Color correction settings. */
|
|
369
|
+
colorCorrectionFilter: FilterMessage | undefined;
|
|
370
|
+
}
|
|
346
371
|
/**
|
|
347
372
|
* Digital pan, tilt, and zoom telemetry from the main camera.
|
|
348
373
|
*
|
|
@@ -353,6 +378,29 @@ export interface CameraPanTiltZoomTel {
|
|
|
353
378
|
/** Current pan, tilt, and zoom state. */
|
|
354
379
|
cameraPanTiltZoom: CameraPanTiltZoom | undefined;
|
|
355
380
|
}
|
|
381
|
+
/**
|
|
382
|
+
* Single-object tracking (SOT) state telemetry from the computer vision pipeline.
|
|
383
|
+
*
|
|
384
|
+
* Reports the current tracking state and the tracked bounding box when active.
|
|
385
|
+
* Published periodically while the SOT pipeline is running.
|
|
386
|
+
*/
|
|
387
|
+
export interface SotStateTel {
|
|
388
|
+
/** Current SOT state and bounding box. */
|
|
389
|
+
sotState: SotState | undefined;
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* An annotation that now exists on the dive.
|
|
393
|
+
*
|
|
394
|
+
* Either added by a client (the drone echoes its AnnotationCtrl here, source APP)
|
|
395
|
+
* or emitted by the drone itself (source DRONE); CLOUD is the post-dive Blueye
|
|
396
|
+
* Cloud path and is not seen here. Published to every connected client and
|
|
397
|
+
* written to the dive logfile. A late-joining client can fetch the most recent
|
|
398
|
+
* one with GetTelemetryReq("AnnotationTel").
|
|
399
|
+
*/
|
|
400
|
+
export interface AnnotationTel {
|
|
401
|
+
/** The annotation that was added. */
|
|
402
|
+
annotation: Annotation | undefined;
|
|
403
|
+
}
|
|
356
404
|
export declare const AttitudeTel: MessageFns<AttitudeTel>;
|
|
357
405
|
export declare const MagneticDeclinationTel: MessageFns<MagneticDeclinationTel>;
|
|
358
406
|
export declare const AltitudeTel: MessageFns<AltitudeTel>;
|
|
@@ -415,7 +463,10 @@ export declare const SurfaceUnitTel: MessageFns<SurfaceUnitTel>;
|
|
|
415
463
|
export declare const LogEntryTel: MessageFns<LogEntryTel>;
|
|
416
464
|
export declare const ObjectDetectionsTel: MessageFns<ObjectDetectionsTel>;
|
|
417
465
|
export declare const TurbidityFilterTel: MessageFns<TurbidityFilterTel>;
|
|
466
|
+
export declare const ColorCorrectionTel: MessageFns<ColorCorrectionTel>;
|
|
418
467
|
export declare const CameraPanTiltZoomTel: MessageFns<CameraPanTiltZoomTel>;
|
|
468
|
+
export declare const SotStateTel: MessageFns<SotStateTel>;
|
|
469
|
+
export declare const AnnotationTel: MessageFns<AnnotationTel>;
|
|
419
470
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
420
471
|
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 {} ? {
|
|
421
472
|
[K in keyof T]?: DeepPartial<T[K]>;
|