@blueyerobotics/protocol-definitions 3.2.0-db84868b → 3.2.0-dc69375e

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.
@@ -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, 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";
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
@@ -104,18 +104,32 @@ export interface TimeLapseStateTel {
104
104
  /** Time-lapse state. */
105
105
  timeLapseState: TimeLapseState | undefined;
106
106
  }
107
- /** Receive essential information about the battery status. */
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
+ */
108
114
  export interface BatteryTel {
109
115
  /** Essential battery information. */
110
116
  battery: Battery | undefined;
117
+ /** Second battery, when present. Not set if only one battery is used. */
118
+ secondBattery: Battery | undefined;
111
119
  }
112
120
  /**
113
121
  * Receive detailed information about a battery using the
114
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).
115
127
  */
116
128
  export interface BatteryBQ40Z50Tel {
117
129
  /** Detailed battery information. */
118
130
  battery: BatteryBQ40Z50 | undefined;
131
+ /** Second battery, when present. Not set if only one battery is used. */
132
+ secondBattery: BatteryBQ40Z50 | undefined;
119
133
  }
120
134
  /** Receive the dive time of the drone. */
121
135
  export interface DiveTimeTel {
@@ -345,6 +359,15 @@ export interface TurbidityFilterTel {
345
359
  /** Turbidity filter settings. */
346
360
  turbidityFilter: FilterMessage | undefined;
347
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
+ }
348
371
  /**
349
372
  * Digital pan, tilt, and zoom telemetry from the main camera.
350
373
  *
@@ -365,6 +388,19 @@ export interface SotStateTel {
365
388
  /** Current SOT state and bounding box. */
366
389
  sotState: SotState | undefined;
367
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
+ }
368
404
  export declare const AttitudeTel: MessageFns<AttitudeTel>;
369
405
  export declare const MagneticDeclinationTel: MessageFns<MagneticDeclinationTel>;
370
406
  export declare const AltitudeTel: MessageFns<AltitudeTel>;
@@ -427,8 +463,10 @@ export declare const SurfaceUnitTel: MessageFns<SurfaceUnitTel>;
427
463
  export declare const LogEntryTel: MessageFns<LogEntryTel>;
428
464
  export declare const ObjectDetectionsTel: MessageFns<ObjectDetectionsTel>;
429
465
  export declare const TurbidityFilterTel: MessageFns<TurbidityFilterTel>;
466
+ export declare const ColorCorrectionTel: MessageFns<ColorCorrectionTel>;
430
467
  export declare const CameraPanTiltZoomTel: MessageFns<CameraPanTiltZoomTel>;
431
468
  export declare const SotStateTel: MessageFns<SotStateTel>;
469
+ export declare const AnnotationTel: MessageFns<AnnotationTel>;
432
470
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
433
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 {} ? {
434
472
  [K in keyof T]?: DeepPartial<T[K]>;
package/dist/telemetry.js CHANGED
@@ -6,7 +6,7 @@
6
6
  // source: telemetry.proto
7
7
  Object.defineProperty(exports, "__esModule", { value: true });
8
8
  exports.Imu2Tel = exports.Imu1Tel = exports.CalibratedImuTel = exports.GuestPortCurrentTel = exports.MultibeamServoTel = exports.GenericServoTel = exports.ConnectedClientsTel = exports.AquaTrollSensorParametersTel = exports.AquaTrollSensorMetadataTel = exports.AquaTrollProbeMetadataTel = exports.CpProbeTel = exports.ThicknessGaugeTel = exports.ControlModeTel = exports.ErrorFlagsTel = exports.DroneInfoTel = exports.TiltAngleTel = exports.NStreamersTel = exports.IperfTel = exports.TiltStabilizationTel = exports.CalibrationStateTel = exports.DataStorageSpaceTel = exports.RemovableStorageTel = exports.VideoStorageSpaceTel = exports.CanisterBottomHumidityTel = exports.CanisterBottomTemperatureTel = exports.CPUTemperatureTel = exports.WaterTemperatureTel = exports.DroneTimeTel = exports.DiveTimeTel = exports.BatteryBQ40Z50Tel = exports.BatteryTel = exports.TimeLapseStateTel = exports.RecordStateTel = exports.PilotGPSPositionTel = exports.LaserTel = exports.GuestPortLightsTel = exports.LightsTel = exports.ControllerHealthTel = exports.ControlForceTel = exports.NotificationTel = exports.MissionStatusTel = exports.ReferenceAutoPilotTel = exports.ReferenceTel = exports.DepthTel = exports.PositionEstimateTel = exports.DvlVelocityTel = exports.ForwardDistanceTel = exports.AltitudeTel = exports.MagneticDeclinationTel = exports.AttitudeTel = void 0;
9
- exports.SotStateTel = exports.CameraPanTiltZoomTel = exports.TurbidityFilterTel = exports.ObjectDetectionsTel = exports.LogEntryTel = exports.SurfaceUnitTel = exports.SystemPerformanceInfoTel = exports.CPUInfoTel = exports.MultibeamDiscoveryTel = exports.MultibeamConfigTel = exports.MultibeamPingTel = exports.MedusaSpectrometerDataTel = exports.CalibratedImuHpTel = exports.ImuHpTel = void 0;
9
+ exports.AnnotationTel = exports.SotStateTel = exports.CameraPanTiltZoomTel = exports.ColorCorrectionTel = exports.TurbidityFilterTel = exports.ObjectDetectionsTel = exports.LogEntryTel = exports.SurfaceUnitTel = exports.SystemPerformanceInfoTel = exports.CPUInfoTel = exports.MultibeamDiscoveryTel = exports.MultibeamConfigTel = exports.MultibeamPingTel = exports.MedusaSpectrometerDataTel = exports.CalibratedImuHpTel = exports.ImuHpTel = void 0;
10
10
  /* eslint-disable */
11
11
  const wire_1 = require("@bufbuild/protobuf/wire");
12
12
  const aquatroll_1 = require("./aquatroll");
@@ -1051,13 +1051,16 @@ exports.TimeLapseStateTel = {
1051
1051
  },
1052
1052
  };
1053
1053
  function createBaseBatteryTel() {
1054
- return { battery: undefined };
1054
+ return { battery: undefined, secondBattery: undefined };
1055
1055
  }
1056
1056
  exports.BatteryTel = {
1057
1057
  encode(message, writer = new wire_1.BinaryWriter()) {
1058
1058
  if (message.battery !== undefined) {
1059
1059
  message_formats_1.Battery.encode(message.battery, writer.uint32(10).fork()).join();
1060
1060
  }
1061
+ if (message.secondBattery !== undefined) {
1062
+ message_formats_1.Battery.encode(message.secondBattery, writer.uint32(18).fork()).join();
1063
+ }
1061
1064
  return writer;
1062
1065
  },
1063
1066
  decode(input, length) {
@@ -1074,6 +1077,13 @@ exports.BatteryTel = {
1074
1077
  message.battery = message_formats_1.Battery.decode(reader, reader.uint32());
1075
1078
  continue;
1076
1079
  }
1080
+ case 2: {
1081
+ if (tag !== 18) {
1082
+ break;
1083
+ }
1084
+ message.secondBattery = message_formats_1.Battery.decode(reader, reader.uint32());
1085
+ continue;
1086
+ }
1077
1087
  }
1078
1088
  if ((tag & 7) === 4 || tag === 0) {
1079
1089
  break;
@@ -1083,13 +1093,19 @@ exports.BatteryTel = {
1083
1093
  return message;
1084
1094
  },
1085
1095
  fromJSON(object) {
1086
- return { battery: isSet(object.battery) ? message_formats_1.Battery.fromJSON(object.battery) : undefined };
1096
+ return {
1097
+ battery: isSet(object.battery) ? message_formats_1.Battery.fromJSON(object.battery) : undefined,
1098
+ secondBattery: isSet(object.secondBattery) ? message_formats_1.Battery.fromJSON(object.secondBattery) : undefined,
1099
+ };
1087
1100
  },
1088
1101
  toJSON(message) {
1089
1102
  const obj = {};
1090
1103
  if (message.battery !== undefined) {
1091
1104
  obj.battery = message_formats_1.Battery.toJSON(message.battery);
1092
1105
  }
1106
+ if (message.secondBattery !== undefined) {
1107
+ obj.secondBattery = message_formats_1.Battery.toJSON(message.secondBattery);
1108
+ }
1093
1109
  return obj;
1094
1110
  },
1095
1111
  create(base) {
@@ -1100,17 +1116,23 @@ exports.BatteryTel = {
1100
1116
  message.battery = (object.battery !== undefined && object.battery !== null)
1101
1117
  ? message_formats_1.Battery.fromPartial(object.battery)
1102
1118
  : undefined;
1119
+ message.secondBattery = (object.secondBattery !== undefined && object.secondBattery !== null)
1120
+ ? message_formats_1.Battery.fromPartial(object.secondBattery)
1121
+ : undefined;
1103
1122
  return message;
1104
1123
  },
1105
1124
  };
1106
1125
  function createBaseBatteryBQ40Z50Tel() {
1107
- return { battery: undefined };
1126
+ return { battery: undefined, secondBattery: undefined };
1108
1127
  }
1109
1128
  exports.BatteryBQ40Z50Tel = {
1110
1129
  encode(message, writer = new wire_1.BinaryWriter()) {
1111
1130
  if (message.battery !== undefined) {
1112
1131
  message_formats_1.BatteryBQ40Z50.encode(message.battery, writer.uint32(10).fork()).join();
1113
1132
  }
1133
+ if (message.secondBattery !== undefined) {
1134
+ message_formats_1.BatteryBQ40Z50.encode(message.secondBattery, writer.uint32(18).fork()).join();
1135
+ }
1114
1136
  return writer;
1115
1137
  },
1116
1138
  decode(input, length) {
@@ -1127,6 +1149,13 @@ exports.BatteryBQ40Z50Tel = {
1127
1149
  message.battery = message_formats_1.BatteryBQ40Z50.decode(reader, reader.uint32());
1128
1150
  continue;
1129
1151
  }
1152
+ case 2: {
1153
+ if (tag !== 18) {
1154
+ break;
1155
+ }
1156
+ message.secondBattery = message_formats_1.BatteryBQ40Z50.decode(reader, reader.uint32());
1157
+ continue;
1158
+ }
1130
1159
  }
1131
1160
  if ((tag & 7) === 4 || tag === 0) {
1132
1161
  break;
@@ -1136,13 +1165,19 @@ exports.BatteryBQ40Z50Tel = {
1136
1165
  return message;
1137
1166
  },
1138
1167
  fromJSON(object) {
1139
- return { battery: isSet(object.battery) ? message_formats_1.BatteryBQ40Z50.fromJSON(object.battery) : undefined };
1168
+ return {
1169
+ battery: isSet(object.battery) ? message_formats_1.BatteryBQ40Z50.fromJSON(object.battery) : undefined,
1170
+ secondBattery: isSet(object.secondBattery) ? message_formats_1.BatteryBQ40Z50.fromJSON(object.secondBattery) : undefined,
1171
+ };
1140
1172
  },
1141
1173
  toJSON(message) {
1142
1174
  const obj = {};
1143
1175
  if (message.battery !== undefined) {
1144
1176
  obj.battery = message_formats_1.BatteryBQ40Z50.toJSON(message.battery);
1145
1177
  }
1178
+ if (message.secondBattery !== undefined) {
1179
+ obj.secondBattery = message_formats_1.BatteryBQ40Z50.toJSON(message.secondBattery);
1180
+ }
1146
1181
  return obj;
1147
1182
  },
1148
1183
  create(base) {
@@ -1153,6 +1188,9 @@ exports.BatteryBQ40Z50Tel = {
1153
1188
  message.battery = (object.battery !== undefined && object.battery !== null)
1154
1189
  ? message_formats_1.BatteryBQ40Z50.fromPartial(object.battery)
1155
1190
  : undefined;
1191
+ message.secondBattery = (object.secondBattery !== undefined && object.secondBattery !== null)
1192
+ ? message_formats_1.BatteryBQ40Z50.fromPartial(object.secondBattery)
1193
+ : undefined;
1156
1194
  return message;
1157
1195
  },
1158
1196
  };
@@ -3461,6 +3499,64 @@ exports.TurbidityFilterTel = {
3461
3499
  return message;
3462
3500
  },
3463
3501
  };
3502
+ function createBaseColorCorrectionTel() {
3503
+ return { colorCorrectionFilter: undefined };
3504
+ }
3505
+ exports.ColorCorrectionTel = {
3506
+ encode(message, writer = new wire_1.BinaryWriter()) {
3507
+ if (message.colorCorrectionFilter !== undefined) {
3508
+ message_formats_1.FilterMessage.encode(message.colorCorrectionFilter, writer.uint32(10).fork()).join();
3509
+ }
3510
+ return writer;
3511
+ },
3512
+ decode(input, length) {
3513
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
3514
+ const end = length === undefined ? reader.len : reader.pos + length;
3515
+ const message = createBaseColorCorrectionTel();
3516
+ while (reader.pos < end) {
3517
+ const tag = reader.uint32();
3518
+ switch (tag >>> 3) {
3519
+ case 1: {
3520
+ if (tag !== 10) {
3521
+ break;
3522
+ }
3523
+ message.colorCorrectionFilter = message_formats_1.FilterMessage.decode(reader, reader.uint32());
3524
+ continue;
3525
+ }
3526
+ }
3527
+ if ((tag & 7) === 4 || tag === 0) {
3528
+ break;
3529
+ }
3530
+ reader.skip(tag & 7);
3531
+ }
3532
+ return message;
3533
+ },
3534
+ fromJSON(object) {
3535
+ return {
3536
+ colorCorrectionFilter: isSet(object.colorCorrectionFilter)
3537
+ ? message_formats_1.FilterMessage.fromJSON(object.colorCorrectionFilter)
3538
+ : undefined,
3539
+ };
3540
+ },
3541
+ toJSON(message) {
3542
+ const obj = {};
3543
+ if (message.colorCorrectionFilter !== undefined) {
3544
+ obj.colorCorrectionFilter = message_formats_1.FilterMessage.toJSON(message.colorCorrectionFilter);
3545
+ }
3546
+ return obj;
3547
+ },
3548
+ create(base) {
3549
+ return exports.ColorCorrectionTel.fromPartial(base ?? {});
3550
+ },
3551
+ fromPartial(object) {
3552
+ const message = createBaseColorCorrectionTel();
3553
+ message.colorCorrectionFilter =
3554
+ (object.colorCorrectionFilter !== undefined && object.colorCorrectionFilter !== null)
3555
+ ? message_formats_1.FilterMessage.fromPartial(object.colorCorrectionFilter)
3556
+ : undefined;
3557
+ return message;
3558
+ },
3559
+ };
3464
3560
  function createBaseCameraPanTiltZoomTel() {
3465
3561
  return { cameraPanTiltZoom: undefined };
3466
3562
  }
@@ -3571,6 +3667,59 @@ exports.SotStateTel = {
3571
3667
  return message;
3572
3668
  },
3573
3669
  };
3670
+ function createBaseAnnotationTel() {
3671
+ return { annotation: undefined };
3672
+ }
3673
+ exports.AnnotationTel = {
3674
+ encode(message, writer = new wire_1.BinaryWriter()) {
3675
+ if (message.annotation !== undefined) {
3676
+ message_formats_1.Annotation.encode(message.annotation, writer.uint32(10).fork()).join();
3677
+ }
3678
+ return writer;
3679
+ },
3680
+ decode(input, length) {
3681
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
3682
+ const end = length === undefined ? reader.len : reader.pos + length;
3683
+ const message = createBaseAnnotationTel();
3684
+ while (reader.pos < end) {
3685
+ const tag = reader.uint32();
3686
+ switch (tag >>> 3) {
3687
+ case 1: {
3688
+ if (tag !== 10) {
3689
+ break;
3690
+ }
3691
+ message.annotation = message_formats_1.Annotation.decode(reader, reader.uint32());
3692
+ continue;
3693
+ }
3694
+ }
3695
+ if ((tag & 7) === 4 || tag === 0) {
3696
+ break;
3697
+ }
3698
+ reader.skip(tag & 7);
3699
+ }
3700
+ return message;
3701
+ },
3702
+ fromJSON(object) {
3703
+ return { annotation: isSet(object.annotation) ? message_formats_1.Annotation.fromJSON(object.annotation) : undefined };
3704
+ },
3705
+ toJSON(message) {
3706
+ const obj = {};
3707
+ if (message.annotation !== undefined) {
3708
+ obj.annotation = message_formats_1.Annotation.toJSON(message.annotation);
3709
+ }
3710
+ return obj;
3711
+ },
3712
+ create(base) {
3713
+ return exports.AnnotationTel.fromPartial(base ?? {});
3714
+ },
3715
+ fromPartial(object) {
3716
+ const message = createBaseAnnotationTel();
3717
+ message.annotation = (object.annotation !== undefined && object.annotation !== null)
3718
+ ? message_formats_1.Annotation.fromPartial(object.annotation)
3719
+ : undefined;
3720
+ return message;
3721
+ },
3722
+ };
3574
3723
  const gt = (() => {
3575
3724
  if (typeof globalThis !== "undefined") {
3576
3725
  return globalThis;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blueyerobotics/protocol-definitions",
3
- "version": "3.2.0-db84868b",
3
+ "version": "3.2.0-dc69375e",
4
4
  "license": "LGPL-3.0-only",
5
5
  "description": "TypeScript definitions for Blueye Robotics protocols",
6
6
  "repository": {