@deeptrekker/api-domain 0.59.0 → 0.60.0

package/dist/schemas/schema.json

@@ -836,6 +836,110 @@
       ],
       "type": "string"
     },
+    "DT645": {
+      "additionalProperties": false,
+      "description": "{@link  IDT645 📖 See extended definition } \n\nDT645 Class\n\nDT645 vehicle type.",
+      "properties": {
+        "bodyLeak": {
+          "description": "Body Leak Fault\n\nIndicates detection of water leakage within the DT645 Utility Crawler's main body compartment.\n\n### Example Payloads #### UPDATE Requests\n\n- No body leak {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645HasNoBodyLeakSample.json}\n\n- Body leak present {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645HasBodyLeakSample.json}\n\n- Arbitrary {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645BodyLeakRandomSample.json}",
+          "type": "boolean"
+        },
+        "cameraHead": {
+          "$ref": "#/definitions/Removable%3CA150CameraHead%3E",
+          "description": "Camera Head\n\nThe rotating part of the camera that controls its pan and tilt orientation.\n\n### Example Payloads #### DELETE Requests\n\n- a150 camera head {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameraHead/a150CameraHead/core/a150A150CameraHeadSample.json}"
+        },
+        "cameras": {
+          "additionalProperties": {
+            "$ref": "#/definitions/Removable%3CCameras%3E"
+          },
+          "description": "📷 List of cameras\n\nHolds a list of all vehicle Cameras.",
+          "type": "object"
+        },
+        "cpProbe": {
+          "description": "The cp probe",
+          "type": "string"
+        },
+        "cygnus": {
+          "$ref": "#/definitions/cygnusType",
+          "description": "The ut(cygnus) probe"
+        },
+        "depth": {
+          "description": "Depth\n\nMeasures the depth of DT645 Utility Crawler (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/dt645/depth/dt645ValidDepthCalibrationSample.json}\n\nInvalid Depth Calibration {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/depth/dt645InvalidDepthCalibrationSample.json}",
+          "type": "number"
+        },
+        "drive": {
+          "$ref": "#/definitions/DT645Drive",
+          "description": "Drive Controls\n\nControls the direction of drive for the Dt645 Utility Crawler.\n\n### Example Payloads #### SET Requests\n\n- Arbitrary Values {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveRandomSample.json}\n\n- Random Speed {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSpeedRandomSample.json}\n\n- Max Speed Forward Speed {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMaxSpeedForwardSample.json}\n\n- Max Speed Backward Speed {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMaxSpeedBackwardSample.json}\n\n- Stop Motor {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMotorStopSample.json}\n\n- Random Steer {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerRandomSample.json}\n\n- Steer Left {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerLeftSample.json}\n\n- Steer Right {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerRightSample.json}\n\n- Stop Steer {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerStopSample.json}\n\n- Motors Disabled {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645MotorsDisabledSample.json}\n\n- Motors Enabled {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645MotorsEnabledSample.json}"
+        },
+        "heading": {
+          "description": "Heading\n\nThe direction that the DT645 Utility Crawler is facing. Measured in degrees from north bearing.\n\n- Random Heading {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/heading/dt645HeadingRandomSample.json}",
+          "maximum": 360,
+          "minimum": 0,
+          "type": "number"
+        },
+        "incline": {
+          "description": "Incline\n\nThe angle at which the DT645 Utility Crawler is positioned relative to a flat surface.\n\n- Random Incline {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineRandomSample.json}\n\n- Min Incline {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineMinSample.json}\n\n- Max Incline {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineMaxSample.json}",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "ip": {
+          "description": "IP address",
+          "type": "string"
+        },
+        "model": {
+          "const": 22,
+          "type": "number"
+        },
+        "pitch": {
+          "description": "Pitch\n\nMeasured in degrees from the neutral pitch position.\n\n- Random Pitch {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchRandomSample.json}\n\n- Min Pitch {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchMinSample.json}\n\n- Max Pitch {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchMaxSample.json}",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "roll": {
+          "description": "Roll\n\nRotation of the DT645 Utility Crawler around its front-to-back (longitudinal) axis.\n\n- Random Roll {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollRandomSample.json}\n\n- Min Roll {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollMinSample.json}\n\n- Max Roll {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollMaxSample.json}",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "usageTime": {
+          "$ref": "#/definitions/UsageTime",
+          "description": "Usage Time\n\n### Example Payloads #### GET Requests\n\n- Current seconds {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645CurrentSecondsRandomSample.json}\n\n- Total Seconds {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645TotalSecondsRandomSample.json}\n\n- Arbitrary Total Usage {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645UsageTimeRandomSample.json}"
+        },
+        "version": {
+          "$ref": "#/definitions/DeviceVersion",
+          "description": "Version"
+        }
+      },
+      "required": [
+        "model"
+      ],
+      "type": "object"
+    },
+    "DT645Drive": {
+      "additionalProperties": false,
+      "description": "Dt645 Drive",
+      "properties": {
+        "motorsDisabled": {
+          "description": "Motors Disabled\n\nWhen enabled, prevents any motor commands from being accepted by firmware",
+          "type": "boolean"
+        },
+        "speed": {
+          "description": "Negative values for reverse, positive for forward\nIgnored by the crawler when it is in either retrieval assist or retrieval cruise modes",
+          "maximum": 120,
+          "minimum": -120,
+          "type": "number"
+        },
+        "steer": {
+          "description": "Steering — Negative values for left, positive for right Ignored by the crawler when it is in either retrieval assist or retrieval cruise modes",
+          "maximum": 120,
+          "minimum": -120,
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
     "DTCam": {
       "additionalProperties": false,
       "description": "{@link  IDtCam 📖 See extended definition } \n\n📷 DT Cam",
@@ -973,6 +1077,7 @@
       "enum": [
         20,
         19,
+        22,
         240,
         5,
         206,
@@ -1041,6 +1146,9 @@
         },
         {
           "$ref": "#/definitions/Onyx"
+        },
+        {
+          "$ref": "#/definitions/DT645"
         }
       ],
       "description": "Devices\n\nThis is a collection of all devices used."

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

@@ -11,6 +11,7 @@
 export declare enum DeviceModel {
     A150Crawler = 20,
     A200Crawler = 19,
+    DT645 = 22,
     TamronHarrierZoomCamera = 240,
     DTCam = 5,
     OcleaCam = 206,

package/dist/types/devices/index.js

@@ -42,6 +42,7 @@ var DeviceModel;
     /* Crawlers */
     DeviceModel[DeviceModel["A150Crawler"] = 20] = "A150Crawler";
     DeviceModel[DeviceModel["A200Crawler"] = 19] = "A200Crawler";
+    DeviceModel[DeviceModel["DT645"] = 22] = "DT645";
     /*Cameras */
     DeviceModel[DeviceModel["TamronHarrierZoomCamera"] = 240] = "TamronHarrierZoomCamera";
     DeviceModel[DeviceModel["DTCam"] = 5] = "DTCam";

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

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

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

@@ -5,7 +5,7 @@ import { Onyx } from "../onyx";
 import { Photon } from "../photon";
 import { Pivot } from "../pivot";
 import { Revolution } from "../revolution";
-import { DeviceModel } from "../../";
+import { DeviceModel, DT645 } from "../../";
 export type VehicleModelMap = {
     [DeviceModel.Pivot]: Pivot;
     [DeviceModel.Revolution]: Revolution;
@@ -13,6 +13,7 @@ export type VehicleModelMap = {
     [DeviceModel.A150Crawler]: A150;
     [DeviceModel.Photon]: Photon;
     [DeviceModel.Onyx]: Onyx;
+    [DeviceModel.DT645]: DT645;
 };
 export type CrawlerModelMap = {
     [DeviceModel.A150Crawler]: A150;

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

@@ -0,0 +1,217 @@
+import { A150CameraHead, DeviceModel, UsageTime, Vehicle } from "../..";
+import { Removable } from "../../../core";
+/** Dt645 Drive */
+export type DT645Drive = {
+    /**
+     * Drive Speed
+     * @description Negative values for reverse, positive for forward
+     * Ignored by the crawler when it is in either retrieval assist or retrieval cruise modes
+     *
+     * @minimum -120
+     * @maximum 120
+     */
+    speed?: number;
+    /**
+     * Steering — Negative values for left, positive for right
+     * Ignored by the crawler when it is in either retrieval assist or retrieval cruise modes
+     *
+     * @minimum -120
+     * @maximum 120
+     */
+    steer?: number;
+    /**
+     * Motors Disabled
+     *
+     * When enabled, prevents any motor commands from being accepted by firmware
+     */
+    motorsDisabled?: boolean;
+};
+/**
+ * {@link IDT645 | 📖 See extended definition}
+ *
+ * DT645 Class
+ *
+ * DT645 vehicle type.
+ *
+ * @category Devices/Vehicles
+ */
+export type DT645 = {
+    model: DeviceModel.DT645;
+    /** Body Leak Fault
+     *
+     * Indicates detection of water leakage within the DT645 Utility Crawler's main body compartment.
+     *
+     * ### Example Payloads
+     * #### UPDATE Requests
+     *
+     * - No body leak
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645HasNoBodyLeakSample.json}
+     *
+     * - Body leak present
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645HasBodyLeakSample.json}
+     *
+     * - Arbitrary
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645BodyLeakRandomSample.json}
+     *
+     */
+    bodyLeak?: boolean;
+    /** Camera Head
+     *
+     * The rotating part of the camera that controls its pan and tilt orientation.
+     *
+     * ### Example Payloads
+     * #### DELETE Requests
+     *
+     * - a150 camera head
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameraHead/a150CameraHead/core/a150A150CameraHeadSample.json}
+     *
+     */
+    cameraHead?: Removable<A150CameraHead>;
+    /**
+     * Depth
+     *
+     * Measures the depth of DT645 Utility Crawler (in meters) from water surface
+     *
+     * To Calibrate depth, set depth to '0'.
+     * Setting depth to any other value will be ignored.
+     *
+     * Valid Depth calibration
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/depth/dt645ValidDepthCalibrationSample.json}
+     *
+     * Invalid Depth Calibration
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/depth/dt645InvalidDepthCalibrationSample.json}
+     *
+     * @readonly
+     */
+    depth?: number;
+    /** Drive Controls
+     *
+     * Controls the direction of drive for the Dt645 Utility Crawler.
+     *
+     * ### Example Payloads
+     * #### SET Requests
+     *
+     * - Arbitrary Values
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveRandomSample.json}
+     *
+     * - Random Speed
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSpeedRandomSample.json}
+     *
+     * - Max Speed Forward Speed
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMaxSpeedForwardSample.json}
+     *
+     * - Max Speed Backward Speed
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMaxSpeedBackwardSample.json}
+     *
+     * - Stop Motor
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMotorStopSample.json}
+     *
+     * - Random Steer
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerRandomSample.json}
+     *
+     * - Steer Left
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerLeftSample.json}
+     *
+     * - Steer Right
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerRightSample.json}
+     *
+     * - Stop Steer
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerStopSample.json}
+     *
+     * - Motors Disabled
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645MotorsDisabledSample.json}
+     *
+     * - Motors Enabled
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645MotorsEnabledSample.json}
+     *
+     */
+    drive?: DT645Drive;
+    /**
+     * Heading
+     *
+     * The direction that the DT645 Utility Crawler is facing. Measured in degrees from north bearing.
+     *
+     * - Random Heading
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/heading/dt645HeadingRandomSample.json}
+     *
+     * @minimum 0
+     * @maximum 360
+     *
+     * @readonly
+     */
+    heading?: number;
+    /**
+     * Incline
+     *
+     * The angle at which the DT645 Utility Crawler is positioned relative to a flat surface.
+     *
+     * - Random Incline
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineRandomSample.json}
+     *
+     * - Min Incline
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineMinSample.json}
+     *
+     * - Max Incline
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineMaxSample.json}
+     *
+     * @minimum -180.0
+     * @maximum 180.0
+     */
+    incline?: number;
+    /**
+     * Pitch
+     *
+     * Measured in degrees from the neutral pitch position.
+     *
+     * - Random Pitch
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchRandomSample.json}
+     *
+     * - Min Pitch
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchMinSample.json}
+     *
+     * - Max Pitch
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchMaxSample.json}
+     *
+     * @minimum -180.0
+     * @maximum 180.0
+     *
+     * @minimum -180.0
+     * @maximum 180.0
+     *
+     * @readonly
+     */
+    pitch?: number;
+    /**
+     * Roll
+     *
+     * Rotation of the DT645 Utility Crawler around its front-to-back (longitudinal) axis.
+     *
+     * - Random Roll
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollRandomSample.json}
+     *
+     * - Min Roll
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollMinSample.json}
+     *
+     * - Max Roll
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollMaxSample.json}
+     *
+     * @minimum -180.0
+     * @maximum 180.0
+     */
+    roll?: number;
+    /** Usage Time
+     *
+     * ### Example Payloads
+     * #### GET Requests
+     *
+     * - Current seconds
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645CurrentSecondsRandomSample.json}
+     *
+     * - Total Seconds
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645TotalSecondsRandomSample.json}
+     *
+     * - Arbitrary Total Usage
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645UsageTimeRandomSample.json}
+     */
+    usageTime?: UsageTime;
+} & Vehicle;

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

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

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

@@ -2,10 +2,12 @@ import { Device, cygnusType } from "..";
 import { Cameras } from "../cameras/types";
 import { Removable } from "../../core";
 /**
+ * {@link IVehicle | 📖 See extended definition}
+ *
  * Vehicle interface provides a base interfaces for vehicle devices,
  * including ROVs and crawlers.
  *
- * @category Device
+ * @category Vehicle
  */
 export type Vehicle = {
     /**
@@ -33,3 +35,4 @@ export * from "./navigation";
 export * from "./crawlerDrive";
 export * from "./rovDrive";
 export * from "./onyx";
+export * from "./dt645";

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

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

package/package.json

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