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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B9CA7AA089B7": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5A856DC76FA3": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D2A5FFE44A0F": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5E59AED2F15E": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6211A813014B": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 297,
                            "y": 61,
                            "uncertainty": 50
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "33E07CEDA1FF": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -37,
                            "longitude": 43,
                            "uncertainty": 100
                        }
                    }
                }
            }
        }
    }

  • 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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D2A63C3CFB18": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 655,
                            "y": -864,
                            "uncertainty": 84
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "09B2429E68CA": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 28,
                            "longitude": -41,
                            "uncertainty": 96
                        }
                    }
                }
            }
        }
    }

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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "20222D09A858": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D2A63C3CFB18": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 655,
                            "y": -864,
                            "uncertainty": 84
                        }
                    }
                }
            }
        }
    }

  • 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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5CB1D87198FD": {
                    "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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "09B2429E68CA": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 28,
                            "longitude": -41,
                            "uncertainty": 96
                        }
                    }
                }
            }
        }
    }

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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B75E12BF7059": {
                    "model": 13,
                    "velocity": {
                        "valid": false,
                        "forward": -15,
                        "rightward": -76,
                        "downward": 13,
                        "speed": 36
                    }
                }
            }
        }
    }
  • 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.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "54C5088BC5BE": {
                    "model": 18,
                    "velocity": {
                        "valid": false,
                        "forward": 39,
                        "rightward": 27,
                        "downward": -53,
                        "speed": 58
                    }
                }
            }
        }
    }