@blueyerobotics/protocol-definitions 3.4.0-8187f91a → 3.4.0-sonar3d-slam.4e329580

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.js";
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, GnssStatus, Gripper, GripperDiagnostics, GripperInfo, GuestPortCurrent, Imu, IperfStatus, KernelLogEntry, Laser, LaserDetection, LatLongPosition, Lights, LogEntry, MagneticDeclination, MarineSnowFilterFrames, MedusaSpectrometerData, ModelDetections, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers, PositionEstimate, PowerCanister, RecordState, Reference, RemovableStorageDevice, SotState, StorageSpace, SurfaceUnitBatteryInfo, SurfaceUnitVersionInfo, SystemPerformanceInfo, SystemTime, ThicknessGauge, TiltAngle, TiltStabilizationState, TimeLapseState, WaterTemperature } from "./message_formats.js";
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, GnssStatus, Gripper, GripperDiagnostics, GripperInfo, GuestPortCurrent, Imu, IperfStatus, KernelLogEntry, Laser, LaserDetection, LatLongPosition, Lights, LogEntry, MagneticDeclination, MarineSnowFilterFrames, MedusaSpectrometerData, ModelDetections, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers, PositionEstimate, PowerCanister, RecordState, Reference, RemovableStorageDevice, SlamMap, SlamMapUpdate, SlamPoseEstimate, SlamRecordingState, SlamScan, SlamSensorStatus, SotState, StorageSpace, SurfaceUnitBatteryInfo, SurfaceUnitVersionInfo, SystemPerformanceInfo, SystemTime, ThicknessGauge, TiltAngle, TiltStabilizationState, TimeLapseState, WaterTemperature } from "./message_formats.js";
4
4
  import { MissionStatus, ReferenceAutoPilot } from "./mission_planning.js";
5
5
  /**
6
6
  * Telemetry
@@ -443,6 +443,60 @@ export interface AnnotationTel {
443
443
  /** The annotation that was added. */
444
444
  annotation: Annotation | undefined;
445
445
  }
446
+ /**
447
+ * SLAM estimate of the sensor pose.
448
+ *
449
+ * Published for every scan on the SLAM publisher, not the main telemetry socket.
450
+ */
451
+ export interface SlamPoseTel {
452
+ /** The pose estimate. */
453
+ estimate: SlamPoseEstimate | undefined;
454
+ }
455
+ /**
456
+ * A change to the SLAM map: new keyframes and points, or a corrected trajectory.
457
+ *
458
+ * Published on the SLAM publisher. A client applies the updates that follow the
459
+ * map it holds (SlamMapTel).
460
+ */
461
+ export interface SlamMapUpdateTel {
462
+ /** The change. */
463
+ update: SlamMapUpdate | undefined;
464
+ }
465
+ /**
466
+ * The latest scan placed in the SLAM map.
467
+ *
468
+ * Published on the SLAM publisher for live display; not part of the map.
469
+ */
470
+ export interface SlamScanTel {
471
+ /** The scan. */
472
+ scan: SlamScan | undefined;
473
+ }
474
+ /**
475
+ * The whole SLAM map.
476
+ *
477
+ * Published on the SLAM publisher when a client asks for it (GetSlamMapReq), and
478
+ * when a SLAM recording stops. A client subscribes, asks, keeps the updates that
479
+ * arrive meanwhile, and applies those that follow this map's sequence.
480
+ */
481
+ export interface SlamMapTel {
482
+ /** The map. */
483
+ map: SlamMap | undefined;
484
+ }
485
+ /**
486
+ * The SLAM's state.
487
+ *
488
+ * Published on the SLAM publisher once a second, and when it changes.
489
+ */
490
+ export interface SlamStatusTel {
491
+ /** True while the SLAM is mapping: its sensors are on and scans are placed. */
492
+ active: boolean;
493
+ /** Identifier of the current map, 0 before the first. */
494
+ mapId: number;
495
+ /** The recording, when one runs or ran. */
496
+ recording: SlamRecordingState | undefined;
497
+ /** The sensors that feed the SLAM. */
498
+ sensors: SlamSensorStatus[];
499
+ }
446
500
  export declare const AttitudeTel: MessageFns<AttitudeTel>;
447
501
  export declare const MagneticDeclinationTel: MessageFns<MagneticDeclinationTel>;
448
502
  export declare const AltitudeTel: MessageFns<AltitudeTel>;
@@ -515,6 +569,11 @@ export declare const MarineSnowFilterTel: MessageFns<MarineSnowFilterTel>;
515
569
  export declare const CameraPanTiltZoomTel: MessageFns<CameraPanTiltZoomTel>;
516
570
  export declare const SotStateTel: MessageFns<SotStateTel>;
517
571
  export declare const AnnotationTel: MessageFns<AnnotationTel>;
572
+ export declare const SlamPoseTel: MessageFns<SlamPoseTel>;
573
+ export declare const SlamMapUpdateTel: MessageFns<SlamMapUpdateTel>;
574
+ export declare const SlamScanTel: MessageFns<SlamScanTel>;
575
+ export declare const SlamMapTel: MessageFns<SlamMapTel>;
576
+ export declare const SlamStatusTel: MessageFns<SlamStatusTel>;
518
577
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
519
578
  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 {} ? {
520
579
  [K in keyof T]?: DeepPartial<T[K]>;
package/dist/telemetry.js CHANGED
@@ -6,7 +6,7 @@
6
6
  /* eslint-disable */
7
7
  import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
8
8
  import { AquaTrollProbeMetadata, AquaTrollSensorMetadataArray, AquaTrollSensorParametersArray } from "./aquatroll.js";
9
- 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, GnssStatus, Gripper, GripperDiagnostics, GripperInfo, GuestPortCurrent, Imu, IperfStatus, KernelLogEntry, Laser, LaserDetection, LatLongPosition, Lights, LogEntry, MagneticDeclination, MarineSnowFilterFrames, MedusaSpectrometerData, ModelDetections, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers, PositionEstimate, PowerCanister, RecordState, Reference, RemovableStorageDevice, SotState, StorageSpace, SurfaceUnitBatteryInfo, SurfaceUnitVersionInfo, SystemPerformanceInfo, SystemTime, ThicknessGauge, TiltAngle, TiltStabilizationState, TimeLapseState, WaterTemperature, } from "./message_formats.js";
9
+ 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, GnssStatus, Gripper, GripperDiagnostics, GripperInfo, GuestPortCurrent, Imu, IperfStatus, KernelLogEntry, Laser, LaserDetection, LatLongPosition, Lights, LogEntry, MagneticDeclination, MarineSnowFilterFrames, MedusaSpectrometerData, ModelDetections, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers, PositionEstimate, PowerCanister, RecordState, Reference, RemovableStorageDevice, SlamMap, SlamMapUpdate, SlamPoseEstimate, SlamRecordingState, SlamScan, SlamSensorStatus, SotState, StorageSpace, SurfaceUnitBatteryInfo, SurfaceUnitVersionInfo, SystemPerformanceInfo, SystemTime, ThicknessGauge, TiltAngle, TiltStabilizationState, TimeLapseState, WaterTemperature, } from "./message_formats.js";
10
10
  import { MissionStatus, ReferenceAutoPilot } from "./mission_planning.js";
11
11
  function createBaseAttitudeTel() {
12
12
  return { attitude: undefined };
@@ -4057,6 +4057,314 @@ export const AnnotationTel = {
4057
4057
  return message;
4058
4058
  },
4059
4059
  };
4060
+ function createBaseSlamPoseTel() {
4061
+ return { estimate: undefined };
4062
+ }
4063
+ export const SlamPoseTel = {
4064
+ encode(message, writer = new BinaryWriter()) {
4065
+ if (message.estimate !== undefined) {
4066
+ SlamPoseEstimate.encode(message.estimate, writer.uint32(10).fork()).join();
4067
+ }
4068
+ return writer;
4069
+ },
4070
+ decode(input, length) {
4071
+ const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
4072
+ const end = length === undefined ? reader.len : reader.pos + length;
4073
+ const message = createBaseSlamPoseTel();
4074
+ while (reader.pos < end) {
4075
+ const tag = reader.uint32();
4076
+ switch (tag >>> 3) {
4077
+ case 1: {
4078
+ if (tag !== 10) {
4079
+ break;
4080
+ }
4081
+ message.estimate = SlamPoseEstimate.decode(reader, reader.uint32());
4082
+ continue;
4083
+ }
4084
+ }
4085
+ if ((tag & 7) === 4 || tag === 0) {
4086
+ break;
4087
+ }
4088
+ reader.skip(tag & 7);
4089
+ }
4090
+ return message;
4091
+ },
4092
+ fromJSON(object) {
4093
+ return { estimate: isSet(object.estimate) ? SlamPoseEstimate.fromJSON(object.estimate) : undefined };
4094
+ },
4095
+ toJSON(message) {
4096
+ const obj = {};
4097
+ if (message.estimate !== undefined) {
4098
+ obj.estimate = SlamPoseEstimate.toJSON(message.estimate);
4099
+ }
4100
+ return obj;
4101
+ },
4102
+ create(base) {
4103
+ return SlamPoseTel.fromPartial(base ?? {});
4104
+ },
4105
+ fromPartial(object) {
4106
+ const message = createBaseSlamPoseTel();
4107
+ message.estimate = (object.estimate !== undefined && object.estimate !== null)
4108
+ ? SlamPoseEstimate.fromPartial(object.estimate)
4109
+ : undefined;
4110
+ return message;
4111
+ },
4112
+ };
4113
+ function createBaseSlamMapUpdateTel() {
4114
+ return { update: undefined };
4115
+ }
4116
+ export const SlamMapUpdateTel = {
4117
+ encode(message, writer = new BinaryWriter()) {
4118
+ if (message.update !== undefined) {
4119
+ SlamMapUpdate.encode(message.update, writer.uint32(10).fork()).join();
4120
+ }
4121
+ return writer;
4122
+ },
4123
+ decode(input, length) {
4124
+ const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
4125
+ const end = length === undefined ? reader.len : reader.pos + length;
4126
+ const message = createBaseSlamMapUpdateTel();
4127
+ while (reader.pos < end) {
4128
+ const tag = reader.uint32();
4129
+ switch (tag >>> 3) {
4130
+ case 1: {
4131
+ if (tag !== 10) {
4132
+ break;
4133
+ }
4134
+ message.update = SlamMapUpdate.decode(reader, reader.uint32());
4135
+ continue;
4136
+ }
4137
+ }
4138
+ if ((tag & 7) === 4 || tag === 0) {
4139
+ break;
4140
+ }
4141
+ reader.skip(tag & 7);
4142
+ }
4143
+ return message;
4144
+ },
4145
+ fromJSON(object) {
4146
+ return { update: isSet(object.update) ? SlamMapUpdate.fromJSON(object.update) : undefined };
4147
+ },
4148
+ toJSON(message) {
4149
+ const obj = {};
4150
+ if (message.update !== undefined) {
4151
+ obj.update = SlamMapUpdate.toJSON(message.update);
4152
+ }
4153
+ return obj;
4154
+ },
4155
+ create(base) {
4156
+ return SlamMapUpdateTel.fromPartial(base ?? {});
4157
+ },
4158
+ fromPartial(object) {
4159
+ const message = createBaseSlamMapUpdateTel();
4160
+ message.update = (object.update !== undefined && object.update !== null)
4161
+ ? SlamMapUpdate.fromPartial(object.update)
4162
+ : undefined;
4163
+ return message;
4164
+ },
4165
+ };
4166
+ function createBaseSlamScanTel() {
4167
+ return { scan: undefined };
4168
+ }
4169
+ export const SlamScanTel = {
4170
+ encode(message, writer = new BinaryWriter()) {
4171
+ if (message.scan !== undefined) {
4172
+ SlamScan.encode(message.scan, writer.uint32(10).fork()).join();
4173
+ }
4174
+ return writer;
4175
+ },
4176
+ decode(input, length) {
4177
+ const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
4178
+ const end = length === undefined ? reader.len : reader.pos + length;
4179
+ const message = createBaseSlamScanTel();
4180
+ while (reader.pos < end) {
4181
+ const tag = reader.uint32();
4182
+ switch (tag >>> 3) {
4183
+ case 1: {
4184
+ if (tag !== 10) {
4185
+ break;
4186
+ }
4187
+ message.scan = SlamScan.decode(reader, reader.uint32());
4188
+ continue;
4189
+ }
4190
+ }
4191
+ if ((tag & 7) === 4 || tag === 0) {
4192
+ break;
4193
+ }
4194
+ reader.skip(tag & 7);
4195
+ }
4196
+ return message;
4197
+ },
4198
+ fromJSON(object) {
4199
+ return { scan: isSet(object.scan) ? SlamScan.fromJSON(object.scan) : undefined };
4200
+ },
4201
+ toJSON(message) {
4202
+ const obj = {};
4203
+ if (message.scan !== undefined) {
4204
+ obj.scan = SlamScan.toJSON(message.scan);
4205
+ }
4206
+ return obj;
4207
+ },
4208
+ create(base) {
4209
+ return SlamScanTel.fromPartial(base ?? {});
4210
+ },
4211
+ fromPartial(object) {
4212
+ const message = createBaseSlamScanTel();
4213
+ message.scan = (object.scan !== undefined && object.scan !== null) ? SlamScan.fromPartial(object.scan) : undefined;
4214
+ return message;
4215
+ },
4216
+ };
4217
+ function createBaseSlamMapTel() {
4218
+ return { map: undefined };
4219
+ }
4220
+ export const SlamMapTel = {
4221
+ encode(message, writer = new BinaryWriter()) {
4222
+ if (message.map !== undefined) {
4223
+ SlamMap.encode(message.map, writer.uint32(10).fork()).join();
4224
+ }
4225
+ return writer;
4226
+ },
4227
+ decode(input, length) {
4228
+ const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
4229
+ const end = length === undefined ? reader.len : reader.pos + length;
4230
+ const message = createBaseSlamMapTel();
4231
+ while (reader.pos < end) {
4232
+ const tag = reader.uint32();
4233
+ switch (tag >>> 3) {
4234
+ case 1: {
4235
+ if (tag !== 10) {
4236
+ break;
4237
+ }
4238
+ message.map = SlamMap.decode(reader, reader.uint32());
4239
+ continue;
4240
+ }
4241
+ }
4242
+ if ((tag & 7) === 4 || tag === 0) {
4243
+ break;
4244
+ }
4245
+ reader.skip(tag & 7);
4246
+ }
4247
+ return message;
4248
+ },
4249
+ fromJSON(object) {
4250
+ return { map: isSet(object.map) ? SlamMap.fromJSON(object.map) : undefined };
4251
+ },
4252
+ toJSON(message) {
4253
+ const obj = {};
4254
+ if (message.map !== undefined) {
4255
+ obj.map = SlamMap.toJSON(message.map);
4256
+ }
4257
+ return obj;
4258
+ },
4259
+ create(base) {
4260
+ return SlamMapTel.fromPartial(base ?? {});
4261
+ },
4262
+ fromPartial(object) {
4263
+ const message = createBaseSlamMapTel();
4264
+ message.map = (object.map !== undefined && object.map !== null) ? SlamMap.fromPartial(object.map) : undefined;
4265
+ return message;
4266
+ },
4267
+ };
4268
+ function createBaseSlamStatusTel() {
4269
+ return { active: false, mapId: 0, recording: undefined, sensors: [] };
4270
+ }
4271
+ export const SlamStatusTel = {
4272
+ encode(message, writer = new BinaryWriter()) {
4273
+ if (message.active !== false) {
4274
+ writer.uint32(8).bool(message.active);
4275
+ }
4276
+ if (message.mapId !== 0) {
4277
+ writer.uint32(16).uint32(message.mapId);
4278
+ }
4279
+ if (message.recording !== undefined) {
4280
+ SlamRecordingState.encode(message.recording, writer.uint32(34).fork()).join();
4281
+ }
4282
+ for (const v of message.sensors) {
4283
+ SlamSensorStatus.encode(v, writer.uint32(42).fork()).join();
4284
+ }
4285
+ return writer;
4286
+ },
4287
+ decode(input, length) {
4288
+ const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
4289
+ const end = length === undefined ? reader.len : reader.pos + length;
4290
+ const message = createBaseSlamStatusTel();
4291
+ while (reader.pos < end) {
4292
+ const tag = reader.uint32();
4293
+ switch (tag >>> 3) {
4294
+ case 1: {
4295
+ if (tag !== 8) {
4296
+ break;
4297
+ }
4298
+ message.active = reader.bool();
4299
+ continue;
4300
+ }
4301
+ case 2: {
4302
+ if (tag !== 16) {
4303
+ break;
4304
+ }
4305
+ message.mapId = reader.uint32();
4306
+ continue;
4307
+ }
4308
+ case 4: {
4309
+ if (tag !== 34) {
4310
+ break;
4311
+ }
4312
+ message.recording = SlamRecordingState.decode(reader, reader.uint32());
4313
+ continue;
4314
+ }
4315
+ case 5: {
4316
+ if (tag !== 42) {
4317
+ break;
4318
+ }
4319
+ message.sensors.push(SlamSensorStatus.decode(reader, reader.uint32()));
4320
+ continue;
4321
+ }
4322
+ }
4323
+ if ((tag & 7) === 4 || tag === 0) {
4324
+ break;
4325
+ }
4326
+ reader.skip(tag & 7);
4327
+ }
4328
+ return message;
4329
+ },
4330
+ fromJSON(object) {
4331
+ return {
4332
+ active: isSet(object.active) ? gt.Boolean(object.active) : false,
4333
+ mapId: isSet(object.mapId) ? gt.Number(object.mapId) : 0,
4334
+ recording: isSet(object.recording) ? SlamRecordingState.fromJSON(object.recording) : undefined,
4335
+ sensors: gt.Array.isArray(object?.sensors) ? object.sensors.map((e) => SlamSensorStatus.fromJSON(e)) : [],
4336
+ };
4337
+ },
4338
+ toJSON(message) {
4339
+ const obj = {};
4340
+ if (message.active !== false) {
4341
+ obj.active = message.active;
4342
+ }
4343
+ if (message.mapId !== 0) {
4344
+ obj.mapId = Math.round(message.mapId);
4345
+ }
4346
+ if (message.recording !== undefined) {
4347
+ obj.recording = SlamRecordingState.toJSON(message.recording);
4348
+ }
4349
+ if (message.sensors?.length) {
4350
+ obj.sensors = message.sensors.map((e) => SlamSensorStatus.toJSON(e));
4351
+ }
4352
+ return obj;
4353
+ },
4354
+ create(base) {
4355
+ return SlamStatusTel.fromPartial(base ?? {});
4356
+ },
4357
+ fromPartial(object) {
4358
+ const message = createBaseSlamStatusTel();
4359
+ message.active = object.active ?? false;
4360
+ message.mapId = object.mapId ?? 0;
4361
+ message.recording = (object.recording !== undefined && object.recording !== null)
4362
+ ? SlamRecordingState.fromPartial(object.recording)
4363
+ : undefined;
4364
+ message.sensors = object.sensors?.map((e) => SlamSensorStatus.fromPartial(e)) || [];
4365
+ return message;
4366
+ },
4367
+ };
4060
4368
  const gt = (() => {
4061
4369
  if (typeof globalThis !== "undefined") {
4062
4370
  return globalThis;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blueyerobotics/protocol-definitions",
3
- "version": "3.4.0-8187f91a",
3
+ "version": "3.4.0-sonar3d-slam.4e329580",
4
4
  "license": "LGPL-3.0-only",
5
5
  "description": "TypeScript definitions for Blueye Robotics protocols",
6
6
  "repository": {