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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0D3AA4BDF36A": {
    "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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0617CBC70FBB": {
    "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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "13EBB212CDD8": {
    "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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "DE8465E4319D": {
    "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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "70794A04B3C0": {
    "model": 13,
    "position": {
    "local": {
    "northing": 761,
    "easting": -718,
    "uncertainty": 67
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C0E2FB81EA88": {
    "model": 13,
    "position": {
    "global": {
    "latitude": 83,
    "longitude": -42,
    "uncertainty": 92
    }
    }
    }
    }
    }
    }
  • 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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0850F26AB34F": {
    "model": 18,
    "position": {
    "local": {
    "northing": 321,
    "easting": 209,
    "uncertainty": 87
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "2FD53A7FC841": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -37,
    "longitude": 69,
    "uncertainty": 74
    }
    }
    }
    }
    }
    }

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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3741F76D4DC1": {
    "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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0850F26AB34F": {
    "model": 18,
    "position": {
    "local": {
    "northing": 321,
    "easting": 209,
    "uncertainty": 87
    }
    }
    }
    }
    }
    }
  • 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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "76E81918CF8E": {
    "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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "2FD53A7FC841": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -37,
    "longitude": 69,
    "uncertainty": 74
    }
    }
    }
    }
    }
    }
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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "B0DC4249ABCD": {
    "model": 13,
    "velocity": {
    "valid": false,
    "forward": -42,
    "rightward": 81,
    "downward": -50,
    "speed": 60
    }
    }
    }
    }
    }
  • 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.1",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C2D1E6D796FA": {
    "model": 18,
    "velocity": {
    "valid": false,
    "forward": -9,
    "rightward": -90,
    "downward": 23,
    "speed": 95
    }
    }
    }
    }
    }