npm - @deeptrekker/api-domain - Versions diffs - 0.58.16 → 0.59.0 - Mend

@deeptrekker/api-domain 0.58.16 → 0.59.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1371) hide show

package/dist/samples/json/swupdates/systemUpdatePayloadSample.json CHANGED Viewed

@@ -6,7 +6,7 @@
     "changelog": {
         "19": {
             "0": {
-                "0.0": {
+                "0.1": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -28,7 +28,7 @@
                         ]
                     }
                 },
-                "0.4": {
+                "0.7": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -39,7 +39,7 @@
                         ]
                     }
                 },
-                "1.0": {
+                "1.2": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -50,7 +50,7 @@
                         ]
                     }
                 },
-                "2.2": {
+                "2.5": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -61,7 +61,7 @@
                         ]
                     }
                 },
-                "3.8": {
+                "3.7": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -96,7 +96,7 @@
                         ]
                     }
                 },
-                "0.4": {
+                "0.9": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -107,7 +107,7 @@
                         ]
                     }
                 },
-                "1.9": {
+                "1.6": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -118,7 +118,7 @@
                         ]
                     }
                 },
-                "2.5": {
+                "2.2": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -129,7 +129,7 @@
                         ]
                     }
                 },
-                "3.4": {
+                "3.2": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -142,7 +142,7 @@
                 }
             },
             "2": {
-                "0.1": {
+                "0.0": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -153,7 +153,7 @@
                         ]
                     }
                 },
-                "0.3": {
+                "0.2": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -175,7 +175,7 @@
                         ]
                     }
                 },
-                "1.1": {
+                "1.0": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -186,7 +186,7 @@
                         ]
                     }
                 },
-                "2.8": {
+                "2.2": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -197,7 +197,7 @@
                         ]
                     }
                 },
-                "3.2": {
+                "3.4": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -223,7 +223,7 @@
                         ]
                     }
                 },
-                "0.3": {
+                "0.2": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -234,7 +234,7 @@
                         ]
                     }
                 },
-                "0.7": {
+                "0.9": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -245,7 +245,7 @@
                         ]
                     }
                 },
-                "1.9": {
+                "1.4": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -256,7 +256,7 @@
                         ]
                     }
                 },
-                "2.5": {
+                "2.4": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -267,7 +267,7 @@
                         ]
                     }
                 },
-                "3.6": {
+                "3.5": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -291,7 +291,7 @@
                         ]
                     }
                 },
-                "0.3": {
+                "0.2": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -302,7 +302,7 @@
                         ]
                     }
                 },
-                "0.6": {
+                "0.9": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -313,7 +313,7 @@
                         ]
                     }
                 },
-                "1.1": {
+                "1.4": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -324,7 +324,7 @@
                         ]
                     }
                 },
-                "2.1": {
+                "2.5": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -335,7 +335,7 @@
                         ]
                     }
                 },
-                "3.5": {
+                "3.0": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -370,7 +370,7 @@
                         ]
                     }
                 },
-                "0.9": {
+                "0.4": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -381,7 +381,7 @@
                         ]
                     }
                 },
-                "1.3": {
+                "1.4": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -392,7 +392,7 @@
                         ]
                     }
                 },
-                "2.1": {
+                "2.8": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -403,7 +403,7 @@
                         ]
                     }
                 },
-                "3.6": {
+                "3.7": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -440,7 +440,7 @@
                         ]
                     }
                 },
-                "0.7": {
+                "0.6": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -462,7 +462,7 @@
                         ]
                     }
                 },
-                "2.0": {
+                "2.7": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -473,7 +473,7 @@
                         ]
                     }
                 },
-                "3.3": {
+                "3.2": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -519,7 +519,7 @@
                         ]
                     }
                 },
-                "1.5": {
+                "1.8": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -530,7 +530,7 @@
                         ]
                     }
                 },
-                "2.5": {
+                "2.7": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -541,7 +541,7 @@
                         ]
                     }
                 },
-                "3.2": {
+                "3.5": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -576,7 +576,7 @@
                         ]
                     }
                 },
-                "0.5": {
+                "0.6": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -598,7 +598,7 @@
                         ]
                     }
                 },
-                "2.7": {
+                "2.2": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [
@@ -609,7 +609,7 @@
                         ]
                     }
                 },
-                "3.1": {
+                "3.7": {
                     "releaseDate": "2025-05-29",
                     "versionNotes": {
                         "improvements": [

package/dist/schemas/schema.json CHANGED Viewed

@@ -623,6 +623,10 @@
           "description": "IP address",
           "type": "string"
         },
+        "macAddressId": {
+          "description": "The unique identifier of the sensor pod, typically a MAC address.",
+          "type": "string"
+        },
         "magnetic": {
           "additionalProperties": false,
           "description": "Calibratable magnetic sensor",
@@ -924,6 +928,31 @@
       ],
       "type": "object"
     },
+    "DVL": {
+      "additionalProperties": false,
+      "properties": {
+        "ip": {
+          "description": "IP address",
+          "type": "string"
+        },
+        "macAddressId": {
+          "description": "The unique identifier of the DVL, typically a MAC address. This is used to identify the DVL in the network.",
+          "type": "string"
+        },
+        "model": {
+          "$ref": "#/definitions/DeviceModel",
+          "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
+        },
+        "version": {
+          "$ref": "#/definitions/DeviceVersion",
+          "description": "Version"
+        }
+      },
+      "required": [
+        "model"
+      ],
+      "type": "object"
+    },
     "DateTime": {
       "additionalProperties": false,
       "description": "DateTime\n\nAn endpoint to facilitate requesting and adjusting the datetime of the BridgeBox.",
@@ -943,9 +972,7 @@
       "description": "Deep Trekker internal device model numbers. TODO: add all model numbers",
       "enum": [
         20,
-        109,
         19,
-        106,
         240,
         5,
         206,
@@ -955,15 +982,18 @@
         24,
         16,
         13,
-        102,
         18,
+        102,
         103,
+        109,
+        106,
         107,
         108,
         "BRIDGEBOX",
         100,
         101,
-        244
+        244,
+        104
       ],
       "type": [
         "number",
@@ -1840,6 +1870,10 @@
           "$ref": "#/definitions/RovDrive",
           "description": "Rov Drive object\n\nCommands thrust actions for the ROV and sets drive modes\n\nSee  {@link  RovDrive }  for more details.\n\n### Example Payloads #### SET Requests\n\n- Random drive request {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json}"
         },
+        "dvl": {
+          "$ref": "#/definitions/DVL",
+          "description": "DVL"
+        },
         "echosounder": {
           "$ref": "#/definitions/Echosounder",
           "description": "Echosounder device information and control"
@@ -2031,6 +2065,10 @@
           "$ref": "#/definitions/RovDrive",
           "description": "Rov Drive object\n\nCommands thrust actions for the ROV and sets drive modes\n\nSee  {@link  RovDrive }  for more details.\n\n### Example Payloads #### SET Requests\n\n- Random drive request {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json}"
         },
+        "dvl": {
+          "$ref": "#/definitions/DVL",
+          "description": "DVL"
+        },
         "echosounder": {
           "$ref": "#/definitions/Echosounder",
           "description": "Echosounder device information and control"
@@ -2212,6 +2250,10 @@
           "$ref": "#/definitions/RovDrive",
           "description": "Rov Drive object\n\nCommands thrust actions for the ROV and sets drive modes\n\nSee  {@link  RovDrive }  for more details.\n\n### Example Payloads #### SET Requests\n\n- Random drive request {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json}"
         },
+        "dvl": {
+          "$ref": "#/definitions/DVL",
+          "description": "DVL"
+        },
         "echosounder": {
           "$ref": "#/definitions/Echosounder",
           "description": "Echosounder device information and control"
@@ -2660,6 +2702,10 @@
           "$ref": "#/definitions/RovDrive",
           "description": "Rov Drive object\n\nCommands thrust actions for the ROV and sets drive modes\n\nSee  {@link  RovDrive }  for more details.\n\n### Example Payloads #### SET Requests\n\n- Random drive request {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json}"
         },
+        "dvl": {
+          "$ref": "#/definitions/DVL",
+          "description": "DVL"
+        },
         "echosounder": {
           "$ref": "#/definitions/Echosounder",
           "description": "Echosounder device information and control"
@@ -2983,10 +3029,18 @@
           "description": "The gain of the sonar",
           "type": "number"
         },
+        "ip": {
+          "description": "The dynamic IP address of the sonar. This is the IP address assigned to the sonar by the network's DHCP server. It can change over time, especially if the sonar is restarted or the network configuration changes.",
+          "type": "string"
+        },
         "lowPower": {
           "description": "The low power state of the device",
           "type": "boolean"
         },
+        "macAddressId": {
+          "description": "The sonar's unique identifier, typically a MAC address. This is used to identify the sonar in the network.",
+          "type": "string"
+        },
         "maxRange": {
           "description": "Maximum range that the sonar can be configured to.",
           "type": "number"
@@ -3385,9 +3439,7 @@
         },
         "turbidityFilter": {
           "$ref": "#/definitions/TurbidityFilter",
-          "description": "Camera Turbidity Filter\n\n### Example Payload (Tamron Oclea Zoom Camera)\n\n#### Turbidity Filter Strength Samples (A150) ##### at Filter Strength Max {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthMaxSample.json\n\n##### at Filter Strength Min {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthMinSample.json\n\n##### at Filter Strength Random {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthRandomSample.json\n\n<br /> <br />\n\n#### Turbidity Filter Strength Samples (A200) ##### at Filter Strength Max {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthMaxSample.json\n\n##### at Filter Strength Min {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthMinSample.json\n\n#####  at Filter Strength Random {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthRandomSample.json\n\n<br /> <br />",
-          "maximum": 30,
-          "minimum": 1
+          "description": "Camera Turbidity Filter\n\n### Example Payload (Tamron Oclea Zoom Camera)\n\n#### Turbidity Filter Strength Samples (A150) ##### at Filter Strength Max {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthMaxSample.json\n\n##### at Filter Strength Min {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthMinSample.json\n\n##### at Filter Strength Random {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthRandomSample.json\n\n<br /> <br />\n\n#### Turbidity Filter Strength Samples (A200) ##### at Filter Strength Max {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthMaxSample.json\n\n##### at Filter Strength Min {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthMinSample.json\n\n#####  at Filter Strength Random {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthRandomSample.json\n\n<br /> <br />"
         },
         "type": {
           "$ref": "#/definitions/CameraType",

package/dist/types/devices/cameras/tamronOcleaZoomCamera/index.d.ts CHANGED Viewed

@@ -306,8 +306,6 @@ export type TamronOcleaZoomCamera = Camera & {
      * <br />
      * <br />
      *
-     * @minimum 1
-     * @maximum 30
      */
     turbidityFilter?: TurbidityFilter;
 };

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

@@ -10,9 +10,7 @@
  */
 export declare enum DeviceModel {
     A150Crawler = 20,
-    A150CameraHead = 109,
     A200Crawler = 19,
-    A200CameraHead = 106,
     TamronHarrierZoomCamera = 240,
     DTCam = 5,
     OcleaCam = 206,
@@ -22,15 +20,18 @@ export declare enum DeviceModel {
     Photon = 24,
     Onyx = 16,
     Revolution = 13,
-    RevolutionCameraHead = 102,
     Pivot = 18,
+    RevolutionCameraHead = 102,
     PivotCameraHead = 103,
+    A150CameraHead = 109,
+    A200CameraHead = 106,
     ManualReel = 107,
     PoweredReel = 108,
     BridgeBox = "BRIDGEBOX",
     SensorPodPlus = 100,
     SensorPod = 101,
-    CeruleanEchosounder = 244
+    CeruleanEchosounder = 244,
+    DVL = 104
 }
 export declare enum BandwidthDegradationThreshold {
     OK = 100,

package/dist/types/devices/index.js CHANGED Viewed

@@ -39,28 +39,35 @@ exports.REEL_DEVICE_MODELS = exports.CRAWLER_DEVICE_MODELS = exports.VEHICLE_DEV
  */
 var DeviceModel;
 (function (DeviceModel) {
+    /* Crawlers */
     DeviceModel[DeviceModel["A150Crawler"] = 20] = "A150Crawler";
-    DeviceModel[DeviceModel["A150CameraHead"] = 109] = "A150CameraHead";
     DeviceModel[DeviceModel["A200Crawler"] = 19] = "A200Crawler";
-    DeviceModel[DeviceModel["A200CameraHead"] = 106] = "A200CameraHead";
+    /*Cameras */
     DeviceModel[DeviceModel["TamronHarrierZoomCamera"] = 240] = "TamronHarrierZoomCamera";
     DeviceModel[DeviceModel["DTCam"] = 5] = "DTCam";
     DeviceModel[DeviceModel["OcleaCam"] = 206] = "OcleaCam";
     DeviceModel[DeviceModel["TamronOcleaZoomCamera"] = 243] = "TamronOcleaZoomCamera";
     DeviceModel[DeviceModel["JZC18ZoomCamera"] = 207] = "JZC18ZoomCamera";
     DeviceModel[DeviceModel["MiniAuxCamera"] = 241] = "MiniAuxCamera";
+    /*Rov Vehicles */
     DeviceModel[DeviceModel["Photon"] = 24] = "Photon";
     DeviceModel[DeviceModel["Onyx"] = 16] = "Onyx";
     DeviceModel[DeviceModel["Revolution"] = 13] = "Revolution";
-    DeviceModel[DeviceModel["RevolutionCameraHead"] = 102] = "RevolutionCameraHead";
     DeviceModel[DeviceModel["Pivot"] = 18] = "Pivot";
+    /* Camera Heads */
+    DeviceModel[DeviceModel["RevolutionCameraHead"] = 102] = "RevolutionCameraHead";
     DeviceModel[DeviceModel["PivotCameraHead"] = 103] = "PivotCameraHead";
+    DeviceModel[DeviceModel["A150CameraHead"] = 109] = "A150CameraHead";
+    DeviceModel[DeviceModel["A200CameraHead"] = 106] = "A200CameraHead";
+    /* Reels */
     DeviceModel[DeviceModel["ManualReel"] = 107] = "ManualReel";
     DeviceModel[DeviceModel["PoweredReel"] = 108] = "PoweredReel";
+    /*Peripherals */
     DeviceModel["BridgeBox"] = "BRIDGEBOX";
     DeviceModel[DeviceModel["SensorPodPlus"] = 100] = "SensorPodPlus";
     DeviceModel[DeviceModel["SensorPod"] = 101] = "SensorPod";
     DeviceModel[DeviceModel["CeruleanEchosounder"] = 244] = "CeruleanEchosounder";
+    DeviceModel[DeviceModel["DVL"] = 104] = "DVL";
 })(DeviceModel = exports.DeviceModel || (exports.DeviceModel = {}));
 var BandwidthDegradationThreshold;
 (function (BandwidthDegradationThreshold) {

package/dist/types/devices/peripherals/dvl/index.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+import { Device } from "../../cameraHeads";
+export type DVL = {
+    /**
+     * The unique identifier of the DVL, typically a MAC address.
+     * This is used to identify the DVL in the network.
+     */
+    macAddressId?: string;
+} & Device;

package/dist/types/devices/peripherals/dvl/index.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ "use strict";
2	+ Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/devices/peripherals/sensorPod/index.d.ts CHANGED Viewed

@@ -21,6 +21,10 @@ export type CalibratableSensorBias = SensorBias & {
     };
 };
 export type CalibratableSensorPod = {
+    /**
+     * The unique identifier of the sensor pod, typically a MAC address.
+     */
+    macAddressId?: string;
     /**
      * Calibratable IMU
      */

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

@@ -47,4 +47,15 @@ export type Sonar = {
      * to the webapp specifically.
      */
     enabled?: boolean;
+    /**
+     * The sonar's unique identifier, typically a MAC address.
+     * This is used to identify the sonar in the network.
+     */
+    macAddressId?: string;
+    /**
+     * The dynamic IP address of the sonar.
+     * This is the IP address assigned to the sonar by the network's DHCP server.
+     * It can change over time, especially if the sonar is restarted or the network configuration changes.
+     */
+    ip?: string;
 };

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

@@ -1,6 +1,7 @@
 import { CalibratableSensorPod, DeviceVersion, Echosounder, UsageTime, Vehicle } from "../../cameraHeads";
 import { RovDrive } from "../rovDrive";
 import { Navigation } from "../navigation";
+import { DVL } from "../../peripherals/dvl";
 /**
  * {@link IRov | 📖 See extended definition}
  * Rov Class
@@ -47,6 +48,11 @@ export type Rov = {
      * @readonly
      */
     roll?: number;
+    /**
+     * DVL
+     * @readonly
+     */
+    dvl?: DVL;
     /**
      * Rov pitch
      *

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "0.58.16",
+    "version": "0.59.0",
     "description": "A business domain of types and schemas that the Deep Trekker topside communicates with via an API.",
     "main": "dist/index.js",
     "engines": {