Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity

parameters: make Stop enum members uppercase

Browse Source
This commit is contained in:
David Lechner
2019-02-27 15:23:14 -06:00
parent be32bd8eb3
commit 2e3d013fec
3 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pybricks/ev3devices.py
+15 -15
View File
@@ -101,13 +101,13 @@ class Motor():
"""
pass
def stop(self, stop_type=Stop.coast):
"""stop(stop_type=Stop.coast)
def stop(self, stop_type=Stop.COAST):
"""stop(stop_type=Stop.COAST)
Stop the motor.
Arguments:
stop_type (Stop): Whether to coast, brake, or hold (*Default*: :class:`Stop.coast <parameters.Stop>`).
stop_type (Stop): Whether to coast, brake, or hold (*Default*: :class:`Stop.COAST <parameters.Stop>`).
"""
pass
@@ -121,8 +121,8 @@ class Motor():
"""
pass
def run_time(self, speed, time, stop_type=Stop.coast, wait=True):
"""run_time(speed, time, stop_type=Stop.coast, wait=True)
def run_time(self, speed, time, stop_type=Stop.COAST, wait=True):
"""run_time(speed, time, stop_type=Stop.COAST, wait=True)
Run the motor at a constant speed (angular velocity) for a given amount of time.
@@ -131,13 +131,13 @@ class Motor():
Arguments:
speed (:ref:`speed`): Speed of the motor.
time (:ref:`time`): Duration of the maneuver.
stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.coast <parameters.Stop>`).
stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.COAST <parameters.Stop>`).
wait (bool): Wait for the maneuver to complete before continuing with the rest of the program (*Default*: ``True``). This means that your program waits for the specified ``time``.
"""
pass
def run_angle(self, speed, rotation_angle, stop_type=Stop.coast, wait=True):
"""run_angle(speed, rotation_angle, stop_type=Stop.coast, wait=True)
def run_angle(self, speed, rotation_angle, stop_type=Stop.COAST, wait=True):
"""run_angle(speed, rotation_angle, stop_type=Stop.COAST, wait=True)
Run the motor at a constant speed (angular velocity) by a given angle.
@@ -146,13 +146,13 @@ class Motor():
Arguments:
speed (:ref:`speed`): Speed of the motor.
rotation_angle (:ref:`angle`): Angle by which the motor should rotate.
stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.coast <parameters.Stop>`).
stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.COAST <parameters.Stop>`).
wait (bool): Wait for the maneuver to complete before continuing with the rest of the program (*Default*: ``True``). This means that your program waits until the motor has traveled precisely the requested angle.
"""
pass
def run_target(self, speed, target_angle, stop_type=Stop.coast, wait=True):
"""run_target(speed, target_angle, stop_type=Stop.coast, wait=True)
def run_target(self, speed, target_angle, stop_type=Stop.COAST, wait=True):
"""run_target(speed, target_angle, stop_type=Stop.COAST, wait=True)
Run the motor at a constant speed (angular velocity) towards a given target angle.
@@ -163,13 +163,13 @@ class Motor():
Arguments:
speed (:ref:`speed`): Absolute speed of the motor. The direction will be automatically selected based on the target angle: it makes no difference if you specify a positive or negative speed.
target_angle (:ref:`angle`): Target angle that the motor should rotate to, regardless of its current angle.
stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.coast <parameters.Stop>`).
stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.COAST <parameters.Stop>`).
wait (bool): Wait for the maneuver to complete before continuing with the rest of the program (*Default*: ``True``). This means that your program waits until the motor has reached the target angle.
"""
pass
def run_until_stalled(self, speed, stop_type=Stop.coast, duty_limit=None):
"""run_until_stalled(speed, stop_type=Stop.coast, duty_limit=default)
def run_until_stalled(self, speed, stop_type=Stop.COAST, duty_limit=None):
"""run_until_stalled(speed, stop_type=Stop.COAST, duty_limit=default)
Run the motor at a constant speed (angular velocity) until it stalls. The motor is considered stalled when it cannot move even with the maximum torque. See :meth:`.stalled` for a more precise definition.
@@ -177,7 +177,7 @@ class Motor():
Arguments:
speed (:ref:`speed`): Speed of the motor.
stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.coast <parameters.Stop>`).
stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.COAST <parameters.Stop>`).
duty_limit (:ref:`percentage`): Relative torque limit. This limit works just like :meth:`.set_dc_settings`, but in this case the limit is temporary: it returns to its previous value after completing this command.
"""
pass
pybricks/parameters.py
+9 -9
View File
@@ -62,15 +62,15 @@ class Port(Enum):
class Stop(Enum):
"""Action after the motor stops: coast, brake, or hold.
.. data:: coast
.. data:: COAST
Let the motor move freely.
.. data:: brake
.. data:: BRAKE
Passively resist small external forces.
.. data:: hold
.. data:: HOLD
Keep controlling the motor to hold it at the commanded angle. This is only available on motors with encoders.
@@ -79,18 +79,18 @@ class Stop(Enum):
+-----------+-------------+------------------------------------------+
|Parameter | Resistance | Physical meaning |
+===========+=============+==========================================+
|Stop.coast | low | Friction |
|Stop.COAST | low | Friction |
+-----------+-------------+------------------------------------------+
|Stop.brake | medium | Friction + Torque opposite to motion |
|Stop.BRAKE | medium | Friction + Torque opposite to motion |
+-----------+-------------+------------------------------------------+
|Stop.hold | high | Friction + Torque to hold commanded angle|
|Stop.HOLD | high | Friction + Torque to hold commanded angle|
+-----------+-------------+------------------------------------------+
"""
coast = 0
brake = 1
hold = 2
COAST = 0
BRAKE = 1
HOLD = 2
class Direction():
pybricks/robotics.py
+3 -3
View File
@@ -66,12 +66,12 @@ class DriveBase():
"""
pass
def stop(self, stop_type=Stop.coast):
"""stop(stop_type=Stop.coast)
def stop(self, stop_type=Stop.COAST):
"""stop(stop_type=Stop.COAST)
Stop the robot.
Arguments:
stop_type (Stop): Whether to coast, brake, or hold (*Default*: :class:`Stop.coast <parameters.Stop>`).
stop_type (Stop): Whether to coast, brake, or hold (*Default*: :class:`Stop.COAST <parameters.Stop>`).
"""
pass