Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPhoton

notexported

See type declaration

Photon ROV

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "FAD20E7CA909": {
                    "model": 18,
                    "altitude": 247
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "79784F4FBFEF": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "3F9D41F8F175": {
                    "model": 18,
                    "altitude": 228,
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "FA6823DD2417": {
                    "model": 13,
                    "altitudeValid": true,
                    "altitude": 60
                }
            }
        }
    }

  • 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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6F0D84778318": {
                    "model": 18,
                    "altitudeValid": true
                }
            }
        }
    }

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

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

Optional auxLight

auxLight?: Light

Aux Light

Controls the auxiliary light attached to the Photon.

Optional battery

battery?: Battery

Battery

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "16793EAF2D25": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "63FFF938FEDE": {
                    "model": 18,
                    "bodyLeak": true
                }
            }
        }
    }

  • Has no body leak fault

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F5120477219C": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "049704DAED47": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "7C70D3760874": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "AF261ACE162C": {
                    "model": 18,
                    "bodyLeak": true
                }
            }
        }
    }
readonly

Optional cameraHead

cameraHead?: Removable<TiltCameraHead>

Camera Head

Optional cameras

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

Photon camera

Optional cpProbe

cpProbe?: string

The cp probe

Optional cpuTemp

cpuTemp?: number

Temperature in degrees celsius

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.58.12",
    "method": "SET",
    "payload": {
        "devices": {
            "5288F1A98373": {
                "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.12",
    "method": "SET",
    "payload": {
        "devices": {
            "543FDFD037E1": {
                "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.12",
    "method": "SET",
    "payload": {
        "devices": {
            "51CB263E86F4": {
                "model": 18,
                "depth": 5
            }
        }
    }
}

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.12",
    "method": "SET",
    "payload": {
        "devices": {
            "22E9F6C19F15": {
                "model": 13,
                "depth": 196
            }
        }
    }
}
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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "EF72A8F4A92C": {
                    "model": 18,
                    "drive": {
                        "thrust": {
                            "forward": -1,
                            "yaw": 18,
                            "vertical": -78,
                            "lateral": 21
                        },
                        "modes": {
                            "headingLock": true,
                            "altitudeLock": false,
                            "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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "849CFF2E6F35": {
                    "model": 13,
                    "drive": {
                        "thrust": {
                            "forward": 64,
                            "yaw": -94,
                            "vertical": -93,
                            "lateral": 16
                        },
                        "modes": {
                            "headingLock": true,
                            "altitudeLock": true,
                            "depthLock": false,
                            "autoStabilization": false,
                            "motorsDisabled": false
                        }
                    }
                }
            }
        }
    }

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

Motor Diagnostics

Optional frontRightMotorDiagnostics

frontRightMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

Optional grabber

grabber?: Grabber

Grabber

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2191F5B6EC8E": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "ECFC3CA27309": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "61B60C8D1D12": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "622455E7FD2F": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "63D723475EB8": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A2AD4B65A530": {
                    "model": 13,
                    "inWater": false
                }
            }
        }
    }

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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "5C55AC3D80C6": {
                    "model": 13,
                    "ip": "192.168.160.68"
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "1FEDC7E4089B": {
                    "model": 18,
                    "ip": "192.168.24.75"
                }
            }
        }
    }
readonly

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: Photon

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B9CA7AA089B7": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5A856DC76FA3": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D2A5FFE44A0F": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5E59AED2F15E": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6211A813014B": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 297,
                            "y": 61,
                            "uncertainty": 50
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "33E07CEDA1FF": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -37,
                            "longitude": 43,
                            "uncertainty": 100
                        }
                    }
                }
            }
        }
    }

  • 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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D2A63C3CFB18": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 655,
                            "y": -864,
                            "uncertainty": 84
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "09B2429E68CA": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 28,
                            "longitude": -41,
                            "uncertainty": 96
                        }
                    }
                }
            }
        }
    }

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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "20222D09A858": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D2A63C3CFB18": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 655,
                            "y": -864,
                            "uncertainty": 84
                        }
                    }
                }
            }
        }
    }

  • 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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5CB1D87198FD": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "09B2429E68CA": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 28,
                            "longitude": -41,
                            "uncertainty": 96
                        }
                    }
                }
            }
        }
    }

Optional rearLeftMotorDiagnostics

rearLeftMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

Optional rearRightMotorDiagnostics

rearRightMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

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 turns

turns?: number

Turns

Count the number of turns the rov has completed

readonly

Optional usageTime

usageTime?: UsageTime

Vehicle Usage Time

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B75E12BF7059": {
                    "model": 13,
                    "velocity": {
                        "valid": false,
                        "forward": -15,
                        "rightward": -76,
                        "downward": 13,
                        "speed": 36
                    }
                }
            }
        }
    }
  • 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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "54C5088BC5BE": {
                    "model": 18,
                    "velocity": {
                        "valid": false,
                        "forward": 39,
                        "rightward": 27,
                        "downward": -53,
                        "speed": 58
                    }
                }
            }
        }
    }

Optional version

version?: DeviceVersion

Photon Version

Optional verticalLeftMotorDiagnostics

verticalLeftMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

Optional verticalRightMotorDiagnostics

verticalRightMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

Optional waterTemp

waterTemp?: number

Water temperature in degrees celsius