@deeptrekker/api-domain 0.48.1 → 0.50.0

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

@@ -1,10 +1,9 @@
 import { Cameras } from "../../cameras/types";
 import { Removable } from "../../../core";
-import { Vehicle } from "..";
 import { DeviceModel, DeviceVersion, Grabber, Light, TiltPlatform } from "../..";
 import { MotorDiagnostics, Battery, UsageTime } from "../../core";
 import { TiltCameraHead } from "../../cameraHeads/tiltCameraHead";
-import { RovDrive } from "../rovDrive";
+import { Rov } from "../rov";
 /**
  * {@link IPivot | 📖 See extended definition}
  * Pivot Class
@@ -132,83 +131,6 @@ export type Pivot = {
      *
      */
     tiltPlatform?: TiltPlatform;
-    /** Rov Drive object
-     *
-     * Commands thrust actions for the ROV and sets drive modes
-     *
-     * See {@link RovDrive} for more details.
-     *
-     * ### Example Payloads
-     * #### SET Requests
-     *
-     * - Random drive request
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json}
-     */
-    drive?: RovDrive;
-    /**
-     * Rov roll
-     *
-     * Measured in degrees from neutral roll position
-     *
-     * @minimum -180.0
-     * @maximum 180.0
-     */
-    roll?: number;
-    /**
-     * Rov pitch
-     *
-     * Measured in degrees from neutral pitch position
-     *
-     * @minimum -180.0
-     * @maximum 180.0
-     */
-    pitch?: number;
-    /**
-     * Rov heading
-     *
-     * Measured in degrees from north bearing
-     *
-     * @minimum 0
-     * @maximum 360
-     */
-    heading?: number;
-    /**
-     * Rov depth
-     *
-     * Measured in meters from water surface
-     */
-    depth?: number;
-    /**
-     * Rov altitude valid
-     *
-     * Altitude validity flag
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     * - Invalid altitude (bad data)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeInvalidSample.json}
-     *
-     * - Valid altitude (good data)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidSample.json}
-     *
-     * - Random altitude validity
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidRandomSample.json}
-     */
-    altitudeValid?: boolean;
-    /**
-     * Rov altitude
-     *
-     * Measured in meters to show relative distance to floor.
-     *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Random altitude
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeRandomSample.json}
-     *
-     */
-    altitude?: number;
     /** Motor Diagnostics
      *
      * ### Example Payloads
@@ -285,6 +207,20 @@ export type Pivot = {
      * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/verticalRearThruster/pivotVerticalRearMotorDiagnosticsRestingSample.json}
      */
     verticalRearMotorDiagnostics?: 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.
+     *
+     * ### Example Payloads
+     * #### UPDATE Requests
+     *
+     * - Resting spare motor 1 diagnostics sample
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/spareMotors/spareMotor1/pivotSpareMotorDiagnosticsRestingSample.json}
+     *
+     * - Arbitrary Spare Motor 1 Diagnostics sample
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/spareMotors/spareMotor1/pivotSpareMotorDiagnosticsRandomSample.json}
+     */
+    spareMotor1?: MotorDiagnostics;
     /** Left Battery
      *
      * ### Example Payloads
@@ -409,38 +345,6 @@ export type Pivot = {
      * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeRandomSample.json}
      */
     usageTime?: UsageTime;
-    /** Body Leak Fault
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     * - No body leak
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasNoBodyLeakSample.json}
-     *
-     * - Body leak present
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasBodyLeakSample.json}
-     *
-     * - Arbitrary
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotBodyLeakRandomSample.json}
-     *
-     */
-    bodyLeak?: boolean;
-    /** Sensor Pod Leak
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     * - No body leak
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/sensorPod/pivotSensorPodHasNoLeakSample.json}
-     *
-     * - Body leak present
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/sensorPod/pivotSensorPodHasLeakSample.json}
-     *
-     * - Arbitrary
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/sensorPod/pivotSensorPodLeakRandomSample.json}
-     *
-     */
-    sensorPodLeak?: boolean;
     /** Pivot Version
      *
      * ### Example Payloads
@@ -460,20 +364,5 @@ export type Pivot = {
      *
      */
     version?: DeviceVersion;
-    /** IP address
-     *
-     * ### Example Payloads
-     * #### SET Requests
-     *
-     * - Arbitrary
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/ip/pivotIpRandomSample.json}
-     */
-    ip?: string;
-    /**
-     * Turns
-     *
-     * Count the number of turns the rov has completed
-     */
-    turns?: number;
-} & Vehicle;
+} & Rov;
 export * from "./core";

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

@@ -1,6 +1,6 @@
 import { Removable } from "../../../core";
-import { Battery, DeviceModel, DeviceVersion, Grabber, Light, MotorDiagnostics, TiltCameraHead, UsageTime, Vehicle } from "../../cameraHeads";
-import { RovDrive } from "../rovDrive";
+import { Battery, DeviceModel, Grabber, Light, MotorDiagnostics, TiltCameraHead } from "../../cameraHeads";
+import { Rov } from "../rov";
 /**
  * {@link IRevolution | 📖 See extended definition}
  * Revolution Class
@@ -22,17 +22,6 @@ export type Revolution = {
      *
      */
     cameraHead?: Removable<TiltCameraHead>;
-    /**
-     * IP
-     *
-     * ### Example Payloads
-     * #### SET Requests
-     *
-     * - Arbitrary value
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json}
-     */
-    ip?: string;
     /**
      *  Aux Light
      *
@@ -91,80 +80,6 @@ export type Revolution = {
      * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateRightSample.json}
      */
     grabber?: Grabber;
-    /** Rov Drive object
-     *
-     * Commands thrust actions for the ROV and sets drive modes
-     *
-     * See {@link RovDrive} for more details.
-     *
-     * ### Example Payloads
-     * #### SET Requests
-     * - Random drive request
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json}
-     */
-    drive?: RovDrive;
-    /**
-     * Rov roll
-     *
-     * Measured in degrees from neutral roll position
-     *
-     * @minimum -180.0
-     * @maximum 180.0
-     */
-    roll?: number;
-    /**
-     * Rov pitch
-     *
-     * Measured in degrees from neutral pitch position
-     *
-     * @minimum -180.0
-     * @maximum 180.0
-     */
-    pitch?: number;
-    /**
-     * Rov heading
-     *
-     * Measured in degrees from north bearing
-     *
-     * @minimum 0
-     * @maximum 360
-     */
-    heading?: number;
-    /**
-     * Rov depth
-     *
-     * Measured in meters from water surface
-     */
-    depth?: number;
-    /**
-     * Rov altitude valid
-     *
-     * Altitude validity flag
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     * - Invalid altitude (bad data)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeInvalidSample.json}
-     *
-     * - Valid altitude (good data)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidSample.json}
-     */
-    altitudeValid?: boolean;
-    /**
-     * Rov altitude
-     *
-     * Measured in meters to show relative distance to floor.
-     *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Current altitude
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeRandomSample.json}
-     *
-     */
-    altitude?: number;
     /** Motor Diagnostics */
     /** Front Left Motor Diagnostics
      *
@@ -261,6 +176,35 @@ export type Revolution = {
      * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalRightThruster/revolutionVerticalRightMotorDiagnosticsRestingSample.json}
      */
     verticalRightMotorDiagnostics?: MotorDiagnostics;
+    /**
+     * Provides diagnostics for spare motor 1 on the Rov. This spare motor can be used to extend
+     * the capabilities of the ROV by attaching a power tool to it.
+     *
+     * ### Example Payloads
+     * #### UPDATE Requests
+     *
+     * - Resting spare motor 1 diagnostics sample
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor1/revolutionSpareMotor1DiagnosticsRestingSample.json}
+     *
+     * - Arbitrary Spare Motor 1 Diagnostics sample
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor1/revolutionSpareMotor1DiagnosticsRandomSample.json}
+     *
+     */
+    spareMotor1?: MotorDiagnostics;
+    /**
+     * Provides diagnostics for spare motor 2 on the Rov. This spare motor can be used to extend
+     * the capabilities of the ROV by attaching a power tool to it.
+     *
+     * ### Example Payloads
+     * #### UPDATE Requests
+     *
+     * - Resting spare motor 2 diagnostics sample
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor2/revolutionSpareMotor2DiagnosticsRestingSample.json}
+     *
+     * - Arbitrary Spare Motor 2 Diagnostics sample
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor2/revolutionSpareMotor2DiagnosticsRandomSample.json}
+     */
+    spareMotor2?: MotorDiagnostics;
     /** Main ROV Batteries */
     /**
      * Left Battery
@@ -334,20 +278,6 @@ export type Revolution = {
      *
      */
     rightBattery?: Battery;
-    /** Vehicle Usage Time
-     *
-     * ### Example payloads
-     * #### UPDATE Requests
-     *
-     * - Arbitrary total seconds
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/usageTime/revolutionRandomTotalSecondsUsageSample.json}
-     *
-     * - Arbitrary current seconds
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/usageTime/revolutionRandomCurrentSecondsUsageSample.json}
-     */
-    usageTime?: UsageTime;
     /** CPU temperature sensors in degrees celsius
      *
      * ### Example Payloads
@@ -373,71 +303,5 @@ export type Revolution = {
      * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionMinWaterTempSample.json}
      */
     waterTemp?: number;
-    /** Body Leak Fault
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     * - Arbitrary
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json}
-     *
-     * - Has no body leak fault
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasNoBodyLeakSample.json}
-     *
-     * - Has body leak fault
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasBodyLeakSample.json}
-     */
-    bodyLeak?: boolean;
-    /** Sensor Pod Leak Fault
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     * - Arbitrary
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/sensorPodLeak/revolutionSensorPodLeakRandomSample.json}
-     *
-     * - Has no sensor pod leak fault
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/sensorPodLeak/revolutionHasNoSensorPodLeakSample.json}
-     *
-     * - has sensor pod leak fault
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/sensorPodLeak/revolutionHasSensorPodLeakSample.json}
-     */
-    sensorPodLeak?: boolean;
-    /** Revolution Version
-     *
-     * @remarks See {@link DeviceVersion} type for more details
-     *
-     * ### Example Payloads
-     * #### UPDATE
-     *
-     * - Arbitrary
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/version/revolutionVersionRandomSample.json}
-     *
-     * - Version 1
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/version/revolutionVersion1Sample.json}
-     *
-     * - Version 2
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/version/revolutionVersion2Sample.json}
-     *
-     * - Version 3
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/version/revolutionVersion3Sample.json}
-     */
-    version?: DeviceVersion;
-    /**
-     * Turns
-     *
-     * Count the number of turns the rov has completed
-     */
-    turns?: number;
-} & Vehicle;
+} & Rov;
 export * from "./core";

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

@@ -0,0 +1,198 @@
+import { DeviceVersion, UsageTime, Vehicle } from "../../cameraHeads";
+import { RovDrive } from "../rovDrive";
+import { Navigation } from "../navigation";
+/**
+ * {@link IRov | 📖 See extended definition}
+ * Rov Class
+ *
+ * @description Rov base vehicle type.
+ *
+ * @category Devices/Vehicles/Rov
+ */
+export type Rov = {
+    /**
+     * IP Address
+     * ### Example Payloads
+     * #### SET Requests
+     *
+     * - Arbitrary
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/ip/pivotIpRandomSample.json}
+     *
+     * @readonly
+     */
+    ip?: string;
+    /** Rov Drive object
+     *
+     * Commands thrust actions for the ROV and sets drive modes
+     *
+     * See {@link RovDrive} for more details.
+     *
+     * ### Example Payloads
+     * #### SET Requests
+     *
+     * - 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}
+     */
+    drive?: RovDrive;
+    /**
+     * Rov roll
+     *
+     * Measured in degrees from neutral roll position
+     *
+     * @minimum -180.0
+     * @maximum 180.0
+     *
+     * @readonly
+     */
+    roll?: number;
+    /**
+     * Rov pitch
+     *
+     * Measured in degrees from neutral pitch position
+     *
+     * @minimum -180.0
+     * @maximum 180.0
+     *
+     * @readonly
+     */
+    pitch?: number;
+    /**
+     * Rov heading
+     *
+     * Measured in degrees from north bearing
+     *
+     * @minimum 0
+     * @maximum 360
+     *
+     * @readonly
+     */
+    heading?: number;
+    /**
+     * Rov depth
+     *
+     * Measured in meters from water surface
+     *
+     * @readonly
+     */
+    depth?: number;
+    /**
+     * Rov altitude valid
+     *
+     * Altitude validity flag
+     *
+     * ### Example Payloads
+     * #### UPDATE Requests
+     *
+     * - Invalid altitude (bad data)
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeInvalidSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeInvalidSample.json}
+     *
+     * - 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}
+     *
+     * - 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}
+     *
+     * @readonly
+     */
+    altitudeValid?: boolean;
+    /**
+     * Rov altitude
+     *
+     * Measured in meters to show relative distance to floor.
+     *
+     * ### Example Payloads
+     * #### GET Requests
+     *
+     * - Random altitude
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json}
+     *
+     * @readonly
+     */
+    altitude?: number;
+    /** Sensor Pod Leak Fault
+     *
+     * Common across all ROV and also comes from the ROV Web Adapter in Con_gui
+     */
+    sensorPodLeak?: boolean;
+    /** Body Leak Fault
+     *
+     * ### Example Payloads
+     * #### UPDATE Requests
+     *
+     * - Arbitrary
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotBodyLeakRandomSample.json}
+     *
+     * - 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}
+     *
+     * - 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}
+     *
+     * @readonly
+     */
+    bodyLeak?: boolean;
+    /**
+     * Turns
+     *
+     * Count the number of turns the rov has completed
+     *
+     * @readonly
+     */
+    turns?: number;
+    /**
+     * ROV Version
+     *
+     * @readonly
+     */
+    version?: DeviceVersion;
+    /** Vehicle Usage Time
+     *
+     * ### Example Payloads
+     * #### GET Requests
+     *
+     * - Total and current usage times
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeSample.json}
+     *
+     * - Arbitrary
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/usageTime/revolutionUsageTimeRandomSample.json}
+     */
+    usageTime?: UsageTime;
+    /**
+     * Rov in water status
+     *
+     * @readonly
+     *
+     * ### Example Payloads
+     * #### UPDATE Requests
+     *
+     * - Pivot in water
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotInWaterSample.json}
+     *
+     * - Pivot out of water
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotOutOfWaterSample.json}
+     *
+     * - Pivot in water random status sample
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotInWaterRandomSample.json}
+     *
+     * - Revolution out of water
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionOutOfWaterSample.json}
+     *
+     * - Revolution in water
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionInWaterSample.json}
+     *
+     * - Revolution in water random status sample
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionInWaterRandomSample.json}
+     *
+     */
+    inWater?: boolean;
+} & Vehicle & Navigation;

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "0.48.1",
+    "version": "0.50.0",
     "description": "A business domain of types and schemas that the DeepTrekker topside communicates with via an API.",
     "main": "dist/index.js",
     "files": [
@@ -34,6 +34,7 @@
         "@types/lodash": "^4.14.182",
         "@types/node": "^18.0.0",
         "@zamiell/typedoc-plugin-not-exported": "^0.2.0",
+        "prettier": "3.0.3",
         "rimraf": "^3.0.2",
         "semver-compare-cli": "^2.0.0",
         "ts-json-schema-generator": "^1.0.0",