Commit Graph
17 Commits
Author SHA1 Message Date
Laurens Valk 81fa637f0b doc/robotics: add note for using individual motors 2020-05-01 15:08:21 +02:00
Laurens Valk a74afd9ed4 doc/robotics: move advanced settings to bottom 2020-05-01 15:07:57 +02:00
Laurens Valk 4ca568079e doc/robotics: clarify wheel_diameter, axle_track
Add tips for practical experiments to validate the dimensions
2020-04-28 17:09:43 +02:00
Laurens Valk dfbda2dd69 doc/robotics: update heading
Make it consistent with the other pages
2020-04-01 13:49:09 +02:00
Laurens Valk aa343d017f doc/robotics: add note for when to change settings 2020-03-17 15:47:54 +01:00
Laurens Valk a0fba6c2d1 api/builtins/Control: Move stalled to control
This is a control status property, so move it to the control class. This way, it is hidden from the common motor methods, and DriveBases will be able to use it too.
2020-02-17 13:55:45 +01:00
Laurens Valk 9db7e95959 api/robotics: DriveBase: rename settings args
Make it explicit that these arguments affect only the settings for the corresponding methods.

Also rephrase a few docstrings to make them easier to read or fix typos.
2020-02-17 13:43:48 +01:00
Laurens Valk f1f1ceaac9 api/robotics/DriveBase: add state getter 2020-02-06 14:05:14 +01:00
Laurens Valk 7423161615 api/robotics: simplify API
drop methods that will not be implemented for next release and simplify descriptions of methods that will be implemented.
2020-02-05 16:55:03 +01:00
Laurens Valk a029757b4a doc/robotics: hide non-implemented methods 2020-01-27 12:51:48 +01:00
Laurens Valk 1c801f1520 api/robotics: add tank method
Also, group similar methods together and explain what they do.
2020-01-27 11:20:07 +01:00
Laurens Valk dd39a2e00f api/robotics: update DriveBase API
Make arc a non-blocking function similar to drive. This allows users to drive the robot along an arc until a sensor (e.g. color) is triggered, instead of relying on the rotation sensors only.

This also lets us simplify the language of some other method docstrings.
2020-01-23 17:58:24 +01:00
David Lechner 31a639f55b doc/api/conf.py: enable nitpicky
This enables the sphinx doc nitpicky option to detect broken references.

Also fix all of the broken references.
2020-01-11 21:08:20 -06:00
Laurens Valk 09d453480b api/robotics: add DriveBase state getters 2020-01-02 16:51:50 +01:00
Laurens Valk 3d9a6f11cc api/robotics: add DriveBase draft
This is a concept for a DriveBase class for common robot tasks.
2020-01-02 16:36:37 +01:00
Laurens Valk 8acab1898a doc: delete existing inline examples
Those should be included as working and tested Python files instead. They should be toggled on/off.
2019-12-09 14:31:53 +01:00
Laurens Valk 372e5ccbd0 doc: single api target
Also delete getting started instructions
2019-10-18 18:11:57 +02:00