mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-15 11:04:55 +00:00
api/robotics: simplify API
drop methods that will not be implemented for next release and simplify descriptions of methods that will be implemented.
This commit is contained in:
+25
-19
@@ -8,35 +8,28 @@
|
||||
.. autoclass:: pybricks.robotics.DriveBase
|
||||
:no-members:
|
||||
|
||||
.. automethod:: pybricks.robotics.DriveBase.drive
|
||||
.. rubric:: Driving for a given distance or by an angle
|
||||
|
||||
.. .. autoclass:: pybricks.robotics.DriveBase
|
||||
:no-members:
|
||||
|
||||
.. rubric:: Automatic drive control
|
||||
Use these commands to drive a given distance, or turn by a given angle.
|
||||
|
||||
This is measured using the internal rotation sensors. Because wheels may
|
||||
slip while moving, the traveled distance and angle are only estimates.
|
||||
|
||||
.. automethod:: pybricks.robotics.DriveBase.straight
|
||||
|
||||
.. automethod:: pybricks.robotics.DriveBase.turn
|
||||
|
||||
.. rubric:: Manual drive control
|
||||
|
||||
The methods :meth:`.drive`, :meth:`.arc`, and :meth:`.tank` make your
|
||||
drive base move at a desired speed and and steering level. It keeps moving
|
||||
until you stop it. For example, you can keep moving until an obstacle is
|
||||
detected with a sensor.
|
||||
Then use :meth:`.stop` to make your drive base stop.
|
||||
.. rubric:: Drive forever
|
||||
|
||||
The only difference between :meth:`.drive`, :meth:`.arc`, and :meth:`.tank`
|
||||
is how you specify the desired speed and steering. You can choose the
|
||||
method which fits your application best.
|
||||
Use :meth:`.drive` to begin driving at a desired speed and steering.
|
||||
|
||||
It keeps going until you use :meth:`.stop` or change course by
|
||||
using :meth:`.drive` again. For example, you can drive until a
|
||||
sensor is triggered and then stop or turn around.
|
||||
|
||||
.. automethod:: pybricks.robotics.DriveBase.drive
|
||||
|
||||
.. automethod:: pybricks.robotics.DriveBase.arc
|
||||
|
||||
.. automethod:: pybricks.robotics.DriveBase.tank
|
||||
|
||||
.. automethod:: pybricks.robotics.DriveBase.stop
|
||||
|
||||
.. rubric:: Measuring
|
||||
@@ -49,4 +42,17 @@
|
||||
|
||||
.. rubric:: Settings
|
||||
|
||||
.. automethod:: pybricks.robotics.DriveBase.set_drive_settings
|
||||
.. automethod:: pybricks.robotics.DriveBase.settings
|
||||
|
||||
.. rubric:: Advanced Settings
|
||||
|
||||
The :meth:`.settings` method can be used to adjust the most commonly used
|
||||
settings. It interacts with both of the attributes below to set the
|
||||
desired speed and acceleration values. You can also adjust the control
|
||||
settings manually using these attributes.
|
||||
|
||||
.. autoattribute:: pybricks.robotics.DriveBase.distance_control
|
||||
:annotation:
|
||||
|
||||
.. autoattribute:: pybricks.robotics.DriveBase.heading_control
|
||||
:annotation:
|
||||
|
||||
Reference in New Issue
Block a user