@deeptrekker/api-domain 0.57.8 → 0.58.0

package/dist/samples/swupdates/index.js

@@ -1,4 +1,15 @@
 "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);
+};
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,9 +25,10 @@ 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 });
-exports.systemUpdatePayloadSample = exports.changelog = exports.hardwareRevisions = exports.randomHardwareRevision = exports.softwareUpdate = exports.versionNote = void 0;
+exports.bridgeBoxNoOfflineUpdatesAvailableSample = exports.bridgeBoxStartOfflineUpdatesSample = exports.bridgeBoxOfflineUpdatesAvailableSample = exports.bridgeBoxCheckOfflineUpdatesSample = exports.systemUpdatePayloadSample = exports.changelog = exports.hardwareRevisions = exports.randomHardwareRevision = exports.softwareUpdate = exports.versionNote = void 0;
 var crypto_1 = require("crypto");
 var types_1 = require("../../types");
+var core_1 = require("../core");
 /**
  * Creates a version note.
  *
@@ -95,4 +107,52 @@ var systemUpdatePayloadSample = function () { return ({
     changelog: (0, exports.changelog)(),
 }); };
 exports.systemUpdatePayloadSample = systemUpdatePayloadSample;
+/**
+ * Creates a check for offline updates sample.
+ *
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/bridgeBox/swupdate
+ */
+var bridgeBoxCheckOfflineUpdatesSample = function () { return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: {
+        swupdate: {
+            offlineUpdates: types_1.OfflineUpdateState.CHECK_FOR_UPDATES
+        }
+    } })); };
+exports.bridgeBoxCheckOfflineUpdatesSample = bridgeBoxCheckOfflineUpdatesSample;
+/**
+ * Creates an offline updates available sample.
+ *
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/bridgeBox/swupdate
+ */
+var bridgeBoxOfflineUpdatesAvailableSample = function () { return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: {
+        swupdate: {
+            offlineUpdates: types_1.OfflineUpdateState.OFFLINE_AVAILABLE
+        }
+    } })); };
+exports.bridgeBoxOfflineUpdatesAvailableSample = bridgeBoxOfflineUpdatesAvailableSample;
+/**
+ * Creates a start offline updates sample.
+ *
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/bridgeBox/swupdate
+ */
+var bridgeBoxStartOfflineUpdatesSample = function () { return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: {
+        swupdate: {
+            offlineUpdates: types_1.OfflineUpdateState.START_OFFLINE_UPDATE
+        }
+    } })); };
+exports.bridgeBoxStartOfflineUpdatesSample = bridgeBoxStartOfflineUpdatesSample;
+/**
+ * Creates a system up-to-date sample.
+ *
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/bridgeBox/swupdate
+ */
+var bridgeBoxNoOfflineUpdatesAvailableSample = function () { return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: {
+        swupdate: {
+            offlineUpdates: types_1.OfflineUpdateState.UPTODATE
+        }
+    } })); };
+exports.bridgeBoxNoOfflineUpdatesAvailableSample = bridgeBoxNoOfflineUpdatesAvailableSample;
 __exportStar(require("../../types/swupdates"), exports);

package/dist/schemas/schema.json

@@ -511,7 +511,7 @@
         },
         "swupdate": {
           "$ref": "#/definitions/SWUpdate",
-          "description": "SWUpdate"
+          "description": "SWUpdate\n\n### Offline Update Samples   \n\n- Check for offline updates {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxCheckOfflineUpdatesSample.json}\n\n- Offline updates available {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxOfflineUpdatesAvailableSample.json}\n\n- System up-to-date (No new offline updates available) {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxNoOfflineUpdatesAvailableSample.json}\n\n- Start offline updates   {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxStartOfflineUpdatesSample.json}"
         },
         "systemSettings": {
           "$ref": "#/definitions/SystemSettings",
@@ -655,6 +655,10 @@
       "additionalProperties": false,
       "description": "{@link  ICamera 📖 See extended definition } \n\n📷 Camera",
       "properties": {
+        "cpuTemp": {
+          "description": "Camera cpu temperature in Celsius",
+          "type": "number"
+        },
         "ip": {
           "description": "IP address",
           "type": "string"
@@ -828,6 +832,10 @@
           "minimum": 0,
           "type": "number"
         },
+        "cpuTemp": {
+          "description": "Camera cpu temperature in Celsius",
+          "type": "number"
+        },
         "ip": {
           "description": "IP address",
           "type": "string"
@@ -1168,17 +1176,17 @@
       "additionalProperties": false,
       "description": "contains positional data for the ROV in the Local reference frame",
       "properties": {
-        "uncertainty": {
-          "description": "Uncertainty radius (in meters)",
-          "minimum": 0,
+        "easting": {
+          "description": "Easting (in meters)",
           "type": "number"
         },
-        "x": {
-          "description": "x (in meters)",
+        "northing": {
+          "description": "Northing (in meters)",
           "type": "number"
         },
-        "y": {
-          "description": "y (in meters)",
+        "uncertainty": {
+          "description": "Uncertainty radius (in meters)",
+          "minimum": 0,
           "type": "number"
         }
       },
@@ -1453,7 +1461,7 @@
           "type": "number"
         },
         "cpuTemp": {
-          "description": "The current temperature of the CPU in degrees Celsius.",
+          "description": "Camera cpu temperature in Celsius",
           "type": "number"
         },
         "dptz": {
@@ -1645,6 +1653,16 @@
       },
       "type": "object"
     },
+    "OfflineUpdateState": {
+      "enum": [
+        0,
+        1,
+        2,
+        3,
+        4
+      ],
+      "type": "number"
+    },
     "Osd": {
       "additionalProperties": false,
       "description": "OSD (On-screen Display)",
@@ -1749,12 +1767,6 @@
           "description": "IP Address ### Example Payloads #### SET Requests\n\n- Arbitrary {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/ip/pivotIpRandomSample.json}",
           "type": "string"
         },
-        "localHeading": {
-          "description": "Rov local heading\n\nMeasure in degrees from local heading",
-          "maximum": 360,
-          "minimum": -360,
-          "type": "number"
-        },
         "model": {
           "const": 24,
           "type": "number"
@@ -1922,12 +1934,6 @@
           "$ref": "#/definitions/Battery",
           "description": "Left Battery\n\n### Example Payloads #### UPDATE Requests\n\n* - Battery random percentage {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryRandomSample.json}\n\n- Battery random voltage {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryVoltageRandomSample.json}\n\n- Battery random leak state {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryLeakRandomSample.json}\n\n- Battery maximum voltage {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryVoltageMaxSample .json}\n\n- Battery minimum voltage {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryVoltageMinSample.json}\n\n- Battery no leak {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotHasNoLeftBatteryLeakSample.json}\n\n- Battery has a leak {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotHasLeftBatteryLeakSample.json}\n\n- Battery shutdown {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryShutdownSample.json}\n\n- Battery warning {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryWarningSample.json}\n\n- Battery All States {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryAllStatesSample.json}"
         },
-        "localHeading": {
-          "description": "Rov local heading\n\nMeasure in degrees from local heading",
-          "maximum": 360,
-          "minimum": -360,
-          "type": "number"
-        },
         "model": {
           "const": 18,
           "type": "number"
@@ -2327,12 +2333,6 @@
           "$ref": "#/definitions/Battery",
           "description": "Left Battery\n\n### Example Payloads #### UPDATE Requests\n\n- All arbitrary values\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryRandomSample.json}\n\n- Left battery warning\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryWarningSample.json}\n\n- Left battery shutdown\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryShutdownSample.json}\n\n- Left battery charging\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsChargingSample.json}\n\n- left battery not charging\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsNotChargingSample.json}\n\n- left battery has leak\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasLeakSample.json}\n\n- left batter has no leak\n\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasNoLeakSample.json}"
         },
-        "localHeading": {
-          "description": "Rov local heading\n\nMeasure in degrees from local heading",
-          "maximum": 360,
-          "minimum": -360,
-          "type": "number"
-        },
         "model": {
           "const": 13,
           "type": "number"
@@ -2508,11 +2508,19 @@
           "description": "Provides messages driven by state of the update. WebApp may\nchoose to display these messages as they are delivered.",
           "type": "string"
         },
+        "offlineUpdates": {
+          "$ref": "#/definitions/OfflineUpdateState",
+          "description": "Informs user of the current state of offline updates.\nUser can also set this state to start offline updates or check for available ones."
+        },
         "progress": {
           "description": "Percentage complete indicator.",
           "maximum": 100,
           "minimum": 0,
           "type": "number"
+        },
+        "releaseInfo": {
+          "description": "Returns a valid stringified JSON that contains \na map of device models to their latest available versions. \nThese latest versions could be the same as the current versions of the robot/peripherals\nin which case, there would be no available update.",
+          "type": "string"
         }
       },
       "type": "object"
@@ -2738,6 +2746,10 @@
           "minimum": 0,
           "type": "number"
         },
+        "cpuTemp": {
+          "description": "Camera cpu temperature in Celsius",
+          "type": "number"
+        },
         "exposure": {
           "additionalProperties": false,
           "description": "🔆 Camera Exposure\n\n### Example Payload (Tamron Harrier Zoom Camera)\n\n#### Exposure Samples (A200) ##### a150 at Exposure Auto {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/exposure/a150TamronHarrierZoomCameraExposureAutoSample.json}\n\n##### a150 at Exposure Manual Max value {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/exposure/a150TamronHarrierZoomCameraExposureManualMaxSample.json}\n\n##### a150 at Exposure Manual Min value {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/exposure/a150TamronHarrierZoomCameraExposureManualMinSample.json}\n\n##### a150 at Exposure Manual Random value {@/codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/exposure/a150CameraTamronExposureManualRandomSample.json}\n\n<br /> <br />\n\n#### Exposure Samples (A200) ##### a200 at Exposure Auto {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/exposure/a200TamronHarrierZoomCameraExposureAutoSample.json}\n\n##### a200 at Exposure Manual Max value {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/exposure/a200TamronHarrierZoomCameraExposureManualMaxSample.json}\n\n##### a200 at Exposure Manual Min value {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/exposure/a200TamronHarrierZoomCameraExposureManualMinSample.json}\n\n##### a200 at Exposure Manual Random value {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/exposure/a200TamronHarrierZoomCameraExposureManualRandomSample.json}\n\n<br /> <br />",
@@ -2870,7 +2882,7 @@
       "description": "{@link  ITamronOcleaZoomCamera 📖 See extended definition } \n\n📷 Tamron-OClea Zoom Camera",
       "properties": {
         "cpuTemp": {
-          "description": "The current temperature of the CPU in degrees Celsius.",
+          "description": "Camera cpu temperature in Celsius",
           "type": "number"
         },
         "dptz": {

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

@@ -127,6 +127,20 @@ export type BridgeBox = {
     version?: DeviceVersion;
     /**
      * SWUpdate
+     *
+     * ### Offline Update Samples
+     *
+     * - Check for offline updates
+     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxCheckOfflineUpdatesSample.json}
+     *
+     * - Offline updates available
+     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxOfflineUpdatesAvailableSample.json}
+     *
+     * - System up-to-date (No new offline updates available)
+     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxNoOfflineUpdatesAvailableSample.json}
+     *
+     * - Start offline updates
+     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxStartOfflineUpdatesSample.json}
      */
     swupdate?: SWUpdate;
     /**

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

@@ -188,6 +188,12 @@ export type Camera = {
      * Camera streaming mode information.
      */
     streamMode?: StreamMode;
+    /**
+     * Camera cpu temperature in Celsius
+     *
+     * @readonly
+     */
+    cpuTemp?: number;
 } & Device;
 export * from "./core";
 export * from "./tamronHarrierZoomCamera";

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

@@ -166,10 +166,10 @@ export type GlobalPosition = {
  * @description contains positional data for the ROV in the Local reference frame
  */
 export type LocalPosition = {
-    /** x (in meters) */
-    x?: number;
-    /** y (in meters) */
-    y?: number;
+    /** Northing (in meters) */
+    northing?: number;
+    /** Easting (in meters) */
+    easting?: number;
     /**
      * Uncertainty radius (in meters)
      *

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

@@ -69,16 +69,6 @@ export type Rov = {
      * @readonly
      */
     heading?: number;
-    /**
-     * Rov local heading
-     *
-     * Measure in degrees from local heading
-     *
-     * @minimum -360
-     * @maximum 360
-     *
-     */
-    localHeading?: number;
     /**
      * Rov depth
      *

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

@@ -1,4 +1,11 @@
 import { DeviceModel } from "../devices";
+export declare enum OfflineUpdateState {
+    OFFLINE_AVAILABLE = 0,
+    UPTODATE = 1,
+    CHECKING = 2,
+    CHECK_FOR_UPDATES = 3,
+    START_OFFLINE_UPDATE = 4
+}
 /**
  * FileTransfer
  *
@@ -57,6 +64,20 @@ export type SWUpdate = {
      * @readonly
      */
     log?: string;
+    /**
+     * OfflineUpdates
+     * @description Informs user of the current state of offline updates.
+     * User can also set this state to start offline updates or check for available ones.
+     */
+    offlineUpdates?: OfflineUpdateState;
+    /**
+     * ReleaseInfo
+     * @description Returns a valid stringified JSON that contains
+     * a map of device models to their latest available versions.
+     * These latest versions could be the same as the current versions of the robot/peripherals
+     * in which case, there would be no available update.
+     */
+    releaseInfo?: string;
 };
 /**
  * VersionNote

package/dist/types/swupdates/index.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OfflineUpdateState = void 0;
+var OfflineUpdateState;
+(function (OfflineUpdateState) {
+    //Backend States, do not set these from the front-end.
+    OfflineUpdateState[OfflineUpdateState["OFFLINE_AVAILABLE"] = 0] = "OFFLINE_AVAILABLE";
+    OfflineUpdateState[OfflineUpdateState["UPTODATE"] = 1] = "UPTODATE";
+    OfflineUpdateState[OfflineUpdateState["CHECKING"] = 2] = "CHECKING";
+    //User states
+    OfflineUpdateState[OfflineUpdateState["CHECK_FOR_UPDATES"] = 3] = "CHECK_FOR_UPDATES";
+    OfflineUpdateState[OfflineUpdateState["START_OFFLINE_UPDATE"] = 4] = "START_OFFLINE_UPDATE";
+})(OfflineUpdateState = exports.OfflineUpdateState || (exports.OfflineUpdateState = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "0.57.8",
+    "version": "0.58.0",
     "description": "A business domain of types and schemas that the Deep Trekker topside communicates with via an API.",
     "main": "dist/index.js",
     "engines": {

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

@@ -1,9 +0,0 @@
-import { BridgeBox, TransferPayload } from "../../../../../../types";
-/**
- * Creates an pivot local heading request for samples.
- * @param localHeading
- * @param pivotId
- * @param transferMethodType
- * @returns TransferPayload<BridgeBox>
- */
-export declare const pivotLocalHeadingRequest: (pivotId?: string) => TransferPayload<BridgeBox>;

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

@@ -1,31 +0,0 @@
-"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.pivotLocalHeadingRequest = void 0;
-var core_1 = require("../../../../../core");
-var types_1 = require("../../../../../../types");
-var utils_1 = require("../../../../../../utils");
-/**
- * Creates an pivot local heading request for samples.
- * @param localHeading
- * @param pivotId
- * @param transferMethodType
- * @returns TransferPayload<BridgeBox>
- */
-var pivotLocalHeadingRequest = 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])({
-            localHeading: (0, core_1.r)(-360, 360),
-        }) }));
-};
-exports.pivotLocalHeadingRequest = pivotLocalHeadingRequest;

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

@@ -1,9 +0,0 @@
-import { BridgeBox, TransferPayload } from "../../../../../../types";
-/**
- * Creates an revolution local heading request for samples.
- * @param localHeading
- * @param revolutionId
- * @param transferMethodType
- * @returns TransferPayload<BridgeBox>
- */
-export declare const revolutionLocalHeadingRequest: (revolutionId?: string) => TransferPayload<BridgeBox>;

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

@@ -1,31 +0,0 @@
-"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.revolutionLocalHeadingRequest = void 0;
-var core_1 = require("../../../../../core");
-var types_1 = require("../../../../../../types");
-var utils_1 = require("../../../../../../utils");
-/**
- * Creates an revolution local heading request for samples.
- * @param localHeading
- * @param revolutionId
- * @param transferMethodType
- * @returns TransferPayload<BridgeBox>
- */
-var revolutionLocalHeadingRequest = function (revolutionId) {
-    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
-    return (__assign(__assign({}, (0, core_1.getApiRequest)(types_1.TransferMethodType.Update)), { payload: (0, utils_1.payload)([types_1.DeviceModel.Revolution, revolutionId])({
-            localHeading: (0, core_1.r)(-360, 360),
-        }) }));
-};
-exports.revolutionLocalHeadingRequest = revolutionLocalHeadingRequest;