@blueyerobotics/protocol-definitions 3.4.0-sonar3d-slam.ba63462d → 3.4.0-sonar3d-slam.1bd69578

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.
@@ -3297,6 +3297,11 @@ export interface SlamSensor {
3297
3297
  fovVertical: number;
3298
3298
  /** Range the sensor is set to (m). */
3299
3299
  maxRange: number;
3300
+ /**
3301
+ * The sensor as a guest port device (e.g. GUEST_PORT_DEVICE_ID_WATERLINKED_SONAR_3D15), for a client
3302
+ * to show the device itself; GUEST_PORT_DEVICE_ID_UNSPECIFIED when it is not one (a simulated sensor).
3303
+ */
3304
+ deviceId: GuestPortDeviceID;
3300
3305
  }
3301
3306
  /**
3302
3307
  * A recording of the SLAM, as the SLAM reports it.
@@ -3383,15 +3388,18 @@ export interface SlamPoseEstimate {
3383
3388
  pose: SlamPose | undefined;
3384
3389
  /** Host time the scan was received. */
3385
3390
  time: Date | undefined;
3386
- /** Points of the scan used for matching. */
3391
+ /** Points (or cells) of the scan used for matching. */
3387
3392
  scanPoints: number;
3388
- /** Share of those points matched to the map (0..1). */
3393
+ /** Share of those matched to the map (0..1). */
3389
3394
  matchInlierRatio: number;
3390
- /** Root mean square point-to-plane distance of the matched points (m). */
3395
+ /**
3396
+ * Root mean square residual of the matched points against the map (m); for a 3D sonar, their distance to the
3397
+ * map's planes.
3398
+ */
3391
3399
  matchRms: number;
3392
3400
  /** Keyframes in the map. */
3393
3401
  keyframeCount: number;
3394
- /** Points in the map. */
3402
+ /** Points (or cells) in the map. */
3395
3403
  mapPointCount: number;
3396
3404
  /**
3397
3405
  * Depth used for the scan (m), when there was one: the sensor's, from the drone's depth sensor
@@ -3547,6 +3555,8 @@ export interface SlamScan {
3547
3555
  sensor: SlamSensor | undefined;
3548
3556
  /** The sensor's pose on the platform at the scan. Unset when the platform is the sensor. */
3549
3557
  mount: SlamPose | undefined;
3558
+ /** Host time the scan was received (as SlamPoseEstimate.time). */
3559
+ time: Date | undefined;
3550
3560
  }
3551
3561
  export declare const BinlogRecord: MessageFns<BinlogRecord>;
3552
3562
  export declare const LogEntry: MessageFns<LogEntry>;
@@ -21211,7 +21211,7 @@ export const PointCloud = {
21211
21211
  },
21212
21212
  };
21213
21213
  function createBaseSlamSensor() {
21214
- return { id: "", type: 0, fovHorizontal: 0, fovVertical: 0, maxRange: 0 };
21214
+ return { id: "", type: 0, fovHorizontal: 0, fovVertical: 0, maxRange: 0, deviceId: 0 };
21215
21215
  }
21216
21216
  export const SlamSensor = {
21217
21217
  encode(message, writer = new BinaryWriter()) {
@@ -21230,6 +21230,9 @@ export const SlamSensor = {
21230
21230
  if (message.maxRange !== 0) {
21231
21231
  writer.uint32(45).float(message.maxRange);
21232
21232
  }
21233
+ if (message.deviceId !== 0) {
21234
+ writer.uint32(48).int32(message.deviceId);
21235
+ }
21233
21236
  return writer;
21234
21237
  },
21235
21238
  decode(input, length) {
@@ -21274,6 +21277,13 @@ export const SlamSensor = {
21274
21277
  message.maxRange = reader.float();
21275
21278
  continue;
21276
21279
  }
21280
+ case 6: {
21281
+ if (tag !== 48) {
21282
+ break;
21283
+ }
21284
+ message.deviceId = reader.int32();
21285
+ continue;
21286
+ }
21277
21287
  }
21278
21288
  if ((tag & 7) === 4 || tag === 0) {
21279
21289
  break;
@@ -21289,6 +21299,7 @@ export const SlamSensor = {
21289
21299
  fovHorizontal: isSet(object.fovHorizontal) ? gt.Number(object.fovHorizontal) : 0,
21290
21300
  fovVertical: isSet(object.fovVertical) ? gt.Number(object.fovVertical) : 0,
21291
21301
  maxRange: isSet(object.maxRange) ? gt.Number(object.maxRange) : 0,
21302
+ deviceId: isSet(object.deviceId) ? guestPortDeviceIDFromJSON(object.deviceId) : 0,
21292
21303
  };
21293
21304
  },
21294
21305
  toJSON(message) {
@@ -21308,6 +21319,9 @@ export const SlamSensor = {
21308
21319
  if (message.maxRange !== 0) {
21309
21320
  obj.maxRange = message.maxRange;
21310
21321
  }
21322
+ if (message.deviceId !== 0) {
21323
+ obj.deviceId = guestPortDeviceIDToJSON(message.deviceId);
21324
+ }
21311
21325
  return obj;
21312
21326
  },
21313
21327
  create(base) {
@@ -21320,6 +21334,7 @@ export const SlamSensor = {
21320
21334
  message.fovHorizontal = object.fovHorizontal ?? 0;
21321
21335
  message.fovVertical = object.fovVertical ?? 0;
21322
21336
  message.maxRange = object.maxRange ?? 0;
21337
+ message.deviceId = object.deviceId ?? 0;
21323
21338
  return message;
21324
21339
  },
21325
21340
  };
@@ -22736,7 +22751,7 @@ export const SlamMap = {
22736
22751
  },
22737
22752
  };
22738
22753
  function createBaseSlamScan() {
22739
- return { mapId: 0, pose: undefined, points: undefined, sensor: undefined, mount: undefined };
22754
+ return { mapId: 0, pose: undefined, points: undefined, sensor: undefined, mount: undefined, time: undefined };
22740
22755
  }
22741
22756
  export const SlamScan = {
22742
22757
  encode(message, writer = new BinaryWriter()) {
@@ -22755,6 +22770,9 @@ export const SlamScan = {
22755
22770
  if (message.mount !== undefined) {
22756
22771
  SlamPose.encode(message.mount, writer.uint32(42).fork()).join();
22757
22772
  }
22773
+ if (message.time !== undefined) {
22774
+ Timestamp.encode(toTimestamp(message.time), writer.uint32(50).fork()).join();
22775
+ }
22758
22776
  return writer;
22759
22777
  },
22760
22778
  decode(input, length) {
@@ -22799,6 +22817,13 @@ export const SlamScan = {
22799
22817
  message.mount = SlamPose.decode(reader, reader.uint32());
22800
22818
  continue;
22801
22819
  }
22820
+ case 6: {
22821
+ if (tag !== 50) {
22822
+ break;
22823
+ }
22824
+ message.time = fromTimestamp(Timestamp.decode(reader, reader.uint32()));
22825
+ continue;
22826
+ }
22802
22827
  }
22803
22828
  if ((tag & 7) === 4 || tag === 0) {
22804
22829
  break;
@@ -22814,6 +22839,7 @@ export const SlamScan = {
22814
22839
  points: isSet(object.points) ? PointCloud.fromJSON(object.points) : undefined,
22815
22840
  sensor: isSet(object.sensor) ? SlamSensor.fromJSON(object.sensor) : undefined,
22816
22841
  mount: isSet(object.mount) ? SlamPose.fromJSON(object.mount) : undefined,
22842
+ time: isSet(object.time) ? fromJsonTimestamp(object.time) : undefined,
22817
22843
  };
22818
22844
  },
22819
22845
  toJSON(message) {
@@ -22833,6 +22859,9 @@ export const SlamScan = {
22833
22859
  if (message.mount !== undefined) {
22834
22860
  obj.mount = SlamPose.toJSON(message.mount);
22835
22861
  }
22862
+ if (message.time !== undefined) {
22863
+ obj.time = message.time.toISOString();
22864
+ }
22836
22865
  return obj;
22837
22866
  },
22838
22867
  create(base) {
@@ -22851,6 +22880,7 @@ export const SlamScan = {
22851
22880
  message.mount = (object.mount !== undefined && object.mount !== null)
22852
22881
  ? SlamPose.fromPartial(object.mount)
22853
22882
  : undefined;
22883
+ message.time = object.time ?? undefined;
22854
22884
  return message;
22855
22885
  },
22856
22886
  };
package/dist/req_rep.d.ts CHANGED
@@ -385,13 +385,16 @@ export interface SetSlamRecordingRep {
385
385
  /**
386
386
  * Request to change the settings of a SLAM sensor.
387
387
  *
388
- * The settings go to the SLAM's sensor of their kind, and those left
389
- * unspecified stay as they are. A change of a sonar's mode or range begins a new
390
- * map, as the map's resolution follows the sensor's range.
388
+ * The settings go to the sensor named by sensor_id, or without one to the SLAM's
389
+ * sensor of their kind, and those left unspecified stay as they are. A change of a
390
+ * sonar's mode or range begins a new map, as the map's resolution follows the
391
+ * sensor's range.
391
392
  */
392
393
  export interface SetSlamSensorSettingsReq {
393
394
  /** The settings to change. */
394
395
  settings: SlamSensorSettings | undefined;
396
+ /** The sensor to change (SlamSensor.id); empty: the SLAM's sensor of the settings' kind. */
397
+ sensorId: string;
395
398
  }
396
399
  /** Response after changing the settings of a SLAM sensor. */
397
400
  export interface SetSlamSensorSettingsRep {
package/dist/req_rep.js CHANGED
@@ -3354,13 +3354,16 @@ export const SetSlamRecordingRep = {
3354
3354
  },
3355
3355
  };
3356
3356
  function createBaseSetSlamSensorSettingsReq() {
3357
- return { settings: undefined };
3357
+ return { settings: undefined, sensorId: "" };
3358
3358
  }
3359
3359
  export const SetSlamSensorSettingsReq = {
3360
3360
  encode(message, writer = new BinaryWriter()) {
3361
3361
  if (message.settings !== undefined) {
3362
3362
  SlamSensorSettings.encode(message.settings, writer.uint32(10).fork()).join();
3363
3363
  }
3364
+ if (message.sensorId !== "") {
3365
+ writer.uint32(18).string(message.sensorId);
3366
+ }
3364
3367
  return writer;
3365
3368
  },
3366
3369
  decode(input, length) {
@@ -3377,6 +3380,13 @@ export const SetSlamSensorSettingsReq = {
3377
3380
  message.settings = SlamSensorSettings.decode(reader, reader.uint32());
3378
3381
  continue;
3379
3382
  }
3383
+ case 2: {
3384
+ if (tag !== 18) {
3385
+ break;
3386
+ }
3387
+ message.sensorId = reader.string();
3388
+ continue;
3389
+ }
3380
3390
  }
3381
3391
  if ((tag & 7) === 4 || tag === 0) {
3382
3392
  break;
@@ -3386,13 +3396,19 @@ export const SetSlamSensorSettingsReq = {
3386
3396
  return message;
3387
3397
  },
3388
3398
  fromJSON(object) {
3389
- return { settings: isSet(object.settings) ? SlamSensorSettings.fromJSON(object.settings) : undefined };
3399
+ return {
3400
+ settings: isSet(object.settings) ? SlamSensorSettings.fromJSON(object.settings) : undefined,
3401
+ sensorId: isSet(object.sensorId) ? gt.String(object.sensorId) : "",
3402
+ };
3390
3403
  },
3391
3404
  toJSON(message) {
3392
3405
  const obj = {};
3393
3406
  if (message.settings !== undefined) {
3394
3407
  obj.settings = SlamSensorSettings.toJSON(message.settings);
3395
3408
  }
3409
+ if (message.sensorId !== "") {
3410
+ obj.sensorId = message.sensorId;
3411
+ }
3396
3412
  return obj;
3397
3413
  },
3398
3414
  create(base) {
@@ -3403,6 +3419,7 @@ export const SetSlamSensorSettingsReq = {
3403
3419
  message.settings = (object.settings !== undefined && object.settings !== null)
3404
3420
  ? SlamSensorSettings.fromPartial(object.settings)
3405
3421
  : undefined;
3422
+ message.sensorId = object.sensorId ?? "";
3406
3423
  return message;
3407
3424
  },
3408
3425
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blueyerobotics/protocol-definitions",
3
- "version": "3.4.0-sonar3d-slam.ba63462d",
3
+ "version": "3.4.0-sonar3d-slam.1bd69578",
4
4
  "license": "LGPL-3.0-only",
5
5
  "description": "TypeScript definitions for Blueye Robotics protocols",
6
6
  "repository": {