Type Alias RovVehicle

RovVehicle: {
    altitude?: number;
    altitudeValid?: boolean;
    bodyLeak?: boolean;
    depth?: number;
    directPowerKitPresent?: boolean;
    drive?: RovDrive;
    dvl?: DVL;
    echosounder?: Echosounder;
    forwardDistance?: number;
    heading?: number;
    inputDiagnostics?: RovInputDiagnostics;
    inWater?: boolean;
    ip?: string;
    localHeading?: number;
    pitch?: number;
    roll?: number;
    sensorPod?: CalibratableSensorPod;
    sensorPodLeak?: boolean;
    sonar3d?: Sonar3D;
    turns?: number;
    usageTime?: UsageTime;
    version?: DeviceVersion;
} & Vehicle & Navigation

Rov Class

Type declaration

Optional Readonlyaltitude?: number
Remarks
Rov altitude

Measured in meters to show relative distance to floor.
Example
```
{
  "altitude": 0
}
```
Optional ReadonlyaltitudeValid?: boolean
Remarks
Rov altitude valid

Altitude validity flag
Example
```
{
  "altitudeValid": true
}
```
Optional ReadonlybodyLeak?: boolean
Body Leak Fault
Remarks
Body Leak Fault

Common across all ROV and also comes from the ROV Web Adapter in Con_gui
Example
```
{
  "bodyLeak": true
}
```
Optional Readonlydepth?: number
Remarks
Rov depth

Measured in meters from water surface

To Calibrate depth, set depth to '0'. Setting depth to any other value will be ignored.
Example
```
{
  "depth": 0
}
```
Optional ReadonlydirectPowerKitPresent?: boolean
Remarks
Direct Power Kit Present Flag
Example
```
{
  "directPowerKitPresent": true
}
```
Optionaldrive?: RovDrive
Remarks
Rov Drive object

Commands thrust actions for the ROV and sets drive modes

See
RovDrive
Optional Readonlydvl?: DVL
DVL

See
DVL
Optionalechosounder?: Echosounder
Echosounder device information and control

See
Echosounder
Optional ReadonlyforwardDistance?: number
Remarks
Rov Forward distance

Measured in meters to show relative distance to an object ahead of the ROV.
Example
```
{
  "forwardDistance": 0
}
```
Optional Readonlyheading?: number
Remarks
Rov heading

Measured in degrees from north bearing
Example
```
{
  "heading": 0
}
```
Minimum
0

Maximum
360
Optional ReadonlyinputDiagnostics?: RovInputDiagnostics
InputDiagnostics

See
RovInputDiagnostics
Optional ReadonlyinWater?: boolean
Remarks
Rov in water status
Example
```
{
  "inWater": true
}
```
Optional Readonlyip?: string
Remarks
IP Address
Example
```
{
  "ip": "192.168.1.1"
}
```
OptionallocalHeading?: number
Remarks
Rov local heading

Measure in degrees from local heading
Example
```
{
  "localHeading": 0
}
```
Minimum
-360

Maximum
360
Optional Readonlypitch?: number
Remarks
Rov pitch

Measured in degrees from neutral pitch position
Example
```
{
  "pitch": 0
}
```
Minimum
-180.0

Maximum
180.0
Optional Readonlyroll?: number
Remarks
Rov roll

Measured in degrees from neutral roll position
Example
```
{
  "roll": 0
}
```
Minimum
-180.0

Maximum
180.0
OptionalsensorPod?: CalibratableSensorPod
Remarks
Sensor pod information and calibration controls based on the model.

See
CalibratableSensorPod
OptionalsensorPodLeak?: boolean
Remarks
Sensor Pod Leak Fault

Common across all ROV and also comes from the ROV Web Adapter in Con_gui
Example
```
{
  "sensorPodLeak": true
}
```
Optionalsonar3d?: Sonar3D
3d Sonar device informaton wihtout the HW and FW versions

See
Sonar3D
Optional Readonlyturns?: number
Remarks
Turns

Count the number of turns the rov has completed. Useful for tracking tether.
Example
```
{
  "turns": 0
}
```
OptionalusageTime?: UsageTime
Vehicle Usage Time

See
UsageTime
Optional Readonlyversion?: DeviceVersion
ROV Version

See
DeviceVersion

Remarks

Rov base vehicle type.

Type Alias RovVehicle

Type declaration

Optional Readonlyaltitude?: number

Remarks

Example

Optional ReadonlyaltitudeValid?: boolean

Remarks

Example

Optional ReadonlybodyLeak?: boolean

Remarks

Example

Optional Readonlydepth?: number

Remarks

Example

Optional ReadonlydirectPowerKitPresent?: boolean

Remarks

Example

Optionaldrive?: RovDrive

Remarks

See

Optional Readonlydvl?: DVL

See

Optionalechosounder?: Echosounder

See

Optional ReadonlyforwardDistance?: number

Remarks

Example

Optional Readonlyheading?: number

Remarks

Example

Minimum

Maximum

Optional ReadonlyinputDiagnostics?: RovInputDiagnostics

See

Optional ReadonlyinWater?: boolean

Remarks

Example

Optional Readonlyip?: string

Remarks

Example

OptionallocalHeading?: number

Remarks

Example

Minimum

Maximum

Optional Readonlypitch?: number

Remarks

Example

Minimum

Maximum

Optional Readonlyroll?: number

Remarks

Example

Minimum

Maximum

OptionalsensorPod?: CalibratableSensorPod

Remarks

See

OptionalsensorPodLeak?: boolean

Remarks

Example

Optionalsonar3d?: Sonar3D

See

Optional Readonlyturns?: number

Remarks

Example

OptionalusageTime?: UsageTime

See

Optional Readonlyversion?: DeviceVersion

See

Remarks

Settings

`Optional` `Readonly`altitude?: number

`Optional` `Readonly`altitudeValid?: boolean

`Optional` `Readonly`bodyLeak?: boolean

`Optional` `Readonly`depth?: number

`Optional` `Readonly`directPowerKitPresent?: boolean

`Optional`drive?: RovDrive

`Optional` `Readonly`dvl?: DVL

`Optional`echosounder?: Echosounder

`Optional` `Readonly`forwardDistance?: number

`Optional` `Readonly`heading?: number

`Optional` `Readonly`inputDiagnostics?: RovInputDiagnostics

`Optional` `Readonly`inWater?: boolean

`Optional` `Readonly`ip?: string

`Optional`localHeading?: number

`Optional` `Readonly`pitch?: number

`Optional` `Readonly`roll?: number

`Optional`sensorPod?: CalibratableSensorPod

`Optional`sensorPodLeak?: boolean

`Optional`sonar3d?: Sonar3D

`Optional` `Readonly`turns?: number

`Optional`usageTime?: UsageTime

`Optional` `Readonly`version?: DeviceVersion