Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRevolution

notexported

See type declaration

Revolution ROV

DELETE Request

From ./dist/samples/json/requests/devices/vehicles/revolution/core/revolutionDeleteSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "DELETE",
    "payload": {
        "devices": {
            "172AEEA7432A": {
                "model": 13
            }
        }
    }
}

Hierarchy

Index

Properties

Properties

Optional altitude

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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0E0A9FD6FF5D": {
                    "model": 18,
                    "altitude": 195
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5562F1FF58E1": {
                    "model": 13,
                    "altitudeValid": true
                }
            }
        }
    }
readonly

Optional altitudeValid

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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0155094090BB": {
                    "model": 18,
                    "altitude": 134,
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E3EC75DD1E89": {
                    "model": 13,
                    "altitudeValid": true,
                    "altitude": 233
                }
            }
        }
    }

  • 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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "976C4DFF76D3": {
                    "model": 18,
                    "altitudeValid": false
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5562F1FF58E1": {
                    "model": 13,
                    "altitudeValid": true
                }
            }
        }
    }
readonly

Optional autoSnapshot

autoSnapshot?: { session?: { active?: boolean; cameras?: string; interval?: SnapshotIntervals } }

Type declaration

  • Optional session?: { active?: boolean; cameras?: string; interval?: SnapshotIntervals }
    • Optional active?: boolean
    • Optional cameras?: string
    • Optional interval?: SnapshotIntervals

Optional auxLight

auxLight?: Light

Aux Light

Controls the auxiliary light attached to the Revolution.

remarks

See Light type for more details.

Example Payloads

SET Requests
  • Light On (mid)

From ./dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMidIntensitySample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "6C56754449A8": {
                "model": 13,
                "auxLight": {
                    "intensity": 50
                }
            }
        }
    }
}
  • Light Off

From ./dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOffSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "4CAF76AC90A6": {
                "model": 13,
                "auxLight": {
                    "intensity": 0
                }
            }
        }
    }
}
  • Light On (max)

From ./dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMaxIntensitySample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "90F81A7C6F97": {
                "model": 13,
                "auxLight": {
                    "intensity": 100
                }
            }
        }
    }
}
  • Arbitrary

From ./dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "2FF24E754077": {
                "model": 13,
                "auxLight": {
                    "intensity": 15
                }
            }
        }
    }
}

Optional bodyLeak

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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "8DC7A5FB9067": {
                    "model": 13,
                    "bodyLeak": true
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "9DA6821E8037": {
                    "model": 18,
                    "bodyLeak": false
                }
            }
        }
    }

  • 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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "C0BB97771BE1": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "57414786871B": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A569F5ECB792": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0A30D13438EC": {
                    "model": 18,
                    "bodyLeak": true
                }
            }
        }
    }
readonly

Optional cameraHead

cameraHead?: Removable<TiltCameraHead>

Camera Head

Controls the camera head attached to the revolution

remarks

See cameraHead type for more details

Example Payloads

Set Requests

Optional cameras

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

📷 List of cameras

Holds a list of all vehicle Cameras.

Optional cpProbe

cpProbe?: string

The cp probe

Optional cpuTemp

cpuTemp?: number

CPU temperature sensors in degrees celsius

Example Payloads

UPDATE Requests
  • Arbitrary

From ./dist/samples/json/requests/devices/vehicles/revolution/cpuTemp/revolutionCpuTempRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "33A983E4DB13": {
                "model": 13,
                "cpuTemp": 84
            }
        }
    }
}

Optional cygnus

cygnus?: cygnusType

The ut(cygnus) probe

Optional depth

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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "FCE128BC2DC6": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "A43B75DBCFC3": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "D989AB58D90F": {
                "model": 18,
                "depth": 92
            }
        }
    }
}

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "D5B3C915E2F8": {
                "model": 13,
                "depth": 171
            }
        }
    }
}
readonly

Optional directPowerKitPresent

directPowerKitPresent?: boolean

Direct Power Kit Present Flag

readonly

Optional drive

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.61.0",
        "method": "SET",
        "payload": {
            "devices": {
                "BC1EAB0AB33E": {
                    "model": 18,
                    "drive": {
                        "thrust": {
                            "forward": 1,
                            "yaw": -98,
                            "vertical": -64,
                            "lateral": 44
                        },
                        "modes": {
                            "headingLock": true,
                            "altitudeLock": true,
                            "depthLock": false,
                            "autoStabilization": true,
                            "motorsDisabled": true
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "SET",
        "payload": {
            "devices": {
                "29B8F0287A8A": {
                    "model": 13,
                    "drive": {
                        "thrust": {
                            "forward": 80,
                            "yaw": 31,
                            "vertical": 96,
                            "lateral": -65
                        },
                        "modes": {
                            "headingLock": true,
                            "altitudeLock": false,
                            "depthLock": false,
                            "autoStabilization": true,
                            "motorsDisabled": true
                        }
                    }
                }
            }
        }
    }

Optional dvl

dvl?: DVL

DVL

readonly

Optional echosounder

echosounder?: Echosounder

Echosounder device information and control

Optional forwardDistance

forwardDistance?: number

Rov Forward distance

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

readonly

Optional frontLeftMotorDiagnostics

frontLeftMotorDiagnostics?: MotorDiagnostics

Front Left Motor Diagnostics

Example Payloads

UPDATE Requests
  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DEBB83376855": {
                "model": 13,
                "frontLeftMotorDiagnostics": {
                    "current": 33,
                    "overcurrent": true,
                    "pwm": 88,
                    "rpm": -91,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F6FB4BCBC555": {
                "model": 13,
                "frontLeftMotorDiagnostics": {
                    "current": 5,
                    "overcurrent": false,
                    "pwm": 1,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Optional frontRightMotorDiagnostics

frontRightMotorDiagnostics?: MotorDiagnostics

Front Right Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontRightThruster/revolutionFrontRightMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B18CB5F7327B": {
                "model": 13,
                "frontRightMotorDiagnostics": {
                    "current": 23,
                    "overcurrent": true,
                    "pwm": 17,
                    "rpm": 14,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontRightThruster/revolutionFrontRightMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "53B75143602B": {
                "model": 13,
                "frontRightMotorDiagnostics": {
                    "current": 9,
                    "overcurrent": false,
                    "pwm": 2,
                    "rpm": 0,
                    "failure": false
                }
            }
        }
    }
}

Optional grabber

grabber?: Grabber

Grabber

remarks

see Grabber for more details}

Example Payloads

SET Requests
  • Arbitrary

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "E44FE8A53188": {
                "model": 13,
                "grabber": {
                    "rotate": 89,
                    "openClose": -93
                }
            }
        }
    }
}
  • Resting

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D2C0DB0D430D": {
                "model": 13,
                "grabber": {
                    "rotate": 0,
                    "openClose": 0
                }
            }
        }
    }
}
  • Open

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberOpenClawSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "EE5423D864AC": {
                "model": 13,
                "grabber": {
                    "openClose": 100
                }
            }
        }
    }
}
  • Close

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberCloseClawSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6C6CE7C0F2A3": {
                "model": 13,
                "grabber": {
                    "openClose": -100
                }
            }
        }
    }
}
  • Rotate Left

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateLeftSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "548CD2FA0DF4": {
                "model": 13,
                "grabber": {
                    "rotate": -100
                }
            }
        }
    }
}
  • Rotate Right

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateRightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "70674A9B7660": {
                "model": 13,
                "grabber": {
                    "rotate": 100
                }
            }
        }
    }
}

Optional heading

heading?: number

Rov heading

Measured in degrees from north bearing

minimum

0

maximum

360

readonly

Optional inWater

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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "CFC4956616C5": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "FF86BBC1CE7C": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "07A95943359F": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A63DB59FE022": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E6BBE0F7D3CA": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "3C18D55091E7": {
                    "model": 13,
                    "inWater": true
                }
            }
        }
    }

Optional inputDiagnostics

inputDiagnostics?: RovInputDiagnostics

InputDiagnostics

readonly

Optional ip

ip?: string

IP Address

Example Payloads

SET Requests
  • Arbitrary

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "SET",
        "payload": {
            "devices": {
                "7EF4C9FD078D": {
                    "model": 13,
                    "ip": "192.168.50.20"
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "SET",
        "payload": {
            "devices": {
                "F121D1E640C2": {
                    "model": 18,
                    "ip": "192.168.234.173"
                }
            }
        }
    }
readonly

Optional leftBattery

leftBattery?: Battery

Left Battery

Example Payloads

UPDATE Requests
  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "00194D1B1B5B": {
                "model": 13,
                "leftBattery": {
                    "percent": 9,
                    "voltage": 100,
                    "charging": false
                }
            }
        }
    }
}
  • Left battery warning

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryWarningSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7ACAEAC2D7A2": {
                "model": 13,
                "leftBattery": {
                    "percent": 10
                }
            }
        }
    }
}
  • Left battery shutdown

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryShutdownSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "29AAE671191D": {
                "model": 13,
                "leftBattery": {
                    "percent": 0
                }
            }
        }
    }
}
  • Left battery charging

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsChargingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D3CE1525431F": {
                "model": 13,
                "leftBattery": {
                    "charging": true
                }
            }
        }
    }
}
  • left battery not charging

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsNotChargingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "BFC45BA02409": {
                "model": 13,
                "leftBattery": {
                    "charging": false
                }
            }
        }
    }
}
  • left battery has leak

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "25B8EF66FD44": {
                "model": 13,
                "leftBattery": {
                    "leak": true
                }
            }
        }
    }
}
  • left batter has no leak

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasNoLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DBAB46F5E9D7": {
                "model": 13,
                "leftBattery": {
                    "leak": false
                }
            }
        }
    }
}

Optional localHeading

localHeading?: number

Rov local heading

Measure in degrees from local heading

minimum

-360

maximum

360

Optional locationForwarderOptions

locationForwarderOptions?: LocationForwarderOptions

Location Forwarding Options

description

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

model

model: Revolution

Optional navigationOptions

navigationOptions?: NavigationOptions

Navigation Options

description

Navigation settings and options for the ROV

Optional pitch

pitch?: number

Rov pitch

Measured in degrees from neutral pitch position

minimum

-180.0

maximum

180.0

readonly

Optional position

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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "8233D6F11011": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6BF47B0F934D": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B8E2AEE6B22C": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "995432B639DA": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "CBF3A4E70DA7": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 993,
                            "y": 13,
                            "uncertainty": 36
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5FCCB5F046CE": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -58,
                            "longitude": -35,
                            "uncertainty": 76
                        }
                    }
                }
            }
        }
    }

  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "169F6E4EDA20": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": -389,
                            "y": -380,
                            "uncertainty": 87
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "7135FCFFDF07": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": -51,
                            "longitude": -27,
                            "uncertainty": 5
                        }
                    }
                }
            }
        }
    }

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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "7A733EFE8669": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "169F6E4EDA20": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": -389,
                            "y": -380,
                            "uncertainty": 87
                        }
                    }
                }
            }
        }
    }

  • 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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0E63575A24CC": {
                    "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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "7135FCFFDF07": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": -51,
                            "longitude": -27,
                            "uncertainty": 5
                        }
                    }
                }
            }
        }
    }

Optional rearLeftMotorDiagnostics

rearLeftMotorDiagnostics?: MotorDiagnostics

Rear Left Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearLeftThruster/revolutionRearLeftMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8F262ED75F07": {
                "model": 13,
                "rearLeftMotorDiagnostics": {
                    "current": 43,
                    "overcurrent": true,
                    "pwm": 24,
                    "rpm": -87,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearLeftThruster/revolutionRearLeftMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "55B3D4A7CC06": {
                "model": 13,
                "rearLeftMotorDiagnostics": {
                    "current": 0,
                    "overcurrent": false,
                    "pwm": 3,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Optional rearRightMotorDiagnostics

rearRightMotorDiagnostics?: MotorDiagnostics

Rear Right Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearRightThruster/revolutionRearRightMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "374BF230DC66": {
                "model": 13,
                "rearRightMotorDiagnostics": {
                    "current": 63,
                    "overcurrent": false,
                    "pwm": 82,
                    "rpm": 31,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearRightThruster/revolutionRearRightMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FE5CDA0A02A4": {
                "model": 13,
                "rearRightMotorDiagnostics": {
                    "current": 0,
                    "overcurrent": false,
                    "pwm": 2,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Optional rightBattery

rightBattery?: Battery

Right Battery

Examples

UPDATE Requests
  • All Arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "22B1B725423C": {
                "model": 13,
                "rightBattery": {
                    "percent": 84,
                    "voltage": 100,
                    "charging": true
                }
            }
        }
    }
}
  • Right battery warning

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryWarningSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0909D741CB59": {
                "model": 13,
                "rightBattery": {
                    "percent": 10
                }
            }
        }
    }
}
  • Right battery shutdown

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryShutdownSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A19CE3702679": {
                "model": 13,
                "rightBattery": {
                    "percent": 0
                }
            }
        }
    }
}
  • Right battery charging

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryIsChargingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FA2322B14D53": {
                "model": 13,
                "rightBattery": {
                    "charging": true
                }
            }
        }
    }
}
  • Right battery not charging

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryIsNotChargingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "894EFD966C52": {
                "model": 13,
                "rightBattery": {
                    "charging": false
                }
            }
        }
    }
}
  • right battery has leak

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/leak/revolutionRightBatteryHasLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "9C9D90948333": {
                "model": 13,
                "rightBattery": {
                    "leak": true
                }
            }
        }
    }
}
  • right battery has no leak

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/leak/revolutionRightBatteryHasNoLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4ECADFF39A51": {
                "model": 13,
                "rightBattery": {
                    "leak": false
                }
            }
        }
    }
}

Optional roll

roll?: number

Rov roll

Measured in degrees from neutral roll position

minimum

-180.0

maximum

180.0

readonly

Optional sensorPod

sensorPod?: CalibratableSensorPod

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

Optional sensorPodLeak

sensorPodLeak?: boolean

Sensor Pod Leak Fault

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

Optional sonar3d

sonar3d?: Sonar3D

3d Sonar device informaton wihtout the HW and FW versions

Optional spareMotor1

spareMotor1?: MotorDiagnostics

Provides diagnostics for spare motor 1 on the Rov. This spare motor can be used to extend the capabilities of the ROV by attaching a power tool to it.

Example Payloads

UPDATE Requests

  • Resting spare motor 1 diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor1/revolutionSpareMotor1DiagnosticsRestingSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "BAF29010FE82": {
                    "model": 13,
                    "spareMotor1": {
                        "current": 22,
                        "overcurrent": false,
                        "pwm": 18,
                        "rpm": -21,
                        "failure": false
                    }
                }
            }
        }
    }

  • Arbitrary Spare Motor 1 Diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor1/revolutionSpareMotor1DiagnosticsRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2DF1BB9D151F": {
                    "model": 13,
                    "spareMotor1": {
                        "current": 4,
                        "overcurrent": true,
                        "pwm": 25,
                        "rpm": 12,
                        "failure": false
                    }
                }
            }
        }
    }

Optional spareMotor2

spareMotor2?: MotorDiagnostics

Provides diagnostics for spare motor 2 on the Rov. This spare motor can be used to extend the capabilities of the ROV by attaching a power tool to it.

Example Payloads

UPDATE Requests

  • Resting spare motor 2 diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor2/revolutionSpareMotor2DiagnosticsRestingSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "317CA6F8F355": {
                    "model": 13,
                    "spareMotor2": {
                        "current": 59,
                        "overcurrent": false,
                        "pwm": 45,
                        "rpm": -41,
                        "failure": false
                    }
                }
            }
        }
    }

  • Arbitrary Spare Motor 2 Diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor2/revolutionSpareMotor2DiagnosticsRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "01F24D08F97A": {
                    "model": 13,
                    "spareMotor2": {
                        "current": 85,
                        "overcurrent": false,
                        "pwm": 44,
                        "rpm": -6,
                        "failure": false
                    }
                }
            }
        }
    }

Optional turns

turns?: number

Turns

Count the number of turns the rov has completed

readonly

Optional usageTime

usageTime?: UsageTime

Vehicle Usage Time

Example Payloads

GET Requests

  • Total and current usage times

    From ./dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4D999922B9AE": {
                    "model": 18,
                    "usageTime": {
                        "totalSeconds": 0,
                        "currentSeconds": 0
                    }
                }
            }
        }
    }

  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "93A4984757C4": {
                    "model": 18,
                    "usageTime": {
                        "totalSeconds": 96,
                        "currentSeconds": 44
                    }
                }
            }
        }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/usageTime/revolutionUsageTimeRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "05BB83D35636": {
                    "model": 13,
                    "usageTime": {
                        "totalSeconds": 52,
                        "currentSeconds": 4
                    }
                }
            }
        }
    }

Optional velocity

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.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "EFD73E137275": {
                    "model": 13,
                    "velocity": {
                        "valid": false,
                        "forward": -57,
                        "rightward": 1,
                        "downward": 37,
                        "speed": 85
                    }
                }
            }
        }
    }
  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.61.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "BF3FE9A2C328": {
                    "model": 18,
                    "velocity": {
                        "valid": true,
                        "forward": 17,
                        "rightward": 1,
                        "downward": -22,
                        "speed": 25
                    }
                }
            }
        }
    }

Optional version

version?: DeviceVersion

ROV Version

readonly

Optional verticalLeftMotorDiagnostics

verticalLeftMotorDiagnostics?: MotorDiagnostics

Vertical Left Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalLeftThruster/revolutionVerticalLeftMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "80A1C1A5EEC4": {
                "model": 13,
                "verticalLeftMotorDiagnostics": {
                    "current": 81,
                    "overcurrent": true,
                    "pwm": 10,
                    "rpm": -39,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalLeftThruster/revolutionVerticalLeftMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "E9C2D6D4BF97": {
                "model": 13,
                "verticalLeftMotorDiagnostics": {
                    "current": 4,
                    "overcurrent": false,
                    "pwm": 0,
                    "rpm": 1,
                    "failure": false
                }
            }
        }
    }
}

Optional verticalRightMotorDiagnostics

verticalRightMotorDiagnostics?: MotorDiagnostics

Vertical Right Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalRightThruster/revolutionVerticalRightMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FBCDE27ADD7C": {
                "model": 13,
                "verticalRightMotorDiagnostics": {
                    "current": 15,
                    "overcurrent": false,
                    "pwm": 62,
                    "rpm": 62,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalRightThruster/revolutionVerticalRightMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "89DEA48CE12E": {
                "model": 13,
                "verticalRightMotorDiagnostics": {
                    "current": 5,
                    "overcurrent": false,
                    "pwm": 3,
                    "rpm": 1,
                    "failure": false
                }
            }
        }
    }
}

Optional waterTemp

waterTemp?: number
  • Arbitrary temp

From ./dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionRandomWaterTempSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "23EC9917EDF0": {
                "model": 13,
                "waterTemp": -2
            }
        }
    }
}
  • Max water temp

From ./dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionMaxWaterTempSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "434407B9A11B": {
                "model": 13,
                "waterTemp": 50
            }
        }
    }
}
  • Min water temp

From ./dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionMinWaterTempSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "86DE46B9DC66": {
                "model": 13,
                "waterTemp": -10
            }
        }
    }
}