@deeptrekker/api-domain 1.0.3 → 1.0.5-rca-1594-add-photogrammetry-support-for.1

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

@@ -1 +1 @@
-export declare const API_VERSION = "1.0.3";
+export declare const API_VERSION = "1.0.5-rca-1594-add-photogrammetry-support-for.1";

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.3";
+exports.API_VERSION = "1.0.5-rca-1594-add-photogrammetry-support-for.1";

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

@@ -57,7 +57,9 @@ export type TransferPayload<T> = {
 /**
  * Movement
  *
- * Represents a movement command with speed and position.
+ * Represents a movement command with speed and position. Only one movement command can be active at a time.
+ *
+ * **When position is the active command, the vehicle will target and hold that position until a velocity command is received**
  *
  * @category Controls
  * @group X4
@@ -229,6 +231,17 @@ export type TransferError = {
      */
     message: string;
 };
+/**
+ * Error message from the Bridge Box
+ * @category Core
+ * @group X4
+ */
+export type AutoSnapshots = {
+    /**
+     * enabled, value used to determine if autoSnapshots are active.
+     */
+    enabled: boolean;
+};
 /**
  * Error Codes
  * @category Core

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

@@ -1,4 +1,4 @@
-import { Movement } from "../../../core";
+import { AutoSnapshots, Movement } from "../../../core";
 import { DeviceModel, MotorDiagnostics, Sonar, StereoCamera, X4CameraHead } from "../../cameraHeads";
 import { SensorPod, X4Light } from "../../peripherals";
 /**
@@ -86,8 +86,9 @@ export type X4Thruster = {
 };
 /**
  * The X4 drive command type.
- * It includes properties for controlling the vehicle's movement in various directions (forward, lateral, vertical depth, roll, pitch, yaw).
+ * It includes properties for controlling the vehicle's movement in various directions (forward, lateral, vertical depth, roll, pitch, yaw). **The vehicle will disable all motors after 500ms if no commands are received.**
  * It also includes options for coordinate type and reference frame. As the vehicle can be controlled in different coordinate systems, this type allows for flexibility in how commands are issued.
+ *
  * @internal
  * @alpha
  * @group X4
@@ -265,6 +266,54 @@ export type X4Position = {
      * @readonly
      */
     heading?: number;
+    /**
+     * Indicates that a position for x has been set. Sending a velocity command for x will disable the lock.
+     *
+     * @readonly
+     */
+    xLock?: boolean;
+    /**
+     * Indicates that a position for y has been set. Sending a velocity command for y will disable the lock.
+     *
+     * @readonly
+     */
+    yLock?: boolean;
+    /**
+     * Indicates that a position for zDepth has been set. Sending a velocity command for zDepth will disable the lock.
+     *
+     * @readonly
+     */
+    zDepthLock?: boolean;
+    /**
+     * Indicates that a position for zAltitude has been set. Sending a velocity command for zAltitude will disable the lock.
+     *
+     * @readonly
+     */
+    zAltitudeLock?: boolean;
+    /**
+     * Indicates that a position for roll has been set. Sending a velocity command for roll will disable the lock.
+     *
+     * @readonly
+     */
+    rollLock?: boolean;
+    /**
+     * Indicates that a position for pitch has been set. Sending a velocity command for pitch will disable the lock.
+     *
+     * @readonly
+     */
+    pitchLock?: boolean;
+    /**
+     * Indicates that a position for yaw has been set. Sending a velocity command for yaw or a drive command for heading will disable the yaw lock.
+     *
+     * @readonly
+     */
+    yawLock?: boolean;
+    /**
+     * Indicates that a position for heading has been set. Sending a velocity command for heading or a drive command for yaw will disable the heading lock.
+     *
+     * @readonly
+     */
+    headingLock?: boolean;
 };
 /**
  * The X4 tracked position type.
@@ -680,4 +729,9 @@ export type X4 = {
      * The current water temperature around the vehicle.
      */
     waterTemperature?: number;
+    /**
+     *  Indicates that autoSnapshots has been set. Sending a enabled command for will turn on autoSnapshots, disabled turning it off.
+     *
+     */
+    autoSnapshot?: AutoSnapshots;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "1.0.3",
+    "version": "1.0.5-rca-1594-add-photogrammetry-support-for.1",
     "description": "A business domain of types and schemas that the Deep Trekker topside communicates with via an API.",
     "main": "dist/index.js",
     "engines": {
@@ -37,16 +37,16 @@
         "@knodes/typedoc-plugin-code-blocks": "^0.22.7",
         "@types/lodash": "^4.14.182",
         "@types/node": "^22.0.0",
-        "@typescript-eslint/eslint-plugin": "^6.1.0",
-        "@typescript-eslint/parser": "^6.1.0",
         "@zamiell/typedoc-plugin-not-exported": "^0.2.0",
-        "eslint": "^8.45.0",
-        "eslint-config-prettier": "^8.8.0",
-        "eslint-plugin-unused-imports": "^3.0.0",
         "prettier": "3.0.3",
         "rimraf": "^3.0.2",
         "semver-compare-cli": "^2.0.0",
         "ts-json-schema-generator": "2.4.0",
+        "eslint": "^8.45.0",
+        "@typescript-eslint/eslint-plugin": "^6.1.0",
+        "@typescript-eslint/parser": "^6.1.0",
+        "eslint-plugin-unused-imports": "^3.0.0",
+        "eslint-config-prettier": "^8.8.0",
         "ts-node": "^10.8.1",
         "tslib": "^2.4.0",
         "typedoc": "^0.28.9",
@@ -62,7 +62,6 @@
         "mkdirp": "^1.0.4",
         "ts-pattern": "^4.3.0",
         "ts-toolbelt": "^9.6.0",
-        "type-zoo": "^3.4.1",
-        "yarn": "^1.22.22"
+        "type-zoo": "^3.4.1"
     }
 }