pybricks.common.Motor: Document when settings take effect.

This updates how and when settings take effect. In this release, you can
change them even while the motor is moving. Some settings do not
take effect right away, as now indicated in the relevant methods.

See also https://github.com/pybricks/pybricks-api/issues/105
This commit is contained in:
Laurens Valk
2022-12-02 12:10:31 +01:00
parent 115ae0d856
commit 631cf31a07
2 changed files with 3 additions and 4 deletions
-4
View File
@@ -64,10 +64,6 @@ Motors with rotation sensors
.. rubric:: Control settings
You can only change these settings while the controller is stopped. For
example, you can change them at the start of your program. Alternatively,
first call :meth:`stop() <pybricks.pupdevices.Motor.stop>`, and then change the settings.
.. automethod:: pybricks.pupdevices.Motor.control.limits
.. automethod:: pybricks.pupdevices.Motor.control.pid
+3
View File
@@ -199,6 +199,9 @@ class Control:
If no arguments are given, this will return the current values.
The new ``acceleration`` and ``speed`` limit will become effective
when you give a new motor command. Ongoing maneuvers are not affected.
Arguments:
speed (Number, deg/s or Number, mm/s):
Maximum speed. All speed commands will be capped to this value.