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

package/dist/constants/schema/schema.json

@@ -783,6 +783,10 @@
                     "description": "\"unknown\" | \"outside\" | \"inside\"",
                     "type": "string"
                 },
+                "environment": {
+                    "$ref": "#/definitions/CollisionAvoidanceEnvironment",
+                    "description": "Which environment the forward axis is tuned for: \"enclosedSpace\" or \"openWater\".\n\nOnly 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."
+                },
                 "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"
@@ -801,6 +805,14 @@
             },
             "type": "object"
         },
+        "CollisionAvoidanceEnvironment": {
+            "description": "Which environment collision avoidance tunes its forward axis for.",
+            "enum": [
+                "enclosedSpace",
+                "openWater"
+            ],
+            "type": "string"
+        },
         "CrawlerDrive": {
             "additionalProperties": false,
             "description": "Crawler drive",

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

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

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.2";
+exports.API_VERSION = "1.0.38-collisionavoidanceprototype.3";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "1.0.38-collisionavoidanceprototype.2",
+    "version": "1.0.38-collisionavoidanceprototype.3",
     "description": "A business domain of types and schemas that the Deep Trekker topside communicates with via an API.",
     "main": "dist/index.js",
     "engines": {
@@ -12,7 +12,7 @@
         "dist/*"
     ],
     "scripts": {
-        "build": "rimraf ./dist ./docs && yarn set-versions && tsc && yarn schema && yarn docs && yarn copy-dist && yarn replace-code-blocks-css",
+        "build": "rimraf ./dist ./docs && yarn set-versions && yarn schema && tsc && yarn docs && yarn copy-dist && yarn replace-code-blocks-css",
         "schema": "ts-json-schema-generator --path src/types/schemas/index.ts --type __TransferPayload_BridgeBox -o src/constants/schema/schema.json",
         "docs": "npx typedoc --options typedoc.json",
         "set-versions": "node scripts/setVersions.js",