Options
All
  • Public
  • Public/Protected
  • All
Menu
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.58.15",
"method": "DELETE",
"payload": {
"devices": {
"F4AF09273CA9": {
"model": 13
}
}
}
}

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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8602689DB2FD": {
    "model": 18,
    "altitude": 159
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4036D54E30F9": {
    "model": 13,
    "altitudeValid": true
    }
    }
    }
    }
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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8921BB168BBA": {
    "model": 18,
    "altitude": 22,
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3B8FFCF63A6A": {
    "model": 13,
    "altitudeValid": true,
    "altitude": 241
    }
    }
    }
    }
  • 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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "879E835BF81E": {
    "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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4036D54E30F9": {
    "model": 13,
    "altitudeValid": true
    }
    }
    }
    }
readonly
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.58.15",
"method": "SET",
"payload": {
"devices": {
"EC4E72BDB9C0": {
"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.58.15",
"method": "SET",
"payload": {
"devices": {
"219908E7F97A": {
"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.58.15",
"method": "SET",
"payload": {
"devices": {
"DBE636A989DA": {
"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.58.15",
"method": "SET",
"payload": {
"devices": {
"0FF30DB1329B": {
"model": 13,
"auxLight": {
"intensity": 77
}
}
}
}
}
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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "375206E81307": {
    "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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9B9E8DF1ABBF": {
    "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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D27CAEECEB05": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "AEA80B325AA8": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0A57CEE1C8C6": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0BE835DE5CA7": {
    "model": 18,
    "bodyLeak": true
    }
    }
    }
    }
readonly

Camera Head

Controls the camera head attached to the revolution

remarks

See cameraHead type for more details

Example Payloads

Set Requests

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

📷 List of cameras

Holds a list of all vehicle Cameras.

cpProbe?: string

The cp probe

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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"95FFBE58F83F": {
"model": 13,
"cpuTemp": 35
}
}
}
}
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.15",
"method": "SET",
"payload": {
"devices": {
"9BE1A512216C": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"48440EB599CB": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"BE07EB0164AD": {
"model": 18,
"depth": 60
}
}
}
}

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

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "SET",
"payload": {
"devices": {
"5F50FE079C8D": {
"model": 13,
"depth": 93
}
}
}
}
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.15",
    "method": "SET",
    "payload": {
    "devices": {
    "FAF31F76C15A": {
    "model": 18,
    "drive": {
    "thrust": {
    "forward": 54,
    "yaw": -35,
    "vertical": 11,
    "lateral": -73
    },
    "modes": {
    "headingLock": false,
    "altitudeLock": false,
    "depthLock": true,
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "C51909396F4E": {
    "model": 13,
    "drive": {
    "thrust": {
    "forward": 50,
    "yaw": 88,
    "vertical": 94,
    "lateral": 20
    },
    "modes": {
    "headingLock": true,
    "altitudeLock": true,
    "depthLock": false,
    "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

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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"8A75EB963E37": {
"model": 13,
"frontLeftMotorDiagnostics": {
"current": 93,
"overcurrent": false,
"pwm": 26,
"rpm": 14,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"D4A4D1928129": {
"model": 13,
"frontLeftMotorDiagnostics": {
"current": 3,
"overcurrent": false,
"pwm": 5,
"rpm": -1,
"failure": false
}
}
}
}
}
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"009682F464B5": {
"model": 13,
"frontRightMotorDiagnostics": {
"current": 66,
"overcurrent": true,
"pwm": 88,
"rpm": -56,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"F223E683388E": {
"model": 13,
"frontRightMotorDiagnostics": {
"current": 3,
"overcurrent": false,
"pwm": 3,
"rpm": 0,
"failure": false
}
}
}
}
}
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"B1C1563F2A27": {
"model": 13,
"grabber": {
"rotate": -58,
"openClose": -52
}
}
}
}
}
  • Resting

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

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"951EC4B60E0E": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"29BF89DB157A": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"4CD2D60ECC8D": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"C9DEF76E3AF7": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"3E97A98D694C": {
"model": 13,
"grabber": {
"rotate": 100
}
}
}
}
}
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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0EA059E9441B": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BD84B4091DC2": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E476E4E3B436": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "B5141546E62B": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "FDA5FD7458AC": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "32D27AE3C2CF": {
    "model": 13,
    "inWater": true
    }
    }
    }
    }
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.15",
    "method": "SET",
    "payload": {
    "devices": {
    "B08413B22A4B": {
    "model": 13,
    "ip": "192.168.58.252"
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "C64A78783123": {
    "model": 18,
    "ip": "192.168.117.189"
    }
    }
    }
    }
readonly
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"78A0B1DE1278": {
"model": 13,
"leftBattery": {
"percent": 9,
"voltage": 100,
"charging": true
}
}
}
}
}
  • 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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"5D145FB41E96": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"DC6DBB6AC961": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"52E869E35062": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"AC905A22C6C6": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"739DDE4BD668": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"3A3EC12CC380": {
"model": 13,
"leftBattery": {
"leak": false
}
}
}
}
}
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: Revolution
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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "EE127CD76F55": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "307F0DC63D62": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9A8CAA64DAF9": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D148B4D1232E": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "66EB49BEB442": {
    "model": 13,
    "position": {
    "local": {
    "x": 292,
    "y": 490,
    "uncertainty": 92
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "98FE2B38A5FC": {
    "model": 13,
    "position": {
    "global": {
    "latitude": -27,
    "longitude": 83,
    "uncertainty": 80
    }
    }
    }
    }
    }
    }
  • 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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0D7CF10BD996": {
    "model": 18,
    "position": {
    "local": {
    "x": 898,
    "y": -12,
    "uncertainty": 17
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0689CC731B36": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 74,
    "longitude": 80,
    "uncertainty": 65
    }
    }
    }
    }
    }
    }

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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5DE89D5C03D8": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0D7CF10BD996": {
    "model": 18,
    "position": {
    "local": {
    "x": 898,
    "y": -12,
    "uncertainty": 17
    }
    }
    }
    }
    }
    }
  • 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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BE8D0A10AE86": {
    "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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0689CC731B36": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 74,
    "longitude": 80,
    "uncertainty": 65
    }
    }
    }
    }
    }
    }
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"9C4856766BF5": {
"model": 13,
"rearLeftMotorDiagnostics": {
"current": 31,
"overcurrent": true,
"pwm": 15,
"rpm": 42,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"779673454942": {
"model": 13,
"rearLeftMotorDiagnostics": {
"current": 2,
"overcurrent": false,
"pwm": 4,
"rpm": 1,
"failure": false
}
}
}
}
}
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"38C1A4C7A6C7": {
"model": 13,
"rearRightMotorDiagnostics": {
"current": 57,
"overcurrent": true,
"pwm": 71,
"rpm": 57,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"37BCD917BF74": {
"model": 13,
"rearRightMotorDiagnostics": {
"current": 6,
"overcurrent": false,
"pwm": 1,
"rpm": 0,
"failure": false
}
}
}
}
}
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"11ED96EC53B3": {
"model": 13,
"rightBattery": {
"percent": 29,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"AA5B9781A241": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"C50D29A254F0": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"17E477EBD07A": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"FC816EF3525E": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"EBE1CBE61C1A": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"1C45F3099849": {
"model": 13,
"rightBattery": {
"leak": false
}
}
}
}
}
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

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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8A5AB42FD6D6": {
    "model": 13,
    "spareMotor1": {
    "current": 94,
    "overcurrent": true,
    "pwm": 31,
    "rpm": 52,
    "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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "CFB72994208E": {
    "model": 13,
    "spareMotor1": {
    "current": 77,
    "overcurrent": false,
    "pwm": 24,
    "rpm": 35,
    "failure": false
    }
    }
    }
    }
    }
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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "22BA53C0569B": {
    "model": 13,
    "spareMotor2": {
    "current": 2,
    "overcurrent": false,
    "pwm": 68,
    "rpm": -100,
    "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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "63781E3DC5D0": {
    "model": 13,
    "spareMotor2": {
    "current": 9,
    "overcurrent": false,
    "pwm": 51,
    "rpm": -60,
    "failure": false
    }
    }
    }
    }
    }
turns?: number

Turns

Count the number of turns the rov has completed

readonly
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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "909ED92469F3": {
    "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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E72E6EE81402": {
    "model": 18,
    "usageTime": {
    "totalSeconds": 71,
    "currentSeconds": 97
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "363CDF46D80B": {
    "model": 13,
    "usageTime": {
    "totalSeconds": 61,
    "currentSeconds": 88
    }
    }
    }
    }
    }
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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1D4CC14D112C": {
    "model": 13,
    "velocity": {
    "valid": true,
    "forward": -29,
    "rightward": 54,
    "downward": 50,
    "speed": 79
    }
    }
    }
    }
    }
  • 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.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "CDF14B69632C": {
    "model": 18,
    "velocity": {
    "valid": true,
    "forward": -13,
    "rightward": 77,
    "downward": 79,
    "speed": 96
    }
    }
    }
    }
    }
version?: DeviceVersion

ROV Version

readonly
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"69E243528684": {
"model": 13,
"verticalLeftMotorDiagnostics": {
"current": 54,
"overcurrent": true,
"pwm": 25,
"rpm": 30,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"F47DDAF8388B": {
"model": 13,
"verticalLeftMotorDiagnostics": {
"current": 2,
"overcurrent": false,
"pwm": 5,
"rpm": -1,
"failure": false
}
}
}
}
}
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"CC49447C7007": {
"model": 13,
"verticalRightMotorDiagnostics": {
"current": 79,
"overcurrent": false,
"pwm": 87,
"rpm": 64,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"0FDB1085DC6F": {
"model": 13,
"verticalRightMotorDiagnostics": {
"current": 1,
"overcurrent": false,
"pwm": 2,
"rpm": 1,
"failure": false
}
}
}
}
}
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"BA59A801B934": {
"model": 13,
"waterTemp": -8
}
}
}
}
  • 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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"28B767103E5F": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"E41F8754C7C4": {
"model": 13,
"waterTemp": -10
}
}
}
}