pybricks.robotics.DriveBase: Add clarifying comments.

Fixes https://github.com/pybricks/support/issues/698
This commit is contained in:
Laurens Valk
2022-12-06 16:38:31 +01:00
parent 6640fba104
commit 4da4ce8f7c
2 changed files with 16 additions and 1 deletions
+9 -1
View File
@@ -28,8 +28,12 @@ class DriveBase:
**Positive** angles and turn rates mean turning **right**.
**Negative** means **left**. So when viewed from the top,
positive means clockwise and negative means counterclockwise.
positive means clockwise and negative means counterclockwise. If desired,
you can flip this convention by reversing the ``left_motor`` and
``right_motor`` when you initialize this class.
See the `measuring`_ section for tips to measure and adjust the diameter
and axle track values.
"""
distance_control = _common.Control()
@@ -139,6 +143,10 @@ class DriveBase:
If you give no arguments, this returns the current values as a tuple.
The default values are automatically configured based on your wheel
diameter and axle track. They are selected such that your robot
drives at about 40% of its maximum speed.
Arguments:
straight_speed (Number, mm/s): Straight-line speed of the robot.
straight_acceleration (Number, mm/s²): Straight-line