Skip to content

underIce/DefaultUnderTimeout.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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
#   Copyright (c) 2024 MBARI
#   MBARI Proprietary Information. Confidential. All Rights Reserved
#   Unauthorized copying or distribution of this file via any medium is strictly
#   prohibited.
#
#   WARNING - This file contains information whose export is restricted by the
#   Export Administration Act of 1979 (Title 50, U.S.C., App. 2401 et seq.), as
#   amended. Violations of these export laws are subject to severe civil and/or
#   criminal penalties.

mission DefaultUnderTimeout {
  arguments {
    MissionTimeout = 4 hour
      """
      Maximum duration of mission
      """

    CommsInterval = 10 minute
      """
      How often to trigger uModem communications while the mission is in an
      idle state (on the dock).
      """

    HomingCommsInterval = 30 minute
      """
      How often to trigger uModem communications while the mission is actively
      homing to the dock (line capture).
      """

    TransponderCode = 2 count
      """
      Dock transponder address.
      """

    AcousticUpdatePeriod = 60 second
      """
      Time duration between acoustic queries while the mission is in an idle
      state (on the dock or surface).
      """

    HomingAcousticUpdatePeriod = 2.5 second
      """
      Time duration between acoustic queries while the mission is actively
      homing to the dock (line capture).
      """

    NumberOfPings = 1 count
      """
      Number of pings requested each time.
      """

    TrackingLowPassFilterWinSize = 1 count
      """
      Median filter bin size. Filters the contact estimated lat/lon position.
      Prefer odd number, set to 1 to disable filter.
      """

    TrackingLowPassFilterWinOverlap = true
      """
      Set True for "sliding" median filter, false for non-overlapping bins.
      """
  }

  output {
    # Mission Variables (don't change!)

    TrackingUpdatePeriod = 60 second
      """
      Mission variable (don't change). How long to wait between acoustic
      queries.
      """

    uModemCommsInterval = 10 minute
      """
      Mission variable (don't change). The mission updates the value of this
      variable to determine how often to trigger uModem communications.
      """

    Surface = -1 count
      """
      Mission variable (don't change). The mission will run in this mode to go
      to the surface after homing attempts have failed.
      """

    Docked = 0 count
      """
      Mission variable (don't change). The mission will run in this mode when
      the vehicle is docked.
      """

    Home = 1 count
      """
      Mission variable (don't change). The mission will run in this mode when
      homing to the dock.
      """

    DefaultMode = 0 count
      """
      Mission variable (don't change). The mission sets this variable to
      switch between default modes.
      """

    CaptureMode = -1 count
      """
      Mission variable (don't change). The mission sets this variable to
      reflect the termination status of the LineCapture insert.
      """

    StartComms = true
      """
      Mission variable (don't change). The mission sets this variable to reset
      the comms timer. Forces comms when true.
      """

    ElapsedSinceDefaultStarted = 0 minute
  }

  timeout duration=MissionTimeout

  # Initialize mission variables with default values

  assign in sequence DefaultMode = Docked

  assign in sequence TrackingUpdatePeriod = AcousticUpdatePeriod

  assign in sequence uModemCommsInterval = CommsInterval

  assign in sequence StartComms = true

  # Safety nets

  behavior Guidance:PitchEnvelope {
    run in parallel
  }

  # uModem communication directives

  aggregate uModemComms {
    run while (
      not ( DefaultMode == Surface )
      and (
        StartComms
        or ( elapsed ( StartComms ) > uModemCommsInterval )
      )
    )

    aggregate doComms {
      run in sequence

      syslog info "Initiating uModem comms cycle."

      # Reduce range interrogation rates to minimize interruptions to uModem comms packets

      assign in sequence TrackingUpdatePeriod = AcousticUpdatePeriod

      readDatum {
        timeout duration=P10M

        Universal:platform_communications
      }

      aggregate ResumeTracking {
        """
        Resume rapid acoustic interrogation rate if the mission is
        still actively homing to the dock.
        """

        run in sequence

        break if ( not ( DefaultMode == Home ) )

        assign in sequence TrackingUpdatePeriod = HomingAcousticUpdatePeriod
      }

      # This assignment restarts the comms timer

      assign in sequence StartComms = false
    }
  }

  # Notify directives.

  aggregate Notify {
    run in parallel

    aggregate {
      run in sequence

      aggregate {
        run in sequence repeat=48

        behavior Guidance:Wait {
          run in sequence

          set duration = 30 minute
        }

        assign in sequence ElapsedSinceDefaultStarted = elapsed ( Universal:mission_started )

        syslog important "Default Under mission has been running for "
             + ElapsedSinceDefaultStarted~minute
      }

      syslog important "Restarting logs."

      behavior Guidance:Execute {
        run in sequence

        set command = "restart logs"
      }
    }
  }

  # Add LineCapture directives.

  insert Insert/LineCapture.tl

  # Add SetNav directives.

  insert Insert/SetNavAcoustic.tl

  # Add track acoustic contact directives.

  aggregate TrackAcousticContact {
    run in parallel

    behavior Estimation:TrackAcousticContact {
      run in parallel

      set contactLabelSetting = TransponderCode
      set numberOfSamplesSetting = NumberOfPings
      set updatePeriodSetting = TrackingUpdatePeriod
      set numFixesLowPassSetting = TrackingLowPassFilterWinSize
      set lowPassOverlapSetting = TrackingLowPassFilterWinOverlap
    }
  }

  # Default mission sequence.

  behavior Guidance:Wait {
    """
    Wait a moment to see if the scheduler starts a new mission before
    starting to actually run Default.
    """

    run in sequence

    set duration = 13 second
  }

  aggregate Default {
    run in sequence

    aggregate Docked {
      """
      Keep the vehicle in an idle state while on the dock, transition
      to Home mode if detached.
      """

      run while ( DefaultMode == Docked )

      aggregate run {
        run in sequence

        syslog info "Running Docked. DefaultMode:" + DefaultMode~count

        aggregate initialize {
          run in sequence

          assign in sequence uModemCommsInterval = CommsInterval

          assign in sequence TrackingUpdatePeriod = AcousticUpdatePeriod

          assign in sequence StartComms = true
        }

        behavior Dock:Docked {
          run in sequence
        }

        assign in sequence DefaultMode = Home
      }
    }

    aggregate Home {
      """
      Execute the homing sequence.
      """

      run while ( DefaultMode == Home )

      aggregate run {
        run in sequence

        syslog info "Running Home sequence. DefaultMode:" + DefaultMode~count

        aggregate initialize {
          run in sequence

          assign in sequence uModemCommsInterval = HomingCommsInterval

          assign in sequence TrackingUpdatePeriod = HomingAcousticUpdatePeriod

          assign in sequence CaptureMode = Surface
        }

        # Execute the LineCapture sequence.

        call refId="LineCapture"

        assign in sequence CaptureMode = LineCapture:GuidanceMode

        aggregate CheckCaptureSuccess {
          run in sequence

          break if ( not ( CaptureMode == Docked ) )

          assign in sequence DefaultMode = Docked
        }

        assign in sequence DefaultMode = Surface
      }
    }

    aggregate Surface {
      run while ( DefaultMode == Surface )

      aggregate run {
        run in sequence

        syslog info "Running Surface sequence. DefaultMode:" + DefaultMode~count

        aggregate initialize {
          run in sequence

          assign in sequence TrackingUpdatePeriod = AcousticUpdatePeriod
        }

        behavior Guidance:GoToSurface {
          run in parallel
        }

        aggregate SurfaceComms {
          run in sequence repeat=288

          readDatum id="Read_GPS" {
            timeout duration=P5M

            Universal:time_fix
          }

          readDatum id="Read_Iridium_uModem" {
            timeout duration=P2H {
              behavior Guidance:Execute {
                run in sequence

                set command = "Burn on"
              }

              syslog critical "Dropped weight due to communications timeout."
            }

            Universal:platform_communications
          }

          behavior Guidance:Wait {
            run in sequence

            set duration = 5 minute
          }
        }
      }
    }
  }
}