Commit Graph
103 Commits
Author SHA1 Message Date
David Lechner d9089bcbae api/media/ev3dev: update for Image API changes 2020-02-11 11:43:54 -06:00
Laurens Valk 0841899394 api/builtins/Control: expose done method
This was added but not yet exposed
2020-02-10 15:57:23 +01:00
Laurens Valk 37de307ef0 doc/motors: add note about controller inactivity 2020-02-09 23:47:35 +01:00
Laurens Valk f5c3347ba1 doc/signaltypes: fix label
This was left behind when grouping labels earlier
2020-02-07 20:13:35 +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 6337b6c451 api/iodevices: Separate Ev3devSensor class
This is not just an alias for a LUMPDevice because it works differently. On ev3dev, sensor modes are set using strings.

Also, simplify the introductory text and reasons for using it.
2020-02-03 13:54:18 +01:00
Laurens Valk 2bd149a121 doc/iodevices: reorganize TOC
Make the heading levels match the module. No subcategories, but say which devices are available on EV3 only.
2020-02-03 11:35:43 +01:00
Laurens Valk ab6b15f047 doc/media: toggle items by category
Make it easier to browse the options.
2020-01-29 14:47:03 +01:00
Laurens Valk e97423da72 doc/motors: hide status getters
These are not yet implemented
2020-01-29 13:38:32 +01:00
Laurens Valk 741af5280a config: ignore only generated images
Make sure we can add other images without doing special things.
2020-01-29 12:57:03 +01:00
Laurens Valk d923f79506 doc/motor: reduce width of commented text 2020-01-28 20:30:42 +01:00
Laurens Valk 6525fbc98a doc/frames: hide page
This won't be needed until support for accelerometers is added.
2020-01-28 20:28:29 +01:00
Laurens Valk f3003720ee doc/parameters: hide unused parameters
There is no functionality in the release that uses this yet.
2020-01-28 20:23:55 +01:00
Laurens Valk 5363ff5015 doc/motors: hide unfinished sections
make it easier to see what is ready for review
2020-01-28 20:23:01 +01:00
Laurens Valk 71ae6825a0 doc/pupdevices: hide non-implemented device/method 2020-01-28 20:12:19 +01:00
Laurens Valk 4ed787240e api/builtins: drop motor setting setters
this will be done through the control attribute instead
2020-01-28 17:53:11 +01:00
Laurens Valk 6278aeb1b6 doc/builtins: drop simplemotor
Now that we have reduced the complexity of the docstrings and after moving the control settings to a separate page, it is no longer necessary to have simplified motor docs.
2020-01-28 17:51:23 +01:00
Laurens Valk 1ba961b29c doc/builtins: simplify motor docs
Reduce unnecessary details for motor methods
2020-01-28 17:41:36 +01:00
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 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 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 50a9d36314 api/ev3.speaker: separate language and voice settings 2020-01-16 11:25:13 +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
David Lechner dc82ccce40 resources renamed to media.ev3dev 2020-01-14 17:32:40 -06: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