Deep Trekker BRIDGE API - v1.0.48
    Preparing search index...

    Type Alias PositionNavigationOption

    Position Navigation Options

    type PositionNavigationOption = {
        deadReckoningAvailable?: boolean;
        resetFilter?: boolean;
        rovGpsStatus?: GpsStatus;
        rovSource?: PositionSources;
        topsideGpsStatus?: GpsStatus;
        topsidePosition?: TopsidePosition;
        topSource?: TopPositionSources;
        usblOffset?: UsblOffset;
    }
    Index

    Properties

    deadReckoningAvailable? resetFilter? rovGpsStatus? rovSource? topsideGpsStatus? topsidePosition? topSource? usblOffset?

    Properties

    deadReckoningAvailable?: boolean

    Dead Reckoning availability flag

    Indicates if the ROV has dead reckoning capability

    resetFilter?: boolean

    Re-zeroes the position filter.

    Write-only trigger; accepts true only and always reads back empty. Clears an operator-pinned position, hands arbitration back to the sensors, and moves the local map frame. X4 only.

    rovGpsStatus?: GpsStatus

    GPS status values for the ROV such as GPS Fix and Signal Strength

    GpsStatus

    rovSource?: PositionSources

    Source of ROV position.

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

    PositionSources

    topsideGpsStatus?: GpsStatus

    GPS status values for the topside GPS such as GPS Fix and Signal Strength

    GpsStatus

    topsidePosition?: TopsidePosition

    Position of the topside, which is the surface end of the tether and the reference the USBL head is offset from.

    Reported by the vehicle whatever the source, so a client that did not issue the write still renders it. Settable only when PositionNavigationOption.topSource is STATIC. X4 only.

    TopsidePosition

    topSource?: TopPositionSources

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

    TopPositionSources

    usblOffset?: UsblOffset

    Fixed offset from the topside to the USBL head.

    Applies when the head is not co-located with the topside. X4 only.

    UsblOffset

    Settings

    Member Visibility

    On This Page

    Properties