libstp.step.wait_for_button
===========================

.. py:module:: libstp.step.wait_for_button


Classes
-------

.. autoapisummary::

   libstp.step.wait_for_button.WaitForButton


Functions
---------

.. autoapisummary::

   libstp.step.wait_for_button.wait_for_button


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

.. py:class:: WaitForButton

   Bases: :py:obj:`libstp.ui.UIStep`


   UI step that blocks until the operator presses the hardware button.


.. py:function:: wait_for_button() -> WaitForButton

   Wait for the operator to press the hardware button before continuing.

   Blocks the step sequence until the physical button on the robot
   controller is pressed. A "Waiting for button press..." message is
   displayed on the UI while waiting. This is useful for pausing
   between autonomous phases, confirming the robot is correctly
   positioned before starting, or gating destructive actions behind
   human approval.

   :returns: A ``WaitForButton`` UI step ready to be scheduled in a step
             sequence.

   Example::

       from libstp.step import wait_for_button

       # Wait for the operator to confirm placement before starting
       sequence(
           wait_for_button(),
           motor_power(robot.motor(0), 100),
           wait(3.0),
           motor_brake(robot.motor(0)),
       )