@deeptrekker/api-domain 0.55.5 → 0.55.6

package/dist/schemas/schema.json

@@ -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

@@ -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

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