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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0C932439A293": {
                    "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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "81EE9F8FFF26": {
                    "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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "911B2EE8E231": {
                    "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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5759A29378BF": {
                    "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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "58538077E212": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": -49,
                            "y": -984,
                            "uncertainty": 88
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "8F537A55AFDA": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": 75,
                            "longitude": -176,
                            "uncertainty": 33
                        }
                    }
                }
            }
        }
    }

  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "CEC3A8754D19": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 322,
                            "y": -503,
                            "uncertainty": 36
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "95EDDB7D7F05": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 59,
                            "longitude": -96,
                            "uncertainty": 50
                        }
                    }
                }
            }
        }
    }

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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "1CB7986123C8": {
                    "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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "CEC3A8754D19": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 322,
                            "y": -503,
                            "uncertainty": 36
                        }
                    }
                }
            }
        }
    }

  • 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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "82C39E755027": {
                    "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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "95EDDB7D7F05": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 59,
                            "longitude": -96,
                            "uncertainty": 50
                        }
                    }
                }
            }
        }
    }

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.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2AF8511756A8": {
                    "model": 13,
                    "velocity": {
                        "valid": true,
                        "forward": -8,
                        "rightward": -62,
                        "downward": -98,
                        "speed": 53
                    }
                }
            }
        }
    }
  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E77FDF9C425A": {
                    "model": 18,
                    "velocity": {
                        "valid": true,
                        "forward": 14,
                        "rightward": 74,
                        "downward": -92,
                        "speed": 100
                    }
                }
            }
        }
    }