Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface INavigation

notexported

See type declaration

Hierarchy

Index

Properties

Properties

Optional locationForwarderOptions

locationForwarderOptions?: LocationForwarderOptions

Location Forwarding Options

description

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

Optional navigationOptions

navigationOptions?: NavigationOptions

Navigation Options

description

Navigation settings and options for the ROV

Optional position

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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6DB683653A20": {
                    "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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "DFAB38D654E0": {
                    "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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E1239588C7F2": {
                    "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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2776D1C51EF0": {
                    "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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6F9E30E21C20": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 630,
                            "y": 190,
                            "uncertainty": 51
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "57451D2FCE4A": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -79,
                            "longitude": -126,
                            "uncertainty": 23
                        }
                    }
                }
            }
        }
    }

  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "71CF800CD68E": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": -594,
                            "y": 123,
                            "uncertainty": 30
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "65B9300488ED": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 21,
                            "longitude": -43,
                            "uncertainty": 61
                        }
                    }
                }
            }
        }
    }

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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4F4728BBDC01": {
                    "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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "71CF800CD68E": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": -594,
                            "y": 123,
                            "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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5480D016AEFE": {
                    "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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "65B9300488ED": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 21,
                            "longitude": -43,
                            "uncertainty": 61
                        }
                    }
                }
            }
        }
    }

Optional velocity

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.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "46E749087743": {
                    "model": 13,
                    "velocity": {
                        "valid": false,
                        "forward": -90,
                        "rightward": -82,
                        "downward": -76,
                        "speed": 10
                    }
                }
            }
        }
    }
  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.60.3",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "604A0601C5C3": {
                    "model": 18,
                    "velocity": {
                        "valid": false,
                        "forward": 42,
                        "rightward": 91,
                        "downward": 74,
                        "speed": 14
                    }
                }
            }
        }
    }