@deeptrekker/api-domain 1.0.45 → 1.0.46-omniscan.0

package/dist/constants/schema/schema.json

@@ -1030,7 +1030,8 @@
                 204,
                 205,
                 244,
-                245
+                245,
+                247
             ],
             "type": ["string", "number"]
         },
@@ -1697,6 +1698,25 @@
             "enum": [0, 1, 2, 3, 4],
             "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",
@@ -1816,6 +1836,10 @@
                     "$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,
@@ -2008,6 +2032,10 @@
                     "$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,
@@ -2186,6 +2214,10 @@
                     "$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,
@@ -2691,6 +2723,10 @@
                     "$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.45";
+export declare const API_VERSION = "1.0.46-omniscan.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.45";
+exports.API_VERSION = "1.0.46-omniscan.0";

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

@@ -49,7 +49,8 @@ export declare enum DeviceModel {
     OculusSonar = 204,
     GeminiSonar = 205,
     Echosounder = 244,
-    WATERLINKED_3D_SONAR = 245
+    WATERLINKED_3D_SONAR = 245,
+    CeruleanOmniscan = 247
 }
 /**
  * Deep Trekker's Bandwidth Degradation Thresholds
@@ -124,6 +125,7 @@ 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";
@@ -179,6 +181,7 @@ 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";
@@ -250,7 +253,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.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.CeruleanOmniscan, 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,6 +97,7 @@ 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
@@ -174,6 +175,7 @@ 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",
@@ -301,7 +303,8 @@ exports.PERIPHERAL_DEVICE_MODELS = __spreadArray(__spreadArray([
     DeviceModel.OculusSonar,
     DeviceModel.GeminiSonar,
     DeviceModel.Echosounder,
-    DeviceModel.WATERLINKED_3D_SONAR
+    DeviceModel.WATERLINKED_3D_SONAR,
+    DeviceModel.CeruleanOmniscan
 ], 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

@@ -98,3 +98,11 @@ export type Sonar3D = {
      */
     acoustics?: boolean;
 } & Omit<Device, "version">;
+/**
+ * Cerulean Omniscan 450 sonar
+ * @group Devices
+ * @category Peripherals
+ */
+export type Omniscan = {
+    mac?: string;
+} & Omit<Device, "version">;

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

@@ -1,4 +1,4 @@
-import { CalibratableSensorPod, DeviceVersion, Echosounder, Sonar3D, UsageTime, Vehicle } from "../../cameraHeads";
+import { CalibratableSensorPod, DeviceVersion, Echosounder, Omniscan, Sonar3D, UsageTime, Vehicle } from "../../cameraHeads";
 import { RovDrive } from "../rovDrive";
 import { Navigation } from "../navigation";
 import { RovInputDiagnostics } from "../../diagnostics";
@@ -275,4 +275,9 @@ 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/package.json

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