mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 01:24:17 +00:00
Laurens Valk
1eb75e24e7
First step towards making a color type with HSV representation. Colors such as Color.RED or Color.BLUE continue to exist, but now you can also define your own colors: DARK_RED = Color(h=0, s=100, v=50)
115 lines
4.3 KiB
ReStructuredText
115 lines
4.3 KiB
ReStructuredText
:mod:`parameters <pybricks.parameters>` -- Parameters and Constants
|
|
===================================================================
|
|
|
|
.. automodule:: pybricks.parameters
|
|
:no-members:
|
|
|
|
.. autoclass:: pybricks.parameters.Port
|
|
:no-members:
|
|
|
|
.. content-tabs::
|
|
|
|
.. tab-container:: ev3brick
|
|
:title: EV3 Brick
|
|
|
|
Motor ports:
|
|
|
|
.. data:: A
|
|
.. data:: B
|
|
.. data:: C
|
|
.. data:: D
|
|
|
|
Sensor ports:
|
|
|
|
.. data:: S1
|
|
.. data:: S2
|
|
.. data:: S3
|
|
.. data:: S4
|
|
|
|
.. tab-container:: movehub
|
|
:title: Move Hub
|
|
|
|
Input/Output ports:
|
|
|
|
.. data:: A
|
|
.. data:: B
|
|
.. data:: C
|
|
.. data:: D
|
|
|
|
.. tab-container:: cityhub
|
|
:title: City Hub
|
|
|
|
Input/Output ports:
|
|
|
|
.. data:: A
|
|
.. data:: B
|
|
|
|
.. 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 following diagrams:
|
|
|
|
- Clockwise direction for :ref:`EV3/NXT motors <fig_ev3motors>`
|
|
- Clockwise direction for :ref:`Powered Up Motors <fig_pupmotors>`
|
|
- Clockwise direction for :ref:`Move Hub Motors <fig_movehub>`
|
|
|
|
.. 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.ev3devices.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
|
|
.. autoattribute:: ORANGE
|
|
.. autoattribute:: YELLOW
|
|
.. autoattribute:: GREEN
|
|
.. autoattribute:: CYAN
|
|
.. autoattribute:: BLUE
|
|
.. autoattribute:: VIOLET
|
|
.. autoattribute:: MAGENTA
|
|
|
|
.. rubric:: Unsaturated colors
|
|
|
|
.. autoattribute:: BLACK
|
|
.. autoattribute:: GRAY
|
|
.. autoattribute:: WHITE
|
|
|
|
.. autoclass:: pybricks.parameters.Button
|
|
:no-members:
|
|
|
|
.. .. autoclass:: pybricks.parameters.Axis
|
|
.. :no-members:
|
|
|
|
.. .. autoclass:: pybricks.parameters.Side
|
|
.. :no-members:
|