@deeptrekker/api-domain 1.0.38-collisionavoidanceprototype.0 → 1.0.38-collisionavoidanceprototype.2

package/dist/constants/schema/schema.json

@@ -776,13 +776,24 @@
                 "downError": {
                     "type": "string"
                 },
+                "downLatched": {
+                    "type": "boolean"
+                },
                 "downState": {
                     "description": "\"unknown\" | \"outside\" | \"inside\"",
                     "type": "string"
                 },
+                "forceUnlock": {
+                    "description": "Write-only. Set true to force any axis currently latched INSIDE (holding that state through stale/unusable sensor data) back to unknown, so the next sensor reading re-determines its real state. Has no effect on an axis that is not latched. Never reported back by the backend.",
+                    "type": "boolean"
+                },
                 "fwdError": {
                     "type": "string"
                 },
+                "fwdLatched": {
+                    "description": "True when the axis reports \"inside\" because it latched - it saw an obstacle in the keep-out zone and has held that state through sensor data it cannot use - rather than because it can currently see the obstacle. Only a latched axis responds to forceUnlock.",
+                    "type": "boolean"
+                },
                 "fwdState": {
                     "description": "\"unknown\" | \"outside\" | \"inside\"",
                     "type": "string"

package/dist/constants/versions/index.d.ts

@@ -1 +1 @@
-export declare const API_VERSION = "1.0.38-collisionavoidanceprototype.0";
+export declare const API_VERSION = "1.0.38-collisionavoidanceprototype.2";

package/dist/constants/versions/index.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.API_VERSION = void 0;
 /* AUTO GENERATED FILE */
-exports.API_VERSION = "1.0.38-collisionavoidanceprototype.0";
+exports.API_VERSION = "1.0.38-collisionavoidanceprototype.2";

package/dist/types/devices/vehicles/rovDrive/index.d.ts

@@ -47,6 +47,16 @@ export type DistanceLock = {
     setPoint?: number;
     error?: string;
 };
+/**
+ * Which environment collision avoidance tunes its forward axis for.
+ *
+ * @group Devices
+ * @category ROV
+ */
+export declare enum CollisionAvoidanceEnvironment {
+    EnclosedSpace = "enclosedSpace",
+    OpenWater = "openWater"
+}
 /**
  * Collision Avoidance
  *
@@ -61,7 +71,32 @@ export type CollisionAvoidance = {
     /** "unknown" | "outside" | "inside" */
     fwdState?: string;
     fwdError?: string;
+    /**
+     * True when the axis reports "inside" because it latched - it saw an obstacle in the
+     * keep-out zone and has held that state through sensor data it cannot use - rather
+     * than because it can currently see the obstacle. Only a latched axis responds to
+     * forceUnlock.
+     */
+    fwdLatched?: boolean;
     /** "unknown" | "outside" | "inside" */
     downState?: string;
     downError?: string;
+    downLatched?: boolean;
+    /**
+     * Which environment the forward axis is tuned for: "enclosedSpace" or "openWater".
+     *
+     * Only the handling of low-confidence Echosounder returns differs. In an enclosed
+     * space a doubtful range is still a range off an awkward surface and is acted on; in
+     * open water, with nothing in range, the same returns arrive sporadically at arbitrary
+     * distances and are ignored. Stored in the BridgeBox's preferences, so it persists
+     * across restarts and applies to every client.
+     */
+    environment?: CollisionAvoidanceEnvironment;
+    /**
+     * Write-only. Set true to force any axis currently latched INSIDE (holding that
+     * state through stale/unusable sensor data) back to unknown, so the next sensor
+     * reading re-determines its real state. Has no effect on an axis that is not
+     * latched. Never reported back by the backend.
+     */
+    forceUnlock?: boolean;
 };

package/dist/types/devices/vehicles/rovDrive/index.js

@@ -1,2 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollisionAvoidanceEnvironment = void 0;
+/**
+ * Which environment collision avoidance tunes its forward axis for.
+ *
+ * @group Devices
+ * @category ROV
+ */
+var CollisionAvoidanceEnvironment;
+(function (CollisionAvoidanceEnvironment) {
+    CollisionAvoidanceEnvironment["EnclosedSpace"] = "enclosedSpace";
+    CollisionAvoidanceEnvironment["OpenWater"] = "openWater";
+})(CollisionAvoidanceEnvironment || (exports.CollisionAvoidanceEnvironment = CollisionAvoidanceEnvironment = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "1.0.38-collisionavoidanceprototype.0",
+    "version": "1.0.38-collisionavoidanceprototype.2",
     "description": "A business domain of types and schemas that the Deep Trekker topside communicates with via an API.",
     "main": "dist/index.js",
     "engines": {