@deeptrekker/api-domain 0.58.9-onyxsupport.4 → 0.58.9-onyxsupport.5

package/dist/samples/requests/devices/vehicles/a150/battery/resetChargeCycles/index.js

@@ -0,0 +1,44 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.a150BatteryResetChargeCyclesSample = exports.a150BatteryResetChargeCyclesRequest = void 0;
+var core_1 = require("../../../../../../core");
+var types_1 = require("../../../../../../../types");
+var utils_1 = require("../../../../../../../utils");
+/**
+ * Creates a sample a150 battery resetChargeCycles sample.
+ *
+ * @param a150Id macAddress
+ * @returns TransferPayload<bridgeBox>
+ */
+var a150BatteryResetChargeCyclesRequest = function (resetChargeCycles, a150Id, deviceModel, transferMethodType) {
+    if (a150Id === void 0) { a150Id = (0, core_1.macAddressId)(); }
+    if (deviceModel === void 0) { deviceModel = types_1.DeviceModel.A150Crawler; }
+    if (transferMethodType === void 0) { transferMethodType = types_1.TransferMethodType.Update; }
+    return __assign(__assign({}, (0, core_1.getApiRequest)(transferMethodType)), { payload: (0, utils_1.payload)([deviceModel, a150Id])({
+            battery: { resetChargeCycles: resetChargeCycles },
+        }) });
+};
+exports.a150BatteryResetChargeCyclesRequest = a150BatteryResetChargeCyclesRequest;
+/**
+ * Creates a sample a150 battery to reset battery charge cycles.
+ *
+ * @param a150Id macAddress
+ * @returns TransferPayload<bridgeBox>
+ * @outputSample requests/devices/vehicles/a150/battery/resetChargeCycles
+ */
+var a150BatteryResetChargeCyclesSample = function (a150Id) {
+    if (a150Id === void 0) { a150Id = (0, core_1.macAddressId)(); }
+    return (0, exports.a150BatteryResetChargeCyclesRequest)(true, a150Id);
+};
+exports.a150BatteryResetChargeCyclesSample = a150BatteryResetChargeCyclesSample;

package/dist/samples/requests/devices/vehicles/a150/drive/index.d.ts

@@ -121,6 +121,7 @@ export declare const a150MotorsDisabledSample: (a150Id?: string) => {
         networkDiagnostics?: Record<string, import("../../../../../../types").NetworkDiagnostics> | undefined;
         serialDevices?: Record<string, import("../../../../../../types").SerialDevice> | undefined;
         sonar?: import("../../../../../../types").Sonar | undefined;
+        enablePassthrough?: boolean | undefined;
     };
     apiVersion: string;
     method: TransferMethodType;
@@ -143,6 +144,7 @@ export declare const a150MotorsEnabledSample: (a150Id?: string) => {
         networkDiagnostics?: Record<string, import("../../../../../../types").NetworkDiagnostics> | undefined;
         serialDevices?: Record<string, import("../../../../../../types").SerialDevice> | undefined;
         sonar?: import("../../../../../../types").Sonar | undefined;
+        enablePassthrough?: boolean | undefined;
     };
     apiVersion: string;
     method: TransferMethodType;
@@ -165,6 +167,7 @@ export declare const a150AFWCalibrationSample: (a150Id?: string) => {
         networkDiagnostics?: Record<string, import("../../../../../../types").NetworkDiagnostics> | undefined;
         serialDevices?: Record<string, import("../../../../../../types").SerialDevice> | undefined;
         sonar?: import("../../../../../../types").Sonar | undefined;
+        enablePassthrough?: boolean | undefined;
     };
     apiVersion: string;
     method: TransferMethodType;

package/dist/samples/requests/devices/vehicles/a200/battery/index.d.ts

@@ -44,3 +44,4 @@ export declare const a200BatteryDangerSample: (a200Id?: string) => TransferPaylo
  */
 export declare const a200BatteryShutdownSample: (a200Id?: string) => TransferPayload<BridgeBox>;
 export * from "./leak";
+export * from "./resetChargeCycles";

package/dist/samples/requests/devices/vehicles/a200/battery/index.js

@@ -102,3 +102,4 @@ var a200BatteryShutdownSample = function (a200Id) {
 };
 exports.a200BatteryShutdownSample = a200BatteryShutdownSample;
 __exportStar(require("./leak"), exports);
+__exportStar(require("./resetChargeCycles"), exports);

package/dist/samples/requests/devices/vehicles/a200/battery/resetChargeCycles/index.d.ts

@@ -0,0 +1,16 @@
+import { BridgeBox, CrawlerModelMap, TransferMethodType, TransferPayload } from "../../../../../../../types";
+/**
+ * Creates a sample a200 battery resetChargeCycles sample.
+ *
+ * @param a200Id macAddress
+ * @returns TransferPayload<bridgeBox>
+ */
+export declare const a200BatteryResetChargeCyclesRequest: (resetChargeCycles: boolean, a200Id?: string, deviceModel?: keyof CrawlerModelMap, transferMethodType?: TransferMethodType) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample a200 battery to reset battery charge cycles.
+ *
+ * @param a200Id macAddress
+ * @returns TransferPayload<bridgeBox>
+ * @outputSample requests/devices/vehicles/a200/battery/resetChargeCycles
+ */
+export declare const a200BatteryResetChargeCyclesSample: (a200Id?: string) => TransferPayload<BridgeBox>;

package/dist/samples/requests/devices/vehicles/a200/battery/resetChargeCycles/index.js

@@ -0,0 +1,44 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.a200BatteryResetChargeCyclesSample = exports.a200BatteryResetChargeCyclesRequest = void 0;
+var core_1 = require("../../../../../../core");
+var types_1 = require("../../../../../../../types");
+var utils_1 = require("../../../../../../../utils");
+/**
+ * Creates a sample a200 battery resetChargeCycles sample.
+ *
+ * @param a200Id macAddress
+ * @returns TransferPayload<bridgeBox>
+ */
+var a200BatteryResetChargeCyclesRequest = function (resetChargeCycles, a200Id, deviceModel, transferMethodType) {
+    if (a200Id === void 0) { a200Id = (0, core_1.macAddressId)(); }
+    if (deviceModel === void 0) { deviceModel = types_1.DeviceModel.A200Crawler; }
+    if (transferMethodType === void 0) { transferMethodType = types_1.TransferMethodType.Update; }
+    return __assign(__assign({}, (0, core_1.getApiRequest)(transferMethodType)), { payload: (0, utils_1.payload)([deviceModel, a200Id])({
+            battery: { resetChargeCycles: resetChargeCycles },
+        }) });
+};
+exports.a200BatteryResetChargeCyclesRequest = a200BatteryResetChargeCyclesRequest;
+/**
+ * Creates a sample a200 battery to reset battery charge cycles.
+ *
+ * @param a200Id macAddress
+ * @returns TransferPayload<bridgeBox>
+ * @outputSample requests/devices/vehicles/a200/battery/resetChargeCycles
+ */
+var a200BatteryResetChargeCyclesSample = function (a200Id) {
+    if (a200Id === void 0) { a200Id = (0, core_1.macAddressId)(); }
+    return (0, exports.a200BatteryResetChargeCyclesRequest)(true, a200Id);
+};
+exports.a200BatteryResetChargeCyclesSample = a200BatteryResetChargeCyclesSample;

package/dist/samples/requests/devices/vehicles/a200/drive/index.d.ts

@@ -121,6 +121,7 @@ export declare const a200MotorsDisabledSample: (a200Id?: string) => {
         networkDiagnostics?: Record<string, import("../../../../../../types").NetworkDiagnostics> | undefined;
         serialDevices?: Record<string, import("../../../../../../types").SerialDevice> | undefined;
         sonar?: import("../../../../../../types").Sonar | undefined;
+        enablePassthrough?: boolean | undefined;
     };
     apiVersion: string;
     method: TransferMethodType;
@@ -143,6 +144,7 @@ export declare const a200MotorsEnabledSample: (a200Id?: string) => {
         networkDiagnostics?: Record<string, import("../../../../../../types").NetworkDiagnostics> | undefined;
         serialDevices?: Record<string, import("../../../../../../types").SerialDevice> | undefined;
         sonar?: import("../../../../../../types").Sonar | undefined;
+        enablePassthrough?: boolean | undefined;
     };
     apiVersion: string;
     method: TransferMethodType;
@@ -165,6 +167,7 @@ export declare const a200AFWCalibrationSample: (a200Id?: string) => {
         networkDiagnostics?: Record<string, import("../../../../../../types").NetworkDiagnostics> | undefined;
         serialDevices?: Record<string, import("../../../../../../types").SerialDevice> | undefined;
         sonar?: import("../../../../../../types").Sonar | undefined;
+        enablePassthrough?: boolean | undefined;
     };
     apiVersion: string;
     method: TransferMethodType;

package/dist/schemas/schema.json

@@ -150,6 +150,10 @@
           "$ref": "#/definitions/Light",
           "description": "Light\n\n### Example Payload\n\n#### Light Intensity Samples\n\n##### at random\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/light/a200A200CameraHeadLightIntensityRandomSample.json}\n\n##### at minimum\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/light/a200A200CameraHeadLightIntensityMinSample.json}\n\n##### at maximum\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/light/a200A200CameraHeadLightIntensityMaxSample.json}\n\n##### crawler at random\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameraHead/a200CameraHead/light/a150A200CameraHeadLightIntensityRandomSample.json}\n\n##### crawler at minimum\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameraHead/a200CameraHead/light/a150A200CameraHeadLightIntensityMinSample.json}\n\n##### crawler at maximum\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameraHead/a200CameraHead/light/a150A200CameraHeadLightIntensityMaxSample.json}"
         },
+        "macAddressId": {
+          "description": "Camera MAC Address",
+          "type": "string"
+        },
         "model": {
           "const": 109,
           "type": "number"
@@ -350,6 +354,10 @@
           "$ref": "#/definitions/Light",
           "description": "Light\n\n### Example Payload\n\n#### Light Intensity Samples\n\n##### at random\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/light/a200A200CameraHeadLightIntensityRandomSample.json}\n\n##### at minimum\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/light/a200A200CameraHeadLightIntensityMinSample.json}\n\n##### at maximum\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/light/a200A200CameraHeadLightIntensityMaxSample.json}\n\n##### crawler at random\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameraHead/a200CameraHead/light/a150A200CameraHeadLightIntensityRandomSample.json}\n\n##### crawler at minimum\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameraHead/a200CameraHead/light/a150A200CameraHeadLightIntensityMinSample.json}\n\n##### crawler at maximum\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameraHead/a200CameraHead/light/a150A200CameraHeadLightIntensityMaxSample.json}"
         },
+        "macAddressId": {
+          "description": "Camera MAC Address",
+          "type": "string"
+        },
         "model": {
           "const": 106,
           "type": "number"
@@ -414,6 +422,10 @@
           "minimum": 0,
           "type": "number"
         },
+        "resetChargeCycles": {
+          "description": "exposes a control to reset charge cycles on supported batteries.\n\n##### A200 Crawler sample request to reset battery charge cycles.\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/battery/resetChargeCycles/a200BatteryResetChargeCyclesSample.json}\n\n##### A150 Crawler sample request to reset battery charge cycles.\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/battery/resetChargeCycles/a150BatteryResetChargeCyclesSample.json}",
+          "type": "boolean"
+        },
         "voltage": {
           "description": "Battery voltage",
           "type": "number"
@@ -487,6 +499,10 @@
           "description": "Devices\n\nThis contains a list of devices and associated UUIDs for accessing connected devices, such as vehicles, reels, etc.",
           "type": "object"
         },
+        "enablePassthrough": {
+          "description": "Enable Passthrough.\n\nCan be set to enable passthrough mode on the bridgebox which modifies its network capabilities",
+          "type": "boolean"
+        },
         "faults": {
           "$ref": "#/definitions/FaultHandler",
           "description": "Fault Handler\n\nAllows users to clear faults from all of their devices {@codeblock ~~/dist/samples/json/requests/devices/faults/clearFaults/clearFaultsSample.json}"
@@ -946,7 +962,8 @@
         108,
         "BRIDGEBOX",
         100,
-        101
+        101,
+        244
       ],
       "type": [
         "number",
@@ -998,6 +1015,27 @@
       ],
       "description": "Devices\n\nThis is a collection of all devices used."
     },
+    "Echosounder": {
+      "additionalProperties": false,
+      "description": "{@link  IEchosounder 📖 See extended definition } \n\nEchosounder",
+      "properties": {
+        "enabled": {
+          "description": "Active",
+          "type": "boolean"
+        },
+        "ip": {
+          "description": "IP address",
+          "type": "string"
+        },
+        "maxRange": {
+          "description": "Maximum range the distance lock can sense",
+          "maximum": 50,
+          "minimum": 0.5,
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
     "ElevatingArm": {
       "additionalProperties": false,
       "description": "{@link  IElevatingArm 📖 See extended definition } \n\n🦾 Elevating arm",
@@ -1199,6 +1237,48 @@
       },
       "type": "object"
     },
+    "LocationConsumerType": {
+      "enum": [
+        0,
+        1,
+        2
+      ],
+      "type": "number"
+    },
+    "LocationForwarderConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "dpt": {
+          "type": "boolean"
+        },
+        "gga": {
+          "type": "boolean"
+        },
+        "hdt": {
+          "type": "boolean"
+        },
+        "rmc": {
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "LocationForwarderOptions": {
+      "additionalProperties": false,
+      "description": "Configuration and status info for Location Forwarder",
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "forwarderSource": {
+          "$ref": "#/definitions/LocationConsumerType"
+        },
+        "nmeaConfig": {
+          "$ref": "#/definitions/LocationForwarderConfig"
+        }
+      },
+      "type": "object"
+    },
     "ManualReel": {
       "additionalProperties": false,
       "description": "{@link  IManualReel 📖 See extended definition } \n\nManual Reel",
@@ -1303,6 +1383,10 @@
         "position": {
           "additionalProperties": false,
           "properties": {
+            "deadReckoningAvailable": {
+              "description": "Indicates if the ROV has dead reckoning capability",
+              "type": "boolean"
+            },
             "rovSource": {
               "$ref": "#/definitions/PositionSources",
               "description": "The source providing ROV position. Could be an external GPS, USBL device or NONE.\n\n### Example payloads\n#### UPDATE Requests\n\n- Setting rovSource to USBL Sample\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/positionOptionsUsbl/revolutionPositionSourceRequest.json}\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/positionOptionsUsbl/pivotPositionSourceRequest.json}"
@@ -1756,6 +1840,14 @@
           "$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}"
         },
+        "echosounder": {
+          "$ref": "#/definitions/Echosounder",
+          "description": "Echosounder device information and control"
+        },
+        "forwardDistance": {
+          "description": "Rov Forward distance\n\nMeasured in meters to show relative distance to an object ahead of the ROV.",
+          "type": "number"
+        },
         "heading": {
           "description": "Rov heading\n\nMeasured in degrees from north bearing",
           "maximum": 360,
@@ -1784,6 +1876,10 @@
           "minimum": -360,
           "type": "number"
         },
+        "locationForwarderOptions": {
+          "$ref": "#/definitions/LocationForwarderOptions",
+          "description": "Locaiton forwarder settings and options for the ROV and Topside location forwarding"
+        },
         "model": {
           "const": 16,
           "type": "number"
@@ -1935,6 +2031,14 @@
           "$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}"
         },
+        "echosounder": {
+          "$ref": "#/definitions/Echosounder",
+          "description": "Echosounder device information and control"
+        },
+        "forwardDistance": {
+          "description": "Rov Forward distance\n\nMeasured in meters to show relative distance to an object ahead of the ROV.",
+          "type": "number"
+        },
         "frontLeftMotorDiagnostics": {
           "$ref": "#/definitions/MotorDiagnostics",
           "description": "Motor Diagnostics"
@@ -1967,6 +2071,10 @@
           "minimum": -360,
           "type": "number"
         },
+        "locationForwarderOptions": {
+          "$ref": "#/definitions/LocationForwarderOptions",
+          "description": "Locaiton forwarder settings and options for the ROV and Topside location forwarding"
+        },
         "model": {
           "const": 24,
           "type": "number"
@@ -2104,6 +2212,14 @@
           "$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}"
         },
+        "echosounder": {
+          "$ref": "#/definitions/Echosounder",
+          "description": "Echosounder device information and control"
+        },
+        "forwardDistance": {
+          "description": "Rov Forward distance\n\nMeasured in meters to show relative distance to an object ahead of the ROV.",
+          "type": "number"
+        },
         "frontLeftMotorDiagnostics": {
           "$ref": "#/definitions/MotorDiagnostics",
           "description": "Motor Diagnostics\n\n### Example Payloads #### GET Requests\n\n- Arbitrary (Front Left Motor) {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontLeftThruster/pivotFrontLeftMotorDiagnosticsRandomSample.json}\n\n- Resting position (Front Left Motor) {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontLeftThruster/pivotFrontLeftMotorDiagnosticsRestingSample.json}"
@@ -2140,6 +2256,10 @@
           "minimum": -360,
           "type": "number"
         },
+        "locationForwarderOptions": {
+          "$ref": "#/definitions/LocationForwarderOptions",
+          "description": "Locaiton forwarder settings and options for the ROV and Topside location forwarding"
+        },
         "model": {
           "const": 18,
           "type": "number"
@@ -2540,6 +2660,14 @@
           "$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}"
         },
+        "echosounder": {
+          "$ref": "#/definitions/Echosounder",
+          "description": "Echosounder device information and control"
+        },
+        "forwardDistance": {
+          "description": "Rov Forward distance\n\nMeasured in meters to show relative distance to an object ahead of the ROV.",
+          "type": "number"
+        },
         "frontLeftMotorDiagnostics": {
           "$ref": "#/definitions/MotorDiagnostics",
           "description": "Front Left Motor Diagnostics\n\n### Example Payloads #### UPDATE Requests\n\n- All arbitrary values\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRandomSample.json}\n\n\n- Resting values\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRestingSample.json}"
@@ -2576,6 +2704,10 @@
           "minimum": -360,
           "type": "number"
         },
+        "locationForwarderOptions": {
+          "$ref": "#/definitions/LocationForwarderOptions",
+          "description": "Locaiton forwarder settings and options for the ROV and Topside location forwarding"
+        },
         "model": {
           "const": 13,
           "type": "number"
@@ -2698,11 +2830,17 @@
             "depthLock": {
               "type": "boolean"
             },
+            "distanceLock": {
+              "$ref": "#/definitions/distanceLock"
+            },
             "headingLock": {
               "type": "boolean"
             },
             "motorsDisabled": {
               "type": "boolean"
+            },
+            "stationHolding": {
+              "type": "boolean"
             }
           },
           "type": "object"
@@ -2716,7 +2854,7 @@
     },
     "RovThrust": {
       "additionalProperties": false,
-      "description": "ROV Thrust commands. All values must be set at the same time as one bundled message.\r\nValues are expected to be integers, within the range of +/- 120.",
+      "description": "ROV Thrust commands. All values must be set at the same time as one bundled message.\nValues are expected to be integers, within the range of +/- 120.",
       "properties": {
         "forward": {
           "type": "number"
@@ -3285,6 +3423,10 @@
           "$ref": "#/definitions/Light",
           "description": "Light\n\n### Example Payload #### SET Requests\n\n- Random {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/cameraHead/light/revolutionCameraHeadLightIntensityRandomSample.json}\n\n- Max intensity {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/cameraHead/light/revolutionCameraHeadLightIntensityRandomSample.json}\n\n- Off {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/cameraHead/light/revolutionCameraHeadLightIntensityRandomSample.json}"
         },
+        "macAddressId": {
+          "description": "Camera MAC Address",
+          "type": "string"
+        },
         "model": {
           "$ref": "#/definitions/TiltCameraHeadModel"
         },
@@ -3481,7 +3623,7 @@
           "type": "number"
         },
         "speed": {
-          "description": "Scalar Magnitude of velocity components (forward, rightward and downward velocity)",
+          "description": "Scalar Magnitude of velocity components (forward, rightward ap nd downward velocity)",
           "minimum": 0,
           "type": "number"
         },
@@ -3552,6 +3694,21 @@
         }
       },
       "type": "object"
+    },
+    "distanceLock": {
+      "additionalProperties": false,
+      "properties": {
+        "active": {
+          "type": "boolean"
+        },
+        "error": {
+          "type": "string"
+        },
+        "setpoint": {
+          "type": "number"
+        }
+      },
+      "type": "object"
     }
   }
 }

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

@@ -178,6 +178,12 @@ export type BridgeBox = {
      * This is the currently connected sonar device
      */
     sonar?: Sonar;
+    /**
+     * Enable Passthrough.
+     *
+     * Can be set to enable passthrough mode on the bridgebox which modifies its network capabilities
+     */
+    enablePassthrough?: boolean;
 };
 /**
  * SystemSettings

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

@@ -13,6 +13,8 @@ export type CameraHead = {
     cpuTemp?: number;
     /** Leak Fault */
     leak?: boolean;
+    /**Camera MAC Address */
+    macAddressId?: string;
 } & Device;
 export * from "./core";
 export * from "./crawlerCameraHead";

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

@@ -79,6 +79,18 @@ export type Battery = {
      */
     charging?: boolean;
     leak?: boolean;
+    /**
+     * Battery charge cycles reset
+     * @description exposes a control to reset charge cycles on supported batteries.
+     *
+     * ##### A200 Crawler sample request to reset battery charge cycles.
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/battery/resetChargeCycles/a200BatteryResetChargeCyclesSample.json}
+     *
+     * ##### A150 Crawler sample request to reset battery charge cycles.
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/battery/resetChargeCycles/a150BatteryResetChargeCyclesSample.json}
+     *
+     */
+    resetChargeCycles?: boolean;
     diagnostics?: BatteryDiagnostics;
 };
 /**

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

@@ -29,7 +29,8 @@ export declare enum DeviceModel {
     PoweredReel = 108,
     BridgeBox = "BRIDGEBOX",
     SensorPodPlus = 100,
-    SensorPod = 101
+    SensorPod = 101,
+    CeruleanEchosounder = 244
 }
 export declare enum BandwidthDegradationThreshold {
     OK = 100,

package/dist/types/devices/index.js

@@ -60,6 +60,7 @@ var DeviceModel;
     DeviceModel["BridgeBox"] = "BRIDGEBOX";
     DeviceModel[DeviceModel["SensorPodPlus"] = 100] = "SensorPodPlus";
     DeviceModel[DeviceModel["SensorPod"] = 101] = "SensorPod";
+    DeviceModel[DeviceModel["CeruleanEchosounder"] = 244] = "CeruleanEchosounder";
 })(DeviceModel = exports.DeviceModel || (exports.DeviceModel = {}));
 var BandwidthDegradationThreshold;
 (function (BandwidthDegradationThreshold) {

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

@@ -0,0 +1,34 @@
+export declare enum EchosounderError {
+    OUT_OF_WATER = "Distance Lock not available out of water",
+    MAX_RANGE_OUT_OF_BOUNDS = "Max range must be between",
+    SETPOINT_OUT_OF_RANGE = "Distance lock disabled. setpoint is out of range",
+    BAD_SURFACE_OR_RANGE = "Ensure surface is even and within range | or increase max range",
+    DISABLED_BAD_SURFACE_OR_RANGE = "Distance Lock disabled. Ensure surface is even and within range",
+    JUMP_IN_DISTANCE = "Distance Lock disabled. Large jump in distance",
+    ECHOSOUNDER_DISABLED = "Echosounder is disabled",
+    ECHOSOUNDER_REQUIRED = "Distance Lock requires Echosounder",
+    SENSOR_MISSING = "Distance Lock requires DVL and SensorPod"
+}
+/**
+ * {@link IEchosounder | 📖 See extended definition}
+ *
+ * Echosounder
+ *
+ * @category Devices/Peripherals
+ */
+export type Echosounder = {
+    /**
+     * Active
+     */
+    enabled?: boolean;
+    /**
+     * Maximum range the distance lock can sense
+     * @minimum 0.5
+     * @maximum 50.0
+     */
+    maxRange?: number;
+    /**
+     * IP address
+     */
+    ip?: string;
+};

package/dist/types/devices/peripherals/echosounder/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EchosounderError = void 0;
+var EchosounderError;
+(function (EchosounderError) {
+    EchosounderError["OUT_OF_WATER"] = "Distance Lock not available out of water";
+    EchosounderError["MAX_RANGE_OUT_OF_BOUNDS"] = "Max range must be between";
+    EchosounderError["SETPOINT_OUT_OF_RANGE"] = "Distance lock disabled. setpoint is out of range";
+    EchosounderError["BAD_SURFACE_OR_RANGE"] = "Ensure surface is even and within range | or increase max range";
+    EchosounderError["DISABLED_BAD_SURFACE_OR_RANGE"] = "Distance Lock disabled. Ensure surface is even and within range";
+    EchosounderError["JUMP_IN_DISTANCE"] = "Distance Lock disabled. Large jump in distance";
+    EchosounderError["ECHOSOUNDER_DISABLED"] = "Echosounder is disabled";
+    EchosounderError["ECHOSOUNDER_REQUIRED"] = "Distance Lock requires Echosounder";
+    EchosounderError["SENSOR_MISSING"] = "Distance Lock requires DVL and SensorPod";
+})(EchosounderError = exports.EchosounderError || (exports.EchosounderError = {}));

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

@@ -1,4 +1,5 @@
 export * from "./sensorPod";
+export * from "./echosounder";
 import { Calibratable, MotorDiagnostics } from "../core";
 /**
  * {@link IElevatingArm | 📖 See extended definition}

package/dist/types/devices/peripherals/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./sensorPod"), exports);
+__exportStar(require("./echosounder"), exports);