@deeptrekker/api-domain 0.31.1

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

@@ -0,0 +1,396 @@
+import { Calibratable, MotorDiagnostics, RotaryJoint } from "../../core";
+import { CameraHead, CameraHeadOrientation, DeviceModel } from "../..";
+import { Laser, Light } from "../../peripherals";
+/** Pan Tilt Camera Head */
+/**
+ * {@link IA200CameraHead | 📖 See extended definition}
+ *
+ * Pan-Tilt Camera Head
+ *
+ * @category Device/CameraHead
+ */
+export declare type A200CameraHead = {
+    model: DeviceModel.A200CameraHead;
+    /** ↔️ Camera Pan Controls
+     *
+     * ### Example Payload
+     *
+     * #### Pan Position Samples
+     *
+     * ##### a200 pan at random position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/pan/a200CameraHeadPanPositionRandomSample.json}
+     *
+     * ##### a200 pan at minimum position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/pan/a200CameraHeadPanPositionMinSample.json}
+     *
+     * ##### a200 pan at maximum position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/pan/a200CameraHeadPanPositionMaxSample.json}
+     *
+     * ##### a150 pan at random position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/pan/a150CameraHeadPanPositionRandomSample.json}
+     *
+     * ##### a150 pan at minimum position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/pan/a150CameraHeadPanPositionMinSample.json}
+     *
+     * ##### a150 pan at maximum position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/pan/a150CameraHeadPanPositionMaxSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### Pan Speed Samples
+     *
+     * ##### a200 pan at random speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/pan/a200CameraHeadPanSpeedRandomSample.json}
+     *
+     * ##### a200 pan at minimum speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/pan/a200CameraHeadPanSpeedMinSample.json}
+     *
+     * ##### a200 pan at maximum speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/pan/a200CameraHeadPanSpeedMaxSample.json}
+     *
+     * ##### a150 pan at random speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/pan/a150CameraHeadPanSpeedRandomSample.json}
+     *
+     * ##### a150 pan at minimum speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/pan/a150CameraHeadPanSpeedMinSample.json}
+     *
+     * ##### a150 pan at maximum speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/pan/a150CameraHeadPanSpeedMaxSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### a200 pan at random position and speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/pan/a200CameraHeadPanRandomSample.json}
+     *
+     * #### a150 pan at random position and speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/pan/a150CameraHeadPanRandomSample.json}
+     *
+     */
+    pan?: RotaryJoint;
+    /** ⤴ Camera Tilt Controls
+     *
+     * ### Example Payload
+     *
+     * #### Tilt Position Samples
+     *
+     * ##### a200 tilt position at random
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tilt/a200CameraHeadTiltPositionRandomSample.json}
+     *
+     * ##### a200 tilt at minimum position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tilt/a200CameraHeadTiltPositionMinSample.json}
+     *
+     * ##### a200 tilt at maximum position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tilt/a200CameraHeadTiltPositionMaxSample.json}
+     *
+     * ##### a150 tilt position at random
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tilt/a150CameraHeadTiltPositionRandomSample.json}
+     *
+     * ##### a150 tilt position at minimum position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tilt/a150CameraHeadTiltPositionMinSample.json}
+     *
+     * ##### a150 tilt position at maximum position
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tilt/a150CameraHeadTiltPositionMaxSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### Tilt Speed Samples
+     *
+     * ##### a200 tilt at random speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tilt/a200CameraHeadTiltSpeedRandomSample.json}
+     *
+     * ##### a200 tilt speed at minimum speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tilt/a200CameraHeadTiltSpeedMinSample.json}
+     *
+     * ##### a200 tilt speed at maximum speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tilt/a200CameraHeadTiltSpeedMaxSample.json}
+     *
+     * ##### a150 tilt at random speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tilt/a150CameraHeadTiltSpeedRandomSample.json}
+     *
+     * ##### a150 tilt speed at minimum speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tilt/a150CameraHeadTiltSpeedMinSample.json}
+     *
+     * ##### a150 tilt speed at maximum speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tilt/a150CameraHeadTiltSpeedMaxSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### a200 tilt at random position and speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tilt/a200CameraHeadTiltRandomSample.json}
+     *
+     * #### a150 tilt at random position and speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tilt/a150CameraHeadTiltRandomSample.json}
+     */
+    tilt?: RotaryJoint;
+    /** Pan Motor Diagnostics
+     *
+     * ### Example Payload
+     *
+     * #### Pan Motor Diagnostics Current Sample
+     *
+     * ##### a200 at random
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/panMotorDiagnostics/a200CameraHeadPanMotorDiagnosticsCurrentRandomSample.json}
+     *
+     * ##### a150 at random
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/panMotorDiagnostics/a150CameraHeadPanMotorDiagnosticsCurrentRandomSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### Pan Motor Diagnostics Overcurrent Sample
+     *
+     * ##### a200 at ON
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/panMotorDiagnostics/a200CameraHeadPanMotorDiagnosticsOvercurrentOnSample.json}
+     *
+     * ##### a200 at OFF
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/panMotorDiagnostics/a200CameraHeadPanMotorDiagnosticsOvercurrentOffSample.json}
+     *
+     * ##### a150 at ON
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/panMotorDiagnostics/a150CameraHeadPanMotorDiagnosticsOvercurrentOnSample.json}
+     *
+     * ##### a150 at OFF
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/panMotorDiagnostics/a150CameraHeadPanMotorDiagnosticsOvercurrentOffSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### Pan Motor Diagnostics PWM Samples
+     *
+     * ##### a200 at random speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/panMotorDiagnostics/a200CameraHeadPanMotorDiagnosticsPWMRandomSample.json}
+     *
+     * ##### a150 at random speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/panMotorDiagnostics/a150CameraHeadPanMotorDiagnosticsPWMRandomSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### Pan Motor Diagnostics RPM Samples
+     *
+     * ##### a200 at static
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/panMotorDiagnostics/a200CameraHeadPanMotorDiagnosticsRPMStaticSample.json}
+     *
+     * ##### a200 at forward
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/panMotorDiagnostics/a200CameraHeadPanMotorDiagnosticsRPMForwardSample.json}
+     *
+     * ##### a200 at backward
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/panMotorDiagnostics/a200CameraHeadPanMotorDiagnosticsRPMBackwardSample.json}
+     *
+     * ##### a150 at static
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/panMotorDiagnostics/a150CameraHeadPanMotorDiagnosticsRPMStaticSample.json}
+     *
+     * ##### a150 at forward
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/panMotorDiagnostics/a150CameraHeadPanMotorDiagnosticsRPMForwardSample.json}
+     *
+     * ##### a150 at backward
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/panMotorDiagnostics/a150CameraHeadPanMotorDiagnosticsRPMBackwardSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### a200 pan Motor Diagnostics with Current, Overcurrent, PWM, RPM
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/panMotorDiagnostics/a200CameraHeadPanMotorDiagnosticsRandomSample.json}
+     *
+     * #### a150 pan Motor Diagnostics with Current, Overcurrent, PWM, RPM
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/panMotorDiagnostics/a150CameraHeadPanMotorDiagnosticsRandomSample.json}
+     *
+     */
+    panMotorDiagnostics?: MotorDiagnostics;
+    /** Tilt Motor Diagnostics
+     *
+     * ### Example Payload
+     *
+     * #### Tilt Motor Diagnostics Current Sample
+     *
+     * ##### a200 at random
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tiltMotorDiagnostics/a200CameraHeadTiltMotorDiagnosticsCurrentRandomSample.json}
+     *
+     * ##### a150 at random
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tiltMotorDiagnostics/a150CameraHeadTiltMotorDiagnosticsCurrentRandomSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### Tilt Motor Diagnostics Overcurrent Sample
+     *
+     * ##### a200 at ON
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tiltMotorDiagnostics/a200CameraHeadTiltMotorDiagnosticsOvercurrentOnSample.json}
+     *
+     * ##### a200 at OFF
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tiltMotorDiagnostics/a200CameraHeadTiltMotorDiagnosticsOvercurrentOffSample.json}
+     *
+     * ##### a150 at ON
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tiltMotorDiagnostics/a150CameraHeadTiltMotorDiagnosticsOvercurrentOnSample.json}
+     *
+     * ##### a150 at OFF
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tiltMotorDiagnostics/a150CameraHeadTiltMotorDiagnosticsOvercurrentOffSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### Tilt Motor Diagnostics PWM Samples
+     *
+     * ##### a200 at random speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tiltMotorDiagnostics/a200CameraHeadTiltMotorDiagnosticsPWMRandomSample.json}
+     *
+     * ##### a150 at random speed
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tiltMotorDiagnostics/a150CameraHeadTiltMotorDiagnosticsPWMRandomSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### Tilt Motor Diagnostics RPM Samples
+     *
+     * ##### a200 at static
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tiltMotorDiagnostics/a200CameraHeadTiltMotorDiagnosticsRPMStaticSample.json}
+     *
+     * ##### a200 at forward
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tiltMotorDiagnostics/a200CameraHeadTiltMotorDiagnosticsRPMForwardSample.json}
+     *
+     * ##### a200 at backward
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tiltMotorDiagnostics/a200CameraHeadTiltMotorDiagnosticsRPMBackwardSample.json}
+     *
+     * ##### a150 at static
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tiltMotorDiagnostics/a150CameraHeadTiltMotorDiagnosticsRPMStaticSample.json}
+     *
+     * ##### a150 at forward
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tiltMotorDiagnostics/a150CameraHeadTiltMotorDiagnosticsRPMForwardSample.json}
+     *
+     * ##### a150 at backward
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tiltMotorDiagnostics/a150CameraHeadTiltMotorDiagnosticsRPMBackwardSample.json}
+     *
+     * <br />
+     * <br />
+     *
+     * #### a200 tilt Motor Diagnostics with Current, Overcurrent, PWM, RPM
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/tiltMotorDiagnostics/a200CameraHeadTiltMotorDiagnosticsRandomSample.json}
+     *
+     * #### a150 tilt Motor Diagnostics with Current, Overcurrent, PWM, RPM
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/tiltMotorDiagnostics/a150CameraHeadTiltMotorDiagnosticsRandomSample.json}
+     *
+     */
+    tiltMotorDiagnostics?: MotorDiagnostics;
+    /** Light
+     *
+     * ### Example Payload
+     *
+     * #### Light Intensity Samples
+     *
+     * ##### at random
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/light/a200CameraHeadLightIntensityRandomSample.json}
+     *
+     * ##### at minimum
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/light/a200CameraHeadLightIntensityMinSample.json}
+     *
+     * ##### at maximum
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/light/a200CameraHeadLightIntensityMaxSample.json}
+     *
+     * ##### a150 at random
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/light/a150CameraHeadLightIntensityRandomSample.json}
+     *
+     * ##### a150 at minimum
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/light/a150CameraHeadLightIntensityMinSample.json}
+     *
+     * ##### a150 at maximum
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/light/a150CameraHeadLightIntensityMaxSample.json}
+     *
+     */
+    light?: Light;
+    /**
+     * Orientation controls
+     *
+     * @remarks This is the orientation controls stemming from the physical assembly of the camera.
+     *
+     * ### Example Payload
+     *
+     * #### Orientation Controls Samples
+     * ##### a200 at horizontal
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/orientationConfig/a200CameraHeadOrientationConfigHorizontalSample.json}
+     *
+     * ##### a200 at vertical
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameraHead/orientationConfig/a200CameraHeadOrientationConfigVerticalSample.json}
+     *
+     * ##### a150 at horizontal
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/orientationConfig/a150CameraHeadOrientationConfigHorizontalSample.json}
+     *
+     * ##### a150 at vertical
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameraHead/orientationConfig/a150CameraHeadOrientationConfigVerticalSample.json}
+     */
+    orientation?: CameraHeadOrientation;
+    /**
+     * TODO: Add laser samples
+     */
+    lasers?: Laser;
+} & CameraHead & Calibratable;
+export * from "..";
+export * from "../../core";

package/dist/types/devices/cameraHeads/a200CameraHead/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require(".."), exports);
+__exportStar(require("../../core"), exports);

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

@@ -0,0 +1,17 @@
+/**
+ * Camera head orientation config
+ *
+ * The orientation in which the camera head is physically assembled
+ *
+ * @enum
+ */
+export declare enum CameraHeadOrientation {
+    /**
+     * A horizontal orientation of the camera head in which the camera moves sideways relative to it's home position.
+     */
+    Horizontal = "HORIZONTAL",
+    /**
+     * A vertical orientation of the camera head in which the camera moves vertically relative to it's home position.
+     */
+    Vertical = "VERTICAL"
+}

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CameraHeadOrientation = void 0;
+/**
+ * Camera head orientation config
+ *
+ * The orientation in which the camera head is physically assembled
+ *
+ * @enum
+ */
+var CameraHeadOrientation;
+(function (CameraHeadOrientation) {
+    /**
+     * A horizontal orientation of the camera head in which the camera moves sideways relative to it's home position.
+     */
+    CameraHeadOrientation["Horizontal"] = "HORIZONTAL";
+    /**
+     * A vertical orientation of the camera head in which the camera moves vertically relative to it's home position.
+     */
+    CameraHeadOrientation["Vertical"] = "VERTICAL";
+})(CameraHeadOrientation = exports.CameraHeadOrientation || (exports.CameraHeadOrientation = {}));

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

@@ -0,0 +1,20 @@
+import { Device, UsageTime } from "..";
+/**
+ * {@link ICameraHead | 📖 See extended definition}
+ *
+ * Camera Head
+ *
+ * @category Device/CameraHeads
+ */
+export declare type CameraHead = {
+    /** Camera Head Usage Time */
+    usageTime?: UsageTime;
+    /** Temperature in degrees celsius */
+    cpuTemp?: number;
+    /** Leak Fault */
+    leak?: boolean;
+} & Device;
+export * from "./core";
+export * from "./a150CameraHead";
+export * from "./a200CameraHead";
+export * from "./tiltCameraHead";

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

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./core"), exports);
+__exportStar(require("./a150CameraHead"), exports);
+__exportStar(require("./a200CameraHead"), exports);
+__exportStar(require("./tiltCameraHead"), exports);