pybricks.robotics.DriveBase: Document use of gyro.

This commit is contained in:
Laurens Valk
2023-04-07 20:54:32 +02:00
parent 6b3808f91d
commit dadaab6f61
2 changed files with 9 additions and 1 deletions
+1
View File
@@ -149,6 +149,7 @@ CONSTRUCTOR_PARAMS = [
"wheel_diameter: Number",
"axle_track: Number",
"positive_direction: Direction=Direction.CLOCKWISE",
"use_gyro: bool=False",
]
],
),
+8 -1
View File
@@ -59,8 +59,9 @@ class DriveBase:
wheel_diameter: Number,
axle_track: Number,
positive_direction: Direction = Direction.CLOCKWISE,
use_gyro: bool = False,
):
"""DriveBase(left_motor, right_motor, wheel_diameter, axle_track, positive_direction=Direction.CLOCKWISE)
"""DriveBase(left_motor, right_motor, wheel_diameter, axle_track, positive_direction=Direction.CLOCKWISE, use_gyro=False)
Arguments:
left_motor (Motor):
@@ -73,6 +74,12 @@ class DriveBase:
positive_direction (Direction): Which direction the drive base
should turn when you give a positive turn rate or turn
angle, viewed from the top.
use_gyro (bool): Choose ``True`` to use the internal gyrosope for
more accurate turns. This can only be used when
the ``positive_direction`` is set to counterclockwise. This is
only supported on hubs with an inertial measurement unit (IMU).
If you choose ``False`` (the default), turns are measured
using the wheel angles.
"""
def drive(self, speed: Number, turn_rate: Number) -> None: