Commit Graph
336 Commits
Author SHA1 Message Date
Laurens Valk 2bb1fe2cb7 doc/motors: move Control class to dedicated place.
This way the DriveBase can refer to it too.
2020-01-28 17:09:21 +01:00
Laurens Valk 36a393c927 api/builtins/Control: introduce Control class
This is a generic class to interact with PID Controllers. A Motor has one control instance (for angle) and a drivebase will have two (one for heading, one for distance).

This will replace the motor specific settings
2020-01-28 16:25:53 +01:00
Laurens Valk 4faa5d3df8 doc/hubs.EV3Brick: toggle note specs
This condenses long lists that are not frequently used.
2020-01-27 13:25:42 +01:00
Laurens Valk 167cf3ad18 doc/builtins/Speaker: use '' for string settings
Also simplify by not listing all the options twice, and follow style for default argument.
2020-01-27 13:12:57 +01:00
Laurens Valk aac25bb050 doc/media/ev3dev: fix ' in docstring
Also update todo note.
2020-01-27 13:07:51 +01:00
Laurens Valk 4bff13b5ca doc: drop separate sound page
The sound is not independently useable, and it is already documented for the speaker.
2020-01-27 13:03:41 +01:00
Laurens Valk 08e63e69ca api/builtins/DCMotor: drop settings
These settings are control properties, so they cannot be altered on DC Motors.
2020-01-27 12:56:47 +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
Laurens Valk f5094cfaba config: use inline math and common characters
Latex errors cannot be parsed by humans, so just use inline math which we had working elsewhere already.

Also use simplified character for ế, for latex compatibility.
2020-01-16 15:03:54 +01:00
Laurens Valk 686a3b8147 doc/media: update to say that these are ev3dev media 2020-01-16 14:31:14 +01:00
Laurens Valk 09a2e3eed9 doc/media/ev3dev: move files back to top
These are the most used. Also add separate heading for images/sounds so they can easily be found through menu.

Also lower currently mixed case rubric titles.

It would still be nice to make these lists shorter, perhaps using a dropdown or table.
2020-01-16 14:30:23 +01:00
Laurens Valk 022f15a437 config/spelling: ignore literals, data directives 2020-01-16 14:22:21 +01:00
Laurens Valk 00f5b9e13b doc/screen: simplify print doc
Only say what it does, not what it doesn't do.

Also delete "on the image" because this is also used for the screen.
2020-01-16 13:48:56 +01:00
Laurens Valk f7ff1e511e api/builtins/ColorLight: remove brightness
Brightness control will not be implemented for the next release, so remove it.
2020-01-16 13:34:18 +01:00
Laurens Valk 90314b3f49 api/ev3.speaker: Fix missing language arg
This was added to the docstring but not the method.
2020-01-16 13:31:04 +01:00
Laurens Valk b6f75eca9c config: ignore literals by regexp and config files
No need to have all of them in the ignore list now.
2020-01-16 13:28:09 +01:00
Laurens Valk 81626bb20d config: more spellchecking and ignoring 2020-01-16 12:02:50 +01:00
Laurens Valk f597ed1f88 config: ignore math during spell check 2020-01-16 11:57:19 +01:00
Laurens Valk 834a2173b4 doc/builtins: fix typos 2020-01-16 11:40:34 +01:00
Laurens Valk efb6d18ff8 doc/ev3.speaker: strings have quotes 2020-01-16 11:39:51 +01:00
Laurens Valk a026e3a12c config: ignore language identifiers 2020-01-16 11:39:08 +01:00
Laurens Valk fe255a9611 config: sort ignored words
No longer have two lists of technical words and regular words.

also add a few more words
2020-01-16 11:31:37 +01:00
Laurens Valk 50a9d36314 api/ev3.speaker: separate language and voice settings 2020-01-16 11:25:13 +01:00
Laurens Valk 3e16ec2ba5 config: use Spell Right for spell checking
Also add initial list of words to ignore
2020-01-16 11:16:39 +01:00
Laurens Valk 8904413084 doc/speaker: Put language under show/hide toggle
This list is rather long, so hide it by default.
2020-01-16 10:34:56 +01:00
Laurens Valk 7a16c637aa doc/speaker: fix typo 2020-01-16 10:27:31 +01:00
David Lechner dc82ccce40 resources renamed to media.ev3dev 2020-01-14 17:32:40 -06:00
Laurens Valk a6e6de28b5 api/nxtdevices: update sound audible argument
rename to audible_only for a more precise description.
2020-01-14 21:27:01 +01:00
Laurens Valk 4546f2b548 doc/signaltype: group units by type
There are now quite a few units, so organize them by physical category.
2020-01-14 21:12:00 +01:00
Laurens Valk c1255e6b95 doc/signaltypes: add temperature conversions 2020-01-14 20:58:55 +01:00
Laurens Valk 6a3bb5d320 doc/signaltypes: add acceleration
This was added but there was no description yet.
2020-01-14 20:51:43 +01:00
Laurens Valk 5a0dc278d0 api/nxtdevices: add Energy Meter 2020-01-14 20:17:43 +01:00
Laurens Valk b1cb062c7c api/nxtdevices: add Temperature Sensor 2020-01-14 20:16:40 +01:00
Laurens Valk aed3823af1 api/nxtdevices: add Sound Sensor 2020-01-14 20:16:10 +01:00
Laurens Valk 7b7b69a141 api/nxtdevices: add Ultrasonic Sensor 2020-01-14 20:15:29 +01:00
Laurens Valk 23b8700773 api/nxtdevices: add Color Sensor 2020-01-14 20:14:56 +01:00
Laurens Valk 7f3ac46558 api/nxtdevices: add Light Sensor 2020-01-14 20:13:23 +01:00
Laurens Valk 19e4d3d36f api/nxtdevices: add Touch Sensor 2020-01-14 20:12:27 +01:00
Laurens Valk ad12d13355 api/nxtdevices: add module 2020-01-14 20:10:33 +01:00
Laurens Valk 57e262e3f9 doc/signaltypes: add Temperature 2020-01-14 19:54:13 +01:00
Laurens Valk 46de4b73ca doc/ev3devices: drop millimeters note
This is already shown as the return type, so this is a duplicate.
2020-01-14 19:38:59 +01:00
Laurens Valk a64069abbc doc/signaltypes: add decibel 2020-01-14 19:36:08 +01:00
Laurens Valk fc8bae1cb9 doc/signaltypes: add energy and power 2020-01-14 19:31:19 +01:00
Laurens Valk fe39782b5a config: rename _instances
Now that the instance hack has been dropped, all that remains is the simplified motor docs, so rename file accordingly.
2020-01-14 17:58:10 +01:00
Laurens Valk 6875e6ff42 config: drop _instances for methods
This is no longer needed with the double colon reference to link to class instances.
2020-01-14 17:47:47 +01:00
Laurens Valk 02d64775af doc/*/button: update to double colon reference
This lets us drop the instances hack
2020-01-14 17:37:07 +01:00
Laurens Valk b578693422 doc/*/light: update to double colon reference
This lets us drop the instances hack
2020-01-14 17:34:04 +01:00
Laurens Valk 6371ebb870 doc/battery: update to double colon reference
This lets us drop the instances hack
2020-01-14 17:15:41 +01:00