diff --git a/README.rst b/README.rst index a0c83a5..8cae63a 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,9 @@ Python language bindings for ev3dev .. image:: https://travis-ci.org/rhempel/ev3dev-lang-python.svg?branch=master :target: https://travis-ci.org/rhempel/ev3dev-lang-python +.. image:: https://readthedocs.org/projects/python-ev3dev/badge/?version=latest + :target: http://python-ev3dev.readthedocs.org/en/latest/?badge=latest + :alt: Documentation Statu This is a python library implementing unified interface for ev3dev_ devices. diff --git a/ev3dev.py b/ev3dev.py index 179149a..92bef19 100644 --- a/ev3dev.py +++ b/ev3dev.py @@ -246,21 +246,22 @@ def commands(self): Returns a list of commands that are supported by the motor controller. Possible values are `run-forever`, `run-to-abs-pos`, `run-to-rel-pos`, `run-timed`, `run-direct`, `stop` and `reset`. Not all commands may be supported. - `run-forever` will cause the motor to run until another command is sent. - `run-to-abs-pos` will run to an absolute position specified by `position_sp` - and then stop using the command specified in `stop_command`. - `run-to-rel-pos` will run to a position relative to the current `position` value. - The new position will be current `position` + `position_sp`. When the new - position is reached, the motor will stop using the command specified by `stop_command`. - `run-timed` will run the motor for the amount of time specified in `time_sp` - and then stop the motor using the command specified by `stop_command`. - `run-direct` will run the motor at the duty cycle specified by `duty_cycle_sp`. - Unlike other run commands, changing `duty_cycle_sp` while running *will* - take effect immediately. - `stop` will stop any of the run commands before they are complete using the - command specified by `stop_command`. - `reset` will reset all of the motor parameter attributes to their default value. - This will also have the effect of stopping the motor. + + - `run-forever` will cause the motor to run until another command is sent. + - `run-to-abs-pos` will run to an absolute position specified by `position_sp` + and then stop using the command specified in `stop_command`. + - `run-to-rel-pos` will run to a position relative to the current `position` value. + The new position will be current `position` + `position_sp`. When the new + position is reached, the motor will stop using the command specified by `stop_command`. + - `run-timed` will run the motor for the amount of time specified in `time_sp` + and then stop the motor using the command specified by `stop_command`. + - `run-direct` will run the motor at the duty cycle specified by `duty_cycle_sp`. + Unlike other run commands, changing `duty_cycle_sp` while running *will* + take effect immediately. + - `stop` will stop any of the run commands before they are complete using the + command specified by `stop_command`. + - `reset` will reset all of the motor parameter attributes to their default value. + This will also have the effect of stopping the motor. """ return self.get_attr_set( 'commands' )