Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface INavigationOptions

notexported

See type declaration

Hierarchy

Index

Properties

Properties

Optional heading

heading?: { autoDeclination?: boolean; declinationOffset?: number; localOffset?: number; vruMode?: boolean }

Type declaration

  • Optional autoDeclination?: boolean
  • Optional declinationOffset?: number
  • Optional localOffset?: number
  • Optional vruMode?: boolean

Optional position

position?: { deadReckoningAvailable?: boolean; rovSource?: PositionSources }

Type declaration

  • Optional deadReckoningAvailable?: boolean

    Dead Reckoning availability flag

    description

    Indicates if the ROV has dead reckoning capability

  • Optional rovSource?: PositionSources

    Source of ROV position.

    description

    The source providing ROV position. Could be an external GPS, USBL device or NONE.

    Example payloads

    UPDATE Requests
    • Setting rovSource to USBL Sample
    • Revolution

      From ./dist/samples/json/requests/devices/vehicles/revolution/positionOptionsUsbl/revolutionPositionSourceRequest.json

      {
          "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
          "apiVersion": "0.59.0",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "EC7CF4A67CF9": {
                      "model": 13,
                      "navigationOptions": {
                          "position": {
                              "rovSource": "SEATRAC_USBL"
                          }
                      }
                  }
              }
          }
      }
    • Pivot

      From ./dist/samples/json/requests/devices/vehicles/pivot/positionOptionsUsbl/pivotPositionSourceRequest.json

      {
          "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
          "apiVersion": "0.59.0",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "7C9009496014": {
                      "model": 18,
                      "navigationOptions": {
                          "position": {
                              "rovSource": "SEATRAC_USBL"
                          }
                      }
                  }
              }
          }
      }