Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

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.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3BCFAF159E23": {
    "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.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E9753C35F66A": {
    "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.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8EAE9DBA7A3A": {
    "model": 13,
    "position": {
    "local": {
    "northing": -891,
    "easting": 607,
    "uncertainty": 33
    },
    "global": {
    "latitude": -38,
    "longitude": -116,
    "uncertainty": 82
    }
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1880F5B0D457": {
    "model": 18,
    "position": {
    "local": {
    "northing": -266,
    "easting": -153,
    "uncertainty": 94
    },
    "global": {
    "latitude": 32,
    "longitude": 85,
    "uncertainty": 31
    }
    }
    }
    }
    }
    }

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.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "02C393BACD83": {
    "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.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "B9979A829D3A": {
    "model": 18,
    "position": {
    "local": {
    "northing": -836,
    "easting": 517,
    "uncertainty": 30
    }
    }
    }
    }
    }
    }
  • 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.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E16025B403DD": {
    "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.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9F8AB3F295F7": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 27,
    "longitude": 91,
    "uncertainty": 93
    }
    }
    }
    }
    }
    }
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.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0E8F9E075949": {
    "model": 13,
    "velocity": {
    "valid": true,
    "forward": 13,
    "rightward": -13,
    "downward": -36,
    "speed": 90
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C81D03E77F91": {
    "model": 18,
    "velocity": {
    "valid": false,
    "forward": 27,
    "rightward": -14,
    "downward": 67,
    "speed": 17
    }
    }
    }
    }
    }