Skip to content

_examples/tank_ballast_and_trim.tl

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
mission ballast_and_trim {
  arguments {
    MissionTimeout = 120 minute
      """
      Maximum duration of mission.
      """

    Depth1 = 7 meter
      """
      Target depth for ballast and trim.
      """

    Depth2 = NaN meter
      """
      Target depth to run a second ballast and trim, skipped if NaN.
      """

    DepthDeadband = 0.1 meter
      """
      How much vertical drift from the specified depth is allowed during the
      mission.
      """

    SurfaceThreshold = 2.5 meter
      """
      Surface threshold depth, relevant only to the ascent.
      """

    TargetDepthTimeout = 20 minute
      """
      Maximum wait time for the vehicle to reach the target ballast and trim
      depth.
      """

    SettleTime = 10 minute
      """
      How long to wait after reaching target depth before starting ballast and
      trim.
      """

    EstimationTimeout = 45 minute
      """
      Timeout for ballast and trim estimation.
      """

    MinEstimationTime = 10 minute
      """
      Minimum time to run ballast and trim estimation before determining
      convergence (must be shorter than timeout).
      """

    MassEstimationErrorBound = 0.25 millimeter
      """
      Desired range of the estimated sample mean from the true mean statistic
      (smaller values take longer to converge).
      """

    BuoyEstimationErrorBound = 15 cubic_centimeter
      """
      Desired range of the estimated sample mean from the true mean statistic
      (smaller values take longer to converge).
      """

    EstimationConfidence = 99.9 percent
      """
      Confidence level that the estimator has reached the desired error range
      (larger values take longer to converge).
      """

    WaitToFloat = 5 minute
      """
      Timeout for reaching surface threshold on float ascent, mission will end
      when reached.
      """
  }

  timeout duration=MissionTimeout

  insert Insert/Science.tl

  insert Insert/BackseatDriver.tl

  aggregate RunBallastAndTrim {
    run in sequence

    insert Insert/BallastAndTrim.tl {
      redefineArg InsertDepthDeadband = DepthDeadband
      redefineArg InsertApproachDepthTimeout = TargetDepthTimeout
      redefineArg InsertSettleTime = SettleTime
      redefineArg EstTimeout = EstimationTimeout
      redefineArg MinEstTime = MinEstimationTime
      redefineArg MassEstErrorBound = MassEstimationErrorBound
      redefineArg BuoyEstErrorBound = BuoyEstimationErrorBound
      redefineArg EstConfidence = EstimationConfidence
    }

    aggregate Depth1 {
      run in sequence

      break if ( isNaN ( Depth1 ) )

      assign in sequence BallastAndTrim:InsertDepth = Depth1

      call refId="BallastAndTrim"
    }

    aggregate Depth2 {
      run in sequence

      break if ( isNaN ( Depth2 ) )

      assign in sequence BallastAndTrim:InsertDepth = Depth2

      call refId="BallastAndTrim"
    }
  }

  aggregate Float_Up {
    """
    Float to surface instead of driving.
    """

    run in sequence

    break if ( Universal:depth < SurfaceThreshold )

    behavior Guidance:Buoyancy {
      run in parallel

      set position = Control:VerticalControl.buoyancyDefault
    }

    behavior Guidance:Wait {
      run in sequence

      set duration = WaitToFloat
    }
  }
}