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; rovGpsStatus?: GpsStatus; rovSource?: PositionSources; topSource?: TopPositionSources; topsideGpsStatus?: GpsStatus }

Type declaration

  • Optional deadReckoningAvailable?: boolean

    Dead Reckoning availability flag

    description

    Indicates if the ROV has dead reckoning capability

  • Optional rovGpsStatus?: GpsStatus
  • 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.61.0",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "FB25B6F993D3": {
                      "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.61.0",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "D1E2EE720685": {
                      "model": 18,
                      "navigationOptions": {
                          "position": {
                              "rovSource": "SEATRAC_USBL"
                          }
                      }
                  }
              }
          }
      }
  • Optional topSource?: TopPositionSources

    Source of Topside location data. Works similarly to the Rov Source. Does not include USBL as an acceptable option.

    • Setting TopSource to External GPS Sample
    • Revolution

      From ./dist/samples/json/requests/devices/vehicles/revolution/positionOptionsTopside/revolutionTopsidePositionSourceRequest.json

      {
          "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
          "apiVersion": "0.61.0",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "27CC71720121": {
                      "model": 13,
                      "navigationOptions": {
                          "position": {
                              "topSource": "EXTERNAL_GPS"
                          }
                      }
                  }
              }
          }
      }
  • Optional topsideGpsStatus?: GpsStatus

    GPS status values such as GPS Fix and Signal Strength

    • Arbitrary Global position only
    • Revolution

      From ./dist/samples/json/requests/devices/vehicles/revolution/navigation/topsideGpsStatus/revolutionTopsideGpsRequestSample.json

      {
          "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
          "apiVersion": "0.61.0",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "0E3B4CEF8648": {
                      "model": 13,
                      "navigationOptions": {
                          "position": {
                              "topsideGpsStatus": {
                                  "fix": 1,
                                  "hdop": 20,
                                  "satelliteCount": 12
                              }
                          }
                      }
                  }
              }
          }
      }

      From ./dist/samples/json/requests/devices/vehicles/revolution/navigation/topsideGpsStatus/revolutionTopsideGpsRequestNoFixSample.json

      {
          "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
          "apiVersion": "0.61.0",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "D9999911A2E9": {
                      "model": 13,
                      "navigationOptions": {
                          "position": {
                              "topsideGpsStatus": {
                                  "fix": 0,
                                  "hdop": 1000,
                                  "satelliteCount": 0
                              }
                          }
                      }
                  }
              }
          }
      }

      From ./dist/samples/json/requests/devices/vehicles/revolution/navigation/rovGpsStatus/revolutionRovGpsRequestSample.json

      {
          "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
          "apiVersion": "0.61.0",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "974B8A6AF005": {
                      "model": 13,
                      "navigationOptions": {
                          "position": {
                              "rovGpsStatus": {
                                  "fix": 1,
                                  "hdop": 20,
                                  "satelliteCount": 12
                              }
                          }
                      }
                  }
              }
          }
      }

      From ./dist/samples/json/requests/devices/vehicles/revolution/navigation/rovGpsStatus/revolutionRovGpsRequestNoFixSample.json

      {
          "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
          "apiVersion": "0.61.0",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "416531E1842A": {
                      "model": 13,
                      "navigationOptions": {
                          "position": {
                              "rovGpsStatus": {
                                  "fix": 0,
                                  "hdop": 1000,
                                  "satelliteCount": 0
                              }
                          }
                      }
                  }
              }
          }
      }