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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0C334EA12549": {
    "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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A87711F3D781": {
    "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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E73373086E74": {
    "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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C27DDAC0CCBE": {
    "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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "34E6FB4C6163": {
    "model": 13,
    "position": {
    "local": {
    "x": -337,
    "y": -910,
    "uncertainty": 90
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BD3C8FB8563B": {
    "model": 13,
    "position": {
    "global": {
    "latitude": 33,
    "longitude": -151,
    "uncertainty": 87
    }
    }
    }
    }
    }
    }
  • 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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BF4CEDCAECC3": {
    "model": 18,
    "position": {
    "local": {
    "x": 539,
    "y": -396,
    "uncertainty": 88
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "489D6980D43D": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -85,
    "longitude": -65,
    "uncertainty": 62
    }
    }
    }
    }
    }
    }

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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3166DF5FD7BD": {
    "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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BF4CEDCAECC3": {
    "model": 18,
    "position": {
    "local": {
    "x": 539,
    "y": -396,
    "uncertainty": 88
    }
    }
    }
    }
    }
    }
  • 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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F7FFA25E190E": {
    "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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "489D6980D43D": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -85,
    "longitude": -65,
    "uncertainty": 62
    }
    }
    }
    }
    }
    }
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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1416FAEABD9B": {
    "model": 13,
    "velocity": {
    "valid": true,
    "forward": 0,
    "rightward": -25,
    "downward": 10,
    "speed": 91
    }
    }
    }
    }
    }
  • 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.10",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3AA5BDF4258D": {
    "model": 18,
    "velocity": {
    "valid": false,
    "forward": 67,
    "rightward": -81,
    "downward": 33,
    "speed": 74
    }
    }
    }
    }
    }