step.setup_timer_dsl
====================

.. py:module:: step.setup_timer_dsl

.. autoapi-nested-parse::

   Auto-generated step builders and DSL functions — DO NOT EDIT.

   Source: setup_timer.py



Classes
-------

.. autoapisummary::

   step.setup_timer_dsl.PauseSetupTimerBuilder
   step.setup_timer_dsl.StartSetupTimerBuilder
   step.setup_timer_dsl.ResumeSetupTimerBuilder


Functions
---------

.. autoapisummary::

   step.setup_timer_dsl.pause_setup_timer
   step.setup_timer_dsl.start_setup_timer
   step.setup_timer_dsl.resume_setup_timer


Module Contents
---------------

.. py:class:: PauseSetupTimerBuilder

   Bases: :py:obj:`raccoon.step.step_builder.StepBuilder`


   Builder for PauseSetupTimer. Auto-generated — do not edit.


.. py:function:: pause_setup_timer()

   Freeze the setup-phase countdown at its current value.

   Stops the remaining-time clock displayed at the top of every setup
   UI screen.  Elapsed time really stops advancing — a later
   :func:`start_setup_timer` (or :func:`resume_setup_timer`) picks up
   from where this step left the clock.

   No-op when used outside a SetupMission.

   :returns: A PauseSetupTimerBuilder (chainable via , ``.on_anomaly()``, ``.skip_timing()``).

   Example::

       from raccoon.step.setup_timer import pause_setup_timer, start_setup_timer

       # As the very first step of the setup sequence: idle until the
       # operator is ready, then kick off the real setup timer.
       sequence(
           pause_setup_timer(),
           wait_for_button(),
           start_setup_timer(),
           calibrate_deadzone(),
           ...
       )


.. py:class:: StartSetupTimerBuilder

   Bases: :py:obj:`raccoon.step.step_builder.StepBuilder`


   Builder for StartSetupTimer. Auto-generated — do not edit.


.. py:function:: start_setup_timer()

   Start (or restart) the setup-phase countdown from full duration.

   Resets the elapsed time to zero and unpauses the timer, so the
   operator gets the full :attr:`SetupMission.setup_time` from the
   moment this step runs.  Combine with :func:`pause_setup_timer` at
   the top of the setup sequence to defer the countdown until you are
   ready.

   No-op when used outside a SetupMission.

   :returns: A StartSetupTimerBuilder (chainable via , ``.on_anomaly()``, ``.skip_timing()``).

   Example::

       from raccoon.step.setup_timer import pause_setup_timer, start_setup_timer

       sequence(
           pause_setup_timer(),
           wait_for_button(),       # idle here — timer stays frozen
           start_setup_timer(),     # full setup_time begins now
           calibrate_deadzone(),
       )


.. py:class:: ResumeSetupTimerBuilder

   Bases: :py:obj:`raccoon.step.step_builder.StepBuilder`


   Builder for ResumeSetupTimer. Auto-generated — do not edit.


.. py:function:: resume_setup_timer()

   Resume a paused setup-phase countdown without resetting it.

   Unlike :func:`start_setup_timer`, this preserves the elapsed time
   so the countdown continues from wherever it was frozen.

   No-op when used outside a SetupMission, or when the timer is
   already running.

   :returns: A ResumeSetupTimerBuilder (chainable via , ``.on_anomaly()``, ``.skip_timing()``).

   Example::

       from raccoon.step.setup_timer import pause_setup_timer, resume_setup_timer

       sequence(
           pause_setup_timer(),
           wait_for_button(),
           resume_setup_timer(),   # continue from the frozen value
       )