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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "053FFD3FE0D3": {
    "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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "23AF4A1E40BE": {
    "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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8ED94EF839EA": {
    "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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0FECCDE74FBF": {
    "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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "ADCB4699CDF4": {
    "model": 13,
    "position": {
    "local": {
    "northing": 433,
    "easting": -942,
    "uncertainty": 15
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A1BF859C4797": {
    "model": 13,
    "position": {
    "global": {
    "latitude": 8,
    "longitude": -173,
    "uncertainty": 0
    }
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "89E2C2938BED": {
    "model": 18,
    "position": {
    "local": {
    "northing": 639,
    "easting": -895,
    "uncertainty": 28
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0488C1A6ACAA": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 78,
    "longitude": 93,
    "uncertainty": 5
    }
    }
    }
    }
    }
    }

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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BA01541BC75F": {
    "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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "89E2C2938BED": {
    "model": 18,
    "position": {
    "local": {
    "northing": 639,
    "easting": -895,
    "uncertainty": 28
    }
    }
    }
    }
    }
    }
  • 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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C7D5EC71480E": {
    "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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0488C1A6ACAA": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 78,
    "longitude": 93,
    "uncertainty": 5
    }
    }
    }
    }
    }
    }
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.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C1277EFE3FA0": {
    "model": 13,
    "velocity": {
    "valid": true,
    "forward": 77,
    "rightward": 74,
    "downward": -4,
    "speed": 29
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.57.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5B7C69C85EAC": {
    "model": 18,
    "velocity": {
    "valid": true,
    "forward": -38,
    "rightward": 14,
    "downward": 16,
    "speed": 32
    }
    }
    }
    }
    }