:py:mod:`phoenix6.mechanisms.mechanism_state`
=============================================

.. py:module:: phoenix6.mechanisms.mechanism_state

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


.. py:class:: MechanismState


   Bases: :py:obj:`enum.Enum`

   Possible states of a mechanism.

   .. py:attribute:: OK
      :value: '0'

      The mechanism is running normally.


   .. py:attribute:: DISABLED
      :value: '1'

      The mechanism is temporarily disabled due to an issue.


   .. py:attribute:: REQUIRES_USER_ACTION
      :value: '2'

      The mechanism is disabled and requires user action.