Skip to content

Commit 8828d32

Browse files
committed
Bullet list in Motor.commands
1 parent 2efcd6f commit 8828d32

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

ev3dev.py

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -246,21 +246,22 @@ def commands(self):
246246
Returns a list of commands that are supported by the motor
247247
controller. Possible values are `run-forever`, `run-to-abs-pos`, `run-to-rel-pos`,
248248
`run-timed`, `run-direct`, `stop` and `reset`. Not all commands may be supported.
249-
`run-forever` will cause the motor to run until another command is sent.
250-
`run-to-abs-pos` will run to an absolute position specified by `position_sp`
251-
and then stop using the command specified in `stop_command`.
252-
`run-to-rel-pos` will run to a position relative to the current `position` value.
253-
The new position will be current `position` + `position_sp`. When the new
254-
position is reached, the motor will stop using the command specified by `stop_command`.
255-
`run-timed` will run the motor for the amount of time specified in `time_sp`
256-
and then stop the motor using the command specified by `stop_command`.
257-
`run-direct` will run the motor at the duty cycle specified by `duty_cycle_sp`.
258-
Unlike other run commands, changing `duty_cycle_sp` while running *will*
259-
take effect immediately.
260-
`stop` will stop any of the run commands before they are complete using the
261-
command specified by `stop_command`.
262-
`reset` will reset all of the motor parameter attributes to their default value.
263-
This will also have the effect of stopping the motor.
249+
250+
- `run-forever` will cause the motor to run until another command is sent.
251+
- `run-to-abs-pos` will run to an absolute position specified by `position_sp`
252+
and then stop using the command specified in `stop_command`.
253+
- `run-to-rel-pos` will run to a position relative to the current `position` value.
254+
The new position will be current `position` + `position_sp`. When the new
255+
position is reached, the motor will stop using the command specified by `stop_command`.
256+
- `run-timed` will run the motor for the amount of time specified in `time_sp`
257+
and then stop the motor using the command specified by `stop_command`.
258+
- `run-direct` will run the motor at the duty cycle specified by `duty_cycle_sp`.
259+
Unlike other run commands, changing `duty_cycle_sp` while running *will*
260+
take effect immediately.
261+
- `stop` will stop any of the run commands before they are complete using the
262+
command specified by `stop_command`.
263+
- `reset` will reset all of the motor parameter attributes to their default value.
264+
This will also have the effect of stopping the motor.
264265
"""
265266
return self.get_attr_set( 'commands' )
266267

0 commit comments

Comments
 (0)