pybricks-api/doc/api/parameters.rst

:mod:`parameters <pybricks.parameters>` -- Parameters and Constants
===================================================================

.. automodule:: pybricks.parameters
    :no-members:

.. autoclass:: pybricks.parameters.Port
    :no-members:

    Input/Output ports:

        .. data:: A
        .. data:: B
        .. data:: C
        .. data:: D
        .. data:: E
        .. data:: F

    EV3 Sensor ports:

        .. data:: S1
        .. data:: S2
        .. data:: S3
        .. data:: S4

.. autoclass:: pybricks.parameters.Direction
    :no-members:

    In general, clockwise is defined by **looking at the motor shaft, just
    like looking at a clock**. Some motors have two shafts. If in doubt,
    refer to the diagram in the ``Motor`` class documentation.

.. autoclass:: pybricks.parameters.Stop
    :no-members:

    The following table show how each stop type adds an extra level of
    resistance to motion. In these examples, ``m`` is a
    :class:`Motor <pybricks.pupdevices.Motor>` and
    and ``d`` is a :class:`DriveBase <pybricks.robotics.DriveBase>`. The
    examples also show how running at zero speed compares to these stop types.

    +--------+------------+--------+-------------+---------------+-----------------------------------------+
    | | Type | | Friction | | Back | | Speed     |  | Angle kept | | Examples                              |
    |        |            | | EMF  | | kept at 0 |  | at target  |                                         |
    +========+============+========+=============+===============+=========================================+
    | Coast  | +          |        |             |               | | ``m.stop()``                          |
    |        |            |        |             |               | | ``m.run_target(500, 90, Stop.COAST)`` |
    +--------+------------+--------+-------------+---------------+-----------------------------------------+
    | Brake  | +          | +      |             |               | | ``m.brake()``                         |
    |        |            |        |             |               | | ``m.run_target(500, 90, Stop.BRAKE)`` |
    +--------+------------+--------+-------------+---------------+-----------------------------------------+
    |        | +          | +      | +           |               | | ``m.run(0)``                          |
    |        |            |        |             |               | | ``d.drive(0, 0)``                     |
    +--------+------------+--------+-------------+---------------+-----------------------------------------+
    | Hold   | +          | +      | +           | +             | | ``m.hold()``                          |
    |        |            |        |             |               | | ``m.run_target(500, 90, Stop.HOLD)``  |
    |        |            |        |             |               | | ``d.straight(0)``                     |
    |        |            |        |             |               | | ``d.straight(100)``                   |
    +--------+------------+--------+-------------+---------------+-----------------------------------------+

.. autoclass:: pybricks.parameters.Color
    :no-members:

    .. rubric:: Saturated colors

    .. autoattribute:: RED

        .. pybricks-color:: RED

    .. autoattribute:: ORANGE

        .. pybricks-color:: ORANGE

    .. autoattribute:: YELLOW

        .. pybricks-color:: YELLOW

    .. autoattribute:: GREEN

        .. pybricks-color:: GREEN

    .. autoattribute:: CYAN

        .. pybricks-color:: CYAN

    .. autoattribute:: BLUE

        .. pybricks-color:: BLUE

    .. autoattribute:: VIOLET

        .. pybricks-color:: VIOLET

    .. autoattribute:: MAGENTA

        .. pybricks-color:: MAGENTA

    .. rubric:: Unsaturated colors

    .. autoattribute:: BLACK

        .. pybricks-color:: BLACK

    .. autoattribute:: GRAY

        .. pybricks-color:: GRAY

    .. autoattribute:: WHITE

        .. pybricks-color:: WHITE

.. autoclass:: pybricks.parameters.Button
    :no-members:

    .. autoattribute:: pybricks.parameters.Button.LEFT_DOWN
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.LEFT_MINUS
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.DOWN
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.RIGHT_DOWN
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.RIGHT_MINUS
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.LEFT
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.CENTER
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.RIGHT
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.LEFT_UP
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.LEFT_PLUS
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.UP
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.BEACON
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.RIGHT_UP
        :annotation:

    .. autoattribute:: pybricks.parameters.Button.RIGHT_PLUS
        :annotation:

.. autoclass:: pybricks.parameters.Side
    :no-members:

    Screens or light matrices have only four sides. For those,
    ``TOP`` is treated the same as ``FRONT``, and ``BOTTOM`` is treated the
    same as ``BACK``. The diagrams below define the sides for relevant devices.

    **Prime Hub**

    .. figure:: ../api/images/orientation_primehub_label.png
        :height: 15 em

    **Inventor Hub**

    .. figure:: ../api/images/orientation_inventorhub_label.png
        :height: 15 em

    **Move Hub**

    .. figure:: ../api/images/orientation_movehub_label.png
        :height: 15 em

    **Technic Hub**

    .. figure:: ../api/images/orientation_technichub_label.png
        :height: 15 em

    **Tilt Sensor**

    .. figure:: ../api/images/orientation_tiltsensor_label.png
        :height: 15 em