@blueyerobotics/protocol-definitions 3.2.0-0f78a956 → 3.2.0-153cd3ce

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.
@@ -335,12 +335,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
335
335
  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 {} ? {
336
336
  [K in keyof T]?: DeepPartial<T[K]>;
337
337
  } : Partial<T>;
338
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
339
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
340
+ [K in keyof P]: Exact<P[K], I[K]>;
341
+ } & {
342
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
343
+ };
338
344
  interface MessageFns<T> {
339
345
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
340
346
  decode(input: BinaryReader | Uint8Array, length?: number): T;
341
347
  fromJSON(object: any): T;
342
348
  toJSON(message: T): unknown;
343
- create(base?: DeepPartial<T>): T;
344
- fromPartial(object: DeepPartial<T>): T;
349
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
350
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
345
351
  }
346
352
  export {};
package/dist/req_rep.d.ts CHANGED
@@ -251,12 +251,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
251
251
  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 {} ? {
252
252
  [K in keyof T]?: DeepPartial<T[K]>;
253
253
  } : Partial<T>;
254
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
255
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
256
+ [K in keyof P]: Exact<P[K], I[K]>;
257
+ } & {
258
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
259
+ };
254
260
  interface MessageFns<T> {
255
261
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
256
262
  decode(input: BinaryReader | Uint8Array, length?: number): T;
257
263
  fromJSON(object: any): T;
258
264
  toJSON(message: T): unknown;
259
- create(base?: DeepPartial<T>): T;
260
- fromPartial(object: DeepPartial<T>): T;
265
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
266
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
261
267
  }
262
268
  export {};
@@ -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, CanisterHumidity, CanisterTemperature, ConnectedClient, ControlForce, ControllerHealth, ControlMode, CpProbe, CPUInfo, CPUTemperature, Depth, DiveTime, DroneInfo, DvlVelocity, ErrorFlags, ForwardDistance, GenericServo, GuestPortCurrent, Imu, IperfStatus, Laser, LatLongPosition, Lights, MagneticDeclination, MedusaSpectrometerData, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers, PositionEstimate, RecordState, Reference, RemovableStorageDevice, StorageSpace, SystemTime, ThicknessGauge, TiltAngle, TiltStabilizationState, TimeLapseState, WaterTemperature } from "./message_formats";
3
+ import { Altitude, Attitude, Battery, BatteryBQ40Z50, CalibrationState, CanisterHumidity, CanisterTemperature, ConnectedClient, ControlForce, ControllerHealth, ControlMode, CpProbe, CPUInfo, CPUTemperature, Depth, DiveTime, DroneInfo, DvlVelocity, ErrorFlags, ForwardDistance, GenericServo, GuestPortCurrent, Imu, IperfStatus, Laser, LatLongPosition, Lights, MagneticDeclination, MedusaSpectrometerData, MultibeamConfig, MultibeamDiscovery, MultibeamPing, MultibeamServo, Notification, NStreamers, PositionEstimate, RecordState, Reference, StorageSpace, SystemTime, ThicknessGauge, TiltAngle, TiltStabilizationState, TimeLapseState, WaterTemperature } from "./message_formats";
4
4
  import { MissionStatus, ReferenceAutoPilot } from "./mission_planning";
5
5
  /**
6
6
  * Telemetry
@@ -149,15 +149,8 @@ export interface CanisterBottomHumidityTel {
149
149
  }
150
150
  /** Video storage info. */
151
151
  export interface VideoStorageSpaceTel {
152
- /** Internal Video storage information. */
152
+ /** Video storage information. */
153
153
  storageSpace: StorageSpace | undefined;
154
- /** Removable Video storage information. Can be empty. */
155
- removableSpace: StorageSpace | undefined;
156
- }
157
- /** Information about removable storage device. */
158
- export interface RemovableStorageTel {
159
- /** Information about the storage device (such as partitions) */
160
- storageDevice: RemovableStorageDevice | undefined;
161
154
  }
162
155
  /** Data storage info. */
163
156
  export interface DataStorageSpaceTel {
@@ -319,7 +312,6 @@ export declare const CPUTemperatureTel: MessageFns<CPUTemperatureTel>;
319
312
  export declare const CanisterBottomTemperatureTel: MessageFns<CanisterBottomTemperatureTel>;
320
313
  export declare const CanisterBottomHumidityTel: MessageFns<CanisterBottomHumidityTel>;
321
314
  export declare const VideoStorageSpaceTel: MessageFns<VideoStorageSpaceTel>;
322
- export declare const RemovableStorageTel: MessageFns<RemovableStorageTel>;
323
315
  export declare const DataStorageSpaceTel: MessageFns<DataStorageSpaceTel>;
324
316
  export declare const CalibrationStateTel: MessageFns<CalibrationStateTel>;
325
317
  export declare const TiltStabilizationTel: MessageFns<TiltStabilizationTel>;
@@ -350,12 +342,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
350
342
  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 {} ? {
351
343
  [K in keyof T]?: DeepPartial<T[K]>;
352
344
  } : Partial<T>;
345
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
346
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
347
+ [K in keyof P]: Exact<P[K], I[K]>;
348
+ } & {
349
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
350
+ };
353
351
  interface MessageFns<T> {
354
352
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
355
353
  decode(input: BinaryReader | Uint8Array, length?: number): T;
356
354
  fromJSON(object: any): T;
357
355
  toJSON(message: T): unknown;
358
- create(base?: DeepPartial<T>): T;
359
- fromPartial(object: DeepPartial<T>): T;
356
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
357
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
360
358
  }
361
359
  export {};
package/dist/telemetry.js CHANGED
@@ -5,8 +5,8 @@
5
5
  // protoc v3.21.12
6
6
  // source: telemetry.proto
7
7
  Object.defineProperty(exports, "__esModule", { value: true });
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.CPUInfoTel = exports.MultibeamDiscoveryTel = exports.MultibeamConfigTel = exports.MultibeamPingTel = exports.MedusaSpectrometerDataTel = void 0;
8
+ exports.MedusaSpectrometerDataTel = 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.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.CPUInfoTel = exports.MultibeamDiscoveryTel = exports.MultibeamConfigTel = exports.MultibeamPingTel = void 0;
10
10
  /* eslint-disable */
11
11
  const wire_1 = require("@bufbuild/protobuf/wire");
12
12
  const aquatroll_1 = require("./aquatroll");
@@ -1475,16 +1475,13 @@ exports.CanisterBottomHumidityTel = {
1475
1475
  },
1476
1476
  };
1477
1477
  function createBaseVideoStorageSpaceTel() {
1478
- return { storageSpace: undefined, removableSpace: undefined };
1478
+ return { storageSpace: undefined };
1479
1479
  }
1480
1480
  exports.VideoStorageSpaceTel = {
1481
1481
  encode(message, writer = new wire_1.BinaryWriter()) {
1482
1482
  if (message.storageSpace !== undefined) {
1483
1483
  message_formats_1.StorageSpace.encode(message.storageSpace, writer.uint32(10).fork()).join();
1484
1484
  }
1485
- if (message.removableSpace !== undefined) {
1486
- message_formats_1.StorageSpace.encode(message.removableSpace, writer.uint32(18).fork()).join();
1487
- }
1488
1485
  return writer;
1489
1486
  },
1490
1487
  decode(input, length) {
@@ -1501,13 +1498,6 @@ exports.VideoStorageSpaceTel = {
1501
1498
  message.storageSpace = message_formats_1.StorageSpace.decode(reader, reader.uint32());
1502
1499
  continue;
1503
1500
  }
1504
- case 2: {
1505
- if (tag !== 18) {
1506
- break;
1507
- }
1508
- message.removableSpace = message_formats_1.StorageSpace.decode(reader, reader.uint32());
1509
- continue;
1510
- }
1511
1501
  }
1512
1502
  if ((tag & 7) === 4 || tag === 0) {
1513
1503
  break;
@@ -1517,19 +1507,13 @@ exports.VideoStorageSpaceTel = {
1517
1507
  return message;
1518
1508
  },
1519
1509
  fromJSON(object) {
1520
- return {
1521
- storageSpace: isSet(object.storageSpace) ? message_formats_1.StorageSpace.fromJSON(object.storageSpace) : undefined,
1522
- removableSpace: isSet(object.removableSpace) ? message_formats_1.StorageSpace.fromJSON(object.removableSpace) : undefined,
1523
- };
1510
+ return { storageSpace: isSet(object.storageSpace) ? message_formats_1.StorageSpace.fromJSON(object.storageSpace) : undefined };
1524
1511
  },
1525
1512
  toJSON(message) {
1526
1513
  const obj = {};
1527
1514
  if (message.storageSpace !== undefined) {
1528
1515
  obj.storageSpace = message_formats_1.StorageSpace.toJSON(message.storageSpace);
1529
1516
  }
1530
- if (message.removableSpace !== undefined) {
1531
- obj.removableSpace = message_formats_1.StorageSpace.toJSON(message.removableSpace);
1532
- }
1533
1517
  return obj;
1534
1518
  },
1535
1519
  create(base) {
@@ -1540,64 +1524,6 @@ exports.VideoStorageSpaceTel = {
1540
1524
  message.storageSpace = (object.storageSpace !== undefined && object.storageSpace !== null)
1541
1525
  ? message_formats_1.StorageSpace.fromPartial(object.storageSpace)
1542
1526
  : undefined;
1543
- message.removableSpace = (object.removableSpace !== undefined && object.removableSpace !== null)
1544
- ? message_formats_1.StorageSpace.fromPartial(object.removableSpace)
1545
- : undefined;
1546
- return message;
1547
- },
1548
- };
1549
- function createBaseRemovableStorageTel() {
1550
- return { storageDevice: undefined };
1551
- }
1552
- exports.RemovableStorageTel = {
1553
- encode(message, writer = new wire_1.BinaryWriter()) {
1554
- if (message.storageDevice !== undefined) {
1555
- message_formats_1.RemovableStorageDevice.encode(message.storageDevice, writer.uint32(10).fork()).join();
1556
- }
1557
- return writer;
1558
- },
1559
- decode(input, length) {
1560
- const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
1561
- const end = length === undefined ? reader.len : reader.pos + length;
1562
- const message = createBaseRemovableStorageTel();
1563
- while (reader.pos < end) {
1564
- const tag = reader.uint32();
1565
- switch (tag >>> 3) {
1566
- case 1: {
1567
- if (tag !== 10) {
1568
- break;
1569
- }
1570
- message.storageDevice = message_formats_1.RemovableStorageDevice.decode(reader, reader.uint32());
1571
- continue;
1572
- }
1573
- }
1574
- if ((tag & 7) === 4 || tag === 0) {
1575
- break;
1576
- }
1577
- reader.skip(tag & 7);
1578
- }
1579
- return message;
1580
- },
1581
- fromJSON(object) {
1582
- return {
1583
- storageDevice: isSet(object.storageDevice) ? message_formats_1.RemovableStorageDevice.fromJSON(object.storageDevice) : undefined,
1584
- };
1585
- },
1586
- toJSON(message) {
1587
- const obj = {};
1588
- if (message.storageDevice !== undefined) {
1589
- obj.storageDevice = message_formats_1.RemovableStorageDevice.toJSON(message.storageDevice);
1590
- }
1591
- return obj;
1592
- },
1593
- create(base) {
1594
- return exports.RemovableStorageTel.fromPartial(base ?? {});
1595
- },
1596
- fromPartial(object) {
1597
- const message = createBaseRemovableStorageTel();
1598
- message.storageDevice = (object.storageDevice !== undefined && object.storageDevice !== null)
1599
- ? message_formats_1.RemovableStorageDevice.fromPartial(object.storageDevice)
1600
- : undefined;
1601
1527
  return message;
1602
1528
  },
1603
1529
  };
package/package.json CHANGED
@@ -1,12 +1,6 @@
1
1
  {
2
2
  "name": "@blueyerobotics/protocol-definitions",
3
- "version": "3.2.0-0f78a956",
4
- "license": "LGPL-3.0-only",
5
- "description": "TypeScript definitions for Blueye Robotics protocols",
6
- "repository": {
7
- "type": "git",
8
- "url": "https://github.com/BluEye-Robotics/ProtocolDefinitions.git"
9
- },
3
+ "version": "3.2.0-153cd3ce",
10
4
  "main": "dist/index.js",
11
5
  "types": "dist/index.d.ts",
12
6
  "files": ["dist"],
package/README.md DELETED
@@ -1,40 +0,0 @@
1
- # @blueyerobotics/protocol-definitions
2
-
3
- TypeScript protobuf definitions for Blueye Robotics protocols generated using [ts-proto](https://github.com/stephenh/ts-proto).
4
-
5
- ## Installation
6
-
7
- ```bash
8
- npm install @blueyerobotics/protocol-definitions
9
- ```
10
-
11
- ## Usage
12
-
13
- ```ts
14
- import { blueye } from "@blueyerobotics/protocol-definitions";
15
-
16
- // Create a new GetBatteryReq message
17
- const request = blueye.protocol.GetBatteryReq.create();
18
-
19
- // Serialize the message to a Uint8Array (binary)
20
- const binary = blueye.protocol.GetBatteryReq.encode(request).finish();
21
-
22
- // ...
23
-
24
- // For demonstration, we will simulate a response from the device
25
- const response = blueye.protocol.GetBatteryRep.create({
26
- battery: {
27
- level: 85,
28
- voltage: 12.5,
29
- temperature: 25,
30
- },
31
- });
32
-
33
- const binaryResponse = blueye.protocol.GetBatteryRep.encode(response).finish();
34
-
35
- // Decode a binary response back into a message
36
- const decoded = blueye.protocol.GetBatteryRep.decode(binaryResponse);
37
-
38
- // Access fields
39
- console.log(decoded.battery?.level);
40
- ```