@deeptrekker/api-domain 1.0.15 → 1.0.16

package/dist/constants/schema/schema.json

@@ -113,7 +113,9 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "A150CameraHead": {
@@ -178,7 +180,9 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "A200": {
@@ -293,7 +297,9 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "A200CameraHead": {
@@ -366,7 +372,9 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "AutoSnapshot": {
@@ -638,12 +646,22 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "CalibrationStates": {
             "description": "Calibration states for the sensor pod.",
-            "enum": [0, 1, 2, 3, 4, 5, 6],
+            "enum": [
+                0,
+                1,
+                2,
+                3,
+                4,
+                5,
+                6
+            ],
             "type": "number"
         },
         "Camera": {
@@ -658,7 +676,14 @@
                     "type": "string"
                 },
                 "model": {
-                    "enum": [240, 5, 206, 243, 241, 207],
+                    "enum": [
+                        240,
+                        5,
+                        206,
+                        243,
+                        241,
+                        207
+                    ],
                     "type": "number"
                 },
                 "osd": {
@@ -680,22 +705,33 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "CameraHeadOrientation": {
             "description": "Camera head orientation config\n\nThe orientation in which the camera head is physically assembled",
-            "enum": ["HORIZONTAL", "VERTICAL"],
+            "enum": [
+                "HORIZONTAL",
+                "VERTICAL"
+            ],
             "type": "string"
         },
         "CameraHeadSensorType": {
             "description": "Camera head sensor type",
-            "enum": ["IMU", "HALL_EFFECT"],
+            "enum": [
+                "IMU",
+                "HALL_EFFECT"
+            ],
             "type": "string"
         },
         "CameraType": {
             "description": "Camera type enums",
-            "enum": ["MAIN", "AUX"],
+            "enum": [
+                "MAIN",
+                "AUX"
+            ],
             "type": "string"
         },
         "Cameras": {
@@ -763,7 +799,11 @@
         },
         "CrawlerDriveMode": {
             "description": "Drive Modes",
-            "enum": ["NORMAL", "RETRIEVAL_ASSIST", "RETRIEVAL_CRUISE"],
+            "enum": [
+                "NORMAL",
+                "RETRIEVAL_ASSIST",
+                "RETRIEVAL_CRUISE"
+            ],
             "type": "string"
         },
         "CygnusType": {
@@ -850,7 +890,9 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "DT645Drive": {
@@ -929,7 +971,9 @@
                     "description": "White Balance Settings for adjusting the white balance of the camera."
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "DVL": {
@@ -952,7 +996,9 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "DateTime": {
@@ -1004,7 +1050,10 @@
                 202,
                 245
             ],
-            "type": ["number", "string"]
+            "type": [
+                "number",
+                "string"
+            ]
         },
         "DeviceVersion": {
             "additionalProperties": false,
@@ -1125,7 +1174,15 @@
         },
         "ErrorCode": {
             "description": "Error Codes",
-            "enum": [400, 401, 403, 405, 500, 503, 519],
+            "enum": [
+                400,
+                401,
+                403,
+                405,
+                500,
+                503,
+                519
+            ],
             "type": "number"
         },
         "ExposureSettings": {
@@ -1217,7 +1274,15 @@
         },
         "GpsFixState": {
             "description": "Enumerates the possible GPS FIX states.",
-            "enum": [0, 1, 2, 3, 4, 5, 6],
+            "enum": [
+                0,
+                1,
+                2,
+                3,
+                4,
+                5,
+                6
+            ],
             "type": "number"
         },
         "GpsStatus": {
@@ -1303,7 +1368,9 @@
                     "type": "boolean"
                 }
             },
-            "required": ["enabled"],
+            "required": [
+                "enabled"
+            ],
             "type": "object"
         },
         "Light": {
@@ -1317,7 +1384,9 @@
                     "type": "number"
                 }
             },
-            "required": ["intensity"],
+            "required": [
+                "intensity"
+            ],
             "type": "object"
         },
         "LocalPosition": {
@@ -1342,7 +1411,11 @@
         },
         "LocationConsumerType": {
             "description": "Enumerates the possible consumers of a location provider.",
-            "enum": [0, 1, 2],
+            "enum": [
+                0,
+                1,
+                2
+            ],
             "type": "number"
         },
         "LocationForwarderConfig": {
@@ -1424,7 +1497,9 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "MotorDiagnostics": {
@@ -1517,7 +1592,10 @@
         },
         "NetworkRole": {
             "description": "Network Diagnostics Physical Location enum",
-            "enum": ["CCO", "STA"],
+            "enum": [
+                "CCO",
+                "STA"
+            ],
             "type": "string"
         },
         "OcleaCam": {
@@ -1590,7 +1668,9 @@
                     "description": "White Balance"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "OcleaDptz": {
@@ -1617,7 +1697,9 @@
                             "type": "object"
                         }
                     },
-                    "required": ["direction"],
+                    "required": [
+                        "direction"
+                    ],
                     "type": "object"
                 },
                 "roi": {
@@ -1658,12 +1740,23 @@
         },
         "OcleaVersion": {
             "description": "Oclea Sensor version",
-            "enum": ["4K UHD v274", "4K UHD v415", "4K UHD v678", "Zoom v3010"],
+            "enum": [
+                "4K UHD v274",
+                "4K UHD v415",
+                "4K UHD v678",
+                "Zoom v3010"
+            ],
             "type": "string"
         },
         "OfflineUpdateState": {
             "description": "Offline Update State",
-            "enum": [0, 1, 2, 3, 4],
+            "enum": [
+                0,
+                1,
+                2,
+                3,
+                4
+            ],
             "type": "number"
         },
         "Onyx": {
@@ -1844,7 +1937,9 @@
                     "type": "number"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "Osd": {
@@ -2037,12 +2132,17 @@
                     "type": "number"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "PhysicalLocation": {
             "description": "Network Diagnostics Physical Location enum",
-            "enum": ["LOC", "REM"],
+            "enum": [
+                "LOC",
+                "REM"
+            ],
             "type": "string"
         },
         "Pivot": {
@@ -2164,6 +2264,10 @@
                     "$ref": "#/definitions/Position",
                     "description": "ROV Position"
                 },
+                "powerTool": {
+                    "$ref": "#/definitions/PowerTool",
+                    "description": "Power Tool"
+                },
                 "rearLeftMotorDiagnostics": {
                     "$ref": "#/definitions/MotorDiagnostics",
                     "description": "Motor Diagnostics"
@@ -2225,7 +2329,9 @@
                     "type": "number"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "Position": {
@@ -2274,9 +2380,41 @@
         },
         "PositionSources": {
             "description": "Enumerates the possible vehicle location provider sources available to the Web App.",
-            "enum": ["NONE", "SEATRAC_USBL", "EXTERNAL_GPS", "STATIC"],
+            "enum": [
+                "NONE",
+                "SEATRAC_USBL",
+                "EXTERNAL_GPS",
+                "STATIC"
+            ],
             "type": "string"
         },
+        "PowerTool": {
+            "additionalProperties": false,
+            "description": "Power Tool Generation 3 power tool that rotates and spins.",
+            "properties": {
+                "authorized": {
+                    "description": "Flag to gain authorization to operate the power tool. This is an added layer of security since power tool can cause  harm to humans and components.\n\nAuthorization is requested by setting this flag to true. \n\nIf the power tool is not used for over 60 seconds, the user looses Authorization and must request it again.",
+                    "type": "boolean"
+                },
+                "enabled": {
+                    "description": "Flag to enable to disable the power tool control\n\nPowertool is only controllable when this is TRUE AND when authorization is TRUE (see authorization property below)",
+                    "type": "boolean"
+                },
+                "rotate": {
+                    "description": "Rotation motor",
+                    "maximum": 100,
+                    "minimum": -100,
+                    "type": "number"
+                },
+                "spin": {
+                    "description": "Spin Motor",
+                    "maximum": 100,
+                    "minimum": -100,
+                    "type": "number"
+                }
+            },
+            "type": "object"
+        },
         "PoweredReel": {
             "additionalProperties": false,
             "description": "Powered Reel",
@@ -2382,11 +2520,17 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "Rate": {
-            "enum": [-1, 0, 1],
+            "enum": [
+                -1,
+                0,
+                1
+            ],
             "type": "number"
         },
         "Removable<A150CameraHead>": {
@@ -2616,6 +2760,10 @@
                     "$ref": "#/definitions/Position",
                     "description": "ROV Position"
                 },
+                "powerTool": {
+                    "$ref": "#/definitions/PowerTool",
+                    "description": "Power Tool"
+                },
                 "rearLeftMotorDiagnostics": {
                     "$ref": "#/definitions/MotorDiagnostics",
                     "description": "Rear Left Motor Diagnostics"
@@ -2676,7 +2824,9 @@
                     "type": "number"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "RotaryJoint": {
@@ -2779,7 +2929,9 @@
                     "type": "object"
                 }
             },
-            "required": ["controls"],
+            "required": [
+                "controls"
+            ],
             "type": "object"
         },
         "RovThrust": {
@@ -2799,7 +2951,10 @@
                     "type": "number"
                 }
             },
-            "required": ["forward", "yaw"],
+            "required": [
+                "forward",
+                "yaw"
+            ],
             "type": "object"
         },
         "SWUpdate": {
@@ -2854,17 +3009,34 @@
                     "type": "string"
                 }
             },
-            "required": ["name"],
+            "required": [
+                "name"
+            ],
             "type": "object"
         },
         "SerialDeviceType": {
             "description": "Denotes the origin of the serial device.",
-            "enum": ["ROV", "Web", "Internal", "Controller"],
+            "enum": [
+                "ROV",
+                "Web",
+                "Internal",
+                "Controller"
+            ],
             "type": "string"
         },
         "SnapshotIntervals": {
             "description": "Snapshot intervals (in seconds) for auto snapshot feature.",
-            "enum": [1, 2, 3, 4, 5, 10, 15, 30, 60],
+            "enum": [
+                1,
+                2,
+                3,
+                4,
+                5,
+                10,
+                15,
+                30,
+                60
+            ],
             "type": "number"
         },
         "SoftwareUpdate": {
@@ -2878,7 +3050,10 @@
                     "$ref": "#/definitions/VersionNote"
                 }
             },
-            "required": ["releaseDate", "versionNotes"],
+            "required": [
+                "releaseDate",
+                "versionNotes"
+            ],
             "type": "object"
         },
         "Sonar": {
@@ -2953,17 +3128,25 @@
                     "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "SonarFrequency": {
             "description": "Sonar frequency levels",
-            "enum": ["HIGH", "LOW"],
+            "enum": [
+                "HIGH",
+                "LOW"
+            ],
             "type": "string"
         },
         "SonarModel": {
             "description": "Sonar models",
-            "enum": ["oculus", "tritech"],
+            "enum": [
+                "oculus",
+                "tritech"
+            ],
             "type": "string"
         },
         "Sonde": {
@@ -2974,12 +3157,17 @@
                     "type": "boolean"
                 }
             },
-            "required": ["enabled"],
+            "required": [
+                "enabled"
+            ],
             "type": "object"
         },
         "SpragBearing": {
             "description": "Sprag Bearing Types",
-            "enum": ["FKNN6204-2RS", "FKNN6205-2RS"],
+            "enum": [
+                "FKNN6204-2RS",
+                "FKNN6205-2RS"
+            ],
             "type": "string"
         },
         "Stream": {
@@ -3006,7 +3194,9 @@
                     "description": "Stream resolution"
                 }
             },
-            "required": ["active"],
+            "required": [
+                "active"
+            ],
             "type": "object"
         },
         "StreamMode": {
@@ -3035,7 +3225,10 @@
         },
         "StreamModes": {
             "description": "Streaming Mode for the camera",
-            "enum": ["RTSP", "WEBRTC"],
+            "enum": [
+                "RTSP",
+                "WEBRTC"
+            ],
             "type": "string"
         },
         "SystemDiagnostics": {
@@ -3059,7 +3252,10 @@
         },
         "SystemOfMeasurement": {
             "description": "System unit of measurement enum",
-            "enum": ["IMPERIAL", "METRIC"],
+            "enum": [
+                "IMPERIAL",
+                "METRIC"
+            ],
             "type": "string"
         },
         "SystemSettings": {
@@ -3100,7 +3296,14 @@
                 },
                 "nearLimit": {
                     "description": "Focus near limit",
-                    "enum": [10, 34, 90, 250, 800, 2300],
+                    "enum": [
+                        10,
+                        34,
+                        90,
+                        250,
+                        800,
+                        2300
+                    ],
                     "type": "number"
                 },
                 "rate": {
@@ -3176,7 +3379,9 @@
                     "$ref": "#/definitions/ZoomControl"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "TamronOcleaZoomCamera": {
@@ -3236,7 +3441,9 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "TiltCameraHead": {
@@ -3282,12 +3489,17 @@
                     "$ref": "#/definitions/DeviceVersion"
                 }
             },
-            "required": ["model"],
+            "required": [
+                "model"
+            ],
             "type": "object"
         },
         "TiltCameraHeadModel": {
             "description": "Tilt Camera Head Model",
-            "enum": [102, 103],
+            "enum": [
+                102,
+                103
+            ],
             "type": "number"
         },
         "TiltPlatform": {
@@ -3306,7 +3518,11 @@
         },
         "TopPositionSources": {
             "description": "Enumerates the possible topside location provider sources available to the Web App.",
-            "enum": ["NONE", "EXTERNAL_GPS", "STATIC"],
+            "enum": [
+                "NONE",
+                "EXTERNAL_GPS",
+                "STATIC"
+            ],
             "type": "string"
         },
         "TransferError": {
@@ -3322,12 +3538,21 @@
                     "type": "string"
                 }
             },
-            "required": ["code", "message"],
+            "required": [
+                "code",
+                "message"
+            ],
             "type": "object"
         },
         "TransferMethodType": {
             "description": "The different kinds of payload requests that can be sent and received.",
-            "enum": ["GET", "SET", "UPDATE", "DELETE", "ERROR"],
+            "enum": [
+                "GET",
+                "SET",
+                "UPDATE",
+                "DELETE",
+                "ERROR"
+            ],
             "type": "string"
         },
         "TransferPayload<BridgeBox>": {
@@ -3348,7 +3573,11 @@
                     "$ref": "#/definitions/BridgeBox"
                 }
             },
-            "required": ["apiVersion", "method", "payload"],
+            "required": [
+                "apiVersion",
+                "method",
+                "payload"
+            ],
             "type": "object"
         },
         "TurbidityFilter": {
@@ -3385,7 +3614,12 @@
                     "type": "string"
                 }
             },
-            "required": ["buildDate", "size", "sha256", "changelog"],
+            "required": [
+                "buildDate",
+                "size",
+                "sha256",
+                "changelog"
+            ],
             "type": "object"
         },
         "UsageTime": {
@@ -3454,7 +3688,10 @@
                     "type": "array"
                 }
             },
-            "required": ["improvements", "fixes"],
+            "required": [
+                "improvements",
+                "fixes"
+            ],
             "type": "object"
         },
         "WhiteBalanceSettings": {

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

@@ -1 +1 @@
-export declare const API_VERSION = "1.0.15";
+export declare const API_VERSION = "1.0.16";

package/dist/constants/versions/index.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.API_VERSION = void 0;
 /* AUTO GENERATED FILE */
-exports.API_VERSION = "1.0.15";
+exports.API_VERSION = "1.0.16";

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

@@ -216,6 +216,73 @@ export type Grabber = {
      */
     rotateMotorDiagnostics?: MotorDiagnostics;
 };
+/**
+ *
+ * Power Tool
+ * Generation 3 power tool that rotates and spins.
+ * @group Devices
+ * @category Peripherals
+ */
+export type PowerTool = {
+    /**
+     * Flag to enable to disable the power tool control
+     *
+     * Powertool is only controllable when this is TRUE
+     * AND when authorization is TRUE (see authorization property below)
+     */
+    enabled?: boolean;
+    /**
+     * Flag to gain authorization to operate the power tool.
+     * This is an added layer of security since power tool can cause
+     * harm to humans and components.
+     *
+     * Authorization is requested by setting this flag to true.
+     *
+     * If the power tool is not used for over 60 seconds, the user looses
+     * Authorization and must request it again.
+     */
+    authorized?: boolean;
+    /**
+     * Rotation motor
+     *
+     * @remarks Power Tool rotation power
+     *
+     * - `< 0` = rotate left
+     * - `== 0` = motor off
+     * - `> 0` = rotate right
+     * @example
+     * ```json
+     * {
+     *   "rotate": 50
+     * }
+     * ```
+     *
+     * @minimum -100
+     * @maximum 100
+     *
+     */
+    rotate?: number;
+    /**
+     * Spin Motor
+     *
+     * @remarks Power Tool spin motor power (in percentage)
+     *
+     * - `< 0` = motor off
+     * - `== 0` = motor off
+     * - `> 0` = spin (Meant to work with joystick down input)
+     *
+     * @example
+     * ```json
+     * {
+     *   "spin": -50
+     * }
+     * ```
+     * @minimum -100
+     * @maximum 100
+     *
+     */
+    spin?: number;
+};
 /**
  * The tilt platform on the pivot.
  * @group PIVOT

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

@@ -2,7 +2,7 @@ import { Cameras } from "../../cameras/types";
 import { Removable } from "../../../core";
 import { DeviceModel, DeviceVersion, Grabber, Light, TiltPlatform } from "../..";
 import { MotorDiagnostics, Battery, UsageTime } from "../../core";
-import { TiltCameraHead } from "../../cameraHeads/tiltCameraHead";
+import { PowerTool, TiltCameraHead } from "../../cameraHeads/tiltCameraHead";
 import { RovVehicle } from "../rov";
 /**
  * Pivot Class
@@ -31,6 +31,11 @@ export type Pivot = {
      * @see {@link Grabber | Grabber}
      */
     grabber?: Grabber;
+    /**Power Tool
+     *
+     * @see {@link PowerTool | PowerTool}
+     */
+    powerTool?: PowerTool;
     /** Grabber
      *
      * @see {@link TiltPlatform | TiltPlatform}

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

@@ -1,5 +1,5 @@
 import { Removable } from "../../../core";
-import { Battery, DeviceModel, Grabber, Light, MotorDiagnostics, TiltCameraHead } from "../../cameraHeads";
+import { Battery, DeviceModel, Grabber, Light, MotorDiagnostics, PowerTool, TiltCameraHead } from "../../cameraHeads";
 import { RovVehicle } from "../rov";
 /**
  * Revolution Class
@@ -29,6 +29,11 @@ export type Revolution = {
      * @see {@link Grabber | Grabber}
      */
     grabber?: Grabber;
+    /**Power Tool
+     *
+     * @see {@link PowerTool | PowerTool}
+     */
+    powerTool?: PowerTool;
     /** Motor Diagnostics */
     /**
      * @remarks

package/dist/utils/index.js

@@ -30,6 +30,7 @@ var validate = function (req) {
     var valid = Validator(req);
     if (!valid) {
         console.log("Not valid: ", valid, Validator);
+        console.log("Not valid: ", req);
         throw new Error((_a = Validator.errors) === null || _a === void 0 ? void 0 : _a[0].message);
     }
     return req;

package/package.json

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