@deeptrekker/api-domain 0.58.13 → 0.58.15

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/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"
@@ -941,6 +953,7 @@
         207,
         241,
         24,
+        16,
         13,
         102,
         18,
@@ -995,6 +1008,9 @@
         },
         {
           "$ref": "#/definitions/Photon"
+        },
+        {
+          "$ref": "#/definitions/Onyx"
         }
       ],
       "description": "Devices\n\nThis is a collection of all devices used."
@@ -1753,6 +1769,190 @@
       ],
       "type": "number"
     },
+    "Onyx": {
+      "additionalProperties": false,
+      "description": "Onyx vehicle type.",
+      "properties": {
+        "altitude": {
+          "description": "Rov altitude\n\nMeasured in meters to show relative distance to floor.\n\n### Example Payloads #### GET Requests\n\n- Random altitude {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json}",
+          "type": "number"
+        },
+        "altitudeValid": {
+          "description": "Rov altitude valid\n\nAltitude validity flag\n\n### Example Payloads #### UPDATE Requests\n\n\n- Valid altitude (good data) {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidSample.json}\n\n- Random altitude validity {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json}",
+          "type": "boolean"
+        },
+        "auxLights": {
+          "additionalProperties": {
+            "$ref": "#/definitions/Removable%3CLight%3E"
+          },
+          "description": "Aux Light",
+          "type": "object"
+        },
+        "bodyLeak": {
+          "description": "Body Leak Fault\n\n### Example Payloads #### UPDATE Requests\n\n- Arbitrary {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotBodyLeakRandomSample.json}\n\n- Has no body leak fault {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasNoBodyLeakSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasNoBodyLeakSample.json}\n\n- Has body leak fault {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasBodyLeakSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasBodyLeakSample.json}",
+          "type": "boolean"
+        },
+        "cameraHeads": {
+          "additionalProperties": {
+            "anyOf": [
+              {
+                "$ref": "#/definitions/Removable%3CA200CameraHead%3E"
+              },
+              {
+                "$ref": "#/definitions/Removable%3CA150CameraHead%3E"
+              },
+              {
+                "$ref": "#/definitions/Removable%3CTiltCameraHead%3E"
+              }
+            ]
+          },
+          "description": "Camera Head",
+          "type": "object"
+        },
+        "cameras": {
+          "additionalProperties": {
+            "$ref": "#/definitions/Removable%3CCameras%3E"
+          },
+          "description": "Onyx camera",
+          "type": "object"
+        },
+        "cpProbe": {
+          "description": "The cp probe",
+          "type": "string"
+        },
+        "cpuTemp": {
+          "description": "Temperature in degrees celsius",
+          "type": "number"
+        },
+        "cygnus": {
+          "$ref": "#/definitions/cygnusType",
+          "description": "The ut(cygnus) probe"
+        },
+        "depth": {
+          "description": "Rov depth\n\nMeasured in meters from water surface\n\nTo Calibrate depth, set depth to '0'. Setting depth to any other value will be ignored.\n\nValid Depth calibration {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/depth/pivotDepthCalibrationSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionDepthCalibrationSample.json}\n\nInvalid Depth Calibration {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/depth/pivotInvalidDepthCalibrationSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionInvalidDepthCalibrationSample.json}",
+          "type": "number"
+        },
+        "directPowerKitPresent": {
+          "description": "Direct Power Kit Present Flag",
+          "type": "boolean"
+        },
+        "drive": {
+          "$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,
+          "minimum": 0,
+          "type": "number"
+        },
+        "inWater": {
+          "description": "Rov in water status",
+          "type": "boolean"
+        },
+        "ip": {
+          "description": "IP Address ### Example Payloads #### SET Requests\n\n- Arbitrary {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/ip/pivotIpRandomSample.json}",
+          "type": "string"
+        },
+        "leftBattery": {
+          "$ref": "#/definitions/Battery",
+          "description": "Left Battery"
+        },
+        "leftMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Left Motor Diagnostics"
+        },
+        "localHeading": {
+          "description": "Rov local heading\n\nMeasure in degrees from local heading",
+          "maximum": 360,
+          "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"
+        },
+        "navigationOptions": {
+          "$ref": "#/definitions/NavigationOptions",
+          "description": "Navigation settings and options for the ROV"
+        },
+        "pitch": {
+          "description": "Rov pitch\n\nMeasured in degrees from neutral pitch position",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "position": {
+          "$ref": "#/definitions/Position",
+          "description": "Contains positional data about the ROV.\n\n### Example payloads\n#### UPDATE Requests\n\n- Invalid position sample\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionInvalidSample.json}\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionInvalidSample.json}\n\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionInvalidSample.json}\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionInvalidSample.json}\n\n\n- Arbitrary position sample\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionRandomSample.json}\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionRandomSample.json}\n\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionRandomSample.json}\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionRandomSample.json}\n\n\n#### UPDATE Requests\n\n- Arbitrary Local position only\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionSample.json}\n\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionRandomSample.json}\n\n\n- Arbitrary Global position only\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionSample.json}\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionRandomSample.json}"
+        },
+        "rightBattery": {
+          "$ref": "#/definitions/Battery",
+          "description": "Right Battery"
+        },
+        "rightMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Right Motor Diagnostics"
+        },
+        "roll": {
+          "description": "Rov roll\n\nMeasured in degrees from neutral roll position",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "sensorPod": {
+          "$ref": "#/definitions/CalibratableSensorPod",
+          "description": "Sensor pod information and calibration controls based on the model. \n\n- Revolution Calibration User Actions for IMU Calibration.  dist/samples/json/requests/devices/vehicles/revolution/calibration/startImuCalibration/revolutionStartImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/stopImuCalibration/revolutionStopImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/denyImuCalibration/revolutionDenyImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptImuCalibration/revolutionAcceptImuCalibrationRequest.json\n\ndist/samples/json/requests/devices/vehicles/pivot/calibration/startImuCalibration/pivotStartImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/stopImuCalibration/pivotStopImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/denyImuCalibration/pivotDenyImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptImuCalibration/pivotAcceptImuCalibrationRequest.json\n\n- Revolution Calibration User Actions for Magnetic Calibration.  dist/samples/json/requests/devices/vehicles/revolution/calibration/startMagneticCalibration/revolutionStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/stopMagneticCalibration/revolutionStopMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/denyMagneticCalibration/revolutionDenyMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptMagneticCalibration/revolutionAcceptMagneticCalibrationRequest.json\n\ndist/samples/json/requests/devices/vehicles/pivot/calibration/startMagneticCalibration/pivotStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/stopMagneticCalibration/pivotStopMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/denyMagneticCalibration/pivotDenyMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptMagneticCalibration/pivotAcceptMagneticCalibrationRequest.json\n\n- Revolution and Pivot Pending IMU update dist/samples/json/requests/devices/vehicles/revolution/calibration/startMagneticCalibration/revolutionStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorPendingImuCalibration/pivotPendingImuRandomUpdate.json\n\n- Revolution and Pivot Pending Magnetic update dist/samples/json/requests/devices/vehicles/revolution/calibration/sensorMagneticCalibration/revolutionPendingMagneticRandomUpdate.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorPendingMagneticCalibration/pivotPendingMagneticRandomUpdate.json\n\n- Revolution and Pivot Accepted Magnetic and IMU update dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptMagneticCalibration/revolutionAcceptMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptMagneticCalibration/pivotAcceptMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorNotCalibratingState/pivotAcceptedRandomUpdate.json dist/samples/json/requests/devices/vehicles/revolution/calibration/sensorNotCalibratingState/revolutionAcceptedRandomUpdate.json"
+        },
+        "sensorPodLeak": {
+          "description": "Sensor Pod Leak Fault\n\nCommon across all ROV and also comes from the ROV Web Adapter in Con_gui",
+          "type": "boolean"
+        },
+        "spareMotors": {
+          "additionalProperties": {
+            "$ref": "#/definitions/Removable%3CMotorDiagnostics%3E"
+          },
+          "description": "Provides diagnostics for spare motors on the Rov. These spare motors can be used to extend the capabilities of the ROV by attaching various power tools to them. These tools can include CaviBlasters, cutters and etc.",
+          "type": "object"
+        },
+        "turns": {
+          "description": "Turns\n\nCount the number of turns the rov has completed",
+          "type": "number"
+        },
+        "usageTime": {
+          "$ref": "#/definitions/UsageTime",
+          "description": "Vehicle Usage Time"
+        },
+        "velocity": {
+          "$ref": "#/definitions/Velocity",
+          "description": "Velocity and speed components for the ROV\n\n### Example payloads\n#### UPDATE Requests\n\n- Arbitrary velocity samples\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/velocity/revolutionVelocityRandomSample.json}\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/velocity/pivotVelocityRandomSample.json}"
+        },
+        "version": {
+          "$ref": "#/definitions/DeviceVersion",
+          "description": "Onyx Version"
+        },
+        "waterTemp": {
+          "description": "Water temperature in degrees celsius",
+          "type": "number"
+        }
+      },
+      "required": [
+        "model"
+      ],
+      "type": "object"
+    },
     "Osd": {
       "additionalProperties": false,
       "description": "OSD (On-screen Display)",
@@ -2350,6 +2550,34 @@
       ],
       "description": "Removable\n\nRepresents an object that can be removed."
     },
+    "Removable<Light>": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Light"
+        },
+        {
+          "additionalProperties": {
+            "not": {}
+          },
+          "type": "object"
+        }
+      ],
+      "description": "Removable\n\nRepresents an object that can be removed."
+    },
+    "Removable<MotorDiagnostics>": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/MotorDiagnostics"
+        },
+        {
+          "additionalProperties": {
+            "not": {}
+          },
+          "type": "object"
+        }
+      ],
+      "description": "Removable\n\nRepresents an object that can be removed."
+    },
     "Removable<TiltCameraHead>": {
       "anyOf": [
         {
@@ -2643,9 +2871,7 @@
       },
       "required": [
         "forward",
-        "yaw",
-        "vertical",
-        "lateral"
+        "yaw"
       ],
       "type": "object"
     },
@@ -3197,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"
         },

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

@@ -20,6 +20,7 @@ export declare enum DeviceModel {
     JZC18ZoomCamera = 207,
     MiniAuxCamera = 241,
     Photon = 24,
+    Onyx = 16,
     Revolution = 13,
     RevolutionCameraHead = 102,
     Pivot = 18,
@@ -57,6 +58,7 @@ export declare const VEHICLE_DEVICE_MODEL_LABELS: {
     readonly 13: "REVOLUTION";
     readonly 18: "PIVOT";
     readonly 24: "PHOTON";
+    readonly 16: "ONYX";
 };
 export declare const CAMERA_HEAD_DEVICE_MODEL_LABELS: {
     readonly 109: "A-150 Camera Head";
@@ -82,6 +84,7 @@ export declare const DEVICE_MODEL_LABELS: {
     readonly 13: "REVOLUTION";
     readonly 18: "PIVOT";
     readonly 24: "PHOTON";
+    readonly 16: "ONYX";
     readonly 206: "4K UHD Camera";
     readonly 240: "Zoom Camera H";
     readonly 243: "Zoom Camera TO";

package/dist/types/devices/index.js

@@ -50,6 +50,7 @@ var DeviceModel;
     DeviceModel[DeviceModel["JZC18ZoomCamera"] = 207] = "JZC18ZoomCamera";
     DeviceModel[DeviceModel["MiniAuxCamera"] = 241] = "MiniAuxCamera";
     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";
@@ -89,6 +90,7 @@ exports.VEHICLE_DEVICE_MODEL_LABELS = (_b = {},
     _b[DeviceModel.Revolution] = "REVOLUTION",
     _b[DeviceModel.Pivot] = "PIVOT",
     _b[DeviceModel.Photon] = "PHOTON",
+    _b[DeviceModel.Onyx] = "ONYX",
     _b);
 exports.CAMERA_HEAD_DEVICE_MODEL_LABELS = (_c = {},
     _c[DeviceModel.A150CameraHead] = "A-150 Camera Head",

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

@@ -1,8 +1,8 @@
 import { ManualReel, PoweredReel } from "../reels";
-import { A200, A150, Revolution, Pivot, Photon } from "../vehicles";
+import { A200, A150, Revolution, Pivot, Photon, Onyx } from "../vehicles";
 /**
  * Devices
  *
  * This is a collection of all devices used.
  */
-export type Devices = A200 | A150 | ManualReel | PoweredReel | Revolution | Pivot | Photon;
+export type Devices = A200 | A150 | ManualReel | PoweredReel | Revolution | Pivot | Photon | Onyx;

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

@@ -1,14 +1,18 @@
 import { Match } from "../../../core";
-import { A150, A200, DeviceModel } from "../../cameraHeads";
+import { A150 } from "../a150";
+import { A200 } from "../a200";
+import { Onyx } from "../onyx";
 import { Photon } from "../photon";
 import { Pivot } from "../pivot";
 import { Revolution } from "../revolution";
+import { DeviceModel } from "../../";
 export type VehicleModelMap = {
     [DeviceModel.Pivot]: Pivot;
     [DeviceModel.Revolution]: Revolution;
     [DeviceModel.A200Crawler]: A200;
     [DeviceModel.A150Crawler]: A150;
     [DeviceModel.Photon]: Photon;
+    [DeviceModel.Onyx]: Onyx;
 };
 export type CrawlerModelMap = {
     [DeviceModel.A150Crawler]: A150;
@@ -16,7 +20,7 @@ export type CrawlerModelMap = {
 };
 export type VehicleDeviceFromModel<T> = Match<T, VehicleModelMap>;
 export type CrawlerDeviceFromModel<T> = Match<T, CrawlerModelMap>;
-export type Rov = Revolution | Pivot;
+export type Rov = Revolution | Pivot | Onyx;
 export type Crawler = A150 | A200;
 export type CrawlerModel = DeviceModel.A150Crawler | DeviceModel.A200Crawler;
 export type CrawlerCameraHeadModel = DeviceModel.A150CameraHead | DeviceModel.A200CameraHead;

package/dist/types/devices/vehicles/core/index.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var cameraHeads_1 = require("../../cameraHeads");
+var __1 = require("../../");

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

@@ -32,3 +32,4 @@ export * from "./core";
 export * from "./navigation";
 export * from "./crawlerDrive";
 export * from "./rovDrive";
+export * from "./onyx";

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

@@ -23,3 +23,4 @@ __exportStar(require("./core"), exports);
 __exportStar(require("./navigation"), exports);
 __exportStar(require("./crawlerDrive"), exports);
 __exportStar(require("./rovDrive"), exports);
+__exportStar(require("./onyx"), exports);

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

@@ -0,0 +1,14 @@
+/**
+ * Onyx temperature level thresholds (internal components)
+ */
+export declare enum OnyxTemperatureThreshold {
+    Warning = 75,
+    Danger = 85
+}
+/**
+ * Onyx operating temperature range (in water)
+ */
+export declare enum OnyxOperatingTemperatureRange {
+    Min = -10,
+    Max = 50
+}

package/dist/types/devices/vehicles/onyx/core/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnyxOperatingTemperatureRange = exports.OnyxTemperatureThreshold = void 0;
+/**
+ * Onyx temperature level thresholds (internal components)
+ */
+var OnyxTemperatureThreshold;
+(function (OnyxTemperatureThreshold) {
+    OnyxTemperatureThreshold[OnyxTemperatureThreshold["Warning"] = 75] = "Warning";
+    OnyxTemperatureThreshold[OnyxTemperatureThreshold["Danger"] = 85] = "Danger";
+})(OnyxTemperatureThreshold = exports.OnyxTemperatureThreshold || (exports.OnyxTemperatureThreshold = {}));
+/**
+ * Onyx operating temperature range (in water)
+ */
+var OnyxOperatingTemperatureRange;
+(function (OnyxOperatingTemperatureRange) {
+    OnyxOperatingTemperatureRange[OnyxOperatingTemperatureRange["Min"] = -10] = "Min";
+    OnyxOperatingTemperatureRange[OnyxOperatingTemperatureRange["Max"] = 50] = "Max";
+})(OnyxOperatingTemperatureRange = exports.OnyxOperatingTemperatureRange || (exports.OnyxOperatingTemperatureRange = {}));

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

@@ -0,0 +1,45 @@
+import { Cameras } from "../../cameras/types";
+import { Removable } from "../../../core";
+import { DeviceModel, DeviceVersion, Light } from "../..";
+import { MotorDiagnostics, Battery, UsageTime } from "../../core";
+import { A150CameraHead, A200CameraHead, TiltCameraHead } from "../../cameraHeads/tiltCameraHead";
+import { Rov } from "../rov";
+/**
+ * {@link IOnyx | 📖 See extended definition}
+ * Onyx Class
+ *
+ * @description Onyx vehicle type.
+ *
+ * @category Devices/Vehicles
+ */
+export type Onyx = {
+    model: DeviceModel.Onyx;
+    /** Camera Head */
+    cameraHeads?: Record<string, Removable<A200CameraHead> | Removable<A150CameraHead> | Removable<TiltCameraHead>>;
+    /** Aux Light */
+    auxLights?: Record<string, Removable<Light>>;
+    /** Left Motor Diagnostics */
+    leftMotorDiagnostics?: MotorDiagnostics;
+    /** Right Motor Diagnostics */
+    rightMotorDiagnostics?: MotorDiagnostics;
+    /**
+     * Provides diagnostics for spare motors on the Rov. These spare motors can be used to extend
+     * the capabilities of the ROV by attaching various power tools to them. These tools can include CaviBlasters, cutters and etc.
+     */
+    spareMotors?: Record<string, Removable<MotorDiagnostics>>;
+    /** Left Battery */
+    leftBattery?: Battery;
+    /** Right Battery */
+    rightBattery?: Battery;
+    /** Onyx camera*/
+    cameras?: Record<string, Removable<Cameras>>;
+    /** Temperature in degrees celsius */
+    cpuTemp?: number;
+    /** Water temperature in degrees celsius     */
+    waterTemp?: number;
+    /** Vehicle Usage Time*/
+    usageTime?: UsageTime;
+    /** Onyx Version */
+    version?: DeviceVersion;
+} & Rov;
+export * from "./core";

package/dist/types/devices/vehicles/onyx/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./core"), exports);

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

@@ -7,8 +7,8 @@
 export type RovThrust = {
     forward: number;
     yaw: number;
-    vertical: number;
-    lateral: number;
+    vertical?: number;
+    lateral?: number;
 };
 /**
  * Rov Drive

package/dist/utils/index.d.ts

@@ -1,7 +1,7 @@
 import Ajv from "ajv";
 import { OmitStrict } from "type-zoo";
 import { TransferPayload } from "../samples";
-import { VehicleModelMap, ReelModelMap, VehicleDeviceFromModel, BridgeBox, CameraHeadDeviceFromModel, CameraDeviceFromModel, ReelDeviceFromModel } from "../types";
+import { VehicleModelMap, ReelModelMap, VehicleDeviceFromModel, BridgeBox, CameraHeadDeviceFromModel, CameraDeviceFromModel, DeviceModel, ReelDeviceFromModel } from "../types";
 export declare const ajv: Ajv;
 /** BridgeBox Web API validator. This can validate requests that are sent and received through the API */
 export declare const validate: (req: TransferPayload<BridgeBox>) => TransferPayload<BridgeBox>;
@@ -24,7 +24,7 @@ export declare const validate: (req: TransferPayload<BridgeBox>) => TransferPayl
  * ```
  * <br><br>
  */
-export declare function payload<M1 extends keyof VehicleModelMap | keyof ReelModelMap>(...models: [[M1, string]]): (payload: OmitStrict<VehicleDeviceFromModel<M1>, "model" | "cameraHead" | "cameras"> | OmitStrict<ReelDeviceFromModel<M1>, "model">) => BridgeBox;
+export declare function payload<M1 extends keyof VehicleModelMap | keyof ReelModelMap>(...models: [[M1, string]]): (payload: M1 extends DeviceModel.Onyx ? OmitStrict<VehicleDeviceFromModel<M1>, Extract<"model" | "cameraHeads" | "cameras", keyof VehicleDeviceFromModel<M1>>> : OmitStrict<VehicleDeviceFromModel<M1>, Extract<"model" | "cameraHead" | "cameras", keyof VehicleDeviceFromModel<M1>>> | OmitStrict<ReelDeviceFromModel<M1>, "model">) => BridgeBox;
 /**
  * ## BRIDGE API Payload
  * ### BridgeBox
@@ -59,7 +59,8 @@ export declare function payload(): (payload: OmitStrict<BridgeBox, "devices">) =
  * ```
  * <br><br>
  */
-export declare function payload<M1 extends keyof VehicleModelMap, M2 extends NonNullable<VehicleDeviceFromModel<M1>["cameraHead"]>["model"]>(...models: [[M1, string], [M2, string]]): (payload: OmitStrict<CameraHeadDeviceFromModel<M2>, "model">) => BridgeBox;
+export declare function payload<M1 extends keyof OmitStrict<VehicleModelMap, DeviceModel.Onyx>, M2 extends NonNullable<VehicleDeviceFromModel<M1>["cameraHead"]>["model"]>(...models: [[M1, string], [M2, string]]): (payload: OmitStrict<CameraHeadDeviceFromModel<M2>, "model">) => BridgeBox;
+export declare function payload<M1 extends DeviceModel.Onyx, M2 extends NonNullable<VehicleDeviceFromModel<M1>["cameraHeads"]>[string]["model"]>(...models: [[M1, string], [M2, string]]): (payload: OmitStrict<CameraHeadDeviceFromModel<M2>, "model">) => BridgeBox;
 /**
  * ## BRIDGE API Payload
  * ### 🛳 Vehicle → 📷 Camera

package/dist/utils/index.js

@@ -62,6 +62,15 @@ function payload() {
                                 return (_a = {},
                                     _a["cameraHead"] = __assign({ model: (_b = models[1]) === null || _b === void 0 ? void 0 : _b[MODEL_INDEX] }, payload),
                                     _a);
+                            })
+                                .with(ts_pattern_1.P.union.apply(ts_pattern_1.P, types_1.CAMERA_HEAD_DEVICE_MODELS), function () {
+                                var _a;
+                                var _b;
+                                return ({
+                                    cameraHeads: (_a = {},
+                                        _a[models[1][ID_INDEX]] = __assign({ model: (_b = models[1]) === null || _b === void 0 ? void 0 : _b[MODEL_INDEX] }, payload),
+                                        _a),
+                                });
                             })
                                 .otherwise(function () { return ({}); }))),
                         _a),