@deeptrekker/api-domain 1.0.34-collisionavoidanceprototype.0 → 1.0.34-laketesting.0

package/dist/constants/schema/schema.json

@@ -766,30 +766,6 @@
             },
             "type": "object"
         },
-        "CollisionAvoidance": {
-            "additionalProperties": false,
-            "description": "Collision Avoidance",
-            "properties": {
-                "active": {
-                    "type": "boolean"
-                },
-                "downError": {
-                    "type": "string"
-                },
-                "downState": {
-                    "description": "\"unknown\" | \"outside\" | \"inside\"",
-                    "type": "string"
-                },
-                "fwdError": {
-                    "type": "string"
-                },
-                "fwdState": {
-                    "description": "\"unknown\" | \"outside\" | \"inside\"",
-                    "type": "string"
-                }
-            },
-            "type": "object"
-        },
         "CrawlerDrive": {
             "additionalProperties": false,
             "description": "Crawler drive",
@@ -1037,6 +1013,32 @@
             },
             "type": "object"
         },
+        "DenoiseMode": {
+            "description": "Denoise mode",
+            "enum": [
+                "off",
+                "fast",
+                "high_quality"
+            ],
+            "type": "string"
+        },
+        "DenoiseSettings": {
+            "additionalProperties": false,
+            "description": "Denoise Settings",
+            "properties": {
+                "mode": {
+                    "$ref": "#/definitions/DenoiseMode",
+                    "description": "Mode"
+                },
+                "strength": {
+                    "description": "Strength\n\nControls the strength of the denoise filter.",
+                    "maximum": 100,
+                    "minimum": 0,
+                    "type": "number"
+                }
+            },
+            "type": "object"
+        },
         "DeviceModel": {
             "description": "Deep Trekker internal device model numbers.",
             "enum": [
@@ -1652,6 +1654,9 @@
                 "cpuTemp": {
                     "type": "number"
                 },
+                "denoise": {
+                    "$ref": "#/definitions/DenoiseSettings"
+                },
                 "dptz": {
                     "$ref": "#/definitions/OcleaDptz"
                 },
@@ -2895,9 +2900,6 @@
                         "autoStabilization": {
                             "type": "boolean"
                         },
-                        "collisionAvoidance": {
-                            "$ref": "#/definitions/CollisionAvoidance"
-                        },
                         "depthLock": {
                             "type": "boolean"
                         },

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

@@ -1 +1 @@
-export declare const API_VERSION = "1.0.34-collisionavoidanceprototype.0";
+export declare const API_VERSION = "1.0.34-laketesting.0";

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.34-collisionavoidanceprototype.0";
+exports.API_VERSION = "1.0.34-laketesting.0";

package/dist/types/core/index.d.ts

@@ -55,13 +55,16 @@ export type TransferPayload<T> = {
     payload: T;
 };
 export declare enum ReferencePoints {
-    Body = "body",
     Altitude = "altitude",
     Depth = "depth",
     Global = "global",
     Local = "local",
     Distance = "distance"
 }
+export declare enum ControlFrames {
+    Body = "body",
+    Footprint = "footprint"
+}
 /**
  * Movement
  *
@@ -99,6 +102,11 @@ export type Movement = {
      * A reference to the position or heading that the vehicle should target and base its locking on.
      */
     reference?: ReferencePoints;
+    /**
+     * @remarks
+     * The frame of reference for the movement. This is used to determine how the vehicle should interpret the movement command.
+     */
+    controlFrame?: ControlFrames;
 };
 /**
  * The different kinds of payload requests that can be sent and received.

package/dist/types/core/index.js

@@ -15,16 +15,20 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ERROR_MESSAGES = exports.ErrorCode = exports.TransferMethodType = exports.ReferencePoints = void 0;
+exports.ERROR_MESSAGES = exports.ErrorCode = exports.TransferMethodType = exports.ControlFrames = exports.ReferencePoints = void 0;
 var ReferencePoints;
 (function (ReferencePoints) {
-    ReferencePoints["Body"] = "body";
     ReferencePoints["Altitude"] = "altitude";
     ReferencePoints["Depth"] = "depth";
     ReferencePoints["Global"] = "global";
     ReferencePoints["Local"] = "local";
     ReferencePoints["Distance"] = "distance";
 })(ReferencePoints || (exports.ReferencePoints = ReferencePoints = {}));
+var ControlFrames;
+(function (ControlFrames) {
+    ControlFrames["Body"] = "body";
+    ControlFrames["Footprint"] = "footprint";
+})(ControlFrames || (exports.ControlFrames = ControlFrames = {}));
 /**
  * The different kinds of payload requests that can be sent and received.
  * @category Core

package/dist/types/devices/cameras/core/index.d.ts

@@ -213,6 +213,26 @@ export type TurbidityFilter = {
      */
     strength?: number;
 };
+/**
+ * Denoise Settings
+ * @group Devices
+ * @category Cameras
+ */
+export type DenoiseSettings = {
+    /**
+     * Strength
+     *
+     * Controls the strength of the denoise filter.
+     * @minimum 0
+     * @maximum 100
+     */
+    strength?: number;
+    /**
+     * Enabled
+     *
+     */
+    enabled?: boolean;
+};
 /**
  * Exposure Settings
  * @group Devices

package/dist/types/devices/cameras/ocleaCam/index.d.ts

@@ -1,5 +1,5 @@
 import { Camera, DeviceModel } from "../..";
-import { ExposureSettings, OcleaDptz, OcleaVersion, TurbidityFilter, WhiteBalanceSettings } from "../core";
+import { DenoiseSettings, ExposureSettings, OcleaDptz, OcleaVersion, TurbidityFilter, WhiteBalanceSettings } from "../core";
 /**
  *
  *  📷 4k UHD Camera
@@ -92,4 +92,11 @@ export type OcleaCam = Camera & {
      * @see {@link TurbidityFilter | TurbidityFilter}
      */
     turbidityFilter?: TurbidityFilter;
+    /**
+     * @remarks
+     * Denoise filter settings
+     *
+     * @see {@link DenoiseSettings | DenoiseSettings}
+     */
+    denoise?: DenoiseSettings;
 };

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

@@ -34,7 +34,6 @@ export type RovDrive = {
         motorsDisabled?: boolean;
         stationHolding?: boolean;
         distanceLock?: DistanceLock;
-        collisionAvoidance?: CollisionAvoidance;
     };
 };
 /**
@@ -47,21 +46,3 @@ export type DistanceLock = {
     setPoint?: number;
     error?: string;
 };
-/**
- * Collision Avoidance
- *
- * @remarks Toggling this mode toggles both forward and downward collision avoidance together,
- * though the two axes are tracked and reported independently. Cannot be active at the same
- * time as Distance Lock.
- * @group Devices
- * @category ROV
- */
-export type CollisionAvoidance = {
-    active?: boolean;
-    /** "unknown" | "outside" | "inside" */
-    fwdState?: string;
-    fwdError?: string;
-    /** "unknown" | "outside" | "inside" */
-    downState?: string;
-    downError?: string;
-};

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

@@ -158,6 +158,11 @@ export type X4DriveCommand = {
      * See {@link ControlMode | ControlMode} for more details.
      */
     controlMode?: ControlMode;
+    /**
+     * The velocity control option for the drive command, which can be used to specify whether the vehicle should use velocity control or position control.
+     * If true the vehicle is locked to velocity control.
+     */
+    useVelocityControl?: boolean;
     /**
      * The forward movement command, which includes speed and position.
      * This allows the user to control the vehicle's forward movement. (Forward and backward)

package/package.json

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