@deeptrekker/api-domain 0.58.14 → 0.58.15-rca-1145-add-topside-location-source-to.1

package/dist/schemas/schema.json

@@ -623,6 +623,10 @@
           "description": "IP address",
           "type": "string"
         },
+        "macAddressId": {
+          "description": "The unique identifier of the sensor pod, typically a MAC address.",
+          "type": "string"
+        },
         "magnetic": {
           "additionalProperties": false,
           "description": "Calibratable magnetic sensor",
@@ -832,6 +836,110 @@
       ],
       "type": "string"
     },
+    "DT645": {
+      "additionalProperties": false,
+      "description": "{@link  IDT645 📖 See extended definition } \n\nDT645 Class\n\nDT645 vehicle type.",
+      "properties": {
+        "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"
+        },
+        "cameraHead": {
+          "$ref": "#/definitions/Removable%3CA150CameraHead%3E",
+          "description": "Camera Head\n\nThe rotating part of the camera that controls its pan and tilt orientation.\n\n### Example Payloads #### DELETE Requests\n\n- a150 camera head {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameraHead/a150CameraHead/core/a150A150CameraHeadSample.json}"
+        },
+        "cameras": {
+          "additionalProperties": {
+            "$ref": "#/definitions/Removable%3CCameras%3E"
+          },
+          "description": "📷 List of cameras\n\nHolds a list of all vehicle Cameras.",
+          "type": "object"
+        },
+        "cpProbe": {
+          "description": "The cp probe",
+          "type": "string"
+        },
+        "cygnus": {
+          "$ref": "#/definitions/cygnusType",
+          "description": "The ut(cygnus) probe"
+        },
+        "depth": {
+          "description": "Depth\n\nMeasures the depth of DT645 Utility Crawler (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/dt645/depth/dt645ValidDepthCalibrationSample.json}\n\nInvalid Depth Calibration {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/depth/dt645InvalidDepthCalibrationSample.json}",
+          "type": "number"
+        },
+        "drive": {
+          "$ref": "#/definitions/DT645Drive",
+          "description": "Drive Controls\n\nControls the direction of drive for the Dt645 Utility Crawler.\n\n### Example Payloads #### SET Requests\n\n- Arbitrary Values {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveRandomSample.json}\n\n- Random Speed {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSpeedRandomSample.json}\n\n- Max Speed Forward Speed {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMaxSpeedForwardSample.json}\n\n- Max Speed Backward Speed {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMaxSpeedBackwardSample.json}\n\n- Stop Motor {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMotorStopSample.json}\n\n- Random Steer {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerRandomSample.json}\n\n- Steer Left {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerLeftSample.json}\n\n- Steer Right {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerRightSample.json}\n\n- Stop Steer {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerStopSample.json}\n\n- Motors Disabled {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645MotorsDisabledSample.json}\n\n- Motors Enabled {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/drive/dt645MotorsEnabledSample.json}"
+        },
+        "heading": {
+          "description": "Heading\n\nThe direction that the DT645 Utility Crawler is facing. Measured in degrees from north bearing.\n\n- Random Heading {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/heading/dt645HeadingRandomSample.json}",
+          "maximum": 360,
+          "minimum": 0,
+          "type": "number"
+        },
+        "incline": {
+          "description": "Incline\n\nThe angle at which the DT645 Utility Crawler is positioned relative to a flat surface.\n\n- Random Incline {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineRandomSample.json}\n\n- Min Incline {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineMinSample.json}\n\n- Max Incline {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineMaxSample.json}",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "ip": {
+          "description": "IP address",
+          "type": "string"
+        },
+        "model": {
+          "const": 22,
+          "type": "number"
+        },
+        "pitch": {
+          "description": "Pitch\n\nMeasured in degrees from the neutral pitch position.\n\n- Random Pitch {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchRandomSample.json}\n\n- Min Pitch {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchMinSample.json}\n\n- Max Pitch {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchMaxSample.json}",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "roll": {
+          "description": "Roll\n\nRotation of the DT645 Utility Crawler around its front-to-back (longitudinal) axis.\n\n- Random Roll {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollRandomSample.json}\n\n- Min Roll {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollMinSample.json}\n\n- Max Roll {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollMaxSample.json}",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "usageTime": {
+          "$ref": "#/definitions/UsageTime",
+          "description": "Usage Time\n\n### Example Payloads #### GET Requests\n\n- Current seconds {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645CurrentSecondsRandomSample.json}\n\n- Total Seconds {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645TotalSecondsRandomSample.json}\n\n- Arbitrary Total Usage {@codeblock ~~/dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645UsageTimeRandomSample.json}"
+        },
+        "version": {
+          "$ref": "#/definitions/DeviceVersion",
+          "description": "Version"
+        }
+      },
+      "required": [
+        "model"
+      ],
+      "type": "object"
+    },
+    "DT645Drive": {
+      "additionalProperties": false,
+      "description": "Dt645 Drive",
+      "properties": {
+        "motorsDisabled": {
+          "description": "Motors Disabled\n\nWhen enabled, prevents any motor commands from being accepted by firmware",
+          "type": "boolean"
+        },
+        "speed": {
+          "description": "Negative values for reverse, positive for forward\nIgnored by the crawler when it is in either retrieval assist or retrieval cruise modes",
+          "maximum": 120,
+          "minimum": -120,
+          "type": "number"
+        },
+        "steer": {
+          "description": "Steering — Negative values for left, positive for right Ignored by the crawler when it is in either retrieval assist or retrieval cruise modes",
+          "maximum": 120,
+          "minimum": -120,
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
     "DTCam": {
       "additionalProperties": false,
       "description": "{@link  IDtCam 📖 See extended definition } \n\n📷 DT Cam",
@@ -924,6 +1032,31 @@
       ],
       "type": "object"
     },
+    "DVL": {
+      "additionalProperties": false,
+      "properties": {
+        "ip": {
+          "description": "IP address",
+          "type": "string"
+        },
+        "macAddressId": {
+          "description": "The unique identifier of the DVL, typically a MAC address. This is used to identify the DVL in the network.",
+          "type": "string"
+        },
+        "model": {
+          "$ref": "#/definitions/DeviceModel",
+          "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
+        },
+        "version": {
+          "$ref": "#/definitions/DeviceVersion",
+          "description": "Version"
+        }
+      },
+      "required": [
+        "model"
+      ],
+      "type": "object"
+    },
     "DateTime": {
       "additionalProperties": false,
       "description": "DateTime\n\nAn endpoint to facilitate requesting and adjusting the datetime of the BridgeBox.",
@@ -943,9 +1076,8 @@
       "description": "Deep Trekker internal device model numbers. TODO: add all model numbers",
       "enum": [
         20,
-        109,
         19,
-        106,
+        22,
         240,
         5,
         206,
@@ -953,16 +1085,20 @@
         207,
         241,
         24,
+        16,
         13,
-        102,
         18,
+        102,
         103,
+        109,
+        106,
         107,
         108,
         "BRIDGEBOX",
         100,
         101,
-        244
+        244,
+        104
       ],
       "type": [
         "number",
@@ -1007,6 +1143,12 @@
         },
         {
           "$ref": "#/definitions/Photon"
+        },
+        {
+          "$ref": "#/definitions/Onyx"
+        },
+        {
+          "$ref": "#/definitions/DT645"
         }
       ],
       "description": "Devices\n\nThis is a collection of all devices used."
@@ -1142,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",
@@ -1383,9 +1552,28 @@
               "description": "Indicates if the ROV has dead reckoning capability",
               "type": "boolean"
             },
+            "rovGpsFixStatus": {
+              "description": "Denotes the GPS Fix value for the ROV gps, extracted from the GGA message received from the GPS Device.\n\nFor more information look at GGA NMEA message structure.",
+              "type": "number"
+            },
+            "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."
+            },
+            "topsideGpsFixStatus": {
+              "description": "Denotes the GPS Fix value for the TOPSIDE gps, extracted from the GGA message received from the GPS Device.\n\nFor more information look at GGA NMEA message structure.",
+              "type": "number"
+            },
+            "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"
@@ -1765,6 +1953,194 @@
       ],
       "type": "number"
     },
+    "Onyx": {
+      "additionalProperties": false,
+      "description": "Onyx 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"
+        },
+        "auxLights": {
+          "additionalProperties": {
+            "$ref": "#/definitions/Removable%3CLight%3E"
+          },
+          "description": "Aux Light",
+          "type": "object"
+        },
+        "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"
+        },
+        "cameraHeads": {
+          "additionalProperties": {
+            "anyOf": [
+              {
+                "$ref": "#/definitions/Removable%3CA200CameraHead%3E"
+              },
+              {
+                "$ref": "#/definitions/Removable%3CA150CameraHead%3E"
+              },
+              {
+                "$ref": "#/definitions/Removable%3CTiltCameraHead%3E"
+              }
+            ]
+          },
+          "description": "Camera Head",
+          "type": "object"
+        },
+        "cameras": {
+          "additionalProperties": {
+            "$ref": "#/definitions/Removable%3CCameras%3E"
+          },
+          "description": "Onyx camera",
+          "type": "object"
+        },
+        "cpProbe": {
+          "description": "The cp probe",
+          "type": "string"
+        },
+        "cpuTemp": {
+          "description": "Temperature in degrees celsius",
+          "type": "number"
+        },
+        "cygnus": {
+          "$ref": "#/definitions/cygnusType",
+          "description": "The ut(cygnus) probe"
+        },
+        "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"
+        },
+        "directPowerKitPresent": {
+          "description": "Direct Power Kit Present Flag",
+          "type": "boolean"
+        },
+        "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}"
+        },
+        "dvl": {
+          "$ref": "#/definitions/DVL",
+          "description": "DVL"
+        },
+        "echosounder": {
+          "$ref": "#/definitions/Echosounder",
+          "description": "Echosounder device information and control"
+        },
+        "forwardDistance": {
+          "description": "Rov Forward distance\n\nMeasured in meters to show relative distance to an object ahead of the ROV.",
+          "type": "number"
+        },
+        "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"
+        },
+        "leftBattery": {
+          "$ref": "#/definitions/Battery",
+          "description": "Left Battery"
+        },
+        "leftMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Left Motor Diagnostics"
+        },
+        "localHeading": {
+          "description": "Rov local heading\n\nMeasure in degrees from local heading",
+          "maximum": 360,
+          "minimum": -360,
+          "type": "number"
+        },
+        "locationForwarderOptions": {
+          "$ref": "#/definitions/LocationForwarderOptions",
+          "description": "Locaiton forwarder settings and options for the ROV and Topside location forwarding"
+        },
+        "model": {
+          "const": 16,
+          "type": "number"
+        },
+        "navigationOptions": {
+          "$ref": "#/definitions/NavigationOptions",
+          "description": "Navigation settings and options for the ROV"
+        },
+        "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/revolutionLocalPositionInvalidSample.json}\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionInvalidSample.json}\n\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionInvalidSample.json}\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionInvalidSample.json}\n\n\n- Arbitrary position sample\n- Revolution\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionRandomSample.json}\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionRandomSample.json}\n\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionRandomSample.json}\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionRandomSample.json}\n\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\n- Pivot\n{@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionRandomSample.json}\n\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}"
+        },
+        "rightBattery": {
+          "$ref": "#/definitions/Battery",
+          "description": "Right Battery"
+        },
+        "rightMotorDiagnostics": {
+          "$ref": "#/definitions/MotorDiagnostics",
+          "description": "Right Motor Diagnostics"
+        },
+        "roll": {
+          "description": "Rov roll\n\nMeasured in degrees from neutral roll position",
+          "maximum": 180,
+          "minimum": -180,
+          "type": "number"
+        },
+        "sensorPod": {
+          "$ref": "#/definitions/CalibratableSensorPod",
+          "description": "Sensor pod information and calibration controls based on the model. \n\n- Revolution Calibration User Actions for IMU Calibration.  dist/samples/json/requests/devices/vehicles/revolution/calibration/startImuCalibration/revolutionStartImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/stopImuCalibration/revolutionStopImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/denyImuCalibration/revolutionDenyImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptImuCalibration/revolutionAcceptImuCalibrationRequest.json\n\ndist/samples/json/requests/devices/vehicles/pivot/calibration/startImuCalibration/pivotStartImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/stopImuCalibration/pivotStopImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/denyImuCalibration/pivotDenyImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptImuCalibration/pivotAcceptImuCalibrationRequest.json\n\n- Revolution Calibration User Actions for Magnetic Calibration.  dist/samples/json/requests/devices/vehicles/revolution/calibration/startMagneticCalibration/revolutionStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/stopMagneticCalibration/revolutionStopMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/denyMagneticCalibration/revolutionDenyMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptMagneticCalibration/revolutionAcceptMagneticCalibrationRequest.json\n\ndist/samples/json/requests/devices/vehicles/pivot/calibration/startMagneticCalibration/pivotStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/stopMagneticCalibration/pivotStopMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/denyMagneticCalibration/pivotDenyMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptMagneticCalibration/pivotAcceptMagneticCalibrationRequest.json\n\n- Revolution and Pivot Pending IMU update dist/samples/json/requests/devices/vehicles/revolution/calibration/startMagneticCalibration/revolutionStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorPendingImuCalibration/pivotPendingImuRandomUpdate.json\n\n- Revolution and Pivot Pending Magnetic update dist/samples/json/requests/devices/vehicles/revolution/calibration/sensorMagneticCalibration/revolutionPendingMagneticRandomUpdate.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorPendingMagneticCalibration/pivotPendingMagneticRandomUpdate.json\n\n- Revolution and Pivot Accepted Magnetic and IMU update dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptMagneticCalibration/revolutionAcceptMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptMagneticCalibration/pivotAcceptMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorNotCalibratingState/pivotAcceptedRandomUpdate.json dist/samples/json/requests/devices/vehicles/revolution/calibration/sensorNotCalibratingState/revolutionAcceptedRandomUpdate.json"
+        },
+        "sensorPodLeak": {
+          "description": "Sensor Pod Leak Fault\n\nCommon across all ROV and also comes from the ROV Web Adapter in Con_gui",
+          "type": "boolean"
+        },
+        "spareMotors": {
+          "additionalProperties": {
+            "$ref": "#/definitions/Removable%3CMotorDiagnostics%3E"
+          },
+          "description": "Provides diagnostics for spare motors on the Rov. These spare motors can be used to extend the capabilities of the ROV by attaching various power tools to them. These tools can include CaviBlasters, cutters and etc.",
+          "type": "object"
+        },
+        "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": "Onyx Version"
+        },
+        "waterTemp": {
+          "description": "Water temperature in degrees celsius",
+          "type": "number"
+        }
+      },
+      "required": [
+        "model"
+      ],
+      "type": "object"
+    },
     "Osd": {
       "additionalProperties": false,
       "description": "OSD (On-screen Display)",
@@ -1843,6 +2219,10 @@
           "$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}"
         },
+        "dvl": {
+          "$ref": "#/definitions/DVL",
+          "description": "DVL"
+        },
         "echosounder": {
           "$ref": "#/definitions/Echosounder",
           "description": "Echosounder device information and control"
@@ -2024,6 +2404,10 @@
           "$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}"
         },
+        "dvl": {
+          "$ref": "#/definitions/DVL",
+          "description": "DVL"
+        },
         "echosounder": {
           "$ref": "#/definitions/Echosounder",
           "description": "Echosounder device information and control"
@@ -2181,7 +2565,8 @@
       "enum": [
         "NONE",
         "SEATRAC_USBL",
-        "EXTERNAL_GPS"
+        "EXTERNAL_GPS",
+        "STATIC"
       ],
       "type": "string"
     },
@@ -2362,6 +2747,34 @@
       ],
       "description": "Removable\n\nRepresents an object that can be removed."
     },
+    "Removable<Light>": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Light"
+        },
+        {
+          "additionalProperties": {
+            "not": {}
+          },
+          "type": "object"
+        }
+      ],
+      "description": "Removable\n\nRepresents an object that can be removed."
+    },
+    "Removable<MotorDiagnostics>": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/MotorDiagnostics"
+        },
+        {
+          "additionalProperties": {
+            "not": {}
+          },
+          "type": "object"
+        }
+      ],
+      "description": "Removable\n\nRepresents an object that can be removed."
+    },
     "Removable<TiltCameraHead>": {
       "anyOf": [
         {
@@ -2444,6 +2857,10 @@
           "$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}"
         },
+        "dvl": {
+          "$ref": "#/definitions/DVL",
+          "description": "DVL"
+        },
         "echosounder": {
           "$ref": "#/definitions/Echosounder",
           "description": "Echosounder device information and control"
@@ -2655,9 +3072,7 @@
       },
       "required": [
         "forward",
-        "yaw",
-        "vertical",
-        "lateral"
+        "yaw"
       ],
       "type": "object"
     },
@@ -2709,6 +3124,10 @@
           "$ref": "#/definitions/SerialDeviceType",
           "description": "Indicates the type of device"
         },
+        "isConfigurable": {
+          "description": "Denotes if a serial device is configurable by the user.  Typically, un-configurable devices will not accept Baud Rate from users.",
+          "type": "boolean"
+        },
         "name": {
           "description": "The display name of this device",
           "type": "string"
@@ -2765,10 +3184,18 @@
           "description": "The gain of the sonar",
           "type": "number"
         },
+        "ip": {
+          "description": "The dynamic IP address of the sonar. This is the IP address assigned to the sonar by the network's DHCP server. It can change over time, especially if the sonar is restarted or the network configuration changes.",
+          "type": "string"
+        },
         "lowPower": {
           "description": "The low power state of the device",
           "type": "boolean"
         },
+        "macAddressId": {
+          "description": "The sonar's unique identifier, typically a MAC address. This is used to identify the sonar in the network.",
+          "type": "string"
+        },
         "maxRange": {
           "description": "Maximum range that the sonar can be configured to.",
           "type": "number"
@@ -2784,6 +3211,10 @@
         "range": {
           "description": "The range of the sonar",
           "type": "number"
+        },
+        "salinity": {
+          "description": "The salinity of the water that the sonar is operating in. Helps decide the speed of sound.",
+          "type": "number"
         }
       },
       "type": "object"
@@ -3167,9 +3598,7 @@
         },
         "turbidityFilter": {
           "$ref": "#/definitions/TurbidityFilter",
-          "description": "Camera Turbidity Filter\n\n### Example Payload (Tamron Oclea Zoom Camera)\n\n#### Turbidity Filter Strength Samples (A150) ##### at Filter Strength Max {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthMaxSample.json\n\n##### at Filter Strength Min {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthMinSample.json\n\n##### at Filter Strength Random {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthRandomSample.json\n\n<br /> <br />\n\n#### Turbidity Filter Strength Samples (A200) ##### at Filter Strength Max {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthMaxSample.json\n\n##### at Filter Strength Min {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthMinSample.json\n\n#####  at Filter Strength Random {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthRandomSample.json\n\n<br /> <br />",
-          "maximum": 30,
-          "minimum": 1
+          "description": "Camera Turbidity Filter\n\n### Example Payload (Tamron Oclea Zoom Camera)\n\n#### Turbidity Filter Strength Samples (A150) ##### at Filter Strength Max {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthMaxSample.json\n\n##### at Filter Strength Min {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthMinSample.json\n\n##### at Filter Strength Random {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a150/cameras/tamronOcleaZoomCamera/turbidityStrength/a150TamronOcleaZoomCameraTurbidityStrengthRandomSample.json\n\n<br /> <br />\n\n#### Turbidity Filter Strength Samples (A200) ##### at Filter Strength Max {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthMaxSample.json\n\n##### at Filter Strength Min {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthMinSample.json\n\n#####  at Filter Strength Random {@codeblock ~~/dist/samples/json/requests/devices/vehicles/a200/cameras/tamronOcleaZoomCamera/turbidityStrength/a200TamronOcleaZoomCameraTurbidityStrengthRandomSample.json\n\n<br /> <br />"
         },
         "type": {
           "$ref": "#/definitions/CameraType",
@@ -3265,6 +3694,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/cameras/tamronOcleaZoomCamera/index.d.ts

@@ -306,8 +306,6 @@ export type TamronOcleaZoomCamera = Camera & {
      * <br />
      * <br />
      *
-     * @minimum 1
-     * @maximum 30
      */
     turbidityFilter?: TurbidityFilter;
 };