npm - @deeptrekker/api-domain - Versions diffs - 0.55.5 → 0.55.7 - Mend

@deeptrekker/api-domain 0.55.5 → 0.55.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1276) hide show

package/dist/samples/json/swupdates/systemUpdatePayloadSample.json CHANGED Viewed

@@ -6,7 +6,7 @@
     "changelog": {
         "19": {
             "0": {
-                "0.0": {
+                "0.1": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -17,7 +17,7 @@
                         ]
                     }
                 },
-                "0.2": {
+                "0.3": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -28,7 +28,7 @@
                         ]
                     }
                 },
-                "0.5": {
+                "0.7": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -39,7 +39,7 @@
                         ]
                     }
                 },
-                "1.6": {
+                "1.3": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -50,7 +50,7 @@
                         ]
                     }
                 },
-                "2.4": {
+                "2.9": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -61,7 +61,7 @@
                         ]
                     }
                 },
-                "3.2": {
+                "3.0": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -85,7 +85,7 @@
                         ]
                     }
                 },
-                "0.3": {
+                "0.2": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -96,7 +96,7 @@
                         ]
                     }
                 },
-                "0.4": {
+                "0.5": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -107,7 +107,7 @@
                         ]
                     }
                 },
-                "1.0": {
+                "1.3": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -118,7 +118,7 @@
                         ]
                     }
                 },
-                "2.1": {
+                "2.9": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -129,7 +129,7 @@
                         ]
                     }
                 },
-                "3.2": {
+                "3.1": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -142,7 +142,7 @@
                 }
             },
             "2": {
-                "0.1": {
+                "0.0": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -153,7 +153,7 @@
                         ]
                     }
                 },
-                "0.3": {
+                "0.2": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -164,7 +164,7 @@
                         ]
                     }
                 },
-                "0.7": {
+                "0.5": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -175,7 +175,7 @@
                         ]
                     }
                 },
-                "1.0": {
+                "1.3": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -186,7 +186,7 @@
                         ]
                     }
                 },
-                "2.7": {
+                "2.5": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -234,7 +234,7 @@
                         ]
                     }
                 },
-                "0.9": {
+                "0.8": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -245,7 +245,7 @@
                         ]
                     }
                 },
-                "1.3": {
+                "1.0": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -256,7 +256,7 @@
                         ]
                     }
                 },
-                "2.7": {
+                "2.2": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -267,7 +267,7 @@
                         ]
                     }
                 },
-                "3.3": {
+                "3.8": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -280,7 +280,7 @@
                 }
             },
             "1": {
-                "0.0": {
+                "0.1": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -291,7 +291,7 @@
                         ]
                     }
                 },
-                "0.3": {
+                "0.2": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -302,7 +302,7 @@
                         ]
                     }
                 },
-                "0.4": {
+                "0.7": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -313,7 +313,7 @@
                         ]
                     }
                 },
-                "1.4": {
+                "1.9": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -324,7 +324,7 @@
                         ]
                     }
                 },
-                "2.8": {
+                "2.2": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -335,7 +335,7 @@
                         ]
                     }
                 },
-                "3.1": {
+                "3.3": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -348,7 +348,7 @@
                 }
             },
             "2": {
-                "0.0": {
+                "0.1": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -359,7 +359,7 @@
                         ]
                     }
                 },
-                "0.2": {
+                "0.3": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -381,7 +381,7 @@
                         ]
                     }
                 },
-                "1.0": {
+                "1.6": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -392,7 +392,7 @@
                         ]
                     }
                 },
-                "2.8": {
+                "2.9": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -403,7 +403,7 @@
                         ]
                     }
                 },
-                "3.0": {
+                "3.9": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -418,7 +418,7 @@
         },
         "108": {
             "0": {
-                "0.0": {
+                "0.1": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -440,7 +440,7 @@
                         ]
                     }
                 },
-                "0.4": {
+                "0.5": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -451,7 +451,7 @@
                         ]
                     }
                 },
-                "1.2": {
+                "1.3": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -462,7 +462,7 @@
                         ]
                     }
                 },
-                "2.1": {
+                "2.7": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -473,7 +473,7 @@
                         ]
                     }
                 },
-                "3.8": {
+                "3.9": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -497,7 +497,7 @@
                         ]
                     }
                 },
-                "0.3": {
+                "0.2": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -519,7 +519,7 @@
                         ]
                     }
                 },
-                "1.7": {
+                "1.5": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -530,7 +530,7 @@
                         ]
                     }
                 },
-                "2.5": {
+                "2.6": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -541,7 +541,7 @@
                         ]
                     }
                 },
-                "3.7": {
+                "3.4": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -565,7 +565,7 @@
                         ]
                     }
                 },
-                "0.2": {
+                "0.3": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -576,7 +576,7 @@
                         ]
                     }
                 },
-                "0.7": {
+                "0.8": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -598,7 +598,7 @@
                         ]
                     }
                 },
-                "2.8": {
+                "2.3": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [
@@ -609,7 +609,7 @@
                         ]
                     }
                 },
-                "3.3": {
+                "3.6": {
                     "releaseDate": "2024-05-27",
                     "versionNotes": {
                         "improvements": [

package/dist/schemas/schema.json CHANGED Viewed

@@ -803,6 +803,9 @@
         },
         {
           "$ref": "#/definitions/Pivot"
+        },
+        {
+          "$ref": "#/definitions/Photon"
         }
       ],
       "description": "Devices\n\nThis is a collection of all devices used."
@@ -1353,6 +1356,145 @@
       },
       "type": "object"
     },
+    "Photon": {
+      "additionalProperties": false,
+      "description": "Photon vehicle type.",
+      "properties": {
+        "altitude": {
+          "description": "Rov altitude\n\nMeasured in meters to show relative distance to floor.\n\n### Example Payloads #### GET Requests\n\n- Random altitude {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json}",
+          "type": "number"
+        },
+        "altitudeValid": {
+          "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"
+        },
+        "auxLight": {
+          "$ref": "#/definitions/Light",
+          "description": "Aux Light\n\nControls the auxiliary light attached to the Photon."
+        },
+        "battery": {
+          "$ref": "#/definitions/Battery",
+          "description": "Battery"
+        },
+        "bodyLeak": {
+          "description": "Body Leak Fault\n\n### Example Payloads #### UPDATE Requests\n\n- Arbitrary {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotBodyLeakRandomSample.json}\n\n- Has no body leak fault {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasNoBodyLeakSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasNoBodyLeakSample.json}\n\n- Has body leak fault {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasBodyLeakSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasBodyLeakSample.json}",
+          "type": "boolean"
+        },
+        "cameraHead": {
+          "$ref": "#/definitions/Removable%3CTiltCameraHead%3E",
+          "description": "Camera Head"
+        },
+        "cameras": {
+          "additionalProperties": {
+            "$ref": "#/definitions/Removable%3CCameras%3E"
+          },
+          "description": "Photon camera",
+          "type": "object"
+        },
+        "cpuTemp": {
+          "description": "Temperature in degrees celsius",
+          "type": "number"
+        },
+        "depth": {
+          "description": "Rov depth\n\nMeasured in meters from water surface\n\nTo Calibrate depth, set depth to '0'. Setting depth to any other value will be ignored.\n\nValid Depth calibration {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/depth/pivotDepthCalibrationSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionDepthCalibrationSample.json}\n\nInvalid Depth Calibration {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/depth/pivotInvalidDepthCalibrationSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionInvalidDepthCalibrationSample.json}",
+          "type": "number"
+        },
+        "drive": {
+          "$ref": "#/definitions/RovDrive",
+          "description": "Rov Drive object\n\nCommands thrust actions for the ROV and sets drive modes\n\nSee  {@link  RovDrive }  for more details.\n\n### Example Payloads #### SET Requests\n\n- Random drive request {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json} {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json}"
+        },
+        "frontLeftMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Motor Diagnostics"
+        },
+        "frontRightMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Motor Diagnostics"
+        },
+        "grabber": {
+          "$ref": "#/definitions/Grabber",
+          "description": "Grabber"
+        },
+        "heading": {
+          "description": "Rov heading\n\nMeasured in degrees from north bearing",
+          "maximum": 360,
+          "minimum": 0,
+          "type": "number"
+        },
+        "inWater": {
+          "description": "Rov in water status",
+          "type": "boolean"
+        },
+        "ip": {
+          "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"
+        },
+        "model": {
+          "const": 24,
+          "type": "number"
+        },
+        "pitch": {
+          "description": "Rov pitch\n\nMeasured in degrees from neutral pitch position",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "position": {
+          "$ref": "#/definitions/Position",
+          "description": "Contains positional data about the ROV.\n\n### Example payloads\n#### UPDATE Requests\n\n- Invalid position sample\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionPositionInvalidSample.json}\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotPositionInvalidSample.json}\n\n- Arbitrary position sample\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionPositionRandomSample.json}\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotPositionRandomSample.json}\n\n#### UPDATE Requests\n\n- Arbitrary Local position only\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionSample.json}\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionRandomSample.json}\n\n- Arbitrary Global position only\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionSample.json}\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionRandomSample.json}"
+        },
+        "rearLeftMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Motor Diagnostics"
+        },
+        "rearRightMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Motor Diagnostics"
+        },
+        "roll": {
+          "description": "Rov roll\n\nMeasured in degrees from neutral roll position",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "sensorPodLeak": {
+          "description": "Sensor Pod Leak Fault\n\nCommon across all ROV and also comes from the ROV Web Adapter in Con_gui",
+          "type": "boolean"
+        },
+        "turns": {
+          "description": "Turns\n\nCount the number of turns the rov has completed",
+          "type": "number"
+        },
+        "usageTime": {
+          "$ref": "#/definitions/UsageTime",
+          "description": "Vehicle Usage Time"
+        },
+        "velocity": {
+          "$ref": "#/definitions/Velocity",
+          "description": "Velocity and speed components for the ROV\n\n### Example payloads\n#### UPDATE Requests\n\n- Arbitrary velocity samples\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/velocity/revolutionVelocityRandomSample.json}\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/velocity/pivotVelocityRandomSample.json}"
+        },
+        "version": {
+          "$ref": "#/definitions/DeviceVersion",
+          "description": "Photon Version"
+        },
+        "verticalLeftMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Motor Diagnostics"
+        },
+        "verticalRightMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Motor Diagnostics"
+        },
+        "waterTemp": {
+          "description": "Water temperature in degrees celsius",
+          "type": "number"
+        }
+      },
+      "required": [
+        "model"
+      ],
+      "type": "object"
+    },
     "PhysicalLocation": {
       "description": "Network Diagnostics Physical Location enum",
       "enum": [

package/dist/types/devices/types/index.d.ts CHANGED Viewed

@@ -1,8 +1,8 @@
 import { ManualReel, PoweredReel } from "../reels";
-import { A200, A150, Revolution, Pivot } from "../vehicles";
+import { A200, A150, Revolution, Pivot, Photon } from "../vehicles";
 /**
  * Devices
  *
  * This is a collection of all devices used.
  */
-export type Devices = A200 | A150 | ManualReel | PoweredReel | Revolution | Pivot;
+export type Devices = A200 | A150 | ManualReel | PoweredReel | Revolution | Pivot | Photon;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "0.55.5",
+    "version": "0.55.7",
     "description": "A business domain of types and schemas that the DeepTrekker topside communicates with via an API.",
     "main": "dist/index.js",
     "files": [