@blueyerobotics/protocol-definitions 3.2.0-153cd3ce → 3.2.0-2bcfe527

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,40 @@
+# @blueyerobotics/protocol-definitions
+
+TypeScript protobuf definitions for Blueye Robotics protocols generated using [ts-proto](https://github.com/stephenh/ts-proto).
+
+## Installation
+
+```bash
+npm install @blueyerobotics/protocol-definitions
+```
+
+## Usage
+
+```ts
+import { blueye } from "@blueyerobotics/protocol-definitions";
+
+// Create a new GetBatteryReq message
+const request = blueye.protocol.GetBatteryReq.create();
+
+// Serialize the message to a Uint8Array (binary)
+const binary = blueye.protocol.GetBatteryReq.encode(request).finish();
+
+// ...
+
+// For demonstration, we will simulate a response from the device
+const response = blueye.protocol.GetBatteryRep.create({
+  battery: {
+    level: 85,
+    voltage: 12.5,
+    temperature: 25,
+  },
+});
+
+const binaryResponse = blueye.protocol.GetBatteryRep.encode(response).finish();
+
+// Decode a binary response back into a message
+const decoded = blueye.protocol.GetBatteryRep.decode(binaryResponse);
+
+// Access fields
+console.log(decoded.battery?.level);
+```

package/README.npm.md

@@ -0,0 +1,40 @@
+# @blueyerobotics/protocol-definitions
+
+TypeScript protobuf definitions for Blueye Robotics protocols generated using [ts-proto](https://github.com/stephenh/ts-proto).
+
+## Installation
+
+```bash
+npm install @blueyerobotics/protocol-definitions
+```
+
+## Usage
+
+```ts
+import { blueye } from "@blueyerobotics/protocol-definitions";
+
+// Create a new GetBatteryReq message
+const request = blueye.protocol.GetBatteryReq.create();
+
+// Serialize the message to a Uint8Array (binary)
+const binary = blueye.protocol.GetBatteryReq.encode(request).finish();
+
+// ...
+
+// For demonstration, we will simulate a response from the device
+const response = blueye.protocol.GetBatteryRep.create({
+  battery: {
+    level: 85,
+    voltage: 12.5,
+    temperature: 25,
+  },
+});
+
+const binaryResponse = blueye.protocol.GetBatteryRep.encode(response).finish();
+
+// Decode a binary response back into a message
+const decoded = blueye.protocol.GetBatteryRep.decode(binaryResponse);
+
+// Access fields
+console.log(decoded.battery?.level);
+```

package/dist/aquatroll.d.ts

@@ -424,18 +424,12 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
 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 {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : Partial<T>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
 interface MessageFns<T> {
     encode(message: T, writer?: BinaryWriter): BinaryWriter;
     decode(input: BinaryReader | Uint8Array, length?: number): T;
     fromJSON(object: any): T;
     toJSON(message: T): unknown;
-    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
 }
 export {};

package/dist/aquatroll.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.7.5
+//   protoc-gen-ts_proto  v2.7.7
 //   protoc               v3.21.12
 // source: aquatroll.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/control.d.ts

@@ -1,6 +1,6 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import { SetAquaTrollConnectionStatus, SetAquaTrollParameterUnit } from "./aquatroll";
-import { AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, ConnectionDuration, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, SystemTime, TiltStabilizationState, TiltVelocity, WaterDensity, WeatherVaningState } from "./message_formats";
+import { AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, CameraPanTiltZoom, ConnectionDuration, FilterMessage, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, OperatorInfo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, WaterDensity, WeatherVaningState } from "./message_formats";
 /**
  * Control
  *
@@ -48,13 +48,17 @@ export interface WatchdogCtrl {
     /** The ID of the client, received in the ConnectClientRep response. */
     clientId: number;
 }
-/** Issue a command to start video recording. */
+/** Issue a command to start video or multibeam recording. */
 export interface RecordCtrl {
     /** Message specifying which cameras to record. */
     recordOn: RecordOn | undefined;
+    /** Storage location to use for the recordings. */
+    storageLocation: StorageLocation;
 }
 /** Issue a command to take a picture. */
 export interface TakePictureCtrl {
+    /** Storage location to use for the picture. */
+    storageLocation: StorageLocation;
 }
 /** Issue a command to start compass calibration. */
 export interface StartCalibrationCtrl {
@@ -196,6 +200,8 @@ export interface DeactivateMultibeamCtrl {
  * at which point the user entered the dive view.
  */
 export interface StartDiveCtrl {
+    /** Optional information about the operator who started the dive. */
+    operatorInfo: OperatorInfo | undefined;
 }
 /**
  * Message sent when the user hits the end dive button in the app.
@@ -205,6 +211,36 @@ export interface StartDiveCtrl {
  */
 export interface EndDiveCtrl {
 }
+/**
+ * Message sent when the user wants to format a connected removable storage device.
+ *
+ * The app will receive a RemovableStorageTel message with information about the newly formatted drive.
+ *
+ * Warning: The drone will delete any partitions and format the drive with a single exFat partition.
+ * Any data on the drive will be lost.
+ */
+export interface FormatRemovableStorageDeviceCtrl {
+}
+/** Message sent when the user wants to set turbidity filter settings. */
+export interface SetTurbidityFilterCtrl {
+    /** Message with the turbidity filter settings to set. */
+    turbidityFilter: FilterMessage | undefined;
+}
+/**
+ * Issue a command to set the digital pan, tilt, and zoom of the main camera.
+ *
+ * Only supported on X3 Ultra.
+ */
+export interface CameraPanTiltZoomCtrl {
+    /** The desired pan, tilt, and zoom state. */
+    cameraPanTiltZoom: CameraPanTiltZoom | undefined;
+}
+/** Message sent to start streaming log entries to the client. */
+export interface StartLogStreamingCtrl {
+}
+/** Message sent to stop streaming log entries to the client. */
+export interface StopLogStreamingCtrl {
+}
 export declare const MotionInputCtrl: MessageFns<MotionInputCtrl>;
 export declare const TiltVelocityCtrl: MessageFns<TiltVelocityCtrl>;
 export declare const LightsCtrl: MessageFns<LightsCtrl>;
@@ -247,22 +283,21 @@ export declare const ActivateMultibeamCtrl: MessageFns<ActivateMultibeamCtrl>;
 export declare const DeactivateMultibeamCtrl: MessageFns<DeactivateMultibeamCtrl>;
 export declare const StartDiveCtrl: MessageFns<StartDiveCtrl>;
 export declare const EndDiveCtrl: MessageFns<EndDiveCtrl>;
+export declare const FormatRemovableStorageDeviceCtrl: MessageFns<FormatRemovableStorageDeviceCtrl>;
+export declare const SetTurbidityFilterCtrl: MessageFns<SetTurbidityFilterCtrl>;
+export declare const CameraPanTiltZoomCtrl: MessageFns<CameraPanTiltZoomCtrl>;
+export declare const StartLogStreamingCtrl: MessageFns<StartLogStreamingCtrl>;
+export declare const StopLogStreamingCtrl: MessageFns<StopLogStreamingCtrl>;
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 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 {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : Partial<T>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
 interface MessageFns<T> {
     encode(message: T, writer?: BinaryWriter): BinaryWriter;
     decode(input: BinaryReader | Uint8Array, length?: number): T;
     fromJSON(object: any): T;
     toJSON(message: T): unknown;
-    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
 }
 export {};