libstp.step.motion.stop
=======================

.. py:module:: libstp.step.motion.stop


Classes
-------

.. autoapisummary::

   libstp.step.motion.stop.Stop


Functions
---------

.. autoapisummary::

   libstp.step.motion.stop.stop


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

.. py:class:: Stop(hard: bool = True)

   Bases: :py:obj:`libstp.step.Step`


   Step that stops all drive motors.


   .. py:attribute:: hard
      :value: True



.. py:function:: stop(hard: bool = True) -> Stop

   Stop all drive motors immediately.

   Use this between motion sequences or at the end of a mission
   to ensure the robot is stationary.

   :param hard: If ``True`` (default), immediately zero motor output.
                If ``False``, decelerate smoothly using the drive controller.

   :returns: A Stop step instance.

   Example::

       from libstp.step.motion import drive_forward, stop

       # Drive forward then stop
       seq([drive_forward(50), stop()])