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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "EE127CD76F55": {
                    "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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "307F0DC63D62": {
                    "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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "9A8CAA64DAF9": {
                    "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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D148B4D1232E": {
                    "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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "66EB49BEB442": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 292,
                            "y": 490,
                            "uncertainty": 92
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "98FE2B38A5FC": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -27,
                            "longitude": 83,
                            "uncertainty": 80
                        }
                    }
                }
            }
        }
    }

  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0D7CF10BD996": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 898,
                            "y": -12,
                            "uncertainty": 17
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0689CC731B36": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 74,
                            "longitude": 80,
                            "uncertainty": 65
                        }
                    }
                }
            }
        }
    }

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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5DE89D5C03D8": {
                    "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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0D7CF10BD996": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 898,
                            "y": -12,
                            "uncertainty": 17
                        }
                    }
                }
            }
        }
    }

  • 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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "BE8D0A10AE86": {
                    "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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0689CC731B36": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 74,
                            "longitude": 80,
                            "uncertainty": 65
                        }
                    }
                }
            }
        }
    }

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.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "1D4CC14D112C": {
                    "model": 13,
                    "velocity": {
                        "valid": true,
                        "forward": -29,
                        "rightward": 54,
                        "downward": 50,
                        "speed": 79
                    }
                }
            }
        }
    }
  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.15",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "CDF14B69632C": {
                    "model": 18,
                    "velocity": {
                        "valid": true,
                        "forward": -13,
                        "rightward": 77,
                        "downward": 79,
                        "speed": 96
                    }
                }
            }
        }
    }