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

package/dist/constants/schema/schema.json

@@ -113,9 +113,7 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "A150CameraHead": {
@@ -180,9 +178,7 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "A200": {
@@ -297,9 +293,7 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "A200CameraHead": {
@@ -372,9 +366,7 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "AutoSnapshot": {
@@ -646,22 +638,12 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "CalibrationStates": {
             "description": "Calibration states for the sensor pod.",
-            "enum": [
-                0,
-                1,
-                2,
-                3,
-                4,
-                5,
-                6
-            ],
+            "enum": [0, 1, 2, 3, 4, 5, 6],
             "type": "number"
         },
         "Camera": {
@@ -676,14 +658,7 @@
                     "type": "string"
                 },
                 "model": {
-                    "enum": [
-                        240,
-                        5,
-                        206,
-                        243,
-                        241,
-                        207
-                    ],
+                    "enum": [240, 5, 206, 243, 241, 207],
                     "type": "number"
                 },
                 "osd": {
@@ -705,33 +680,22 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "CameraHeadOrientation": {
             "description": "Camera head orientation config\n\nThe orientation in which the camera head is physically assembled",
-            "enum": [
-                "HORIZONTAL",
-                "VERTICAL"
-            ],
+            "enum": ["HORIZONTAL", "VERTICAL"],
             "type": "string"
         },
         "CameraHeadSensorType": {
             "description": "Camera head sensor type",
-            "enum": [
-                "IMU",
-                "HALL_EFFECT"
-            ],
+            "enum": ["IMU", "HALL_EFFECT"],
             "type": "string"
         },
         "CameraType": {
             "description": "Camera type enums",
-            "enum": [
-                "MAIN",
-                "AUX"
-            ],
+            "enum": ["MAIN", "AUX"],
             "type": "string"
         },
         "Cameras": {
@@ -799,11 +763,7 @@
         },
         "CrawlerDriveMode": {
             "description": "Drive Modes",
-            "enum": [
-                "NORMAL",
-                "RETRIEVAL_ASSIST",
-                "RETRIEVAL_CRUISE"
-            ],
+            "enum": ["NORMAL", "RETRIEVAL_ASSIST", "RETRIEVAL_CRUISE"],
             "type": "string"
         },
         "CygnusType": {
@@ -890,9 +850,7 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "DT645Drive": {
@@ -971,9 +929,7 @@
                     "description": "White Balance Settings for adjusting the white balance of the camera."
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "DVL": {
@@ -996,9 +952,7 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "DateTime": {
@@ -1076,12 +1030,10 @@
                 204,
                 205,
                 244,
-                245
+                245,
+                247
             ],
-            "type": [
-                "string",
-                "number"
-            ]
+            "type": ["string", "number"]
         },
         "DeviceVersion": {
             "additionalProperties": false,
@@ -1202,15 +1154,7 @@
         },
         "ErrorCode": {
             "description": "Error Codes",
-            "enum": [
-                400,
-                401,
-                403,
-                405,
-                500,
-                503,
-                519
-            ],
+            "enum": [400, 401, 403, 405, 500, 503, 519],
             "type": "number"
         },
         "ExposureSettings": {
@@ -1302,15 +1246,7 @@
         },
         "GpsFixState": {
             "description": "Enumerates the possible GPS FIX states.",
-            "enum": [
-                0,
-                1,
-                2,
-                3,
-                4,
-                5,
-                6
-            ],
+            "enum": [0, 1, 2, 3, 4, 5, 6],
             "type": "number"
         },
         "GpsStatus": {
@@ -1396,9 +1332,7 @@
                     "type": "boolean"
                 }
             },
-            "required": [
-                "enabled"
-            ],
+            "required": ["enabled"],
             "type": "object"
         },
         "Light": {
@@ -1412,9 +1346,7 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "intensity"
-            ],
+            "required": ["intensity"],
             "type": "object"
         },
         "LocalPosition": {
@@ -1439,11 +1371,7 @@
         },
         "LocationConsumerType": {
             "description": "Enumerates the possible consumers of a location provider.",
-            "enum": [
-                0,
-                1,
-                2
-            ],
+            "enum": [0, 1, 2],
             "type": "number"
         },
         "LocationForwarderConfig": {
@@ -1525,9 +1453,7 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "MotorDiagnostics": {
@@ -1620,10 +1546,7 @@
         },
         "NetworkRole": {
             "description": "Network Diagnostics Physical Location enum",
-            "enum": [
-                "CCO",
-                "STA"
-            ],
+            "enum": ["CCO", "STA"],
             "type": "string"
         },
         "OcleaCam": {
@@ -1699,9 +1622,7 @@
                     "description": "White Balance"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "OcleaDptz": {
@@ -1728,9 +1649,7 @@
                             "type": "object"
                         }
                     },
-                    "required": [
-                        "direction"
-                    ],
+                    "required": ["direction"],
                     "type": "object"
                 },
                 "roi": {
@@ -1771,25 +1690,33 @@
         },
         "OcleaVersion": {
             "description": "Oclea Sensor version",
-            "enum": [
-                "4K UHD v274",
-                "4K UHD v415",
-                "4K UHD v678",
-                "Zoom v3010"
-            ],
+            "enum": ["4K UHD v274", "4K UHD v415", "4K UHD v678", "Zoom v3010"],
             "type": "string"
         },
         "OfflineUpdateState": {
             "description": "Offline Update State",
-            "enum": [
-                0,
-                1,
-                2,
-                3,
-                4
-            ],
+            "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",
@@ -1909,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,
@@ -1968,9 +1899,7 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "Osd": {
@@ -2103,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,
@@ -2163,17 +2096,12 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "PhysicalLocation": {
             "description": "Network Diagnostics Physical Location enum",
-            "enum": [
-                "LOC",
-                "REM"
-            ],
+            "enum": ["LOC", "REM"],
             "type": "string"
         },
         "Pivot": {
@@ -2286,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,
@@ -2360,9 +2292,7 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "Position": {
@@ -2568,17 +2498,11 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "Rate": {
-            "enum": [
-                -1,
-                0,
-                1
-            ],
+            "enum": [-1, 0, 1],
             "type": "number"
         },
         "Removable<A150CameraHead>": {
@@ -2799,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,
@@ -2872,9 +2800,7 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "RotaryJoint": {
@@ -2977,9 +2903,7 @@
                     "type": "object"
                 }
             },
-            "required": [
-                "controls"
-            ],
+            "required": ["controls"],
             "type": "object"
         },
         "RovThrust": {
@@ -2999,10 +2923,7 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "forward",
-                "yaw"
-            ],
+            "required": ["forward", "yaw"],
             "type": "object"
         },
         "SWUpdate": {
@@ -3057,34 +2978,17 @@
                     "type": "string"
                 }
             },
-            "required": [
-                "name"
-            ],
+            "required": ["name"],
             "type": "object"
         },
         "SerialDeviceType": {
             "description": "Denotes the origin of the serial device.",
-            "enum": [
-                "ROV",
-                "Web",
-                "Internal",
-                "Controller"
-            ],
+            "enum": ["ROV", "Web", "Internal", "Controller"],
             "type": "string"
         },
         "SnapshotIntervals": {
             "description": "Snapshot intervals (in seconds) for auto snapshot feature.",
-            "enum": [
-                1,
-                2,
-                3,
-                4,
-                5,
-                10,
-                15,
-                30,
-                60
-            ],
+            "enum": [1, 2, 3, 4, 5, 10, 15, 30, 60],
             "type": "number"
         },
         "SoftwareUpdate": {
@@ -3098,10 +3002,7 @@
                     "$ref": "#/definitions/VersionNote"
                 }
             },
-            "required": [
-                "releaseDate",
-                "versionNotes"
-            ],
+            "required": ["releaseDate", "versionNotes"],
             "type": "object"
         },
         "Sonar": {
@@ -3118,7 +3019,7 @@
                     "type": "boolean"
                 },
                 "errorCode": {
-                    "description": "Oculus sonar throws errors if something goes wrong within it.  This property will only appear if there is an active error and will show the error code.",
+                    "description": "Oculus sonar throws errors if something goes wrong within it. This property will only appear if there is an active error and will show the error code.",
                     "type": "number"
                 },
                 "frequency": {
@@ -3168,6 +3069,10 @@
             "additionalProperties": false,
             "description": "Sonar 3D",
             "properties": {
+                "acoustics": {
+                    "description": "Enables/disables acoustics",
+                    "type": "boolean"
+                },
                 "ip": {
                     "description": "IP address",
                     "type": "string"
@@ -3180,25 +3085,17 @@
                     "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "SonarFrequency": {
             "description": "Sonar frequency levels",
-            "enum": [
-                "HIGH",
-                "LOW"
-            ],
+            "enum": ["HIGH", "LOW"],
             "type": "string"
         },
         "SonarModel": {
             "description": "Sonar models",
-            "enum": [
-                "oculus",
-                "tritech"
-            ],
+            "enum": ["oculus", "tritech"],
             "type": "string"
         },
         "Sonde": {
@@ -3209,17 +3106,12 @@
                     "type": "boolean"
                 }
             },
-            "required": [
-                "enabled"
-            ],
+            "required": ["enabled"],
             "type": "object"
         },
         "SpragBearing": {
             "description": "Sprag Bearing Types",
-            "enum": [
-                "FKNN6204-2RS",
-                "FKNN6205-2RS"
-            ],
+            "enum": ["FKNN6204-2RS", "FKNN6205-2RS"],
             "type": "string"
         },
         "Stream": {
@@ -3246,9 +3138,7 @@
                     "description": "Stream resolution"
                 }
             },
-            "required": [
-                "active"
-            ],
+            "required": ["active"],
             "type": "object"
         },
         "StreamMode": {
@@ -3277,10 +3167,7 @@
         },
         "StreamModes": {
             "description": "Streaming Mode for the camera",
-            "enum": [
-                "RTSP",
-                "WEBRTC"
-            ],
+            "enum": ["RTSP", "WEBRTC"],
             "type": "string"
         },
         "SystemDiagnostics": {
@@ -3304,10 +3191,7 @@
         },
         "SystemOfMeasurement": {
             "description": "System unit of measurement enum",
-            "enum": [
-                "IMPERIAL",
-                "METRIC"
-            ],
+            "enum": ["IMPERIAL", "METRIC"],
             "type": "string"
         },
         "SystemSettings": {
@@ -3348,14 +3232,7 @@
                 },
                 "nearLimit": {
                     "description": "Focus near limit",
-                    "enum": [
-                        10,
-                        34,
-                        90,
-                        250,
-                        800,
-                        2300
-                    ],
+                    "enum": [10, 34, 90, 250, 800, 2300],
                     "type": "number"
                 },
                 "rate": {
@@ -3431,9 +3308,7 @@
                     "$ref": "#/definitions/ZoomControl"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "TamronOcleaZoomCamera": {
@@ -3493,9 +3368,7 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "TiltCameraHead": {
@@ -3541,17 +3414,12 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": [
-                "model"
-            ],
+            "required": ["model"],
             "type": "object"
         },
         "TiltCameraHeadModel": {
             "description": "Tilt Camera Head Model",
-            "enum": [
-                102,
-                103
-            ],
+            "enum": [102, 103],
             "type": "number"
         },
         "TiltPlatform": {
@@ -3586,11 +3454,7 @@
         },
         "TopPositionSources": {
             "description": "Enumerates the possible topside location provider sources available to the Web App.",
-            "enum": [
-                "NONE",
-                "EXTERNAL_GPS",
-                "STATIC"
-            ],
+            "enum": ["NONE", "EXTERNAL_GPS", "STATIC"],
             "type": "string"
         },
         "TopsidePosition": {
@@ -3625,21 +3489,12 @@
                     "type": "string"
                 }
             },
-            "required": [
-                "code",
-                "message"
-            ],
+            "required": ["code", "message"],
             "type": "object"
         },
         "TransferMethodType": {
             "description": "The different kinds of payload requests that can be sent and received.",
-            "enum": [
-                "GET",
-                "SET",
-                "UPDATE",
-                "DELETE",
-                "ERROR"
-            ],
+            "enum": ["GET", "SET", "UPDATE", "DELETE", "ERROR"],
             "type": "string"
         },
         "TransferPayload<BridgeBox>": {
@@ -3660,11 +3515,7 @@
                     "$ref": "#/definitions/BridgeBox"
                 }
             },
-            "required": [
-                "apiVersion",
-                "method",
-                "payload"
-            ],
+            "required": ["apiVersion", "method", "payload"],
             "type": "object"
         },
         "TurbidityFilter": {
@@ -3701,12 +3552,7 @@
                     "type": "string"
                 }
             },
-            "required": [
-                "buildDate",
-                "size",
-                "sha256",
-                "changelog"
-            ],
+            "required": ["buildDate", "size", "sha256", "changelog"],
             "type": "object"
         },
         "UsageTime": {
@@ -3790,10 +3636,7 @@
                     "type": "array"
                 }
             },
-            "required": [
-                "improvements",
-                "fixes"
-            ],
+            "required": ["improvements", "fixes"],
             "type": "object"
         },
         "WhiteBalanceSettings": {

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

@@ -1 +1 @@
-export declare const API_VERSION = "1.0.44";
+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.44";
+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

@@ -93,4 +93,16 @@ export type Sonar = {
  */
 export type Sonar3D = {
     mac?: string;
+    /**
+     * Enables/disables acoustics
+     */
+    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/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.44",
+    "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"
     }
 }