Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

navigationOptions?: NavigationOptions

Navigation Options

description

Navigation settings and options for the ROV

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/revolutionPositionInvalidSample.json

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

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

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

  • Revolution

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8AD5DAC2713C": {
    "model": 13,
    "position": {
    "local": {
    "northing": 979,
    "easting": -661,
    "uncertainty": 80
    },
    "global": {
    "latitude": -78,
    "longitude": 112,
    "uncertainty": 63
    }
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "53FA9CE76A57": {
    "model": 18,
    "position": {
    "local": {
    "northing": -477,
    "easting": -419,
    "uncertainty": 29
    },
    "global": {
    "latitude": 90,
    "longitude": -74,
    "uncertainty": 28
    }
    }
    }
    }
    }
    }

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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "239063603183": {
    "model": 13,
    "position": {
    "local": {
    "northing": 10,
    "easting": 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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BC02CA289316": {
    "model": 18,
    "position": {
    "local": {
    "northing": -426,
    "easting": -905,
    "uncertainty": 25
    }
    }
    }
    }
    }
    }
  • 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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7DF4DBB506B8": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E31188D1927A": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 48,
    "longitude": 143,
    "uncertainty": 63
    }
    }
    }
    }
    }
    }
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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "782BB2467D3B": {
    "model": 13,
    "velocity": {
    "valid": false,
    "forward": -25,
    "rightward": -33,
    "downward": -65,
    "speed": 23
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "77821D558B05": {
    "model": 18,
    "velocity": {
    "valid": true,
    "forward": -42,
    "rightward": 47,
    "downward": -61,
    "speed": 19
    }
    }
    }
    }
    }