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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "466A5E15B9CC": {
                    "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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "DE9E5DA60EF5": {
                    "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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "84F08BE39D15": {
                    "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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "70AB3F87DBD5": {
                    "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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D3F1ACF6A8FC": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 466,
                            "y": 918,
                            "uncertainty": 17
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.60.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "58D759837A27": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -58,
                            "longitude": 100,
                            "uncertainty": 35
                        }
                    }
                }
            }
        }
    }

  • 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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2299E38CCF03": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 132,
                            "y": 943,
                            "uncertainty": 82
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.60.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5EE3DE766F30": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": -46,
                            "longitude": -154,
                            "uncertainty": 4
                        }
                    }
                }
            }
        }
    }

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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "C53235E7F936": {
                    "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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2299E38CCF03": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 132,
                            "y": 943,
                            "uncertainty": 82
                        }
                    }
                }
            }
        }
    }

  • 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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "AAF8266C4026": {
                    "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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5EE3DE766F30": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": -46,
                            "longitude": -154,
                            "uncertainty": 4
                        }
                    }
                }
            }
        }
    }

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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D0623CC29A36": {
                    "model": 13,
                    "velocity": {
                        "valid": true,
                        "forward": 21,
                        "rightward": -52,
                        "downward": -7,
                        "speed": 30
                    }
                }
            }
        }
    }
  • 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.2",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "08F6D6CEEFA1": {
                    "model": 18,
                    "velocity": {
                        "valid": true,
                        "forward": -90,
                        "rightward": 79,
                        "downward": 65,
                        "speed": 62
                    }
                }
            }
        }
    }