Rov altitude
Measured in meters to show relative distance to floor.
From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"ACAA8AF833FB": {
"model": 18,
"altitude": 227
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"D8DA21D53D31": {
"model": 13,
"altitudeValid": true
}
}
}
}
Rov altitude valid
Altitude validity flag
Valid altitude (good data)
From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"9DDED16A7CCB": {
"model": 18,
"altitude": 103,
"altitudeValid": true
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"36B1BC713EDB": {
"model": 13,
"altitudeValid": true,
"altitude": 293
}
}
}
}
Random altitude validity
From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"76929A829877": {
"model": 18,
"altitudeValid": false
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"D8DA21D53D31": {
"model": 13,
"altitudeValid": true
}
}
}
}
Body Leak Fault
Arbitrary
From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"B34847218FC4": {
"model": 13,
"bodyLeak": true
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotBodyLeakRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"34A92067D479": {
"model": 18,
"bodyLeak": false
}
}
}
}
Has no body leak fault
From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasNoBodyLeakSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"62C9337EE138": {
"model": 13,
"bodyLeak": false
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasNoBodyLeakSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"4DBFF90007BD": {
"model": 18,
"bodyLeak": false
}
}
}
}
Has body leak fault
From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasBodyLeakSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"52288DEE3F02": {
"model": 13,
"bodyLeak": true
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasBodyLeakSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"854F091C3313": {
"model": 18,
"bodyLeak": true
}
}
}
}
📷 List of cameras
Holds a list of all vehicle Cameras.
The cp probe
The ut(cygnus) probe
Rov depth
Measured in meters from water surface
To Calibrate depth, set depth to '0'. Setting depth to any other value will be ignored.
Valid Depth calibration
From ./dist/samples/json/requests/devices/vehicles/pivot/depth/pivotDepthCalibrationSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "SET",
"payload": {
"devices": {
"B1E14D3BC684": {
"model": 18,
"depth": 0
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionDepthCalibrationSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "SET",
"payload": {
"devices": {
"DE3BD09C58FA": {
"model": 13,
"depth": 0
}
}
}
}
Invalid Depth Calibration
From ./dist/samples/json/requests/devices/vehicles/pivot/depth/pivotInvalidDepthCalibrationSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "SET",
"payload": {
"devices": {
"2A459A3C1186": {
"model": 18,
"depth": 27
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionInvalidDepthCalibrationSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "SET",
"payload": {
"devices": {
"EE594DCB6A13": {
"model": 13,
"depth": 251
}
}
}
}
Direct Power Kit Present Flag
Rov Drive object
Commands thrust actions for the ROV and sets drive modes
See RovDrive for more details.
From ./dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "SET",
"payload": {
"devices": {
"8C567F9E9602": {
"model": 18,
"drive": {
"thrust": {
"forward": -31,
"yaw": -62,
"vertical": -17,
"lateral": 42
},
"modes": {
"headingLock": true,
"altitudeLock": true,
"depthLock": true,
"autoStabilization": true,
"motorsDisabled": true
}
}
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "SET",
"payload": {
"devices": {
"7133DA8258D1": {
"model": 13,
"drive": {
"thrust": {
"forward": 58,
"yaw": 49,
"vertical": -31,
"lateral": -62
},
"modes": {
"headingLock": true,
"altitudeLock": true,
"depthLock": false,
"autoStabilization": true,
"motorsDisabled": false
}
}
}
}
}
}
Rov heading
Measured in degrees from north bearing
Rov in water status
From ./dist/samples/json/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "SET",
"payload": {
"devices": {
"8157D0211CA8": {
"model": 13,
"ip": "192.168.84.90"
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/pivot/ip/pivotIpRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "SET",
"payload": {
"devices": {
"CECABE6CDCC3": {
"model": 18,
"ip": "192.168.66.96"
}
}
}
}
Rov local heading
Measure in degrees from local heading
Deep Trekker internal device model numbers. This can be used for selecting the associated device schema.
Navigation Options
Rov pitch
Measured in degrees from neutral pitch position
ROV Position
Rov roll
Measured in degrees from neutral roll position
Sensor pod information and calibration controls based on the model.
dist/samples/json/requests/devices/vehicles/pivot/calibration/startImuCalibration/pivotStartImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/stopImuCalibration/pivotStopImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/denyImuCalibration/pivotDenyImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptImuCalibration/pivotAcceptImuCalibrationRequest.json
dist/samples/json/requests/devices/vehicles/pivot/calibration/startMagneticCalibration/pivotStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/stopMagneticCalibration/pivotStopMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/denyMagneticCalibration/pivotDenyMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptMagneticCalibration/pivotAcceptMagneticCalibrationRequest.json
Revolution and Pivot Pending IMU update dist/samples/json/requests/devices/vehicles/revolution/calibration/startMagneticCalibration/revolutionStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorPendingImuCalibration/pivotPendingImuRandomUpdate.json
Revolution and Pivot Pending Magnetic update dist/samples/json/requests/devices/vehicles/revolution/calibration/sensorMagneticCalibration/revolutionPendingMagneticRandomUpdate.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorPendingMagneticCalibration/pivotPendingMagneticRandomUpdate.json
Revolution and Pivot Accepted Magnetic and IMU update dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptMagneticCalibration/revolutionAcceptMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptMagneticCalibration/pivotAcceptMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorNotCalibratingState/pivotAcceptedRandomUpdate.json dist/samples/json/requests/devices/vehicles/revolution/calibration/sensorNotCalibratingState/revolutionAcceptedRandomUpdate.json
Sensor Pod Leak Fault
Common across all ROV and also comes from the ROV Web Adapter in Con_gui
Turns
Count the number of turns the rov has completed
Vehicle Usage Time
Total and current usage times
From ./dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"097DD1576B79": {
"model": 18,
"usageTime": {
"totalSeconds": 0,
"currentSeconds": 0
}
}
}
}
}
Arbitrary
From ./dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"349737E08F1B": {
"model": 18,
"usageTime": {
"totalSeconds": 57,
"currentSeconds": 60
}
}
}
}
}
From ./dist/samples/json/requests/devices/vehicles/revolution/usageTime/revolutionUsageTimeRandomSample.json
{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.4",
"method": "UPDATE",
"payload": {
"devices": {
"87DA6496E1CD": {
"model": 13,
"usageTime": {
"totalSeconds": 6,
"currentSeconds": 100
}
}
}
}
}
Rov Velocity
ROV Version
See type declaration
Base ROV