Interface IRevolution

Measured in meters to show relative distance to floor.

• Random altitude

  From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeRandomSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "250F264D1E6C": {
                  "model": 18,
                  "altitude": 243
              }
          }
      }
  }
  

  From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "C570FAD37070": {
                  "model": 13,
                  "altitudeValid": false
              }
          }
      }
  }
  

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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "1EB38F2F21F3": {
                  "model": 18,
                  "altitude": 251,
                  "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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "B5524D4630EF": {
                  "model": 13,
                  "altitudeValid": true,
                  "altitude": 64
              }
          }
      }
  }
  

• 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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "5737A6E61185": {
                  "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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "C570FAD37070": {
                  "model": 13,
                  "altitudeValid": false
              }
          }
      }
  }
  

Controls the auxiliary light attached to the Revolution.

• Arbitrary

  From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "3CBEBF87C7A5": {
                  "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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "5E16C3EADD90": {
                  "model": 18,
                  "bodyLeak": true
              }
          }
      }
  }
  

• 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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "724770D3B098": {
                  "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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "A3BC6BE7F844": {
                  "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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "277F0CA9D5D7": {
                  "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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "6182C6EFF310": {
                  "model": 18,
                  "bodyLeak": true
              }
          }
      }
  }
  

Controls the camera head attached to the revolution

Holds a list of all vehicle Cameras.

• Arbitrary

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "45287C256FAE": {
                "model": 13,
                "cpuTemp": 85
            }
        }
    }
}

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "71A62A92509B": {
                "model": 18,
                "depth": 0
            }
        }
    }
}

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "1D044DA1B4B8": {
                "model": 13,
                "depth": 0
            }
        }
    }
}

Invalid Depth Calibration

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "5766DC0E1114": {
                "model": 18,
                "depth": 14
            }
        }
    }
}

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "05975215B22A": {
                "model": 13,
                "depth": 53
            }
        }
    }
}

Commands thrust actions for the ROV and sets drive modes

See RovDrive for more details.

• Random drive request

  From ./dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "SET",
      "payload": {
          "devices": {
              "7B2845F18226": {
                  "model": 18,
                  "drive": {
                      "thrust": {
                          "forward": 55,
                          "yaw": 10,
                          "vertical": 5,
                          "lateral": -6
                      },
                      "modes": {
                          "headingLock": false,
                          "altitudeLock": false,
                          "depthLock": true,
                          "autoStabilization": true,
                          "motorsDisabled": false
                      }
                  }
              }
          }
      }
  }
  

  From ./dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "SET",
      "payload": {
          "devices": {
              "9DAEF04EEBD0": {
                  "model": 13,
                  "drive": {
                      "thrust": {
                          "forward": -45,
                          "yaw": 80,
                          "vertical": -60,
                          "lateral": -90
                      },
                      "modes": {
                          "headingLock": true,
                          "altitudeLock": true,
                          "depthLock": true,
                          "autoStabilization": true,
                          "motorsDisabled": true
                      }
                  }
              }
          }
      }
  }
  

Measured in meters to show relative distance to an object ahead of the ROV.

• All arbitrary values

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "ACC4C35B55BB": {
                "model": 13,
                "frontLeftMotorDiagnostics": {
                    "current": 56,
                    "overcurrent": true,
                    "pwm": 36,
                    "rpm": -67,
                    "failure": false
                }
            }
        }
    }
}

• Resting values

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A5BC871D635E": {
                "model": 13,
                "frontLeftMotorDiagnostics": {
                    "current": 9,
                    "overcurrent": false,
                    "pwm": 5,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Measured in degrees from north bearing

• Arbitrary

  From ./dist/samples/json/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "SET",
      "payload": {
          "devices": {
              "19DA222C3769": {
                  "model": 13,
                  "ip": "192.168.222.138"
              }
          }
      }
  }
  

  From ./dist/samples/json/requests/devices/vehicles/pivot/ip/pivotIpRandomSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "SET",
      "payload": {
          "devices": {
              "93F613395876": {
                  "model": 18,
                  "ip": "192.168.148.143"
              }
          }
      }
  }
  

• All arbitrary values

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7498C1A319DA": {
                "model": 13,
                "leftBattery": {
                    "percent": 10,
                    "voltage": 100,
                    "charging": false
                }
            }
        }
    }
}

• Left battery warning

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "5558BB4B7659": {
                "model": 13,
                "leftBattery": {
                    "percent": 10
                }
            }
        }
    }
}

• Left battery shutdown

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "E81B52172321": {
                "model": 13,
                "leftBattery": {
                    "percent": 0
                }
            }
        }
    }
}

• Left battery charging

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "988700118E29": {
                "model": 13,
                "leftBattery": {
                    "charging": true
                }
            }
        }
    }
}

• left battery not charging

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "82ED1D340268": {
                "model": 13,
                "leftBattery": {
                    "charging": false
                }
            }
        }
    }
}

• left battery has leak

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4B45E91AB652": {
                "model": 13,
                "leftBattery": {
                    "leak": true
                }
            }
        }
    }
}

• left batter has no leak

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "1CA45FE49430": {
                "model": 13,
                "leftBattery": {
                    "leak": false
                }
            }
        }
    }
}

Measure in degrees from local heading

Measured in degrees from neutral pitch position

• All Arbitrary values

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "052BE2E87A9B": {
                "model": 13,
                "rightBattery": {
                    "percent": 76,
                    "voltage": 100,
                    "charging": false
                }
            }
        }
    }
}

• Right battery warning

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0EBF00049E32": {
                "model": 13,
                "rightBattery": {
                    "percent": 10
                }
            }
        }
    }
}

• Right battery shutdown

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "148B2F021795": {
                "model": 13,
                "rightBattery": {
                    "percent": 0
                }
            }
        }
    }
}

• Right battery charging

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "41163CCD5D25": {
                "model": 13,
                "rightBattery": {
                    "charging": true
                }
            }
        }
    }
}

• Right battery not charging

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7447401833E8": {
                "model": 13,
                "rightBattery": {
                    "charging": false
                }
            }
        }
    }
}

• right battery has leak

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A2998E331AAF": {
                "model": 13,
                "rightBattery": {
                    "leak": true
                }
            }
        }
    }
}

• right battery has no leak

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0B16FDD53037": {
                "model": 13,
                "rightBattery": {
                    "leak": false
                }
            }
        }
    }
}

Measured in degrees from neutral roll position

• Revolution Calibration User Actions for IMU Calibration. dist/samples/json/requests/devices/vehicles/revolution/calibration/startImuCalibration/revolutionStartImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/stopImuCalibration/revolutionStopImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/denyImuCalibration/revolutionDenyImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptImuCalibration/revolutionAcceptImuCalibrationRequest.json

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

• Revolution Calibration User Actions for Magnetic Calibration. dist/samples/json/requests/devices/vehicles/revolution/calibration/startMagneticCalibration/revolutionStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/stopMagneticCalibration/revolutionStopMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/denyMagneticCalibration/revolutionDenyMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptMagneticCalibration/revolutionAcceptMagneticCalibrationRequest.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

Common across all ROV and also comes from the ROV Web Adapter in Con_gui

• Resting spare motor 1 diagnostics sample

  From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor1/revolutionSpareMotor1DiagnosticsRestingSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "B91ABBA4F6CF": {
                  "model": 13,
                  "spareMotor1": {
                      "current": 62,
                      "overcurrent": true,
                      "pwm": 73,
                      "rpm": -19,
                      "failure": false
                  }
              }
          }
      }
  }
  

• Arbitrary Spare Motor 1 Diagnostics sample

  From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor1/revolutionSpareMotor1DiagnosticsRandomSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "6748F9B128DA": {
                  "model": 13,
                  "spareMotor1": {
                      "current": 72,
                      "overcurrent": false,
                      "pwm": 72,
                      "rpm": -79,
                      "failure": false
                  }
              }
          }
      }
  }
  

• Resting spare motor 2 diagnostics sample

  From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor2/revolutionSpareMotor2DiagnosticsRestingSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "2295D14F9B69": {
                  "model": 13,
                  "spareMotor2": {
                      "current": 17,
                      "overcurrent": false,
                      "pwm": 100,
                      "rpm": 48,
                      "failure": false
                  }
              }
          }
      }
  }
  

• Arbitrary Spare Motor 2 Diagnostics sample

  From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor2/revolutionSpareMotor2DiagnosticsRandomSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "65AB2109FB2B": {
                  "model": 13,
                  "spareMotor2": {
                      "current": 45,
                      "overcurrent": true,
                      "pwm": 97,
                      "rpm": 39,
                      "failure": false
                  }
              }
          }
      }
  }
  

Count the number of turns the rov has completed

• 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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "25F62F70F03D": {
                  "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.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "BC8CEA5D0929": {
                  "model": 18,
                  "usageTime": {
                      "totalSeconds": 63,
                      "currentSeconds": 55
                  }
              }
          }
      }
  }
  

  From ./dist/samples/json/requests/devices/vehicles/revolution/usageTime/revolutionUsageTimeRandomSample.json

  {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.59.0",
      "method": "UPDATE",
      "payload": {
          "devices": {
              "4B8B7F9E3B40": {
                  "model": 13,
                  "usageTime": {
                      "totalSeconds": 65,
                      "currentSeconds": 19
                  }
              }
          }
      }
  }
  

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "EFE508F4047D": {
                "model": 13,
                "waterTemp": 11
            }
        }
    }
}

• Max water temp

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "00C3D66741A8": {
                "model": 13,
                "waterTemp": 50
            }
        }
    }
}

• Min water temp

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B4C8DB7FB24D": {
                "model": 13,
                "waterTemp": -10
            }
        }
    }
}