Options
All
  • Public
  • Public/Protected
  • All
Menu
notexported

See type declaration

Photon ROV

Hierarchy

Index

Properties

altitude?: number

Rov altitude

Measured in meters to show relative distance to floor.

Example Payloads

GET Requests

  • Random altitude

    From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "576D07DA9422": {
    "model": 18,
    "altitude": 194
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A1C65FF0FF05": {
    "model": 13,
    "altitudeValid": false
    }
    }
    }
    }
readonly
altitudeValid?: boolean

Rov altitude valid

Altitude validity flag

Example Payloads

UPDATE Requests

  • Valid altitude (good data)

    From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BDD8EA1D7C2E": {
    "model": 18,
    "altitude": 92,
    "altitudeValid": true
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D213C4973A66": {
    "model": 13,
    "altitudeValid": true,
    "altitude": 24
    }
    }
    }
    }
  • Random altitude validity

    From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E651B9C74380": {
    "model": 18,
    "altitudeValid": true
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A1C65FF0FF05": {
    "model": 13,
    "altitudeValid": false
    }
    }
    }
    }
readonly
auxLight?: Light

Aux Light

Controls the auxiliary light attached to the Photon.

battery?: Battery

Battery

bodyLeak?: boolean

Body Leak Fault

Example Payloads

UPDATE Requests

  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0FAB44D87583": {
    "model": 13,
    "bodyLeak": false
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotBodyLeakRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5532C0DB5E85": {
    "model": 18,
    "bodyLeak": true
    }
    }
    }
    }
  • Has no body leak fault

    From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasNoBodyLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "171021B95459": {
    "model": 13,
    "bodyLeak": false
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasNoBodyLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D34656FECFF5": {
    "model": 18,
    "bodyLeak": false
    }
    }
    }
    }
  • Has body leak fault

    From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasBodyLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "44C72D05E0FE": {
    "model": 13,
    "bodyLeak": true
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasBodyLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "DEE24D094F69": {
    "model": 18,
    "bodyLeak": true
    }
    }
    }
    }
readonly

Camera Head

cameras?: Record<string, Removable<Cameras>>

Photon camera

cpProbe?: string

The cp probe

cpuTemp?: number

Temperature in degrees celsius

cygnus?: cygnusType

The ut(cygnus) probe

depth?: number

Rov depth

Measured in meters from water surface

To Calibrate depth, set depth to '0'. Setting depth to any other value will be ignored.

Valid Depth calibration

From ./dist/samples/json/requests/devices/vehicles/pivot/depth/pivotDepthCalibrationSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"1C4750BE5110": {
"model": 18,
"depth": 0
}
}
}
}

From ./dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionDepthCalibrationSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"9194AF2E0F55": {
"model": 13,
"depth": 0
}
}
}
}

Invalid Depth Calibration

From ./dist/samples/json/requests/devices/vehicles/pivot/depth/pivotInvalidDepthCalibrationSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"AE9AC18A1FA8": {
"model": 18,
"depth": 6
}
}
}
}

From ./dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionInvalidDepthCalibrationSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"E1B0CB6A162F": {
"model": 13,
"depth": 13
}
}
}
}
readonly
directPowerKitPresent?: boolean

Direct Power Kit Present Flag

readonly
drive?: RovDrive

Rov Drive object

Commands thrust actions for the ROV and sets drive modes

See RovDrive for more details.

Example Payloads

SET Requests

  • Random drive request

    From ./dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "SET",
    "payload": {
    "devices": {
    "6C30E93EB49F": {
    "model": 18,
    "drive": {
    "thrust": {
    "forward": 52,
    "yaw": -14,
    "vertical": -9,
    "lateral": 80
    },
    "modes": {
    "headingLock": true,
    "altitudeLock": true,
    "depthLock": false,
    "autoStabilization": true,
    "motorsDisabled": false
    }
    }
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "SET",
    "payload": {
    "devices": {
    "BB51D366A8C6": {
    "model": 13,
    "drive": {
    "thrust": {
    "forward": -67,
    "yaw": -94,
    "vertical": -85,
    "lateral": -81
    },
    "modes": {
    "headingLock": false,
    "altitudeLock": true,
    "depthLock": true,
    "autoStabilization": false,
    "motorsDisabled": true
    }
    }
    }
    }
    }
    }
echosounder?: Echosounder

Echosounder device information and control

forwardDistance?: number

Rov Forward distance

Measured in meters to show relative distance to an object ahead of the ROV.

readonly
frontLeftMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

frontRightMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

grabber?: Grabber

Grabber

heading?: number

Rov heading

Measured in degrees from north bearing

minimum

0

maximum

360

readonly
inWater?: boolean

Rov in water status

readonly

Example Payloads

UPDATE Requests

  • Pivot in water

    From ./dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotInWaterSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "62150D457CA3": {
    "model": 18,
    "inWater": true
    }
    }
    }
    }
  • Pivot out of water

    From ./dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotOutOfWaterSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D9A0EAC75623": {
    "model": 18,
    "inWater": false
    }
    }
    }
    }
  • Pivot in water random status sample

    From ./dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotInWaterRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6072A76AF35F": {
    "model": 18,
    "inWater": true
    }
    }
    }
    }
  • Revolution out of water

    From ./dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionOutOfWaterSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "04C358AB2E62": {
    "model": 13,
    "inWater": false
    }
    }
    }
    }
  • Revolution in water

    From ./dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionInWaterSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C42197C15B01": {
    "model": 13,
    "inWater": true
    }
    }
    }
    }
  • Revolution in water random status sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionInWaterRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "DDC19A5C3381": {
    "model": 13,
    "inWater": false
    }
    }
    }
    }
ip?: string
  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "SET",
    "payload": {
    "devices": {
    "3417009E22A4": {
    "model": 13,
    "ip": "192.168.171.126"
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/ip/pivotIpRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "SET",
    "payload": {
    "devices": {
    "1E3EE4D0B774": {
    "model": 18,
    "ip": "192.168.2.99"
    }
    }
    }
    }
readonly
localHeading?: number

Rov local heading

Measure in degrees from local heading

minimum

-360

maximum

360

locationForwarderOptions?: LocationForwarderOptions

Location Forwarding Options

description

Locaiton forwarder settings and options for the ROV and Topside location forwarding

model: Photon
navigationOptions?: NavigationOptions

Navigation Options

description

Navigation settings and options for the ROV

pitch?: number

Rov pitch

Measured in degrees from neutral pitch position

minimum

-180.0

maximum

180.0

readonly
position?: Position

ROV Position

description

Contains positional data about the ROV.

Example payloads

UPDATE Requests

  • Invalid position sample

  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionInvalidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5C69029E9519": {
    "model": 13,
    "position": {
    "local": {
    "uncertainty": 10000
    }
    }
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionInvalidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "99D8124340DD": {
    "model": 13,
    "position": {
    "global": {
    "uncertainty": 10000
    }
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionInvalidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A335B9A8AECD": {
    "model": 18,
    "position": {
    "local": {
    "uncertainty": 10000
    }
    }
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionInvalidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D403DE0C8B81": {
    "model": 18,
    "position": {
    "global": {
    "uncertainty": 10000
    }
    }
    }
    }
    }
    }
  • Arbitrary position sample

  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E2D6F7039DC5": {
    "model": 13,
    "position": {
    "local": {
    "x": 92,
    "y": -22,
    "uncertainty": 29
    }
    }
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5EAFCE71B1AD": {
    "model": 13,
    "position": {
    "global": {
    "latitude": -61,
    "longitude": 56,
    "uncertainty": 66
    }
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E23F79C03185": {
    "model": 18,
    "position": {
    "local": {
    "x": 614,
    "y": 412,
    "uncertainty": 77
    }
    }
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4059F7BCFC7C": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -62,
    "longitude": 142,
    "uncertainty": 41
    }
    }
    }
    }
    }
    }

UPDATE Requests

  • Arbitrary Local position only

  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F4D98B1757D9": {
    "model": 13,
    "position": {
    "local": {
    "x": 10,
    "y": 10,
    "uncertainty": 10
    }
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E23F79C03185": {
    "model": 18,
    "position": {
    "local": {
    "x": 614,
    "y": 412,
    "uncertainty": 77
    }
    }
    }
    }
    }
    }
  • Arbitrary Global position only

  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "99DD8F8453E6": {
    "model": 13,
    "position": {
    "global": {
    "latitude": 10,
    "longitude": 10,
    "uncertainty": 10
    }
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4059F7BCFC7C": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -62,
    "longitude": 142,
    "uncertainty": 41
    }
    }
    }
    }
    }
    }
rearLeftMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

rearRightMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

roll?: number

Rov roll

Measured in degrees from neutral roll position

minimum

-180.0

maximum

180.0

readonly

Sensor pod information and calibration controls based on the model.

  • 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

dist/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

  • 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

dist/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

  • 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

  • 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

  • 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?: boolean

Sensor Pod Leak Fault

Common across all ROV and also comes from the ROV Web Adapter in Con_gui

turns?: number

Turns

Count the number of turns the rov has completed

readonly
usageTime?: UsageTime

Vehicle Usage Time

velocity?: Velocity

Rov Velocity

description

Velocity and speed components for the ROV

Example payloads

UPDATE Requests

  • Arbitrary velocity samples
  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/velocity/revolutionVelocityRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "49ECDB6E8A6D": {
    "model": 13,
    "velocity": {
    "valid": false,
    "forward": 61,
    "rightward": 58,
    "downward": 26,
    "speed": 100
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/velocity/pivotVelocityRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0639D6EB167B": {
    "model": 18,
    "velocity": {
    "valid": true,
    "forward": -89,
    "rightward": -5,
    "downward": -36,
    "speed": 20
    }
    }
    }
    }
    }
version?: DeviceVersion

Photon Version

verticalLeftMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

verticalRightMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

waterTemp?: number

Water temperature in degrees celsius