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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5C69029E9519": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "99D8124340DD": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A335B9A8AECD": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D403DE0C8B81": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E2D6F7039DC5": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 92,
                            "y": -22,
                            "uncertainty": 29
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5EAFCE71B1AD": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -61,
                            "longitude": 56,
                            "uncertainty": 66
                        }
                    }
                }
            }
        }
    }

  • 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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E23F79C03185": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 614,
                            "y": 412,
                            "uncertainty": 77
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4059F7BCFC7C": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": -62,
                            "longitude": 142,
                            "uncertainty": 41
                        }
                    }
                }
            }
        }
    }

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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F4D98B1757D9": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E23F79C03185": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 614,
                            "y": 412,
                            "uncertainty": 77
                        }
                    }
                }
            }
        }
    }

  • 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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "99DD8F8453E6": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4059F7BCFC7C": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": -62,
                            "longitude": 142,
                            "uncertainty": 41
                        }
                    }
                }
            }
        }
    }

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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "49ECDB6E8A6D": {
                    "model": 13,
                    "velocity": {
                        "valid": false,
                        "forward": 61,
                        "rightward": 58,
                        "downward": 26,
                        "speed": 100
                    }
                }
            }
        }
    }
  • 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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0639D6EB167B": {
                    "model": 18,
                    "velocity": {
                        "valid": true,
                        "forward": -89,
                        "rightward": -5,
                        "downward": -36,
                        "speed": 20
                    }
                }
            }
        }
    }