@deeptrekker/api-domain 0.61.6 → 1.0.0

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

@@ -1,6 +1,13 @@
+/**
+ * Default Reel battery voltage
+ * @group Powered Reel
+ * @category Battery
+ */
 export declare const DEFAULT_REEL_BATTERY_VOLTAGE = 21;
 /**
  * A200 Battery Level thresholds
+ * @group A200
+ * @category Battery
  * @enum
  */
 export declare enum A200BatteryLevel {
@@ -11,6 +18,8 @@ export declare enum A200BatteryLevel {
 }
 /**
  * A150 Battery Level thresholds
+ * @group A150
+ * @category Battery
  * @enum
  */
 export declare enum A150BatteryLevel {
@@ -19,87 +28,125 @@ export declare enum A150BatteryLevel {
     Danger = 15,
     Shutdown = 3
 }
+/**
+ * Powered Reel battery level threshold
+ * @group Powered Reel
+ * @category Battery
+ * @enum
+ */
 export declare enum ReelBatteryLevel {
     FullyCharged = 100,
     Warning = 30,
     Danger = 15,
     Shutdown = 3
 }
+/**
+ * Pivot battery level threshold
+ * @group PIVOT
+ * @category Battery
+ * @enum
+ */
 export declare enum PivotBatteryLevel {
     Warning = 15,
     Shutdown = 0
 }
+/**
+ * Revolution battery level threshold
+ * @group REVOLUTION
+ * @category Battery
+ * @enum
+ */
 export declare enum RevolutionBatteryLevel {
     Warning = 10,
     Shutdown = 0
 }
+/**
+ * Pivot battery voltage threshold
+ * @group PIVOT
+ * @category Battery
+ * @enum
+ */
 export declare enum PivotBatteryVoltage {
     Max = 19.2,
     Min = 0
 }
+/**
+ * Pivot rotary position threshold
+ * @group PIVOT
+ * @category Rotary
+ * @enum
+ */
 export declare enum PivotRotaryPosition {
     Max = 110,
     Min = -90
 }
 /**
- * Rate modifer
- *
- * This is meant to be sent continuously in order to increment/decrement
- * certain values.
  *
+ *@remarks
+
+ * Used to indicate the desired rate of change for a specific parameter. (e.g. Zoom)
  * - 📉 Decrease = -1
  * - 📈 Increase = 1
  * - No Change = 0
+ * @group Devices
+ * @category Core
  */
 export type Rate = -1 | 0 | 1;
 /**
- * {@link IBattery | 📖 See extended definition}
  *
- * 🔋 Battery
- *
- * @category Devices/Core
- * @notExported
- * @readonly
+ * 🔋 Basic battery information
+ * @group Devices
+ * @category Battery
  */
 export type Battery = {
-    /** Battery voltage */
+    /**
+     * @remarks
+     * Battery voltage
+     * @readonly
+     */
     voltage?: number;
     /**
      * Battery charge percentage
      *
      * @minimum 0
      * @maximum 100
-     * @TJS-type integer
+     * @readonly
      */
     percent?: number;
     /**
      * Battery charging state
-     * @description Represents whether the battery is being charged or not
-     *
+     * @remarks Represents whether the battery is being charged or not
+     * @readonly
      */
     charging?: boolean;
+    /**
+     * @remarks Represents whether the battery is leaking or not
+     */
     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}
-     *
+     * @remarks
+     * Used to reset the reported charge cycles.
+     * @example
+     * ```json
+     * {
+     *   "resetChargeCycles": true
+     * }
+     * ```
      */
     resetChargeCycles?: boolean;
+    /**
+     * @remarks
+     * Advanced battery information.
+     * @see {@link BatteryDiagnostics | BatteryDiagnostics}
+     */
     diagnostics?: BatteryDiagnostics;
 };
 /**
- * BatteryDiagnostics
+ * Provides advanced battery diagnostics information.
  *
- * TODO: Add samples for all devices that use battery diagnostics
  *
- * @category Devices/Core
- * @notExported
+ * @category Diagnostics
+ * @group Devices
  * @readonly
  */
 export type BatteryDiagnostics = {
@@ -170,17 +217,15 @@ export type BatteryDiagnostics = {
      *
      * @minimum 0
      * @maximum 100
-     * @TJS-type integer
      */
     estimatedSoC?: number;
 };
 /**
- * {@link ICalibratable | 📖 See extended definition}
  *
  * Calibrated
  *
- * @category Devices/Core
- * @readonly
+ * @category Diagnostics
+ * @group Devices
  */
 export type Calibratable = {
     /**
@@ -195,11 +240,11 @@ export type Calibratable = {
     calibrator?: boolean;
 };
 /**
- * {@link IA200 | 📖 See extended definition}
  *
- * Motor Diagnostics
+ * Basic motor diagnostics.
  *
- * @category Devices/Core
+ * @category Diagnostics
+ * @group Devices
  */
 export type MotorDiagnostics = {
     /**
@@ -213,7 +258,6 @@ export type MotorDiagnostics = {
      *
      * @minimum 0
      * @maximum 100
-     * @TJS-type integer
      *
      * @readonly
      */
@@ -241,43 +285,44 @@ export type MotorDiagnostics = {
      */
     failure?: boolean;
 };
+/**
+ * @group Devices
+ * @category Crawlers
+ */
 export type VehicleHpDiagnostics = {
     /**
-     * Charge Voltage
-     *
-     * @description The voltage that goes from the hybrid power boards into the batteries
+     * @remarks The voltage that goes from the hybrid power boards into the batteries
      * @readonly
      */
     chargeVoltage?: number;
     /**
-     * Input Voltage
-     *
-     * @description The voltage that the vehicle is receiving from the reel
+     * @remarks The voltage that the vehicle is receiving from the reel
      * @readonly
      */
     inputVoltage?: number;
 };
 /**
- * {@link IRotaryJoint | 📖 See extended definition}
  *
  * Rotary Joint
  *
  * This joint can rotate around.
+ *
+ * @group Devices
+ * @category Peripherals
  */
 export type RotaryJoint = {
     /**
-     * Position
+     * @remarks
      *
      * The rotary position in degrees.
      *
-     * Pivot rotary position
-     *
      * @minimum -90
      * @maximum 110
      */
     position?: number;
     /**
-     * Joint Speed
+     * @remarks
+     * The rotary speed based on percentage (-100% to 100%).
      *
      * @minimum -100
      * @maximum 100
@@ -285,33 +330,43 @@ export type RotaryJoint = {
     speed?: number;
 };
 /**
- * {@link ICalibratableRotaryJoint | 📖 See extended definition}
  *
  * Calibratable Rotary Joint
  *
  * Allows specific calibration routines to be run on a rotary joint.
+ *
+ * @see {@link Calibratable | Calibratable}
+ * {@link RotaryJoint | RotaryJoint}
+ *
+ * @group Devices
+ * @category Peripherals
  */
 export type CalibratableRotaryJoint = RotaryJoint & Calibratable;
 /**
- * {@link IUsageTime | 📖 See extended definition}
- *
  * Usage Time
  *
  * The usage time of a device.
- *
- * @category Devices/Core
+ * @group Devices
+ * @category Core
  * @readonly
  */
 export type UsageTime = {
     /**
+     * @remarks
      * Total usage time in seconds.
      */
     totalSeconds?: number;
     /**
+     * @remarks
      * Current usage time in seconds.
      */
     currentSeconds?: number;
 };
+/**
+ * Snapshot intervals (in seconds) for auto snapshot feature.
+ * @category Cameras
+ * @group Devices
+ */
 export declare enum SnapshotIntervals {
     ONE = 1,
     TWO = 2,

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

@@ -1,9 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SnapshotIntervals = exports.PivotRotaryPosition = exports.PivotBatteryVoltage = exports.RevolutionBatteryLevel = exports.PivotBatteryLevel = exports.ReelBatteryLevel = exports.A150BatteryLevel = exports.A200BatteryLevel = exports.DEFAULT_REEL_BATTERY_VOLTAGE = void 0;
+/**
+ * Default Reel battery voltage
+ * @group Powered Reel
+ * @category Battery
+ */
 exports.DEFAULT_REEL_BATTERY_VOLTAGE = 21;
 /**
  * A200 Battery Level thresholds
+ * @group A200
+ * @category Battery
  * @enum
  */
 var A200BatteryLevel;
@@ -12,9 +19,11 @@ var A200BatteryLevel;
     A200BatteryLevel[A200BatteryLevel["Warning"] = 30] = "Warning";
     A200BatteryLevel[A200BatteryLevel["Danger"] = 15] = "Danger";
     A200BatteryLevel[A200BatteryLevel["Shutdown"] = 3] = "Shutdown";
-})(A200BatteryLevel = exports.A200BatteryLevel || (exports.A200BatteryLevel = {}));
+})(A200BatteryLevel || (exports.A200BatteryLevel = A200BatteryLevel = {}));
 /**
  * A150 Battery Level thresholds
+ * @group A150
+ * @category Battery
  * @enum
  */
 var A150BatteryLevel;
@@ -23,34 +32,69 @@ var A150BatteryLevel;
     A150BatteryLevel[A150BatteryLevel["Warning"] = 30] = "Warning";
     A150BatteryLevel[A150BatteryLevel["Danger"] = 15] = "Danger";
     A150BatteryLevel[A150BatteryLevel["Shutdown"] = 3] = "Shutdown";
-})(A150BatteryLevel = exports.A150BatteryLevel || (exports.A150BatteryLevel = {}));
+})(A150BatteryLevel || (exports.A150BatteryLevel = A150BatteryLevel = {}));
+/**
+ * Powered Reel battery level threshold
+ * @group Powered Reel
+ * @category Battery
+ * @enum
+ */
 var ReelBatteryLevel;
 (function (ReelBatteryLevel) {
     ReelBatteryLevel[ReelBatteryLevel["FullyCharged"] = 100] = "FullyCharged";
     ReelBatteryLevel[ReelBatteryLevel["Warning"] = 30] = "Warning";
     ReelBatteryLevel[ReelBatteryLevel["Danger"] = 15] = "Danger";
     ReelBatteryLevel[ReelBatteryLevel["Shutdown"] = 3] = "Shutdown";
-})(ReelBatteryLevel = exports.ReelBatteryLevel || (exports.ReelBatteryLevel = {}));
+})(ReelBatteryLevel || (exports.ReelBatteryLevel = ReelBatteryLevel = {}));
+/**
+ * Pivot battery level threshold
+ * @group PIVOT
+ * @category Battery
+ * @enum
+ */
 var PivotBatteryLevel;
 (function (PivotBatteryLevel) {
     PivotBatteryLevel[PivotBatteryLevel["Warning"] = 15] = "Warning";
     PivotBatteryLevel[PivotBatteryLevel["Shutdown"] = 0] = "Shutdown";
-})(PivotBatteryLevel = exports.PivotBatteryLevel || (exports.PivotBatteryLevel = {}));
+})(PivotBatteryLevel || (exports.PivotBatteryLevel = PivotBatteryLevel = {}));
+/**
+ * Revolution battery level threshold
+ * @group REVOLUTION
+ * @category Battery
+ * @enum
+ */
 var RevolutionBatteryLevel;
 (function (RevolutionBatteryLevel) {
     RevolutionBatteryLevel[RevolutionBatteryLevel["Warning"] = 10] = "Warning";
     RevolutionBatteryLevel[RevolutionBatteryLevel["Shutdown"] = 0] = "Shutdown";
-})(RevolutionBatteryLevel = exports.RevolutionBatteryLevel || (exports.RevolutionBatteryLevel = {}));
+})(RevolutionBatteryLevel || (exports.RevolutionBatteryLevel = RevolutionBatteryLevel = {}));
+/**
+ * Pivot battery voltage threshold
+ * @group PIVOT
+ * @category Battery
+ * @enum
+ */
 var PivotBatteryVoltage;
 (function (PivotBatteryVoltage) {
     PivotBatteryVoltage[PivotBatteryVoltage["Max"] = 19.2] = "Max";
     PivotBatteryVoltage[PivotBatteryVoltage["Min"] = 0] = "Min";
-})(PivotBatteryVoltage = exports.PivotBatteryVoltage || (exports.PivotBatteryVoltage = {}));
+})(PivotBatteryVoltage || (exports.PivotBatteryVoltage = PivotBatteryVoltage = {}));
+/**
+ * Pivot rotary position threshold
+ * @group PIVOT
+ * @category Rotary
+ * @enum
+ */
 var PivotRotaryPosition;
 (function (PivotRotaryPosition) {
     PivotRotaryPosition[PivotRotaryPosition["Max"] = 110] = "Max";
     PivotRotaryPosition[PivotRotaryPosition["Min"] = -90] = "Min";
-})(PivotRotaryPosition = exports.PivotRotaryPosition || (exports.PivotRotaryPosition = {}));
+})(PivotRotaryPosition || (exports.PivotRotaryPosition = PivotRotaryPosition = {}));
+/**
+ * Snapshot intervals (in seconds) for auto snapshot feature.
+ * @category Cameras
+ * @group Devices
+ */
 var SnapshotIntervals;
 (function (SnapshotIntervals) {
     SnapshotIntervals[SnapshotIntervals["ONE"] = 1] = "ONE";
@@ -62,4 +106,4 @@ var SnapshotIntervals;
     SnapshotIntervals[SnapshotIntervals["FIFTEEN"] = 15] = "FIFTEEN";
     SnapshotIntervals[SnapshotIntervals["THIRTY"] = 30] = "THIRTY";
     SnapshotIntervals[SnapshotIntervals["SIXTY"] = 60] = "SIXTY";
-})(SnapshotIntervals = exports.SnapshotIntervals || (exports.SnapshotIntervals = {}));
+})(SnapshotIntervals || (exports.SnapshotIntervals = SnapshotIntervals = {}));

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

@@ -1,7 +1,7 @@
 /**
  * RovInputDiagnostics
- *
- * @category Devices/Diagnostics
+ * @group Devices
+ * @category Diagnostics
  */
 export type RovInputDiagnostics = {
     /**

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

@@ -1,12 +1,7 @@
-/**
- * TODO: API Domain - Constants and Types - Separate Concerns
- *
- * Currently we have a muddled mix of both types and constants under this type file, as well as other type files in this repo.
- * We should utilize the constants folder for these constants and remove them from all type files.
- */
 /**
  * Deep Trekker internal device model numbers.
- * TODO: add all model numbers
+ * @category Core
+ * @group Devices
  */
 export declare enum DeviceModel {
     A150Crawler = 20,
@@ -23,13 +18,13 @@ export declare enum DeviceModel {
     Revolution = 13,
     Pivot = 18,
     X4 = 32,
-    X4PCM = 112,
-    X4PDM = 113,
-    X4Thruster = 114,
+    X4PCM = 112,// DNE
+    X4PDM = 113,// DNE
+    X4Thruster = 114,// DNE
     X4Lights = 115,
     X4BrushedMotor = 116,
-    X4SensorPod = 117,
-    X4Grabber = 118,
+    X4SensorPod = 117,// DNE
+    X4Grabber = 118,// DNE
     RevolutionCameraHead = 102,
     PivotCameraHead = 103,
     A150CameraHead = 109,
@@ -43,6 +38,11 @@ export declare enum DeviceModel {
     DVL = 202,
     WATERLINKED_3D_SONAR = 245
 }
+/**
+ * Deep Trekker's Bandwidth Degradation Thresholds
+ * @group Devices
+ * @category Diagnostics
+ */
 export declare enum BandwidthDegradationThreshold {
     OK = 100,
     Minor = 50,
@@ -51,10 +51,20 @@ export declare enum BandwidthDegradationThreshold {
     High = 20,
     Extreme = 10
 }
+/**
+ * Deep Trekker's CPU Temperature Thresholds
+ * @group Devices
+ * @category Diagnostics
+ */
 export declare enum CpuTemperatureThreshold {
     Low = -15,
     High = 75
 }
+/**
+ * Deep Trekker's Camera Device Model Labels
+ * @group Devices
+ * @category Cameras
+ */
 export declare const CAMERA_DEVICE_MODEL_LABELS: {
     readonly 206: "4K UHD Camera";
     readonly 240: "Zoom Camera H";
@@ -63,6 +73,11 @@ export declare const CAMERA_DEVICE_MODEL_LABELS: {
     readonly 207: "Zoom Camera JZC";
     readonly 241: "Mini Aux Camera";
 };
+/**
+ * Deep Trekker's Vehicle Device Model Labels
+ * @group Devices
+ * @category Vehicles
+ */
 export declare const VEHICLE_DEVICE_MODEL_LABELS: {
     readonly 20: "A-150";
     readonly 19: "A-200";
@@ -71,17 +86,37 @@ export declare const VEHICLE_DEVICE_MODEL_LABELS: {
     readonly 24: "PHOTON";
     readonly 16: "ONYX";
 };
+/**
+ * Deep Trekker's Camera Head Device Model Labels
+ * @group Devices
+ * @category Camera Heads
+ */
 export declare const CAMERA_HEAD_DEVICE_MODEL_LABELS: {
     readonly 109: "A-150 Camera Head";
     readonly 106: "A-200 Camera Head";
     readonly 102: "REVOLUTION Camera Head";
     readonly 103: "PIVOT Camera Head";
 };
+/**
+ * Deep Trekker's Reel Device Model Labels
+ * @group Devices
+ * @category Reels
+ */
 export declare const REEL_DEVICE_MODEL_LABELS: {
     readonly 107: "Tether Reel";
     readonly 108: "Powered Tether Reel";
 };
+/**
+ * Deep Trekker's Camera Device Models
+ * @group Devices
+ * @category Cameras
+ */
 export declare const CAMERA_DEVICE_MODELS: readonly [DeviceModel.TamronHarrierZoomCamera, DeviceModel.DTCam, DeviceModel.OcleaCam, DeviceModel.TamronOcleaZoomCamera, DeviceModel.MiniAuxCamera, DeviceModel.JZC18ZoomCamera];
+/**
+ * Deep Trekker's Device Model Labels
+ * @group Devices
+ * @category Core
+ */
 export declare const DEVICE_MODEL_LABELS: {
     readonly BRIDGEBOX: "BridgeBox";
     readonly 245: "Water Linked 3D Sonar";
@@ -104,19 +139,35 @@ export declare const DEVICE_MODEL_LABELS: {
     readonly 207: "Zoom Camera JZC";
     readonly 241: "Mini Aux Camera";
 };
+/**
+ * Deep Trekker's Camera Head Device Models
+ * @group Devices
+ * @category Camera Heads
+ */
 export declare const CAMERA_HEAD_DEVICE_MODELS: readonly [DeviceModel.A150CameraHead, DeviceModel.A200CameraHead, DeviceModel.RevolutionCameraHead, DeviceModel.PivotCameraHead];
+/**
+ * Deep Trekker's Vehicle Device Models
+ * @group Devices
+ * @category Vehicles
+ */
 export declare const VEHICLE_DEVICE_MODELS: DeviceModel[];
+/**
+ * Deep Trekker's Crawler Device Models
+ * @group Devices
+ * @category Crawlers
+ */
 export declare const CRAWLER_DEVICE_MODELS: readonly [DeviceModel.A150Crawler, DeviceModel.A200Crawler];
+/**
+ * Deep Trekker's Reel Device Models
+ * @group Devices
+ * @category Reels
+ */
 export declare const REEL_DEVICE_MODELS: readonly [DeviceModel.ManualReel, DeviceModel.PoweredReel];
 /**
- * {@link IVersion | 📖 See extended definition}
- *
- * Device Version
- *
  * Device Version is a base interface for hardware and software version sample payloads.
  * -1 hardware versions and 0.0 software versions refer to not applicable
- *
- * @category DeviceVersions
+ * @group Devices
+ * @category Software Updates
  */
 export type DeviceVersion = {
     hardware?: string;
@@ -124,7 +175,6 @@ export type DeviceVersion = {
     branchInfo?: string;
 };
 /**
- * {@link IDevice | 📖 See extended definition}
  *
  * Device
  *
@@ -134,12 +184,14 @@ export type DeviceVersion = {
  * appropriate schema must be selected. This can be done by parsing the
  * device's @param model and mapping the associated device schema.
  *
- * @category Devices
+ * @group Devices
+ * @category Core
  */
 export type Device = {
     /**
      * Deep Trekker internal device model numbers. This can be used for
      * selecting the associated device schema.
+     * @see {@link DeviceModel | DeviceModel}
      */
     model: DeviceModel;
     /**
@@ -147,13 +199,24 @@ export type Device = {
      */
     ip?: string;
     /**
-     * Version
+     * @remarks
+     * Version info for the device
+     * @example
+     * ```json
+     * {
+     *  "hardware": "1.0.0", //Hardware version of the device.
+     *  "software": "1.0.0", //Software version of the device.
+     *  "branchInfo": "main" //Branch that the software was compiled from
+     * }
+     * ```
+     * @see {@link DeviceVersion | DeviceVersion}
      */
     version?: DeviceVersion;
 };
 export * from "./cameraHeads";
 export * from "./cameras";
 export * from "./core";
+export * from "./diagnostics";
 export * from "./peripherals";
 export * from "./reels";
 export * from "./types";