mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-11 17:14:41 +00:00
doc/motors: hide extra sections until ready
Avoid references to non-existing explanations.
This commit is contained in:
+17
-17
@@ -1,31 +1,31 @@
|
||||
More about Motors
|
||||
===========================================
|
||||
|
||||
Motor Tips & Tricks
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
.. Motor Tips & Tricks
|
||||
.. ^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. The difference between ``run_angle`` and ``run_target``
|
||||
.. -------------------------------------------------------
|
||||
|
||||
.. *TODO*
|
||||
|
||||
.. _absangles:
|
||||
.. .. _absangles:
|
||||
|
||||
Absolute angles
|
||||
----------------------------
|
||||
.. Absolute angles
|
||||
.. ----------------------------
|
||||
|
||||
.. todo::
|
||||
.. .. todo::
|
||||
|
||||
This section will be included in a future release.
|
||||
.. This section will be included in a future release.
|
||||
|
||||
.. _stalled:
|
||||
.. .. _stalled:
|
||||
|
||||
Using stall detection
|
||||
---------------------
|
||||
.. Using stall detection
|
||||
.. ---------------------
|
||||
|
||||
.. todo::
|
||||
.. .. todo::
|
||||
|
||||
This section will be included in a future release.
|
||||
.. This section will be included in a future release.
|
||||
|
||||
.. When a motor cannot move any further despite using the maximally allowed
|
||||
.. torque we say that the motor is stalled. Something could be blocking the
|
||||
@@ -49,14 +49,14 @@ Using stall detection
|
||||
|
||||
.. TODO
|
||||
|
||||
.. _gears:
|
||||
.. .. _gears:
|
||||
|
||||
Using gears
|
||||
-----------------
|
||||
.. Using gears
|
||||
.. -----------------
|
||||
|
||||
.. todo::
|
||||
.. .. todo::
|
||||
|
||||
This section will be included in a future release.
|
||||
.. This section will be included in a future release.
|
||||
|
||||
.. Many LEGO robots use mechanisms with gears to change the speed and torque
|
||||
.. output of a motor. Let's consider the following dial mechanism.
|
||||
|
||||
+2
-4
@@ -168,8 +168,7 @@ class Motor(DCMotor):
|
||||
|
||||
When you specify a gear train, all motor commands and settings
|
||||
are automatically adjusted to account for the resulting gear
|
||||
ratio. The motor direction remains unchanged by this. See
|
||||
:ref:`gears` for more information.
|
||||
ratio. The motor direction remains unchanged by this.
|
||||
"""
|
||||
pass
|
||||
|
||||
@@ -262,8 +261,7 @@ class Motor(DCMotor):
|
||||
pass
|
||||
|
||||
def run_until_stalled(self, speed, then=Stop.COAST, duty_limit=None):
|
||||
"""Runs the motor at a constant speed until it
|
||||
:ref:`stalls <stalled>`.
|
||||
"""Runs the motor at a constant speed until it stalls.
|
||||
|
||||
Arguments:
|
||||
speed (:ref:`speed`): Speed of the motor.
|
||||
|
||||
@@ -13,7 +13,7 @@ class Motor(_Motor):
|
||||
def reset_angle(self, angle=None):
|
||||
"""Sets the accumulated rotation angle of the motor to a desired value.
|
||||
|
||||
If you don't specify an angle, the :ref:`absolute angle <absangles>`
|
||||
If you don't specify an angle, the absolute angle
|
||||
will be used if your motor supports it.
|
||||
|
||||
Arguments:
|
||||
|
||||
Reference in New Issue
Block a user