@deeptrekker/api-domain 0.61.5 → 1.0.0

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

@@ -3,17 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PivotOperatingTemperatureRange = exports.PivotTemperatureThreshold = void 0;
 /**
  * Pivot temperature level thresholds (internal components)
+ * @group PIVOT
+ * @category Core
  */
 var PivotTemperatureThreshold;
 (function (PivotTemperatureThreshold) {
     PivotTemperatureThreshold[PivotTemperatureThreshold["Warning"] = 75] = "Warning";
     PivotTemperatureThreshold[PivotTemperatureThreshold["Danger"] = 85] = "Danger";
-})(PivotTemperatureThreshold = exports.PivotTemperatureThreshold || (exports.PivotTemperatureThreshold = {}));
+})(PivotTemperatureThreshold || (exports.PivotTemperatureThreshold = PivotTemperatureThreshold = {}));
 /**
  * Pivot operating temperature range (in water)
+ * @group PIVOT
+ * @category Core
  */
 var PivotOperatingTemperatureRange;
 (function (PivotOperatingTemperatureRange) {
     PivotOperatingTemperatureRange[PivotOperatingTemperatureRange["Min"] = -10] = "Min";
     PivotOperatingTemperatureRange[PivotOperatingTemperatureRange["Max"] = 50] = "Max";
-})(PivotOperatingTemperatureRange = exports.PivotOperatingTemperatureRange || (exports.PivotOperatingTemperatureRange = {}));
+})(PivotOperatingTemperatureRange || (exports.PivotOperatingTemperatureRange = PivotOperatingTemperatureRange = {}));

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

@@ -3,366 +3,122 @@ import { Removable } from "../../../core";
 import { DeviceModel, DeviceVersion, Grabber, Light, TiltPlatform } from "../..";
 import { MotorDiagnostics, Battery, UsageTime } from "../../core";
 import { TiltCameraHead } from "../../cameraHeads/tiltCameraHead";
-import { Rov } from "../rov";
+import { RovVehicle } from "../rov";
 /**
- * {@link IPivot | 📖 See extended definition}
  * Pivot Class
  *
- * @description Pivot vehicle type.
- *
- * @category Devices/Vehicles
+ * @remarks Pivot vehicle type.
+ * @group PIVOT
+ * @category Core
  */
 export type Pivot = {
     model: DeviceModel.Pivot;
     /** Camera Head
-     *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Pivot camera head
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/cameraHead/pivotCameraHeadRequest.json}
+     * @remarks
+     * Controls for the camera head
+     * @see {@link TiltCameraHead | TiltCameraHead}
      *
      */
     cameraHead?: Removable<TiltCameraHead>;
     /** Aux Light
      *
      * Controls the auxiliary light attached to the Revolution.
-     *
-     * ### Example Payloads
-     * #### SET Requests
-     *
-     * - Lights On (mid)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/auxLight/pivotAuxLightOnMidIntensitySample.json}
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMidIntensitySample.json}
-     *
-     * - Lights Off
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOffSample.json}
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/auxLight/pivotAuxLightOffSample.json}
-     *
-     * - Lights On (max)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/auxLight/pivotAuxLightOnMaxIntensitySample.json}
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMaxIntensitySample.json}
-     *
-     * - Arbitrary
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/auxLight/pivotAuxLightRandomSample.json}
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightRandomSample.json}
+     * @see {@link Light | Light}
      */
     auxLight?: Light;
     /** Grabber
      *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Resting pivot grabber
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRestingGrabberSample.json}
-     *
-     * - Resting pivot openClose grabber diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotGrabberOpenCloseMotorDiagnosticRestingSample.json}
-     *
-     * - Resting pivot rotate grabber diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotGrabberRotateMotorDiagnosticsRestingSample.json}
-     *
-     * - Random pivot rotate grabber diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotGrabberRotateMotorDiagnosticsRandomSample.json}
-     *
-     * - Random pivot openClose grabber diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotGrabberOpenCloseMotorDiagnosticsRandomSample.json}
-     *
-     * - Open pivot grabber claw
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotOpenClawGrabberSample.json}
-     *
-     * - open pivot grabber claw diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotOpenClawGrabberDiagnosticSample.json}
-     *
-     * - Close pivot grabber claw
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotCloseClawGrabberSample.json}
-     *
-     * - Close pivot grabber claw diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotCloseClawGrabberDiagnosticSample.json}
-     *
-     * - Rotate right pivot grabber
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRotateGrabberRightSample.json}
-     *
-     * - Rotate right pivot grabber claw diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotRotateGrabberRightDiagnosticSample.json}
-     *
-     * - Rotate left pivot grabber
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRotateGrabberLeftSample.json}
-     *
-     * - Rotate left pivot grabber claw diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotRotateGrabberLeftDiagnosticSample.json}
-     *
-     * - Random pivot rotate grabber diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotGrabberRotateMotorDiagnosticsRestingSample.json}
-     *
-     * - Random pivot rotate and open close grabber
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRandomGrabberSample.json}
-     *
+     * @see {@link Grabber | Grabber}
      */
     grabber?: Grabber;
     /** Grabber
      *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Resting pivot grabber arm
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformRestingSample.json}
-     *
-     * - Resting pivot grabber arm diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformDiagnosticsRestingSample.json}
-     *
-     * - Tilt up
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformUpSample.json}
-     *
-     * - Tilt up pivot grabber arm diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformUpDiagnosticsSample.json}
-     *
-     * - Tilt down
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformDownSample.json}
-     *
-     * - Tilt down pivot grabber arm diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformDownDiagnosticsSample.json}
-     *
-     * - Random pivot grabber arm
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformRandomSample.json}
-     *
-     * - Random pivot grabber arm diagnostic
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformDiagnosticsRandomSample.json}
-     *
+     * @see {@link TiltPlatform | TiltPlatform}
      */
     tiltPlatform?: TiltPlatform;
     /** Motor Diagnostics
      *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Arbitrary (Front Left Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontLeftThruster/pivotFrontLeftMotorDiagnosticsRandomSample.json}
-     *
-     * - Resting position (Front Left Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontLeftThruster/pivotFrontLeftMotorDiagnosticsRestingSample.json}
-     *
+     *  @see {@link MotorDiagnostics | MotorDiagnostics}
      */
     frontLeftMotorDiagnostics?: MotorDiagnostics;
     /** Motor Diagnostics
      *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Arbitrary (Front Right Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontRightThruster/pivotFrontRightMotorDiagnosticsRandomSample.json}
-     *
-     * - Resting position (Front Right Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontRightThruster/pivotFrontRightMotorDiagnosticsRestingSample.json}
-     *
+     * @see {@link MotorDiagnostics | MotorDiagnostics}
      */
     frontRightMotorDiagnostics?: MotorDiagnostics;
     /** Motor Diagnostics
      *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     *  * - Arbitrary (Rear Left Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/rearLeftThruster/pivotRearLeftMotorDiagnosticsRandomSample.json}
-     *
-     * - Resting position (Rear Left Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/rearLeftThruster/pivotRearLeftMotorDiagnosticsRestingSample.json}
+     *  @see {@link MotorDiagnostics | MotorDiagnostics}
      */
     rearLeftMotorDiagnostics?: MotorDiagnostics;
     /** Motor Diagnostics
      *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     *  * - Arbitrary (Rear Right Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/rearRightThruster/pivotRearRightMotorDiagnosticsRandomSample.json}
-     *
-     * - Resting position (Rear Right Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/rearRightThruster/pivotRearRightMotorDiagnosticsRestingSample.json}
-     *
+     * @see {@link MotorDiagnostics | MotorDiagnostics}
      */
     rearRightMotorDiagnostics?: MotorDiagnostics;
     /** Motor Diagnostics
      *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Arbitrary (Vertical Front Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/verticalFrontThruster/pivotVerticalFrontMotorDiagnosticsRandomSample.json}
-     *
-     * - Resting position (Vertical Front Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/verticalFrontThruster/pivotVerticalFrontMotorDiagnosticsRestingSample.json}
-     *
+     * @see {@link MotorDiagnostics | MotorDiagnostics}
      */
     verticalFrontMotorDiagnostics?: MotorDiagnostics;
     /** Motor Diagnostics
      *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Arbitrary (Vertical Rear Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/verticalRearThruster/pivotVerticalRearMotorDiagnosticsRandomSample.json}
-     *
-     * - Resting position (Vertical Rear Motor)
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/thrusters/verticalRearThruster/pivotVerticalRearMotorDiagnosticsRestingSample.json}
+     * @see {@link MotorDiagnostics | MotorDiagnostics}
      */
     verticalRearMotorDiagnostics?: MotorDiagnostics;
     /**
+     * @remarks
      * 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}
+     *  @see {@link MotorDiagnostics | MotorDiagnostics}
      */
     spareMotor1?: MotorDiagnostics;
     /** Left Battery
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     *  * - Battery random percentage
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryRandomSample.json}
-     *
-     * - Battery random voltage
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryVoltageRandomSample.json}
-     *
-     * - Battery random leak state
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryLeakRandomSample.json}
-     *
-     * - Battery maximum voltage
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryVoltageMaxSample .json}
-     *
-     * - Battery minimum voltage
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryVoltageMinSample.json}
-     *
-     * - Battery no leak
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotHasNoLeftBatteryLeakSample.json}
-     *
-     * - Battery has a leak
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotHasLeftBatteryLeakSample.json}
-     *
-     * - Battery shutdown
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryShutdownSample.json}
-     *
-     * - Battery warning
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryWarningSample.json}
-     *
-     * - Battery All States
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryAllStatesSample.json}
-     *
+     * @see {@link Battery | Battery}
      */
     leftBattery?: Battery;
     /** Right Battery
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     * - Battery random percentage
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryRandomSample.json}
-     *
-     * - Battery random voltage
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryVoltageRandomSample.json}
-     *
-     * - Battery random leak state
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryLeakRandomSample.json}
-     *
-     * - Battery maximum voltage
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryVoltageMaxSample .json}
-     *
-     * - Battery minimum voltage
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryVoltageMinSample.json}
-     *
-     * - Battery no leak
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotHasNoRightBatteryLeakSample.json}
-     *
-     * - Battery has a leak
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotHasRightBatteryLeakSample.json}
-     *
-     * - Battery shutdown
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryShutdownSample.json}
-     *
-     * - Battery warning
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryWarningSample.json}
-     *
-     * - Battery All States
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryAllStatesSample.json}
+     * @see {@link Battery | Battery}
      */
     rightBattery?: Battery;
     /** Pivot camera
      *
-     * ### Example Payloads
-     * #### DELETE Requests
-     *
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/cameras/pivotCameraDeleteSample.json}
-     *
+     * @see {@link Cameras | Cameras}
      */
     cameras?: Record<string, Removable<Cameras>>;
-    /** Temperature in degrees celsius
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     * - CPU temperature warning
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/temperature/cpuTemp/pivotCPUTemperatureWarningSample.json}
-     *
-     * - CPU temperature shutdown
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/temperature/cpuTemp/pivotCPUTemperatureShutdownSample.json}
+    /**
+     * @remarks Temperature in degrees celsius
      *
-     * - Arbitrary
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/temperature/cpuTemp/pivotCPUTemperatureRandomSample.json}
+     * @example
+     * ```json
+     * {
+     *   "cpuTemp": 75
+     * }
+     * ```
      */
     cpuTemp?: number;
-    /** Water temperature in degrees celsius
-     *
-     * ### Example Payloads
-     * #### UPDATE Requests
-     *
-     * - Minimum water temperature
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/temperature/waterTemp/pivotWaterTemperatureMinSample.json}
-     *
-     * - Maximum water temperature
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/temperature/waterTemp/pivotWaterTemperatureMaxSample.json}
+    /**
+     * @remarks Water temperature in degrees celsius
      *
-     * - Arbitrary
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/temperature/waterTemp/pivotWaterTemperatureRandomSample.json}
+     * @example
+     * ```json
+     * {
+     *   "waterTemp": 80
+     * }
+     * ```
      */
     waterTemp?: number;
     /** 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}
+     * @see {@link UsageTime | UsageTime}
      */
     usageTime?: UsageTime;
     /** Pivot Version
-     *
-     * ### Example Payloads
-     * #### GET Requests
-     *
-     * - Version 1
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/version/pivotVersion1Sample.json}
-     *
-     * - Version 2
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/version/pivotVersion2Sample.json}
-     *
-     * - Version 3
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/version/pivotVersion3Sample.json}
-     *
-     * - Arbitrary
-     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/version/pivotVersionRandomSample.json}
-     *
+     * @remarks
+     * The version of the pivot device.
+     * @see {@link DeviceVersion | DeviceVersion}
      */
     version?: DeviceVersion;
-} & Rov;
+} & RovVehicle;
 export * from "./core";

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

@@ -1,5 +1,7 @@
 /**
  * Revolution water temperature levels
+ * @group REVOLUTION
+ * @category Core
  */
 export declare enum WaterTemperatureRevolutionRange {
     Min = -10,
@@ -7,11 +9,18 @@ export declare enum WaterTemperatureRevolutionRange {
 }
 /**
  * Revolution cpu temperature thresholds
+ * @group REVOLUTION
+ * @category Core
  */
 export declare enum RevolutionCPUTemperatureThreshold {
     Warning = 75,
     Danger = 85
 }
+/**
+ * Revolution tilt camera head position range
+ * @group REVOLUTION
+ * @category Camera Head
+ */
 export declare enum RevolutionTiltCameraHeadPositionRange {
     Min = -110,
     Max = 140

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

@@ -3,22 +3,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RevolutionTiltCameraHeadPositionRange = exports.RevolutionCPUTemperatureThreshold = exports.WaterTemperatureRevolutionRange = void 0;
 /**
  * Revolution water temperature levels
+ * @group REVOLUTION
+ * @category Core
  */
 var WaterTemperatureRevolutionRange;
 (function (WaterTemperatureRevolutionRange) {
     WaterTemperatureRevolutionRange[WaterTemperatureRevolutionRange["Min"] = -10] = "Min";
     WaterTemperatureRevolutionRange[WaterTemperatureRevolutionRange["Max"] = 50] = "Max";
-})(WaterTemperatureRevolutionRange = exports.WaterTemperatureRevolutionRange || (exports.WaterTemperatureRevolutionRange = {}));
+})(WaterTemperatureRevolutionRange || (exports.WaterTemperatureRevolutionRange = WaterTemperatureRevolutionRange = {}));
 /**
  * Revolution cpu temperature thresholds
+ * @group REVOLUTION
+ * @category Core
  */
 var RevolutionCPUTemperatureThreshold;
 (function (RevolutionCPUTemperatureThreshold) {
     RevolutionCPUTemperatureThreshold[RevolutionCPUTemperatureThreshold["Warning"] = 75] = "Warning";
     RevolutionCPUTemperatureThreshold[RevolutionCPUTemperatureThreshold["Danger"] = 85] = "Danger";
-})(RevolutionCPUTemperatureThreshold = exports.RevolutionCPUTemperatureThreshold || (exports.RevolutionCPUTemperatureThreshold = {}));
+})(RevolutionCPUTemperatureThreshold || (exports.RevolutionCPUTemperatureThreshold = RevolutionCPUTemperatureThreshold = {}));
+/**
+ * Revolution tilt camera head position range
+ * @group REVOLUTION
+ * @category Camera Head
+ */
 var RevolutionTiltCameraHeadPositionRange;
 (function (RevolutionTiltCameraHeadPositionRange) {
     RevolutionTiltCameraHeadPositionRange[RevolutionTiltCameraHeadPositionRange["Min"] = -110] = "Min";
     RevolutionTiltCameraHeadPositionRange[RevolutionTiltCameraHeadPositionRange["Max"] = 140] = "Max";
-})(RevolutionTiltCameraHeadPositionRange = exports.RevolutionTiltCameraHeadPositionRange || (exports.RevolutionTiltCameraHeadPositionRange = {}));
+})(RevolutionTiltCameraHeadPositionRange || (exports.RevolutionTiltCameraHeadPositionRange = RevolutionTiltCameraHeadPositionRange = {}));