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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "544507431609": {
    "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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "577404670509": {
    "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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "017495A2157B": {
    "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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BCEB0923F7F7": {
    "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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "57EF4D4EAD2D": {
    "model": 13,
    "position": {
    "local": {
    "northing": 928,
    "easting": 94,
    "uncertainty": 40
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BB12681E6715": {
    "model": 13,
    "position": {
    "global": {
    "latitude": -41,
    "longitude": -109,
    "uncertainty": 15
    }
    }
    }
    }
    }
    }
  • 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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BDC45B22CFC9": {
    "model": 18,
    "position": {
    "local": {
    "northing": -656,
    "easting": 575,
    "uncertainty": 47
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A94A1471B86F": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 0,
    "longitude": -128,
    "uncertainty": 27
    }
    }
    }
    }
    }
    }

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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "CFE3CAEB8577": {
    "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.58.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BDC45B22CFC9": {
    "model": 18,
    "position": {
    "local": {
    "northing": -656,
    "easting": 575,
    "uncertainty": 47
    }
    }
    }
    }
    }
    }
  • 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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D59AAB398EB7": {
    "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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A94A1471B86F": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 0,
    "longitude": -128,
    "uncertainty": 27
    }
    }
    }
    }
    }
    }
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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "498D9E6C712B": {
    "model": 13,
    "velocity": {
    "valid": false,
    "forward": 88,
    "rightward": -61,
    "downward": 91,
    "speed": 74
    }
    }
    }
    }
    }
  • 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.3",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "64DCAAD93FD2": {
    "model": 18,
    "velocity": {
    "valid": false,
    "forward": -69,
    "rightward": 0,
    "downward": -19,
    "speed": 37
    }
    }
    }
    }
    }