@rise-maritime/keelson-js 0.6.0-alpha.255.dev.1 → 0.6.0-alpha.275.dev.2

package/dist/interfaces/VehicleNavigation.js

@@ -5,7 +5,7 @@
 //   protoc               v6.30.2
 // source: VehicleNavigation.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VehicleNavigationDefinition = exports.SetCruiseSpeedResponse = exports.SetCruiseSpeedRequest = exports.NavigationTargetResponse = exports.NavigationTarget = exports.protobufPackage = void 0;
+exports.VehicleNavigationDefinition = exports.SetSteeringOrderResponse = exports.SetSteeringOrderRequest = exports.SteeringOrder = exports.SetCruiseSpeedResponse = exports.SetCruiseSpeedRequest = exports.NavigationTargetResponse = exports.NavigationTarget = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const VehicleCommon_1 = require("./VehicleCommon");
@@ -380,6 +380,229 @@ exports.SetCruiseSpeedResponse = {
         return message;
     },
 };
+function createBaseSteeringOrder() {
+    return { courseOverGroundDeg: undefined, headingDeg: undefined };
+}
+exports.SteeringOrder = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.courseOverGroundDeg !== undefined) {
+            writer.uint32(9).double(message.courseOverGroundDeg);
+        }
+        if (message.headingDeg !== undefined) {
+            writer.uint32(17).double(message.headingDeg);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseSteeringOrder();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 9) {
+                        break;
+                    }
+                    message.courseOverGroundDeg = reader.double();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 17) {
+                        break;
+                    }
+                    message.headingDeg = reader.double();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            courseOverGroundDeg: isSet(object.courseOverGroundDeg)
+                ? globalThis.Number(object.courseOverGroundDeg)
+                : undefined,
+            headingDeg: isSet(object.headingDeg) ? globalThis.Number(object.headingDeg) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.courseOverGroundDeg !== undefined) {
+            obj.courseOverGroundDeg = message.courseOverGroundDeg;
+        }
+        if (message.headingDeg !== undefined) {
+            obj.headingDeg = message.headingDeg;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.SteeringOrder.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSteeringOrder();
+        message.courseOverGroundDeg = object.courseOverGroundDeg ?? undefined;
+        message.headingDeg = object.headingDeg ?? undefined;
+        return message;
+    },
+};
+function createBaseSetSteeringOrderRequest() {
+    return { timestamp: undefined, order: undefined };
+}
+exports.SetSteeringOrderRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.timestamp !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.timestamp), writer.uint32(10).fork()).join();
+        }
+        if (message.order !== undefined) {
+            exports.SteeringOrder.encode(message.order, writer.uint32(18).fork()).join();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseSetSteeringOrderRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.timestamp = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.order = exports.SteeringOrder.decode(reader, reader.uint32());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            timestamp: isSet(object.timestamp) ? fromJsonTimestamp(object.timestamp) : undefined,
+            order: isSet(object.order) ? exports.SteeringOrder.fromJSON(object.order) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.timestamp !== undefined) {
+            obj.timestamp = message.timestamp.toISOString();
+        }
+        if (message.order !== undefined) {
+            obj.order = exports.SteeringOrder.toJSON(message.order);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.SetSteeringOrderRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSetSteeringOrderRequest();
+        message.timestamp = object.timestamp ?? undefined;
+        message.order = (object.order !== undefined && object.order !== null)
+            ? exports.SteeringOrder.fromPartial(object.order)
+            : undefined;
+        return message;
+    },
+};
+function createBaseSetSteeringOrderResponse() {
+    return { result: 0, rawAutopilotResult: 0, detail: "" };
+}
+exports.SetSteeringOrderResponse = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.result !== 0) {
+            writer.uint32(8).int32(message.result);
+        }
+        if (message.rawAutopilotResult !== 0) {
+            writer.uint32(16).int32(message.rawAutopilotResult);
+        }
+        if (message.detail !== "") {
+            writer.uint32(26).string(message.detail);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseSetSteeringOrderResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.result = reader.int32();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.rawAutopilotResult = reader.int32();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.detail = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            result: isSet(object.result) ? (0, VehicleCommon_1.commandResultFromJSON)(object.result) : 0,
+            rawAutopilotResult: isSet(object.rawAutopilotResult) ? globalThis.Number(object.rawAutopilotResult) : 0,
+            detail: isSet(object.detail) ? globalThis.String(object.detail) : "",
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.result !== 0) {
+            obj.result = (0, VehicleCommon_1.commandResultToJSON)(message.result);
+        }
+        if (message.rawAutopilotResult !== 0) {
+            obj.rawAutopilotResult = Math.round(message.rawAutopilotResult);
+        }
+        if (message.detail !== "") {
+            obj.detail = message.detail;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.SetSteeringOrderResponse.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSetSteeringOrderResponse();
+        message.result = object.result ?? 0;
+        message.rawAutopilotResult = object.rawAutopilotResult ?? 0;
+        message.detail = object.detail ?? "";
+        return message;
+    },
+};
 exports.VehicleNavigationDefinition = {
     name: "VehicleNavigation",
     fullName: "keelson.interfaces.vehicle_navigation.VehicleNavigation",
@@ -406,6 +629,15 @@ exports.VehicleNavigationDefinition = {
             responseStream: false,
             options: {},
         },
+        /** Hold a course over ground or a heading until told otherwise. */
+        set_steering_order: {
+            name: "set_steering_order",
+            requestType: exports.SetSteeringOrderRequest,
+            requestStream: false,
+            responseType: exports.SetSteeringOrderResponse,
+            responseStream: false,
+            options: {},
+        },
     },
 };
 function toTimestamp(date) {

package/dist/interfaces/VehicleSimulatorControl.d.ts

@@ -15,76 +15,8 @@ export interface InitialPose {
  */
 export interface SetInitialPoseResponse {
 }
-/**
- * How a vehicle is told to steer. The frame is the field rather than a
- * separate discriminator, so an order cannot name one frame and carry a
- * value meant for another.
- *
- * The two are different instructions, not two spellings of one. A course
- * over ground is made good against the water that is moving the hull; a
- * heading is where she points, and in any current the two differ by the
- * drift angle. A simulator that treats them alike is wrong by that angle
- * and says nothing about it.
- */
-export interface SteeringOrder {
-    /** Make good this course, degrees true, [0, 360). */
-    courseOverGroundDeg?: number | undefined;
-    /**
-     * Point this way, degrees true, [0, 360). What she makes good is then
-     * whatever the water leaves her.
-     */
-    headingDeg?: number | undefined;
-}
-/**
- * How a vehicle is told to drive. Four frames, in decreasing order of what
- * the vehicle is asked to guarantee: a speed over the ground is a promise
- * about the track, a speed through the water is a promise about the hull,
- * and the last two are machinery settings that promise nothing about
- * either — what they produce is the vehicle's business.
- */
-export interface PropulsionOrder {
-    /**
-     * Make good this speed over the ground, m/s. Not always reachable: in
-     * a stream that beats her, the vehicle makes its best and the
-     * shortfall is what the recording shows.
-     */
-    sogMps?: number | undefined;
-    /** This speed through the water, m/s. */
-    stwMps?: number | undefined;
-    /**
-     * A throttle setting, percent. Negative is astern where the vehicle
-     * has it; a vehicle that cannot go astern replies OUT_OF_RANGE rather
-     * than clamping silently.
-     */
-    enginePct?: number | undefined;
-    /** Shaft revolutions per minute. Signed, as engine_pct is. */
-    shaftRpm?: number | undefined;
-}
-/**
- * A standing order: what the vehicle should be doing until told otherwise.
- *
- * Both halves are optional and omitting one leaves it as it is, so a course
- * can be changed without disturbing a speed. Sending neither is an error
- * rather than a no-op: it is almost always a caller that failed to set the
- * field it meant to.
- */
-export interface StandingOrder {
-    steering: SteeringOrder | undefined;
-    propulsion: PropulsionOrder | undefined;
-}
-/**
- * Dedicated response for the same reason SetInitialPoseResponse is one: an
- * order that was accepted but modified — clamped to a limit the vehicle
- * declares — is a plausible thing to want to return later.
- */
-export interface SetStandingOrderResponse {
-}
 export declare const InitialPose: MessageFns<InitialPose>;
 export declare const SetInitialPoseResponse: MessageFns<SetInitialPoseResponse>;
-export declare const SteeringOrder: MessageFns<SteeringOrder>;
-export declare const PropulsionOrder: MessageFns<PropulsionOrder>;
-export declare const StandingOrder: MessageFns<StandingOrder>;
-export declare const SetStandingOrderResponse: MessageFns<SetStandingOrderResponse>;
 export type VehicleSimulatorControlDefinition = typeof VehicleSimulatorControlDefinition;
 export declare const VehicleSimulatorControlDefinition: {
     readonly name: "VehicleSimulatorControl";
@@ -102,21 +34,6 @@ export declare const VehicleSimulatorControlDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
-        /**
-         * Give a RUNNING entity a new standing order, without moving it. On a
-         * STOPPED or ASSIGNED entity, replies ErrorResponse{code =
-         * INVALID_STATE} — the mirror of set_initial_pose's own rule, and for
-         * the same reason: an order to a vehicle that is not going anywhere is
-         * a caller confusing setup with command.
-         */
-        readonly set_standing_order: {
-            readonly name: "set_standing_order";
-            readonly requestType: MessageFns<StandingOrder>;
-            readonly requestStream: false;
-            readonly responseType: MessageFns<SetStandingOrderResponse>;
-            readonly responseStream: false;
-            readonly options: {};
-        };
     };
 };
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;

package/dist/interfaces/VehicleSimulatorControl.js

@@ -5,7 +5,7 @@
 //   protoc               v6.30.2
 // source: VehicleSimulatorControl.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VehicleSimulatorControlDefinition = exports.SetStandingOrderResponse = exports.StandingOrder = exports.PropulsionOrder = exports.SteeringOrder = exports.SetInitialPoseResponse = exports.InitialPose = exports.protobufPackage = void 0;
+exports.VehicleSimulatorControlDefinition = exports.SetInitialPoseResponse = exports.InitialPose = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const Coordinate_1 = require("./Coordinate");
@@ -132,283 +132,6 @@ exports.SetInitialPoseResponse = {
         return message;
     },
 };
-function createBaseSteeringOrder() {
-    return { courseOverGroundDeg: undefined, headingDeg: undefined };
-}
-exports.SteeringOrder = {
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.courseOverGroundDeg !== undefined) {
-            writer.uint32(9).double(message.courseOverGroundDeg);
-        }
-        if (message.headingDeg !== undefined) {
-            writer.uint32(17).double(message.headingDeg);
-        }
-        return writer;
-    },
-    decode(input, length) {
-        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
-        let end = length === undefined ? reader.len : reader.pos + length;
-        const message = createBaseSteeringOrder();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 9) {
-                        break;
-                    }
-                    message.courseOverGroundDeg = reader.double();
-                    continue;
-                }
-                case 2: {
-                    if (tag !== 17) {
-                        break;
-                    }
-                    message.headingDeg = reader.double();
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return {
-            courseOverGroundDeg: isSet(object.courseOverGroundDeg)
-                ? globalThis.Number(object.courseOverGroundDeg)
-                : undefined,
-            headingDeg: isSet(object.headingDeg) ? globalThis.Number(object.headingDeg) : undefined,
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.courseOverGroundDeg !== undefined) {
-            obj.courseOverGroundDeg = message.courseOverGroundDeg;
-        }
-        if (message.headingDeg !== undefined) {
-            obj.headingDeg = message.headingDeg;
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.SteeringOrder.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBaseSteeringOrder();
-        message.courseOverGroundDeg = object.courseOverGroundDeg ?? undefined;
-        message.headingDeg = object.headingDeg ?? undefined;
-        return message;
-    },
-};
-function createBasePropulsionOrder() {
-    return { sogMps: undefined, stwMps: undefined, enginePct: undefined, shaftRpm: undefined };
-}
-exports.PropulsionOrder = {
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.sogMps !== undefined) {
-            writer.uint32(9).double(message.sogMps);
-        }
-        if (message.stwMps !== undefined) {
-            writer.uint32(17).double(message.stwMps);
-        }
-        if (message.enginePct !== undefined) {
-            writer.uint32(25).double(message.enginePct);
-        }
-        if (message.shaftRpm !== undefined) {
-            writer.uint32(33).double(message.shaftRpm);
-        }
-        return writer;
-    },
-    decode(input, length) {
-        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
-        let end = length === undefined ? reader.len : reader.pos + length;
-        const message = createBasePropulsionOrder();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 9) {
-                        break;
-                    }
-                    message.sogMps = reader.double();
-                    continue;
-                }
-                case 2: {
-                    if (tag !== 17) {
-                        break;
-                    }
-                    message.stwMps = reader.double();
-                    continue;
-                }
-                case 3: {
-                    if (tag !== 25) {
-                        break;
-                    }
-                    message.enginePct = reader.double();
-                    continue;
-                }
-                case 4: {
-                    if (tag !== 33) {
-                        break;
-                    }
-                    message.shaftRpm = reader.double();
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return {
-            sogMps: isSet(object.sogMps) ? globalThis.Number(object.sogMps) : undefined,
-            stwMps: isSet(object.stwMps) ? globalThis.Number(object.stwMps) : undefined,
-            enginePct: isSet(object.enginePct) ? globalThis.Number(object.enginePct) : undefined,
-            shaftRpm: isSet(object.shaftRpm) ? globalThis.Number(object.shaftRpm) : undefined,
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.sogMps !== undefined) {
-            obj.sogMps = message.sogMps;
-        }
-        if (message.stwMps !== undefined) {
-            obj.stwMps = message.stwMps;
-        }
-        if (message.enginePct !== undefined) {
-            obj.enginePct = message.enginePct;
-        }
-        if (message.shaftRpm !== undefined) {
-            obj.shaftRpm = message.shaftRpm;
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.PropulsionOrder.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBasePropulsionOrder();
-        message.sogMps = object.sogMps ?? undefined;
-        message.stwMps = object.stwMps ?? undefined;
-        message.enginePct = object.enginePct ?? undefined;
-        message.shaftRpm = object.shaftRpm ?? undefined;
-        return message;
-    },
-};
-function createBaseStandingOrder() {
-    return { steering: undefined, propulsion: undefined };
-}
-exports.StandingOrder = {
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.steering !== undefined) {
-            exports.SteeringOrder.encode(message.steering, writer.uint32(10).fork()).join();
-        }
-        if (message.propulsion !== undefined) {
-            exports.PropulsionOrder.encode(message.propulsion, writer.uint32(18).fork()).join();
-        }
-        return writer;
-    },
-    decode(input, length) {
-        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
-        let end = length === undefined ? reader.len : reader.pos + length;
-        const message = createBaseStandingOrder();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 10) {
-                        break;
-                    }
-                    message.steering = exports.SteeringOrder.decode(reader, reader.uint32());
-                    continue;
-                }
-                case 2: {
-                    if (tag !== 18) {
-                        break;
-                    }
-                    message.propulsion = exports.PropulsionOrder.decode(reader, reader.uint32());
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return {
-            steering: isSet(object.steering) ? exports.SteeringOrder.fromJSON(object.steering) : undefined,
-            propulsion: isSet(object.propulsion) ? exports.PropulsionOrder.fromJSON(object.propulsion) : undefined,
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.steering !== undefined) {
-            obj.steering = exports.SteeringOrder.toJSON(message.steering);
-        }
-        if (message.propulsion !== undefined) {
-            obj.propulsion = exports.PropulsionOrder.toJSON(message.propulsion);
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.StandingOrder.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBaseStandingOrder();
-        message.steering = (object.steering !== undefined && object.steering !== null)
-            ? exports.SteeringOrder.fromPartial(object.steering)
-            : undefined;
-        message.propulsion = (object.propulsion !== undefined && object.propulsion !== null)
-            ? exports.PropulsionOrder.fromPartial(object.propulsion)
-            : undefined;
-        return message;
-    },
-};
-function createBaseSetStandingOrderResponse() {
-    return {};
-}
-exports.SetStandingOrderResponse = {
-    encode(_, writer = new wire_1.BinaryWriter()) {
-        return writer;
-    },
-    decode(input, length) {
-        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
-        let end = length === undefined ? reader.len : reader.pos + length;
-        const message = createBaseSetStandingOrderResponse();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(_) {
-        return {};
-    },
-    toJSON(_) {
-        const obj = {};
-        return obj;
-    },
-    create(base) {
-        return exports.SetStandingOrderResponse.fromPartial(base ?? {});
-    },
-    fromPartial(_) {
-        const message = createBaseSetStandingOrderResponse();
-        return message;
-    },
-};
 exports.VehicleSimulatorControlDefinition = {
     name: "VehicleSimulatorControl",
     fullName: "keelson.interfaces.vehicle_simulator_control.VehicleSimulatorControl",
@@ -425,21 +148,6 @@ exports.VehicleSimulatorControlDefinition = {
             responseStream: false,
             options: {},
         },
-        /**
-         * Give a RUNNING entity a new standing order, without moving it. On a
-         * STOPPED or ASSIGNED entity, replies ErrorResponse{code =
-         * INVALID_STATE} — the mirror of set_initial_pose's own rule, and for
-         * the same reason: an order to a vehicle that is not going anywhere is
-         * a caller confusing setup with command.
-         */
-        set_standing_order: {
-            name: "set_standing_order",
-            requestType: exports.StandingOrder,
-            requestStream: false,
-            responseType: exports.SetStandingOrderResponse,
-            responseStream: false,
-            options: {},
-        },
     },
 };
 function isSet(value) {