@deeptrekker/api-domain 0.60.2-rca-1303-rca-1352-add-snapshot-interv.1 → 0.60.3

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

@@ -0,0 +1,130 @@
+"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.revolutionTopsideGpsRequestNoFixSample = exports.revolutionRovGpsRequestNoFixSample = exports.revolutionTopsideGpsRequestSample = exports.revolutionRovGpsRequestSample = exports.revolutionRovGpsStatusSample = exports.revolutionTopsideGpsStatusSample = exports.revolutionRovGpsStatusRequest = exports.revolutionTopsideGpsStatusRequest = void 0;
+var core_1 = require("../../../../../core");
+var utils_1 = require("../../../../../../utils");
+var types_1 = require("../../../../../../types");
+var errors_1 = require("../../../../errors");
+/**
+ * Creates a sample revolutions TOPSIDE GPS status UPDATE request for samples.
+ * @param status GPS status values
+ * @param revolutionId mac address of the revolution device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ */
+var revolutionTopsideGpsStatusRequest = function (status, revolutionId, transferMethodType) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    if (transferMethodType === void 0) { transferMethodType = errors_1.TransferMethodType.Update; }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(transferMethodType)), { payload: (0, utils_1.payload)([types_1.DeviceModel.Revolution, revolutionId])({
+            navigationOptions: {
+                position: {
+                    topsideGpsStatus: status,
+                },
+            },
+        }) }));
+};
+exports.revolutionTopsideGpsStatusRequest = revolutionTopsideGpsStatusRequest;
+/**
+ * Creates a sample revolutions ROV GPS status UPDATE request for samples.
+ * @param status GPS status values
+ * @param revolutionId mac address of the revolution device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ */
+var revolutionRovGpsStatusRequest = function (status, revolutionId, transferMethodType) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    if (transferMethodType === void 0) { transferMethodType = errors_1.TransferMethodType.Update; }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(transferMethodType)), { payload: (0, utils_1.payload)([types_1.DeviceModel.Revolution, revolutionId])({
+            navigationOptions: {
+                position: {
+                    rovGpsStatus: status,
+                },
+            },
+        }) }));
+};
+exports.revolutionRovGpsStatusRequest = revolutionRovGpsStatusRequest;
+/**
+ * Creates a sample revolution topside gps status UPDATE request for samples.
+ * @param fix GPS fix value of the connection
+ * @param hdop GPS HDOP value of the connection
+ * @param satelliteCount GPS satellite count of the connection
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ */
+var revolutionTopsideGpsStatusSample = function (fix, hdop, satelliteCount, revolutionId) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    return (0, exports.revolutionTopsideGpsStatusRequest)({ fix: fix, hdop: hdop, satelliteCount: satelliteCount }, revolutionId);
+};
+exports.revolutionTopsideGpsStatusSample = revolutionTopsideGpsStatusSample;
+/**
+ * Creates a sample revolution ROV gps status UPDATE request for samples.
+ * @param fix GPS fix value of the connection
+ * @param hdop GPS HDOP value of the connection
+ * @param satelliteCount GPS satellite count of the connection
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ */
+var revolutionRovGpsStatusSample = function (fix, hdop, satelliteCount, revolutionId) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    return (0, exports.revolutionRovGpsStatusRequest)({ fix: fix, hdop: hdop, satelliteCount: satelliteCount }, revolutionId);
+};
+exports.revolutionRovGpsStatusSample = revolutionRovGpsStatusSample;
+/**
+ * Creates a revolution Rov GPS Status request for samples.
+ * @param revolutionId
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/revolution/navigation/rovGpsStatus
+ *
+ */
+var revolutionRovGpsRequestSample = function (revolutionId) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    return (0, exports.revolutionRovGpsStatusSample)(types_1.GpsFixState.GPS, 20, 12, revolutionId);
+};
+exports.revolutionRovGpsRequestSample = revolutionRovGpsRequestSample;
+/**
+* Creates a revolution Rov GPS Status request for samples.
+* @param revolutionId
+* @returns TransferPayload<BridgeBox>
+* @outputSample requests/devices/vehicles/revolution/navigation/topsideGpsStatus
+*
+*/
+var revolutionTopsideGpsRequestSample = function (revolutionId) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    return (0, exports.revolutionTopsideGpsStatusSample)(types_1.GpsFixState.GPS, 20, 12, revolutionId);
+};
+exports.revolutionTopsideGpsRequestSample = revolutionTopsideGpsRequestSample;
+/**
+ * Creates a revolution Rov GPS Status request for samples.
+ * @param revolutionId
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/revolution/navigation/rovGpsStatus
+ *
+ */
+var revolutionRovGpsRequestNoFixSample = function (revolutionId) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    return (0, exports.revolutionRovGpsStatusSample)(types_1.GpsFixState.INVALID, 1000, 0, revolutionId);
+};
+exports.revolutionRovGpsRequestNoFixSample = revolutionRovGpsRequestNoFixSample;
+/**
+* Creates a revolution Rov GPS Status request for samples.
+* @param revolutionId
+* @returns TransferPayload<BridgeBox>
+* @outputSample requests/devices/vehicles/revolution/navigation/topsideGpsStatus
+*
+*/
+var revolutionTopsideGpsRequestNoFixSample = function (revolutionId) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    return (0, exports.revolutionTopsideGpsStatusSample)(types_1.GpsFixState.INVALID, 1000, 0, revolutionId);
+};
+exports.revolutionTopsideGpsRequestNoFixSample = revolutionTopsideGpsRequestNoFixSample;

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

@@ -85,10 +85,18 @@ export declare const revolutionLocalPositionInvalidSample: (localPosition?: Loca
  */
 export declare const revolutionGlobalPositionInvalidSample: (globalPosition?: GlobalPosition, position?: Position, revolutionId?: string) => TransferPayload<BridgeBox>;
 /**
- * Creates a sample Random revolution potion source UPDATE request for samples.
+ * Creates a sample Random revolution position source UPDATE request for samples.
  * @param revolutionId mac address of the revolution device
  * @param transferMethodType GET, SET, UPDATE, or DELETE
  * @returns TransferPayload<BridgeBox>
  * @outputSample requests/devices/vehicles/revolution/positionOptionsUsbl
  */
 export declare const revolutionPositionSourceRequest: (revolutionId?: string, transferMethodType?: TransferMethodType) => TransferPayload<BridgeBox>;
+/**
+ * Creates a sample Random revolution topside position source UPDATE request for samples.
+ * @param revolutionId mac address of the revolution device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/revolution/positionOptionsTopside
+ */
+export declare const revolutionTopsidePositionSourceRequest: (revolutionId?: string, transferMethodType?: TransferMethodType) => TransferPayload<BridgeBox>;

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

@@ -11,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.revolutionPositionSourceRequest = exports.revolutionGlobalPositionInvalidSample = exports.revolutionLocalPositionInvalidSample = exports.revolutionGlobalPositionRandomSample = exports.revolutionReferencePositionRandomSample = exports.revolutionLocalPositionRandomSample = exports.revolutionGlobalPositionSample = exports.revolutionReferencePositionSample = exports.revolutionLocalPositionSample = exports.revolutionPositionRequest = void 0;
+exports.revolutionTopsidePositionSourceRequest = exports.revolutionPositionSourceRequest = exports.revolutionGlobalPositionInvalidSample = exports.revolutionLocalPositionInvalidSample = exports.revolutionGlobalPositionRandomSample = exports.revolutionReferencePositionRandomSample = exports.revolutionLocalPositionRandomSample = exports.revolutionGlobalPositionSample = exports.revolutionReferencePositionSample = exports.revolutionLocalPositionSample = exports.revolutionPositionRequest = void 0;
 var core_1 = require("../../../../../core");
 var utils_1 = require("../../../../../../utils");
 var types_1 = require("../../../../../../types");
@@ -196,7 +196,7 @@ var revolutionGlobalPositionInvalidSample = function (globalPosition, position,
 };
 exports.revolutionGlobalPositionInvalidSample = revolutionGlobalPositionInvalidSample;
 /**
- * Creates a sample Random revolution potion source UPDATE request for samples.
+ * Creates a sample Random revolution position source UPDATE request for samples.
  * @param revolutionId mac address of the revolution device
  * @param transferMethodType GET, SET, UPDATE, or DELETE
  * @returns TransferPayload<BridgeBox>
@@ -214,3 +214,22 @@ var revolutionPositionSourceRequest = function (revolutionId, transferMethodType
         }) }));
 };
 exports.revolutionPositionSourceRequest = revolutionPositionSourceRequest;
+/**
+ * Creates a sample Random revolution topside position source UPDATE request for samples.
+ * @param revolutionId mac address of the revolution device
+ * @param transferMethodType GET, SET, UPDATE, or DELETE
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/revolution/positionOptionsTopside
+ */
+var revolutionTopsidePositionSourceRequest = function (revolutionId, transferMethodType) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    if (transferMethodType === void 0) { transferMethodType = errors_1.TransferMethodType.Update; }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(transferMethodType)), { payload: (0, utils_1.payload)([types_1.DeviceModel.Revolution, revolutionId])({
+            navigationOptions: {
+                position: {
+                    topSource: types_1.TopPositionSources.EXTERNAL_GPS,
+                },
+            },
+        }) }));
+};
+exports.revolutionTopsidePositionSourceRequest = revolutionTopsidePositionSourceRequest;

package/dist/schemas/schema.json

@@ -6,27 +6,6 @@
       "additionalProperties": false,
       "description": "{@link  IA150 📖 See extended definition } \n\nA150 Class\n\nA-150 vehicle type.",
       "properties": {
-        "autoSnapshot": {
-          "additionalProperties": false,
-          "properties": {
-            "session": {
-              "additionalProperties": false,
-              "properties": {
-                "active": {
-                  "type": "boolean"
-                },
-                "cameras": {
-                  "type": "string"
-                },
-                "interval": {
-                  "$ref": "#/definitions/SnapshotIntervals"
-                }
-              },
-              "type": "object"
-            }
-          },
-          "type": "object"
-        },
         "auxLight": {
           "$ref": "#/definitions/Light",
           "description": "Aux Light\n\nControls the auxiliary light attached to the a150 crawler."
@@ -223,27 +202,6 @@
       "additionalProperties": false,
       "description": "{@link  IA200 📖 See extended definition } \n\nA200 Class\n\nA-200 vehicle type.",
       "properties": {
-        "autoSnapshot": {
-          "additionalProperties": false,
-          "properties": {
-            "session": {
-              "additionalProperties": false,
-              "properties": {
-                "active": {
-                  "type": "boolean"
-                },
-                "cameras": {
-                  "type": "string"
-                },
-                "interval": {
-                  "$ref": "#/definitions/SnapshotIntervals"
-                }
-              },
-              "type": "object"
-            }
-          },
-          "type": "object"
-        },
         "auxLight": {
           "$ref": "#/definitions/Light",
           "description": "Aux Light\n\nControls the auxiliary light attached to the a200 crawler."
@@ -882,27 +840,6 @@
       "additionalProperties": false,
       "description": "{@link  IDT645 📖 See extended definition } \n\nDT645 Class\n\nDT645 vehicle type.",
       "properties": {
-        "autoSnapshot": {
-          "additionalProperties": false,
-          "properties": {
-            "session": {
-              "additionalProperties": false,
-              "properties": {
-                "active": {
-                  "type": "boolean"
-                },
-                "cameras": {
-                  "type": "string"
-                },
-                "interval": {
-                  "$ref": "#/definitions/SnapshotIntervals"
-                }
-              },
-              "type": "object"
-            }
-          },
-          "type": "object"
-        },
         "bodyLeak": {
           "description": "Body Leak Fault\n\nIndicates detection of water leakage within the DT645 Utility Crawler's main body compartment.\n\n### Example Payloads #### UPDATE Requests\n\n- No body leak {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645HasNoBodyLeakSample.json}\n\n- Body leak present {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645HasBodyLeakSample.json}\n\n- Arbitrary {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645BodyLeakRandomSample.json}",
           "type": "boolean"
@@ -1347,6 +1284,33 @@
       },
       "type": "object"
     },
+    "GpsFixState": {
+      "enum": [
+        0,
+        1,
+        2,
+        3,
+        4,
+        5,
+        6
+      ],
+      "type": "number"
+    },
+    "GpsStatus": {
+      "additionalProperties": false,
+      "properties": {
+        "fix": {
+          "$ref": "#/definitions/GpsFixState"
+        },
+        "hdop": {
+          "type": "number"
+        },
+        "satelliteCount": {
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
     "Grabber": {
       "additionalProperties": false,
       "description": "{@link  IGrabber 📖 See extended definition } \n\nGrabber",
@@ -1588,9 +1552,20 @@
               "description": "Indicates if the ROV has dead reckoning capability",
               "type": "boolean"
             },
+            "rovGpsStatus": {
+              "$ref": "#/definitions/GpsStatus"
+            },
             "rovSource": {
               "$ref": "#/definitions/PositionSources",
               "description": "The source providing ROV position. Could be an external GPS, USBL device or NONE.\n\n### Example payloads\n#### UPDATE Requests\n\n- Setting rovSource to USBL Sample\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/positionOptionsUsbl/revolutionPositionSourceRequest.json}\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/positionOptionsUsbl/pivotPositionSourceRequest.json}"
+            },
+            "topSource": {
+              "$ref": "#/definitions/TopPositionSources",
+              "description": "Source of Topside location data. Works similarly to the Rov Source.  Does not include USBL as an acceptable option. \n\n- Setting TopSource to External GPS Sample  - Revolution {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/positionOptionsTopside/revolutionTopsidePositionSourceRequest.json}"
+            },
+            "topsideGpsStatus": {
+              "$ref": "#/definitions/GpsStatus",
+              "description": "GPS status values such as GPS Fix and Signal Strength\n- Arbitrary Global position only  - Revolution {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/navigation/topsideGpsStatus/revolutionTopsideGpsRequestSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/navigation/topsideGpsStatus/revolutionTopsideGpsRequestNoFixSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/navigation/rovGpsStatus/revolutionRovGpsRequestSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/navigation/rovGpsStatus/revolutionRovGpsRequestNoFixSample.json}"
             }
           },
           "type": "object"
@@ -1982,27 +1957,6 @@
           "description": "Rov altitude valid\n\nAltitude validity flag\n\n### Example Payloads #### UPDATE Requests\n\n\n- Valid altitude (good data) {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidSample.json}\n\n- Random altitude validity {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json}",
           "type": "boolean"
         },
-        "autoSnapshot": {
-          "additionalProperties": false,
-          "properties": {
-            "session": {
-              "additionalProperties": false,
-              "properties": {
-                "active": {
-                  "type": "boolean"
-                },
-                "cameras": {
-                  "type": "string"
-                },
-                "interval": {
-                  "$ref": "#/definitions/SnapshotIntervals"
-                }
-              },
-              "type": "object"
-            }
-          },
-          "type": "object"
-        },
         "auxLights": {
           "additionalProperties": {
             "$ref": "#/definitions/Removable%3CLight%3E"
@@ -2210,27 +2164,6 @@
           "description": "Rov altitude valid\n\nAltitude validity flag\n\n### Example Payloads #### UPDATE Requests\n\n\n- Valid altitude (good data) {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidSample.json}\n\n- Random altitude validity {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json}",
           "type": "boolean"
         },
-        "autoSnapshot": {
-          "additionalProperties": false,
-          "properties": {
-            "session": {
-              "additionalProperties": false,
-              "properties": {
-                "active": {
-                  "type": "boolean"
-                },
-                "cameras": {
-                  "type": "string"
-                },
-                "interval": {
-                  "$ref": "#/definitions/SnapshotIntervals"
-                }
-              },
-              "type": "object"
-            }
-          },
-          "type": "object"
-        },
         "auxLight": {
           "$ref": "#/definitions/Light",
           "description": "Aux Light\n\nControls the auxiliary light attached to the Photon."
@@ -2420,27 +2353,6 @@
           "description": "Rov altitude valid\n\nAltitude validity flag\n\n### Example Payloads #### UPDATE Requests\n\n\n- Valid altitude (good data) {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidSample.json}\n\n- Random altitude validity {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json}",
           "type": "boolean"
         },
-        "autoSnapshot": {
-          "additionalProperties": false,
-          "properties": {
-            "session": {
-              "additionalProperties": false,
-              "properties": {
-                "active": {
-                  "type": "boolean"
-                },
-                "cameras": {
-                  "type": "string"
-                },
-                "interval": {
-                  "$ref": "#/definitions/SnapshotIntervals"
-                }
-              },
-              "type": "object"
-            }
-          },
-          "type": "object"
-        },
         "auxLight": {
           "$ref": "#/definitions/Light",
           "description": "Aux Light\n\nControls the auxiliary light attached to the Revolution.\n\n### Example Payloads #### SET Requests\n\n- 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}\n\n- Lights Off {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOffSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/auxLight/pivotAuxLightOffSample.json}\n\n- 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}\n\n- Arbitrary {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/auxLight/pivotAuxLightRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightRandomSample.json}"
@@ -2645,7 +2557,8 @@
       "enum": [
         "NONE",
         "SEATRAC_USBL",
-        "EXTERNAL_GPS"
+        "EXTERNAL_GPS",
+        "STATIC"
       ],
       "type": "string"
     },
@@ -2893,27 +2806,6 @@
           "description": "Rov altitude valid\n\nAltitude validity flag\n\n### Example Payloads #### UPDATE Requests\n\n\n- Valid altitude (good data) {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidSample.json}\n\n- Random altitude validity {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json}",
           "type": "boolean"
         },
-        "autoSnapshot": {
-          "additionalProperties": false,
-          "properties": {
-            "session": {
-              "additionalProperties": false,
-              "properties": {
-                "active": {
-                  "type": "boolean"
-                },
-                "cameras": {
-                  "type": "string"
-                },
-                "interval": {
-                  "$ref": "#/definitions/SnapshotIntervals"
-                }
-              },
-              "type": "object"
-            }
-          },
-          "type": "object"
-        },
         "auxLight": {
           "$ref": "#/definitions/Light",
           "description": "Aux Light\n\nControls the auxiliary light attached to the Revolution."
@@ -3247,21 +3139,6 @@
       ],
       "type": "string"
     },
-    "SnapshotIntervals": {
-      "enum": [
-        0,
-        1,
-        2,
-        3,
-        4,
-        5,
-        10,
-        15,
-        30,
-        60
-      ],
-      "type": "number"
-    },
     "SoftwareUpdate": {
       "additionalProperties": false,
       "description": "SoftwareUpdate\n\nDescribes a software update giving a release date and corresponding version notes.",
@@ -3809,6 +3686,14 @@
       },
       "type": "object"
     },
+    "TopPositionSources": {
+      "enum": [
+        "NONE",
+        "EXTERNAL_GPS",
+        "STATIC"
+      ],
+      "type": "string"
+    },
     "TransferError": {
       "additionalProperties": false,
       "description": "Error message from the Bridge Box",

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

@@ -312,15 +312,3 @@ export type UsageTime = {
      */
     currentSeconds?: number;
 };
-export declare enum SnapshotIntervals {
-    ZERO = 0,
-    ONE = 1,
-    TWO = 2,
-    THREE = 3,
-    FOUR = 4,
-    FIVE = 5,
-    TEN = 10,
-    FIFTEEN = 15,
-    THIRTY = 30,
-    SIXTY = 60
-}

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SnapshotIntervals = exports.PivotRotaryPosition = exports.PivotBatteryVoltage = exports.RevolutionBatteryLevel = exports.PivotBatteryLevel = exports.ReelBatteryLevel = exports.A150BatteryLevel = exports.A200BatteryLevel = exports.DEFAULT_REEL_BATTERY_VOLTAGE = void 0;
+exports.PivotRotaryPosition = exports.PivotBatteryVoltage = exports.RevolutionBatteryLevel = exports.PivotBatteryLevel = exports.ReelBatteryLevel = exports.A150BatteryLevel = exports.A200BatteryLevel = exports.DEFAULT_REEL_BATTERY_VOLTAGE = void 0;
 exports.DEFAULT_REEL_BATTERY_VOLTAGE = 21;
 /**
  * A200 Battery Level thresholds
@@ -51,16 +51,3 @@ var PivotRotaryPosition;
     PivotRotaryPosition[PivotRotaryPosition["Max"] = 110] = "Max";
     PivotRotaryPosition[PivotRotaryPosition["Min"] = -90] = "Min";
 })(PivotRotaryPosition = exports.PivotRotaryPosition || (exports.PivotRotaryPosition = {}));
-var SnapshotIntervals;
-(function (SnapshotIntervals) {
-    SnapshotIntervals[SnapshotIntervals["ZERO"] = 0] = "ZERO";
-    SnapshotIntervals[SnapshotIntervals["ONE"] = 1] = "ONE";
-    SnapshotIntervals[SnapshotIntervals["TWO"] = 2] = "TWO";
-    SnapshotIntervals[SnapshotIntervals["THREE"] = 3] = "THREE";
-    SnapshotIntervals[SnapshotIntervals["FOUR"] = 4] = "FOUR";
-    SnapshotIntervals[SnapshotIntervals["FIVE"] = 5] = "FIVE";
-    SnapshotIntervals[SnapshotIntervals["TEN"] = 10] = "TEN";
-    SnapshotIntervals[SnapshotIntervals["FIFTEEN"] = 15] = "FIFTEEN";
-    SnapshotIntervals[SnapshotIntervals["THIRTY"] = 30] = "THIRTY";
-    SnapshotIntervals[SnapshotIntervals["SIXTY"] = 60] = "SIXTY";
-})(SnapshotIntervals = exports.SnapshotIntervals || (exports.SnapshotIntervals = {}));

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

@@ -1,4 +1,4 @@
-import { Device, SnapshotIntervals, cygnusType } from "..";
+import { Device, cygnusType } from "..";
 import { Cameras } from "../cameras/types";
 import { Removable } from "../../core";
 /**
@@ -24,13 +24,6 @@ export type Vehicle = {
      * The ut(cygnus) probe
      */
     cygnus?: cygnusType;
-    autoSnapshot?: {
-        session?: {
-            active?: boolean;
-            interval?: SnapshotIntervals;
-            cameras?: string;
-        };
-    };
 } & Device;
 export * from "./a150";
 export * from "./a200";

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

@@ -91,13 +91,33 @@ export declare const POSITION_UNCERTAINTY_LIMIT = 10000;
 export declare enum PositionSources {
     NONE = "NONE",
     SEATRAC_USBL = "SEATRAC_USBL",
-    EXTERNAL_GPS = "EXTERNAL_GPS"
+    EXTERNAL_GPS = "EXTERNAL_GPS",
+    STATIC = "STATIC"
+}
+export declare enum TopPositionSources {
+    NONE = "NONE",
+    EXTERNAL_GPS = "EXTERNAL_GPS",
+    STATIC = "STATIC"
 }
 export declare enum LocationConsumerType {
     NONE = 0,
     TOP = 1,
     ROV = 2
 }
+export declare enum GpsFixState {
+    INVALID = 0,
+    GPS = 1,
+    DIFFERENTIAL_GPS = 2,
+    NOT_APPLICABLE = 3,
+    RTK_FIXED = 4,
+    RTK_FLOAT = 5,
+    INS_DEAD_RECKONING = 6
+}
+export type GpsStatus = {
+    fix?: GpsFixState;
+    hdop?: number;
+    satelliteCount?: number;
+};
 /**
  * {@link INavigationOptions | 📖 See extended definition}
  * Navigation Options type
@@ -129,12 +149,34 @@ export type NavigationOptions = {
          *
          */
         rovSource?: PositionSources;
+        /**
+         * Source of Topside location data.
+         * Works similarly to the Rov Source.
+         * Does not include USBL as an acceptable option.
+         *
+         * - Setting TopSource to External GPS Sample
+         *  - Revolution
+         * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/positionOptionsTopside/revolutionTopsidePositionSourceRequest.json}
+
+         */
+        topSource?: TopPositionSources;
         /**
          * Dead Reckoning availability flag
          *
          * @description Indicates if the ROV has dead reckoning capability
          */
         deadReckoningAvailable?: boolean;
+        /**
+         * GPS status values such as GPS Fix and Signal Strength
+         * - Arbitrary Global position only
+         *  - Revolution
+         * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/navigation/topsideGpsStatus/revolutionTopsideGpsRequestSample.json}
+         * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/navigation/topsideGpsStatus/revolutionTopsideGpsRequestNoFixSample.json}
+         * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/navigation/rovGpsStatus/revolutionRovGpsRequestSample.json}
+         * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/navigation/rovGpsStatus/revolutionRovGpsRequestNoFixSample.json}
+         */
+        topsideGpsStatus?: GpsStatus;
+        rovGpsStatus?: GpsStatus;
     };
 };
 /**

package/dist/types/devices/vehicles/navigation/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LocationConsumerType = exports.PositionSources = exports.POSITION_UNCERTAINTY_LIMIT = void 0;
+exports.GpsFixState = exports.LocationConsumerType = exports.TopPositionSources = exports.PositionSources = exports.POSITION_UNCERTAINTY_LIMIT = void 0;
 /**
  * Position uncertainty limit.
  *
@@ -14,7 +14,15 @@ var PositionSources;
     PositionSources["NONE"] = "NONE";
     PositionSources["SEATRAC_USBL"] = "SEATRAC_USBL";
     PositionSources["EXTERNAL_GPS"] = "EXTERNAL_GPS";
+    PositionSources["STATIC"] = "STATIC";
 })(PositionSources = exports.PositionSources || (exports.PositionSources = {}));
+//Enumerates the possible topside location provider sources available to the Web App.
+var TopPositionSources;
+(function (TopPositionSources) {
+    TopPositionSources["NONE"] = "NONE";
+    TopPositionSources["EXTERNAL_GPS"] = "EXTERNAL_GPS";
+    TopPositionSources["STATIC"] = "STATIC";
+})(TopPositionSources = exports.TopPositionSources || (exports.TopPositionSources = {}));
 //Enumerates the possible consumers of a location provider.
 var LocationConsumerType;
 (function (LocationConsumerType) {
@@ -22,3 +30,14 @@ var LocationConsumerType;
     LocationConsumerType[LocationConsumerType["TOP"] = 1] = "TOP";
     LocationConsumerType[LocationConsumerType["ROV"] = 2] = "ROV";
 })(LocationConsumerType = exports.LocationConsumerType || (exports.LocationConsumerType = {}));
+//Enumerates the possible GPS FIX states.
+var GpsFixState;
+(function (GpsFixState) {
+    GpsFixState[GpsFixState["INVALID"] = 0] = "INVALID";
+    GpsFixState[GpsFixState["GPS"] = 1] = "GPS";
+    GpsFixState[GpsFixState["DIFFERENTIAL_GPS"] = 2] = "DIFFERENTIAL_GPS";
+    GpsFixState[GpsFixState["NOT_APPLICABLE"] = 3] = "NOT_APPLICABLE";
+    GpsFixState[GpsFixState["RTK_FIXED"] = 4] = "RTK_FIXED";
+    GpsFixState[GpsFixState["RTK_FLOAT"] = 5] = "RTK_FLOAT";
+    GpsFixState[GpsFixState["INS_DEAD_RECKONING"] = 6] = "INS_DEAD_RECKONING";
+})(GpsFixState = exports.GpsFixState || (exports.GpsFixState = {}));