@deeptrekker/api-domain 0.61.6 → 1.0.1

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

@@ -1,18 +1,33 @@
 import { Device } from "../../cameraHeads";
+/**
+ * Calibration states for the sensor pod.
+ * @group Devices
+ * @category Sensor Pods
+ */
 export declare enum CalibrationStates {
-    CALIBRATION_ACCEPTED = 0,
-    CALIBRATION_PENDING = 1,
-    CALIBRATION_START = 2,
-    CALIBRATION_STOP = 3,
-    CALIBRATION_ACCEPT = 4,
-    CALIBRATION_DENY = 5,
+    CALIBRATION_ACCEPTED = 0,//Running with calibration.
+    CALIBRATION_PENDING = 1,//Currently calibrating or pending user acceptance.
+    CALIBRATION_START = 2,//move to calibrating state.
+    CALIBRATION_STOP = 3,//move to not calibrating state.
+    CALIBRATION_ACCEPT = 4,//move to CALIBRATION_ACCEPTED state and use Pending results.
+    CALIBRATION_DENY = 5,//move to CALIBRATION_ACCEPTED but use previous Values and discard the pending results.
     CALIBRATION_FAILED = 6
 }
+/**
+ * Sensor biases for the sensor pod.
+ * @group Devices
+ * @category Sensor Pods
+ */
 export type SensorBias = {
     x?: number;
     y?: number;
     z?: number;
 };
+/**
+ * Calibratable sensor biases for the sensor pod.
+ * @group Devices
+ * @category Sensor Pods
+ */
 export type CalibratableSensorBias = SensorBias & {
     pending?: {
         x?: number;
@@ -20,6 +35,11 @@ export type CalibratableSensorBias = SensorBias & {
         z?: number;
     };
 };
+/**
+ * Sensor pod representation.
+ * @group Devices
+ * @category Sensor Pods
+ */
 export type SensorPod = {
     /**
      * The unique identifier of the sensor pod, typically a MAC address.
@@ -38,7 +58,7 @@ export type SensorPod = {
          */
         state?: CalibrationStates;
         /**
-         * Gyro biases. Both Current and pending calibrated biases (if applicable)
+         * Gyro biases. Both Current and pending calibrated biases (if applicable)F
          */
         gyroBias?: CalibratableSensorBias;
         /**
@@ -61,4 +81,10 @@ export type SensorPod = {
         state?: CalibrationStates;
     };
 };
+/**
+ * Calibratable sensor pod representation.
+ * Combines the properties of a SensorPod with those of a Device.
+ * @group Devices
+ * @category Sensor Pods
+ */
 export type CalibratableSensorPod = SensorPod & Device;

package/dist/types/devices/peripherals/sensorPod/index.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CalibrationStates = void 0;
+/**
+ * Calibration states for the sensor pod.
+ * @group Devices
+ * @category Sensor Pods
+ */
 var CalibrationStates;
 (function (CalibrationStates) {
     //Backend States
@@ -12,4 +17,4 @@ var CalibrationStates;
     CalibrationStates[CalibrationStates["CALIBRATION_ACCEPT"] = 4] = "CALIBRATION_ACCEPT";
     CalibrationStates[CalibrationStates["CALIBRATION_DENY"] = 5] = "CALIBRATION_DENY";
     CalibrationStates[CalibrationStates["CALIBRATION_FAILED"] = 6] = "CALIBRATION_FAILED";
-})(CalibrationStates = exports.CalibrationStates || (exports.CalibrationStates = {}));
+})(CalibrationStates || (exports.CalibrationStates = CalibrationStates = {}));

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

@@ -1,8 +1,23 @@
 import { DeviceModel, ManualReel, PoweredReel } from "../..";
 import { Match } from "../../../core";
+/**
+ * Reel model types
+ * @group Devices
+ * @category Reels
+ */
 export type ReelModelMap = {
     [DeviceModel.ManualReel]: ManualReel;
     [DeviceModel.PoweredReel]: PoweredReel;
 };
+/**
+ * Extract the reel device type from the model type
+ * @group Devices
+ * @category Reels
+ */
 export type ReelDeviceFromModel<T> = Match<T, ReelModelMap>;
+/**
+ * Reel model types
+ * @group Devices
+ * @category Reels
+ */
 export type ReelModels = DeviceModel.PoweredReel | DeviceModel.ManualReel;

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

@@ -1,17 +1,18 @@
 import { Calibratable, Device } from "..";
 /**
  * Reel Temperature level thresholds
+ * @group Devices
+ * @category Reels
  */
 export declare enum ReelTemperatureThreshold {
     Warning = 75,
     Danger = 85
 }
 /**
- * {@link IReel | 📖 See extended definition}
  *
  * Reel
- *
- * @category Devices/Reels
+ * @group Devices
+ * @category Reels
  */
 export type Reel = {
     /**
@@ -23,17 +24,20 @@ export type Reel = {
     /**
      * Section tether distance
      *
-     * @description relative payed out tether distance, given in cm. This can be overwritten to set a value from the UI. This is used to keep track of the relative payed out tether, which is different from 'totalDistance',
+     * @remarks relative payed out tether distance, given in cm. This can be overwritten to set a value from the UI. This is used to keep track of the relative payed out tether, which is different from 'totalDistance',
      *
      */
     distance?: number;
     /**
      * Total tether distance
      *
-     * @description total payed out tether distance, given in cm. This can be overwritten to set a value from the UI. This is used to keep track of the total payed out tether distance even after having reset the 'distance' property.
-     *
-     * #### Reel total distance random sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/totalDistance/poweredReelTotalDistanceRandomSample.json}
+     * @remarks total payed out tether distance, given in cm. This can be overwritten to set a value from the UI. This is used to keep track of the total payed out tether distance even after having reset the 'distance' property.
+     * @example
+     * ```json
+     * {
+     *   "totalDistance": 100
+     * }
+     * ```
      */
     totalDistance?: number;
     /**
@@ -46,15 +50,12 @@ export type Reel = {
      * Encoder failure detection
      *
      * @readonly
-     *
-     * #### Reel encoder failed random sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/encoderFailed/poweredReelEncoderFailedRandomSample.json}
-     *
-     * #### Reel encoder failed sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/encoderFailed/poweredReelHasEncoderFailedSample.json}
-     *
-     * #### Reel encoder not failed sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/encoderFailed/poweredReelHasNoEncoderFailedSample.json}
+     * @example
+     * ```json
+     * {
+     *   "encoderFailed": true
+     * }
+     * ```
      */
     encoderFailed?: boolean;
     /**

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

@@ -17,12 +17,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReelTemperatureThreshold = void 0;
 /**
  * Reel Temperature level thresholds
+ * @group Devices
+ * @category Reels
  */
 var ReelTemperatureThreshold;
 (function (ReelTemperatureThreshold) {
     ReelTemperatureThreshold[ReelTemperatureThreshold["Warning"] = 75] = "Warning";
     ReelTemperatureThreshold[ReelTemperatureThreshold["Danger"] = 85] = "Danger";
-})(ReelTemperatureThreshold = exports.ReelTemperatureThreshold || (exports.ReelTemperatureThreshold = {}));
+})(ReelTemperatureThreshold || (exports.ReelTemperatureThreshold = ReelTemperatureThreshold = {}));
 __exportStar(require("./core"), exports);
 __exportStar(require("./manualReel"), exports);
 __exportStar(require("./poweredReel"), exports);

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

@@ -1,10 +1,10 @@
 import { DeviceModel, Reel } from "../..";
 /**
- * {@link IManualReel | 📖 See extended definition}
  *
  * Manual Reel
  *
- * @category Devices/Reels
+ * @group Manual Reel
+ * @category Core
  */
 export type ManualReel = {
     model: DeviceModel.ManualReel;

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

@@ -1,139 +1,152 @@
 import { Battery, DeviceModel, MotorDiagnostics, Reel, SpragBearing, UsageTime } from "../..";
 /**
- * {@link IPoweredReel | 📖 See extended definition}
  *
  * Powered Reel
- *
- * @category Devices/Reels
+ * @group Powered Reel
+ * @category Core
  * @summary
  * ![Reel](https://images.ctfassets.net/kzewhs8e6cvu/4AqzRgyN4W0dIXmBdwvdlx/3cc7b4ba22805653b086795e4209c5de/dt300_pipe_crawler_series-powered_reel.jpg?fm=webp&w=350&h=200&fit=fill)
  */
 export type PoweredReel = {
     model: DeviceModel.PoweredReel;
     /** Powered Reel Batteries 1
-     * ### Example Payload
-     * #### Reel Battery Danger State Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/battery/battery1/poweredReelBattery1DangerSample.json}
-     *
-     * #### Reel Battery Random State Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/battery/battery1/poweredReelBattery1RandomSample.json}
-     *
-     * #### Reel Battery Shutdown State Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/battery/battery1/poweredReelBattery1ShutdownSample.json}
-     *
-     * #### Reel Battery Warning State Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/battery/battery1/poweredReelBattery1WarningSample.json}
+     * @see {@link Battery | Battery}
      */
     battery1?: Battery;
     /** Powered Reel Batteries 2
-     * ### Example Payload
-     * #### Reel Battery Danger State Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/battery/battery2/poweredReelBattery2DangerSample.json}
-     *
-     * #### Reel Battery Random State Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/battery/battery2/poweredReelBattery2RandomSample.json}
-     *
-     * #### Reel Battery Shutdown State Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/battery/battery2/poweredReelBattery2ShutdownSample.json}
-     *
-     * #### Reel Battery Warning State Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/battery/battery2/poweredReelBattery2WarningSample.json}
+     * @see {@link Battery | Battery}
      */
     battery2?: Battery;
-    /** Physical Button States */
+    /**
+     * @remarks Indicates whether the physical e-stop button is engaged.
+     * @example
+     * ```json
+     * {
+     *   "eStop": true
+     * }
+     * ```
+     * @readonly
+     */
     eStop?: boolean;
+    /**
+     * @remarks Indicates if the rocker switch on the reel is engaged and if the reel itself is **disengaged** (This function doesn't actually forcibly spool out the reel)
+     * @example
+     * ```json
+     * {
+     *   "reelForward": true
+     * }
+     * ```
+     * @readonly
+     */
     reelForward?: boolean;
+    /**
+     * @remarks Indicates if the rocker switch on the reel is engaged and if the reel itself is spooling in.
+     * @example
+     * ```json
+     * {
+     *   "reelReverse": true
+     * }
+     * ```
+     * @readonly
+     */
     reelReverse?: boolean;
+    /**
+     * @remarks Indicates if the rocker switch is engaged and if the crawler is moving forward.
+     * @example
+     * ```json
+     * {
+     *   "crawlerForward": true
+     * }
+     * ```
+     * @readonly
+     */
     crawlerForward?: boolean;
+    /**
+     * @remarks Indicates if the rocker switch is engaged and if the crawler is moving in reverse.
+     * @example
+     * ```json
+     * {
+     *   "crawlerReverse": true
+     * }
+     * ```
+     * @readonly
+     */
     crawlerReverse?: boolean;
     /**
      * Reel Drive Speed
-     * @description Negative values for reverse (retract), positive for forward (payout)
-     *
+     * @remarks Negative values for reverse (retract), positive for forward (payout)
+     * @example
+     * ```json
+     * {
+     *   "speed": 100
+     * }
+     * ```
      * @minimum -120
      * @maximum 120
      */
     speed?: number;
     /**
      * Hybrid Power Enabled
-     * @description Represents the actual state of whether power is enabled or not.
-     *
+     * @remarks Represents the actual state of whether hybrid power is enabled or not.
+     * @example
+     * ```json
+     * {
+     *   "hybridPower": true
+     * }
+     * ```
      */
     hybridPower?: boolean;
     /**
      * Usage Time
-     * @description Represents the current running and lifetime usage of the device.
+     * @remarks Represents the current running and lifetime usage of the device.
      * @readonly
-     *
-     * #### Powered Reel Random Usage Time Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/usageTime/poweredReelUsageTimeRandomSample.json}
+     * @see {@link UsageTime | UsageTime}
      */
     usageTime?: UsageTime;
     /** Motor 1 Diagnostics
      *
-     * #### Powered Reel Motor 1 Random Motor Diagnostics Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/motorDiagnostics/motor1/poweredReelMotor1DiagnosticsRandomSample.json}
-     *
-     * #### Powered Reel Motor 1 Resting Motor Diagnostics Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/motorDiagnostics/motor1/poweredReelMotor1DiagnosticsRestingSample.json}
+     * @see {@link MotorDiagnostics | MotorDiagnostics}
      */
     motor1Diagnostics?: MotorDiagnostics;
     /** Motor 2 Diagnostics
      *
-     * #### Powered Reel Motor 2 Random Motor Diagnostics Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/motorDiagnostics/motor2/poweredReelMotor2DiagnosticsRandomSample.json}
-     *
-     * #### Powered Reel Motor 2 Resting Motor Diagnostics Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/motorDiagnostics/motor2/poweredReelMotor2DiagnosticsRestingSample.json}
+     * @see {@link MotorDiagnostics | MotorDiagnostics}
      */
     motor2Diagnostics?: MotorDiagnostics;
     /**
      * AC Connected
-     * @description Represents whether AC power cable is connected or not.
+     * @remarks Represents whether AC power cable is connected or not.
      */
     acConnected?: boolean;
     /**
      * Encoder miscalibration detection
      *
+     * @example
+     * ```json
+     * {
+     *   "encoderMiscalibrated": true
+     * }
+     * ```
      * @readonly
-     *
-     * #### Reel encoder miscalibrated random sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/encoderMiscalibrated/poweredReelEncoderMiscalibratedRandomSample.json}
-     *
-     * #### Reel encoder miscalibrated sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/encoderMiscalibrated/poweredReelHasEncoderMiscalibratedSample.json}
-     *
-     * #### Reel encoder not miscalibrated sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/encoderMiscalibrated/poweredReelHasNoEncoderMiscalibratedSample.json}
      */
     encoderMiscalibrated?: boolean;
     /**
      * Reel stalled
      *
+     * @example
+     * ```json
+     * {
+     *   "stalled": true
+     * }
+     * ```
      * @readonly
-     *
-     * #### Reel stalled random sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/stalled/poweredReelStalledRandomSample.json}
-     *
-     * #### Reel stalled sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/stalled/poweredReelHasStalledSample.json}
-     *
-     * #### Reel not stalled sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/stalled/poweredReelHasNoStalledSample.json}
      */
     stalled?: boolean;
     /**
      * Sprag Bearing
-     * @description Represents the actual state of the sprag bearing.
-     *
-     * #### Reel Sprag Bearing FKNN6204-2RS Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/spragBearing/poweredReelSpragBearingFKNN62042RSSample.json}
-     *
-     * #### Reel Sprag Bearing FKNN6205-2RS Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/spragBearing/poweredReelSpragBearingFKNN62052RSSample.json}
+     * @remarks Represents the actual state of the sprag bearing.
      *
-     * #### Reel Sprag Bearing Random Sample
-     * {@codeblock ~~/dist/samples/json/requests/devices/reels/poweredReels/spragBearing/poweredReelSpragBearingRandomSample.json}
+     * @see {@link SpragBearing | SpragBearing}
      */
     spragBearing?: SpragBearing;
 } & Reel;

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

@@ -1,3 +1,8 @@
+/**
+ * Sprag Bearing Types
+ * @group Devices
+ * @category Reels
+ */
 export declare enum SpragBearing {
     FKNN62042RS = "FKNN6204-2RS",
     FKNN62052RS = "FKNN6205-2RS"

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

@@ -1,8 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SpragBearing = void 0;
+/**
+ * Sprag Bearing Types
+ * @group Devices
+ * @category Reels
+ */
 var SpragBearing;
 (function (SpragBearing) {
     SpragBearing["FKNN62042RS"] = "FKNN6204-2RS";
     SpragBearing["FKNN62052RS"] = "FKNN6205-2RS";
-})(SpragBearing = exports.SpragBearing || (exports.SpragBearing = {}));
+})(SpragBearing || (exports.SpragBearing = SpragBearing = {}));

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

@@ -1,5 +1,11 @@
+/**
+ * Denotes the origin of the serial device.
+ * @category Serial
+ * @group Devices
+ */
 export declare enum SerialDeviceType {
     /**
+     * @remarks
      * Serial device directly connected to ROV
      */
     Rov = "ROV",
@@ -16,32 +22,44 @@ export declare enum SerialDeviceType {
      */
     Controller = "Controller"
 }
+/**
+ * Handler for serial-over-ip. Allows for the topside controller to transmit data to/from the vehicle/peripheral to/from another system. (i.e. Side-scan sonar, topside GPS)
+ *
+ * @category Serial
+ * @group Devices
+ */
 export type SerialDevice = {
     /**
+     * @remarks
      * The id of the device that this device is connected to.
      * If null then this device is not connected to anything
      */
     connectionId?: string;
     /**
+     * @remarks
      * The name of the device that this device is connected to.
      * if null then this device is not connected to anything.
      * This is purely provided for convenience. If a name change is required send an update to the actual device.
      */
     connectionName?: string;
     /**
+     * @remarks
      * Indicates the type of device
      */
     deviceType?: SerialDeviceType;
     /**
+     * @remarks
      * The baud rate for the serial device.
      * This value is meaningless with deviceType::Web
      */
     baudRate?: number;
     /**
+     * @remarks
      * The display name of this device
      */
     name: string;
     /**
+     * @remarks
      * Denotes if a serial device is configurable by the user.
      * Typically, un-configurable devices will not accept Baud Rate from users.
      */

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

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SerialDeviceType = void 0;
+/**
+ * Denotes the origin of the serial device.
+ * @category Serial
+ * @group Devices
+ */
 var SerialDeviceType;
 (function (SerialDeviceType) {
     /**
+     * @remarks
      * Serial device directly connected to ROV
      */
     SerialDeviceType["Rov"] = "ROV";
@@ -19,4 +25,4 @@ var SerialDeviceType;
      * Serial device connected to the controller or bridgebox
      */
     SerialDeviceType["Controller"] = "Controller";
-})(SerialDeviceType = exports.SerialDeviceType || (exports.SerialDeviceType = {}));
+})(SerialDeviceType || (exports.SerialDeviceType = SerialDeviceType = {}));

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

@@ -1,12 +1,27 @@
 import { Device } from "..";
+/**
+ * Sonar frequency levels
+ * @group Devices
+ * @category Peripherals
+ */
 export declare enum SonarFrequency {
     High = "HIGH",
     Low = "LOW"
 }
+/**
+ * Sonar models
+ * @group Devices
+ * @category Peripherals
+ */
 export declare enum SonarModel {
     Oculus = "oculus",
     Tritech = "tritech"
 }
+/**
+ * Sonar
+ * @group Devices
+ * @category Peripherals
+ */
 export type Sonar = {
     /**
      * The range of the sonar
@@ -65,6 +80,11 @@ export type Sonar = {
      */
     ip?: string;
 };
+/**
+ * Sonar 3D
+ * @group Devices
+ * @category Peripherals
+ */
 export type Sonar3D = {
     mac?: string;
 } & Omit<Device, "version">;

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

@@ -1,13 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SonarModel = exports.SonarFrequency = void 0;
+/**
+ * Sonar frequency levels
+ * @group Devices
+ * @category Peripherals
+ */
 var SonarFrequency;
 (function (SonarFrequency) {
     SonarFrequency["High"] = "HIGH";
     SonarFrequency["Low"] = "LOW";
-})(SonarFrequency = exports.SonarFrequency || (exports.SonarFrequency = {}));
+})(SonarFrequency || (exports.SonarFrequency = SonarFrequency = {}));
+/**
+ * Sonar models
+ * @group Devices
+ * @category Peripherals
+ */
 var SonarModel;
 (function (SonarModel) {
     SonarModel["Oculus"] = "oculus";
     SonarModel["Tritech"] = "tritech";
-})(SonarModel = exports.SonarModel || (exports.SonarModel = {}));
+})(SonarModel || (exports.SonarModel = SonarModel = {}));

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

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

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

@@ -1,5 +1,7 @@
 /**
  * A150 Temperature level thresholds
+ * @group A150
+ * @category Core
  */
 export declare enum A150TemperatureThreshold {
     Warning = 75,

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

@@ -3,9 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.A150TemperatureThreshold = void 0;
 /**
  * A150 Temperature level thresholds
+ * @group A150
+ * @category Core
  */
 var A150TemperatureThreshold;
 (function (A150TemperatureThreshold) {
     A150TemperatureThreshold[A150TemperatureThreshold["Warning"] = 75] = "Warning";
     A150TemperatureThreshold[A150TemperatureThreshold["Danger"] = 85] = "Danger";
-})(A150TemperatureThreshold = exports.A150TemperatureThreshold || (exports.A150TemperatureThreshold = {}));
+})(A150TemperatureThreshold || (exports.A150TemperatureThreshold = A150TemperatureThreshold = {}));