Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

locationForwarderOptions?: LocationForwarderOptions

Location Forwarding Options

description

Locaiton forwarder settings and options for the ROV and Topside location forwarding

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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8233D6F11011": {
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6BF47B0F934D": {
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "B8E2AEE6B22C": {
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "995432B639DA": {
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "CBF3A4E70DA7": {
    "model": 13,
    "position": {
    "local": {
    "x": 993,
    "y": 13,
    "uncertainty": 36
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5FCCB5F046CE": {
    "model": 13,
    "position": {
    "global": {
    "latitude": -58,
    "longitude": -35,
    "uncertainty": 76
    }
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "169F6E4EDA20": {
    "model": 18,
    "position": {
    "local": {
    "x": -389,
    "y": -380,
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7135FCFFDF07": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -51,
    "longitude": -27,
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7A733EFE8669": {
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "169F6E4EDA20": {
    "model": 18,
    "position": {
    "local": {
    "x": -389,
    "y": -380,
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0E63575A24CC": {
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7135FCFFDF07": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -51,
    "longitude": -27,
    "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.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "EFD73E137275": {
    "model": 13,
    "velocity": {
    "valid": false,
    "forward": -57,
    "rightward": 1,
    "downward": 37,
    "speed": 85
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.61.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BF3FE9A2C328": {
    "model": 18,
    "velocity": {
    "valid": true,
    "forward": 17,
    "rightward": 1,
    "downward": -22,
    "speed": 25
    }
    }
    }
    }
    }