@deeptrekker/api-domain 1.0.48-omniscan.0 → 1.0.48

package/dist/constants/schema/schema.json

@@ -642,6 +642,15 @@
                     "$ref": "#/definitions/DeviceModel",
                     "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
                 },
+                "pressure": {
+                    "additionalProperties": false,
+                    "properties": {
+                        "calibrate": {
+                            "type": "boolean"
+                        }
+                    },
+                    "type": "object"
+                },
                 "version": {
                     "$ref": "#/definitions/DeviceVersion"
                 }
@@ -1076,8 +1085,7 @@
                 204,
                 205,
                 244,
-                245,
-                247
+                245
             ],
             "type": [
                 "string",
@@ -1791,27 +1799,6 @@
             ],
             "type": "number"
         },
-        "Omniscan": {
-            "additionalProperties": false,
-            "description": "Cerulean Omniscan 450 sonar",
-            "properties": {
-                "ip": {
-                    "description": "IP address",
-                    "type": "string"
-                },
-                "mac": {
-                    "type": "string"
-                },
-                "model": {
-                    "$ref": "#/definitions/DeviceModel",
-                    "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
-                }
-            },
-            "required": [
-                "model"
-            ],
-            "type": "object"
-        },
         "Onyx": {
             "additionalProperties": false,
             "description": "Onyx Class",
@@ -1931,10 +1918,6 @@
                     "$ref": "#/definitions/NavigationOptions",
                     "description": "Navigation Options"
                 },
-                "omniscan": {
-                    "$ref": "#/definitions/Omniscan",
-                    "description": "Omniscan 450 sonar device information without the HW and FW versions"
-                },
                 "pitch": {
                     "maximum": 180,
                     "minimum": -180,
@@ -2129,10 +2112,6 @@
                     "$ref": "#/definitions/NavigationOptions",
                     "description": "Navigation Options"
                 },
-                "omniscan": {
-                    "$ref": "#/definitions/Omniscan",
-                    "description": "Omniscan 450 sonar device information without the HW and FW versions"
-                },
                 "pitch": {
                     "maximum": 180,
                     "minimum": -180,
@@ -2316,10 +2295,6 @@
                     "$ref": "#/definitions/NavigationOptions",
                     "description": "Navigation Options"
                 },
-                "omniscan": {
-                    "$ref": "#/definitions/Omniscan",
-                    "description": "Omniscan 450 sonar device information without the HW and FW versions"
-                },
                 "pitch": {
                     "maximum": 180,
                     "minimum": -180,
@@ -2833,10 +2808,6 @@
                     "$ref": "#/definitions/NavigationOptions",
                     "description": "Navigation Options"
                 },
-                "omniscan": {
-                    "$ref": "#/definitions/Omniscan",
-                    "description": "Omniscan 450 sonar device information without the HW and FW versions"
-                },
                 "pitch": {
                     "maximum": 180,
                     "minimum": -180,

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

@@ -1 +1 @@
-export declare const API_VERSION = "1.0.48-omniscan.0";
+export declare const API_VERSION = "1.0.48";

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.48-omniscan.0";
+exports.API_VERSION = "1.0.48";

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

@@ -49,8 +49,7 @@ export declare enum DeviceModel {
     OculusSonar = 204,
     GeminiSonar = 205,
     Echosounder = 244,
-    WATERLINKED_3D_SONAR = 245,
-    CeruleanOmniscan = 247
+    WATERLINKED_3D_SONAR = 245
 }
 /**
  * Deep Trekker's Bandwidth Degradation Thresholds
@@ -125,7 +124,6 @@ export declare const PERIPHERAL_DEVICE_MODEL_LABELS: {
     readonly 205: "Gemini Sonar";
     readonly 244: "Echosounder";
     readonly 245: "Water Linked 3D Sonar";
-    readonly 247: "Omniscan 450";
     readonly 104: "DT840 Hoser";
     readonly 105: "DT840 Manipulator Arm";
     readonly 113: "Power Distribution Module";
@@ -181,7 +179,6 @@ export declare const DEVICE_MODEL_LABELS: {
     readonly 205: "Gemini Sonar";
     readonly 244: "Echosounder";
     readonly 245: "Water Linked 3D Sonar";
-    readonly 247: "Omniscan 450";
     readonly 104: "DT840 Hoser";
     readonly 105: "DT840 Manipulator Arm";
     readonly 113: "Power Distribution Module";
@@ -253,7 +250,7 @@ export declare const X4_PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.X4PDM, D
  * @group Devices
  * @category Peripherals
  */
-export declare const PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.RovGps, DeviceModel.SerialBox, DeviceModel.WaterlinkedGps, DeviceModel.Seatrac, DeviceModel.DVL, DeviceModel.PathfindrDVL, DeviceModel.OculusSonar, DeviceModel.GeminiSonar, DeviceModel.Echosounder, DeviceModel.WATERLINKED_3D_SONAR, DeviceModel.CeruleanOmniscan, DeviceModel.SensorPod, DeviceModel.SensorPodPlus, DeviceModel.SensorPodX, DeviceModel.X4PDM, DeviceModel.X4Thruster, DeviceModel.X4Lights, DeviceModel.X4GrabberModel];
+export declare const PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.RovGps, DeviceModel.SerialBox, DeviceModel.WaterlinkedGps, DeviceModel.Seatrac, DeviceModel.DVL, DeviceModel.PathfindrDVL, DeviceModel.OculusSonar, DeviceModel.GeminiSonar, DeviceModel.Echosounder, DeviceModel.WATERLINKED_3D_SONAR, DeviceModel.SensorPod, DeviceModel.SensorPodPlus, DeviceModel.SensorPodX, DeviceModel.X4PDM, DeviceModel.X4Thruster, DeviceModel.X4Lights, DeviceModel.X4GrabberModel];
 /**
  * Device Version is a base interface for hardware and software version sample payloads.
  * -1 hardware versions and 0.0 software versions refer to not applicable

package/dist/types/devices/index.js

@@ -97,7 +97,6 @@ var DeviceModel;
     DeviceModel[DeviceModel["GeminiSonar"] = 205] = "GeminiSonar";
     DeviceModel[DeviceModel["Echosounder"] = 244] = "Echosounder";
     DeviceModel[DeviceModel["WATERLINKED_3D_SONAR"] = 245] = "WATERLINKED_3D_SONAR";
-    DeviceModel[DeviceModel["CeruleanOmniscan"] = 247] = "CeruleanOmniscan";
 })(DeviceModel || (exports.DeviceModel = DeviceModel = {}));
 /**
  * Deep Trekker's Bandwidth Degradation Thresholds
@@ -175,7 +174,6 @@ exports.PERIPHERAL_DEVICE_MODEL_LABELS = (_c = {},
     _c[DeviceModel.GeminiSonar] = "Gemini Sonar",
     _c[DeviceModel.Echosounder] = "Echosounder",
     _c[DeviceModel.WATERLINKED_3D_SONAR] = "Water Linked 3D Sonar",
-    _c[DeviceModel.CeruleanOmniscan] = "Omniscan 450",
     /* Legacy / Special Components */
     _c[DeviceModel.DT840Hoser] = "DT840 Hoser",
     _c[DeviceModel.DT840Arm] = "DT840 Manipulator Arm",
@@ -303,8 +301,7 @@ exports.PERIPHERAL_DEVICE_MODELS = __spreadArray(__spreadArray([
     DeviceModel.OculusSonar,
     DeviceModel.GeminiSonar,
     DeviceModel.Echosounder,
-    DeviceModel.WATERLINKED_3D_SONAR,
-    DeviceModel.CeruleanOmniscan
+    DeviceModel.WATERLINKED_3D_SONAR
 ], exports.SENSOR_POD_DEVICE_MODELS, true), exports.X4_PERIPHERAL_DEVICE_MODELS, true);
 __exportStar(require("./cameraHeads"), exports);
 __exportStar(require("./cameras"), exports);

package/dist/types/devices/sonar/index.d.ts

@@ -93,12 +93,8 @@ export type Sonar = {
  */
 export type Sonar3D = {
     mac?: string;
-} & Omit<Device, "version">;
-/**
- * Cerulean Omniscan 450 sonar
- * @group Devices
- * @category Peripherals
- */
-export type Omniscan = {
-    mac?: string;
+    /**
+     * Enables/disables acoustics
+     */
+    acoustics?: boolean;
 } & Omit<Device, "version">;

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

@@ -1,4 +1,4 @@
-import { CalibratableSensorPod, DeviceVersion, Echosounder, Omniscan, Sonar3D, UsageTime, Vehicle } from "../../cameraHeads";
+import { CalibratableSensorPod, DeviceVersion, Echosounder, Sonar3D, UsageTime, Vehicle } from "../../cameraHeads";
 import { RovDrive } from "../rovDrive";
 import { Navigation } from "../navigation";
 import { RovInputDiagnostics } from "../../diagnostics";
@@ -275,9 +275,4 @@ export type RovVehicle = {
      * @see {@link Sonar3D | Sonar3D}
      */
     sonar3d?: Sonar3D;
-    /**
-     * Omniscan 450 sonar device information without the HW and FW versions
-     * @see {@link Omniscan | Omniscan}
-     */
-    omniscan?: Omniscan;
 } & Vehicle & Navigation;

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

@@ -1,5 +1,5 @@
 import { Movement } from "../../../core";
-import { DeviceModel, MotorDiagnostics, Sonar, StereoCamera, X4CameraHead } from "../../cameraHeads";
+import { DeviceModel, MotorDiagnostics, Sonar, Sonar3D, StereoCamera, X4CameraHead } from "../../cameraHeads";
 import { ImpaqDriver, SensorPod, X4Light } from "../../peripherals";
 import { LightConfig, ThrusterConfig } from "./deviceAllocation";
 export * from "./deviceAllocation";
@@ -715,9 +715,10 @@ export type X4 = {
     /**
      * A record of sonars associated with the X4 vehicle.
      * Each sonar is identified by its unique MAC address and contains properties such as range, gain, frequency, and more.
-     * See {@link Sonar | Sonar} for more details.
+     * Also includes 3D sonar devices.
+     * See {@link Sonar | Sonar} and {@link Sonar3D | Sonar3D} for more details.
      */
-    sonars?: Record<string, Sonar>;
+    sonars?: Record<string, Sonar | Sonar3D>;
     /**
      * A record of lights associated with the X4 vehicle.
      * Each light is identified by its unique MAC address and contains properties such as brightness and color.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "1.0.48-omniscan.0",
+    "version": "1.0.48",
     "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"
     }
 }