@deeptrekker/api-domain 1.0.43-x4-localization.1 → 1.0.43

package/dist/constants/schema/schema.json

@@ -766,25 +766,6 @@
             },
             "type": "object"
         },
-        "ControllerPosition": {
-            "additionalProperties": false,
-            "description": "Controller position",
-            "properties": {
-                "lat": {
-                    "description": "Latitude of the controller, in degrees.",
-                    "maximum": 90,
-                    "minimum": -90,
-                    "type": "number"
-                },
-                "lng": {
-                    "description": "Longitude of the controller, in degrees.",
-                    "maximum": 180,
-                    "minimum": -180,
-                    "type": "number"
-                }
-            },
-            "type": "object"
-        },
         "CrawlerDrive": {
             "additionalProperties": false,
             "description": "Crawler drive",
@@ -2430,12 +2411,12 @@
                     "$ref": "#/definitions/GpsStatus"
                 },
                 "topsidePosition": {
-                    "$ref": "#/definitions/ControllerPosition",
-                    "description": "Position of the controller, which is the surface end of the tether and the reference the USBL head is offset from."
+                    "$ref": "#/definitions/TopsidePosition",
+                    "description": "Position of the topside, which is the surface end of the tether and the reference the USBL head is offset from."
                 },
                 "usblOffset": {
                     "$ref": "#/definitions/UsblOffset",
-                    "description": "Fixed offset from the controller to the USBL head."
+                    "description": "Fixed offset from the topside to the USBL head."
                 }
             },
             "type": "object"
@@ -3612,6 +3593,25 @@
             ],
             "type": "string"
         },
+        "TopsidePosition": {
+            "additionalProperties": false,
+            "description": "Topside position",
+            "properties": {
+                "lat": {
+                    "description": "Latitude of the topside, in degrees.",
+                    "maximum": 90,
+                    "minimum": -90,
+                    "type": "number"
+                },
+                "lng": {
+                    "description": "Longitude of the topside, in degrees.",
+                    "maximum": 180,
+                    "minimum": -180,
+                    "type": "number"
+                }
+            },
+            "type": "object"
+        },
         "TransferError": {
             "additionalProperties": false,
             "description": "Error message from the Bridge Box",
@@ -3727,11 +3727,11 @@
             "description": "USBL head offset",
             "properties": {
                 "x": {
-                    "description": "Distance east from the controller to the USBL head (in meters). Negative is west.",
+                    "description": "Distance east from the topside to the USBL head (in meters). Negative is west.",
                     "type": "number"
                 },
                 "y": {
-                    "description": "Distance north from the controller to the USBL head (in meters). Negative is south.",
+                    "description": "Distance north from the topside to the USBL head (in meters). Negative is south.",
                     "type": "number"
                 }
             },

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

@@ -1 +1 @@
-export declare const API_VERSION = "1.0.43-x4-localization.1";
+export declare const API_VERSION = "1.0.43";

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.43-x4-localization.1";
+exports.API_VERSION = "1.0.43";

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

@@ -247,19 +247,19 @@ export type PositionNavigationOption = {
      */
     rovGpsStatus?: GpsStatus;
     /**
-     * Position of the controller, which is the surface end of the tether and the
+     * Position of the topside, which is the surface end of the tether and the
      * reference the USBL head is offset from.
      *
      * @remarks Reported by the vehicle whatever the source, so a client that did not
      * issue the write still renders it. Settable only when {@link PositionNavigationOption.topSource}
      * is `STATIC`. X4 only.
-     * @see {@link ControllerPosition | ControllerPosition}
+     * @see {@link TopsidePosition | TopsidePosition}
      */
-    topsidePosition?: ControllerPosition;
+    topsidePosition?: TopsidePosition;
     /**
-     * Fixed offset from the controller to the USBL head.
+     * Fixed offset from the topside to the USBL head.
      *
-     * @remarks Applies when the head is not co-located with the controller. X4 only.
+     * @remarks Applies when the head is not co-located with the topside. X4 only.
      * @see {@link UsblOffset | UsblOffset}
      */
     usblOffset?: UsblOffset;
@@ -273,22 +273,23 @@ export type PositionNavigationOption = {
     resetFilter?: boolean;
 };
 /**
- * Controller position
+ * Topside position
  *
- * @remarks Latitude and longitude of the controller, in degrees.
+ * @remarks Latitude and longitude of the topside controller at the surface end of the
+ * tether, in degrees.
  * @group Devices
  * @category Navigation
  */
-export type ControllerPosition = {
+export type TopsidePosition = {
     /**
-     * Latitude of the controller, in degrees.
+     * Latitude of the topside, in degrees.
      *
      * @minimum -90
      * @maximum 90
      */
     lat?: number;
     /**
-     * Longitude of the controller, in degrees.
+     * Longitude of the topside, in degrees.
      *
      * @minimum -180
      * @maximum 180
@@ -298,18 +299,18 @@ export type ControllerPosition = {
 /**
  * USBL head offset
  *
- * @remarks Offset from the controller to the USBL head, in metres. Note these are
+ * @remarks Offset from the topside to the USBL head, in metres. Note these are
  * compass-aligned rather than vehicle-relative: `x` is east and `y` is north.
  * @group Devices
  * @category Navigation
  */
 export type UsblOffset = {
     /**
-     * Distance east from the controller to the USBL head (in meters). Negative is west.
+     * Distance east from the topside to the USBL head (in meters). Negative is west.
      */
     x?: number;
     /**
-     * Distance north from the controller to the USBL head (in meters). Negative is south.
+     * Distance north from the topside to the USBL head (in meters). Negative is south.
      */
     y?: number;
 };

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

@@ -796,7 +796,7 @@ export type X4 = {
     vehiclePosition?: X4Position;
     /**
      * Navigation settings and options for the X4: which source supplies the global position,
-     * where the controller is, and the heading corrections.
+     * where the topside is, and the heading corrections.
      *
      * Only `navigationOptions` is taken from {@link Navigation | Navigation}, rather than
      * intersecting the whole type as {@link RovVehicle | RovVehicle} does. The X4 reports

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "1.0.43-x4-localization.1",
+    "version": "1.0.43",
     "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,6 +62,7 @@
         "mkdirp": "^1.0.4",
         "ts-pattern": "^4.3.0",
         "ts-toolbelt": "^9.6.0",
-        "type-zoo": "^3.4.1"
+        "type-zoo": "^3.4.1",
+        "yarn": "^1.22.22"
     }
 }