@deeptrekker/api-domain 0.49.0 → 0.51.0

package/dist/samples/requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics/index.js

@@ -0,0 +1,145 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.a200A200CameraHeadJoint2MotorDiagnosticsRandomSample = exports.a200A200CameraHeadJoint2MotorDiagnosticsRPMBackwardSample = exports.a200A200CameraHeadJoint2MotorDiagnosticsRPMForwardSample = exports.a200A200CameraHeadJoint2MotorDiagnosticsRPMStaticSample = exports.a200A200CameraHeadJoint2MotorDiagnosticsFailureOffSample = exports.a200A200CameraHeadJoint2MotorDiagnosticsFailureOnSample = exports.a200A200CameraHeadJoint2MotorDiagnosticsOvercurrentOffSample = exports.a200A200CameraHeadJoint2MotorDiagnosticsOvercurrentOnSample = exports.a200A200CameraHeadJoint2MotorDiagnosticsPWMRandomSample = exports.a200A200CameraHeadJoint2MotorDiagnosticsCurrentRandomSample = void 0;
+var types_1 = require("../../../../../../../../types");
+var utils_1 = require("../../../../../../../../utils");
+var core_1 = require("../../../../../../../core");
+/**
+ * Creates random camera head motor diagnostics current sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsCurrentRandomSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({ joint2MotorDiagnostics: { current: (0, core_1.r)() } }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsCurrentRandomSample = a200A200CameraHeadJoint2MotorDiagnosticsCurrentRandomSample;
+/**
+ * Creates random camera head motor diagnostics PWM sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsPWMRandomSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({ joint2MotorDiagnostics: { pwm: (0, core_1.r)() } }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsPWMRandomSample = a200A200CameraHeadJoint2MotorDiagnosticsPWMRandomSample;
+/**
+ * Creates true camera head motor diagnostics overcurrent sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsOvercurrentOnSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({ joint2MotorDiagnostics: { overcurrent: true } }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsOvercurrentOnSample = a200A200CameraHeadJoint2MotorDiagnosticsOvercurrentOnSample;
+/**
+ * Creates false camera head motor diagnostics overcurrent sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsOvercurrentOffSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({ joint2MotorDiagnostics: { overcurrent: false } }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsOvercurrentOffSample = a200A200CameraHeadJoint2MotorDiagnosticsOvercurrentOffSample;
+/**
+ * Creates true camera head motor diagnostics failure sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsFailureOnSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({ joint2MotorDiagnostics: { failure: true } }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsFailureOnSample = a200A200CameraHeadJoint2MotorDiagnosticsFailureOnSample;
+/**
+ * Creates false camera head motor diagnostics failure sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsFailureOffSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({ joint2MotorDiagnostics: { failure: false } }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsFailureOffSample = a200A200CameraHeadJoint2MotorDiagnosticsFailureOffSample;
+/**
+ * Creates static camera head motor diagnostics RPM sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsRPMStaticSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({ joint2MotorDiagnostics: { rpm: 0 } }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsRPMStaticSample = a200A200CameraHeadJoint2MotorDiagnosticsRPMStaticSample;
+/**
+ * Creates forward camera head motor diagnostics RPM sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsRPMForwardSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({ joint2MotorDiagnostics: { rpm: 10 } }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsRPMForwardSample = a200A200CameraHeadJoint2MotorDiagnosticsRPMForwardSample;
+/**
+ * Creates backward camera head motor diagnostics RPM sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsRPMBackwardSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({ joint2MotorDiagnostics: { rpm: -10 } }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsRPMBackwardSample = a200A200CameraHeadJoint2MotorDiagnosticsRPMBackwardSample;
+/**
+ * Creates random camera head motor diagnostics of all parameters sample update.
+ *
+ * @param deviceId macAddress
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/a200/cameraHead/a200CameraHead/joint2MotorDiagnostics
+ */
+var a200A200CameraHeadJoint2MotorDiagnosticsRandomSample = function (deviceId) {
+    if (deviceId === void 0) { deviceId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.A200Crawler, deviceId], [types_1.DeviceModel.A200CameraHead, ""])({
+            joint2MotorDiagnostics: {
+                current: (0, core_1.r)(),
+                failure: (0, core_1.randomBoolean)(),
+                overcurrent: (0, core_1.randomBoolean)(),
+                pwm: (0, core_1.r)(),
+                rpm: (0, core_1.r)(-10, 10),
+            },
+        }) }));
+};
+exports.a200A200CameraHeadJoint2MotorDiagnosticsRandomSample = a200A200CameraHeadJoint2MotorDiagnosticsRandomSample;

package/dist/samples/requests/devices/vehicles/index.d.ts

@@ -3,3 +3,4 @@ export * from "./a150";
 export * from "./crawler";
 export * from "./revolution";
 export * from "./pivot";
+export * from "./revolution";

package/dist/samples/requests/devices/vehicles/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./a150"), exports);
 __exportStar(require("./crawler"), exports);
 __exportStar(require("./revolution"), exports);
 __exportStar(require("./pivot"), exports);
+__exportStar(require("./revolution"), exports);

package/dist/samples/requests/devices/vehicles/pivot/inWater/index.d.ts

@@ -0,0 +1,25 @@
+import { BridgeBox, TransferPayload } from "../../../../../../types";
+/**
+ * Creates an pivot random inWater sample.
+ *
+ * @param pivotId
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/inWater
+ */
+export declare const pivotOutOfWaterSample: (pivotId?: string) => TransferPayload<BridgeBox>;
+/**
+ * Creates an pivot random inWater sample.
+ *
+ * @param pivotId
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/inWater
+ */
+export declare const pivotInWaterSample: (pivotId?: string) => TransferPayload<BridgeBox>;
+/**
+ * Creates an pivot random inWater sample.
+ *
+ * @param pivotId
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/inWater
+ */
+export declare const pivotInWaterRandomSample: (pivotId?: string) => TransferPayload<BridgeBox>;

package/dist/samples/requests/devices/vehicles/pivot/inWater/index.js

@@ -0,0 +1,59 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pivotInWaterRandomSample = exports.pivotInWaterSample = exports.pivotOutOfWaterSample = void 0;
+var core_1 = require("../../../../../core");
+var types_1 = require("../../../../../../types");
+var utils_1 = require("../../../../../../utils");
+/**
+ * Creates an pivot random inWater sample.
+ *
+ * @param pivotId
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/inWater
+ */
+var pivotOutOfWaterSample = function (pivotId) {
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.Pivot, pivotId])({
+            inWater: false,
+        }) }));
+};
+exports.pivotOutOfWaterSample = pivotOutOfWaterSample;
+/**
+ * Creates an pivot random inWater sample.
+ *
+ * @param pivotId
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/inWater
+ */
+var pivotInWaterSample = function (pivotId) {
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.Pivot, pivotId])({
+            inWater: true,
+        }) }));
+};
+exports.pivotInWaterSample = pivotInWaterSample;
+/**
+ * Creates an pivot random inWater sample.
+ *
+ * @param pivotId
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/inWater
+ */
+var pivotInWaterRandomSample = function (pivotId) {
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.Pivot, pivotId])({
+            inWater: (0, core_1.randomBoolean)(),
+        }) }));
+};
+exports.pivotInWaterRandomSample = pivotInWaterRandomSample;

package/dist/samples/requests/devices/vehicles/pivot/index.d.ts

@@ -37,11 +37,14 @@ export * from "./cameras";
 export * from "./core";
 export * from "./drive";
 export * from "./ip";
-export * from "./peripherals/grabber";
-export * from "./peripherals/tiltPlatform";
+export * from "./peripherals";
 export * from "./sensorPod";
 export * from "./temperature";
 export * from "./thrusters";
 export * from "./turns";
 export * from "./usageTime";
 export * from "./version";
+export * from "./inWater";
+export * from "./position";
+export * from "./spareMotors/spareMotor1";
+export * from "./velocity";

package/dist/samples/requests/devices/vehicles/pivot/index.js

@@ -86,11 +86,14 @@ __exportStar(require("./cameras"), exports);
 __exportStar(require("./core"), exports);
 __exportStar(require("./drive"), exports);
 __exportStar(require("./ip"), exports);
-__exportStar(require("./peripherals/grabber"), exports);
-__exportStar(require("./peripherals/tiltPlatform"), exports);
+__exportStar(require("./peripherals"), exports);
 __exportStar(require("./sensorPod"), exports);
 __exportStar(require("./temperature"), exports);
 __exportStar(require("./thrusters"), exports);
 __exportStar(require("./turns"), exports);
 __exportStar(require("./usageTime"), exports);
 __exportStar(require("./version"), exports);
+__exportStar(require("./inWater"), exports);
+__exportStar(require("./position"), exports);
+__exportStar(require("./spareMotors/spareMotor1"), exports);
+__exportStar(require("./velocity"), exports);

package/dist/samples/requests/devices/vehicles/pivot/position/index.d.ts

@@ -0,0 +1,98 @@
+import { BridgeBox, TransferMethodType, TransferPayload } from "../../../../../../types";
+import { Position } from "../../../../../../types/devices/vehicles/navigation";
+import { LocalPosition } from "../../../../../../types/devices/vehicles/navigation";
+import { GlobalPosition } from "../../../../../../types/devices/vehicles/navigation";
+/**
+ * Creates a sample pivot position UPDATE request for samples.
+ * @param position global and local
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ */
+export declare const pivotPositionRequest: (position: Position, pivotId?: string, transferMethodType?: TransferMethodType) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample pivot local position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+export declare const pivotLocalPositionSample: (localPosition?: LocalPosition, position?: Position, pivotId?: string) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample pivot global position UPDATE request for samples.
+ * @param localPosition global position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+export declare const pivotGlobalPositionSample: (globalPosition?: GlobalPosition, position?: Position, pivotId?: string, transferMethodType?: TransferMethodType) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample random pivot global position UPDATE request for samples.
+ * @param localPosition global position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+export declare const pivotGlobalPositionRandomSample: (globalPosition?: GlobalPosition, position?: Position, pivotId?: string) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample random pivot local position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+export declare const pivotLocalPositionRandomSample: (localPosition?: LocalPosition, position?: Position, pivotId?: string) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample invalid pivot local position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+export declare const pivotPositionInvalidSample: (localPosition?: LocalPosition, globalPosition?: GlobalPosition, position?: Position, pivotId?: string) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample Random pivot position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+export declare const pivotPositionRandomSample: (localPosition?: LocalPosition, globalPosition?: GlobalPosition, position?: {
+    local: LocalPosition;
+    global: GlobalPosition;
+}, pivotId?: string) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample Random pivot global position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+export declare const pivotPositionRandomGlobalSample: (localPosition?: LocalPosition, globalPosition?: GlobalPosition, position?: {
+    local: LocalPosition;
+    global: GlobalPosition;
+}, pivotId?: string) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample Random pivot local position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+export declare const pivotPositionRandomLocalSample: (localPosition?: LocalPosition, globalPosition?: GlobalPosition, position?: {
+    local: LocalPosition;
+    global: GlobalPosition;
+}, pivotId?: string) => TransferPayload<BridgeBox>;

package/dist/samples/requests/devices/vehicles/pivot/position/index.js

@@ -0,0 +1,221 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pivotPositionRandomLocalSample = exports.pivotPositionRandomGlobalSample = exports.pivotPositionRandomSample = exports.pivotPositionInvalidSample = exports.pivotLocalPositionRandomSample = exports.pivotGlobalPositionRandomSample = exports.pivotGlobalPositionSample = exports.pivotLocalPositionSample = exports.pivotPositionRequest = void 0;
+var core_1 = require("../../../../../core");
+var types_1 = require("../../../../../../types");
+var utils_1 = require("../../../../../../utils");
+var navigation_1 = require("../../../../../../types/devices/vehicles/navigation");
+/**
+ * Creates a sample pivot position UPDATE request for samples.
+ * @param position global and local
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ */
+var pivotPositionRequest = function (position, pivotId, transferMethodType) {
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    if (transferMethodType === void 0) { transferMethodType = types_1.TransferMethodType.Update; }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(transferMethodType)), { payload: (0, utils_1.payload)([types_1.DeviceModel.Pivot, pivotId])({ position: position }) }));
+};
+exports.pivotPositionRequest = pivotPositionRequest;
+/**
+ * Creates a sample pivot local position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+var pivotLocalPositionSample = function (localPosition, position, pivotId) {
+    if (localPosition === void 0) { localPosition = {
+        northing: 10,
+        easting: 10,
+        uncertainty: 10,
+    }; }
+    if (position === void 0) { position = {
+        local: localPosition,
+    }; }
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (0, exports.pivotPositionRequest)(position, pivotId);
+};
+exports.pivotLocalPositionSample = pivotLocalPositionSample;
+/**
+ * Creates a sample pivot global position UPDATE request for samples.
+ * @param localPosition global position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+var pivotGlobalPositionSample = function (globalPosition, position, pivotId, transferMethodType) {
+    if (globalPosition === void 0) { globalPosition = {
+        latitude: 10,
+        longitude: 10,
+        uncertainty: 10,
+    }; }
+    if (position === void 0) { position = {
+        global: globalPosition,
+    }; }
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    if (transferMethodType === void 0) { transferMethodType = types_1.TransferMethodType.Set; }
+    return (0, exports.pivotPositionRequest)(position, pivotId);
+};
+exports.pivotGlobalPositionSample = pivotGlobalPositionSample;
+/**
+ * Creates a sample random pivot global position UPDATE request for samples.
+ * @param localPosition global position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+var pivotGlobalPositionRandomSample = function (globalPosition, position, pivotId) {
+    if (globalPosition === void 0) { globalPosition = {
+        latitude: (0, core_1.r)(-90, 90),
+        longitude: (0, core_1.r)(-180, 180),
+        uncertainty: (0, core_1.r)(0, 100),
+    }; }
+    if (position === void 0) { position = {
+        global: globalPosition,
+    }; }
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (0, exports.pivotPositionRequest)(position, pivotId);
+};
+exports.pivotGlobalPositionRandomSample = pivotGlobalPositionRandomSample;
+/**
+ * Creates a sample random pivot local position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+var pivotLocalPositionRandomSample = function (localPosition, position, pivotId) {
+    if (localPosition === void 0) { localPosition = {
+        northing: (0, core_1.r)(-1000, 1000),
+        easting: (0, core_1.r)(-1000, 1000),
+        uncertainty: (0, core_1.r)(0, 100),
+    }; }
+    if (position === void 0) { position = {
+        local: localPosition,
+    }; }
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (0, exports.pivotPositionRequest)(position, pivotId);
+};
+exports.pivotLocalPositionRandomSample = pivotLocalPositionRandomSample;
+/**
+ * Creates a sample invalid pivot local position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param position position type
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+var pivotPositionInvalidSample = function (localPosition, globalPosition, position, pivotId) {
+    if (localPosition === void 0) { localPosition = {
+        uncertainty: navigation_1.POSITION_UNCERTAINTY_LIMIT,
+    }; }
+    if (globalPosition === void 0) { globalPosition = {
+        uncertainty: navigation_1.POSITION_UNCERTAINTY_LIMIT,
+    }; }
+    if (position === void 0) { position = {
+        local: localPosition,
+        global: globalPosition,
+    }; }
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (0, exports.pivotPositionRequest)(position, pivotId);
+};
+exports.pivotPositionInvalidSample = pivotPositionInvalidSample;
+/**
+ * Creates a sample Random pivot position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+var pivotPositionRandomSample = function (localPosition, globalPosition, position, pivotId) {
+    if (localPosition === void 0) { localPosition = {
+        northing: (0, core_1.r)(-1000, 1000),
+        easting: (0, core_1.r)(-1000, 1000),
+        uncertainty: (0, core_1.r)(0, 100),
+    }; }
+    if (globalPosition === void 0) { globalPosition = {
+        latitude: (0, core_1.r)(-90, 90),
+        longitude: (0, core_1.r)(-180, 180),
+        uncertainty: (0, core_1.r)(0, 100),
+    }; }
+    if (position === void 0) { position = {
+        local: localPosition,
+        global: globalPosition,
+    }; }
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (0, exports.pivotPositionRequest)(position, pivotId);
+};
+exports.pivotPositionRandomSample = pivotPositionRandomSample;
+/**
+ * Creates a sample Random pivot global position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+var pivotPositionRandomGlobalSample = function (localPosition, globalPosition, position, pivotId) {
+    if (localPosition === void 0) { localPosition = {
+        uncertainty: navigation_1.POSITION_UNCERTAINTY_LIMIT,
+    }; }
+    if (globalPosition === void 0) { globalPosition = {
+        latitude: (0, core_1.r)(-90, 90),
+        longitude: (0, core_1.r)(-180, 180),
+        uncertainty: (0, core_1.r)(0, 100),
+    }; }
+    if (position === void 0) { position = {
+        local: localPosition,
+        global: globalPosition,
+    }; }
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (0, exports.pivotPositionRequest)(position, pivotId);
+};
+exports.pivotPositionRandomGlobalSample = pivotPositionRandomGlobalSample;
+/**
+ * Creates a sample Random pivot local position UPDATE request for samples.
+ * @param localPosition local position of the rov
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/position
+ */
+var pivotPositionRandomLocalSample = function (localPosition, globalPosition, position, pivotId) {
+    if (localPosition === void 0) { localPosition = {
+        northing: (0, core_1.r)(-1000, 1000),
+        easting: (0, core_1.r)(-1000, 1000),
+        uncertainty: (0, core_1.r)(0, 100),
+    }; }
+    if (globalPosition === void 0) { globalPosition = {
+        uncertainty: navigation_1.POSITION_UNCERTAINTY_LIMIT,
+    }; }
+    if (position === void 0) { position = {
+        local: localPosition,
+        global: globalPosition,
+    }; }
+    if (pivotId === void 0) { pivotId = (0, core_1.macAddressId)(); }
+    return (0, exports.pivotPositionRequest)(position, pivotId);
+};
+exports.pivotPositionRandomLocalSample = pivotPositionRandomLocalSample;

package/dist/samples/requests/devices/vehicles/pivot/spareMotors/spareMotor1/index.d.ts

@@ -0,0 +1,25 @@
+import { BridgeBox, MotorDiagnostics, TransferMethodType, TransferPayload } from "../../../../../../../types";
+/**
+ * Creates a Spare Motor request for samples.
+ * @param value
+ * @param pivotId mac address of the pivot device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @readonly
+ */
+export declare const pivotSpareMotorRequest: (value: MotorDiagnostics, pivotId?: string, transferMethodType?: TransferMethodType) => TransferPayload<BridgeBox>;
+/**
+ * Creates a random pivot spare motor diagnostics sample update.
+ *
+ * @param pivotId mac address of the pivot device
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/spareMotors/spareMotor1
+ */
+export declare const pivotSpareMotorDiagnosticsRandomSample: (pivotId?: string) => TransferPayload<BridgeBox>;
+/**
+ * Creates a resting pivot spare motor diagnostics sample update.
+ *
+ * @param pivotId mac address of the pivot device
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/pivot/spareMotors/spareMotor1
+ */
+export declare const pivotSpareMotorDiagnosticsRestingSample: (pivotId?: string) => TransferPayload<BridgeBox>;