Commit Graph
38 Commits
Author SHA1 Message Date
Laurens Valk ada319f88d doc/pupdevices: drop gears example
This is reserved for the detailed Motor page.
2019-11-11 13:30:08 +01:00
Laurens Valk 4f25a0c467 doc/ev3devices: On EV3 docs, drop DC methods.
These can still be viewed on the full Motor class description. But on EV3, these functions are not so relevant as all motors have encoders.

Then we can also remove the encoded/encoderless rubric, further removing clutter.
2019-11-11 13:25:41 +01:00
Laurens Valk f12c579159 doc: move Motor to dedicated page.
Instead, show shorter, simpler Motor docs platform-devices pages. For the moment, this just means deleting the advanced methods section from those pages, but we may choose to simplify further.

This change makes it easier to navigate the ev3devices/pupdevices pages because the motor sections aren't overly long.

Details will still be available on the Motor pages for those who wish to use the more advanced motor capabilities such as adjusting the PID settings.
2019-11-11 13:22:08 +01:00
Laurens Valk f73e10b99b api: add EV3 Analog Sensor 2019-11-04 16:58:30 +01:00
Laurens Valk 15f5626948 doc: document new media submodule 2019-11-04 16:58:22 +01:00
Laurens Valk ea1d19b66d doc: resolve css conflict 2019-10-19 21:52:51 +02:00
Laurens Valk 5c832498b6 doc: motors match module 2019-10-19 21:38:33 +02:00
Laurens Valk 2307a20cf0 doc: simplify module toc 2019-10-19 21:18:59 +02:00
Laurens Valk a9f3b2a556 doc: clean up City Hub and Move Hub 2019-10-19 20:25:47 +02:00
Laurens Valk 2ec5b0aab9 doc: organize motors 2019-10-18 18:32:09 +02:00
Laurens Valk 372e5ccbd0 doc: single api target
Also delete getting started instructions
2019-10-18 18:11:57 +02:00
Laurens Valk e23d9661cc doc: rename hub rst file
Each hub will have its own RST file.
2019-10-18 17:31:52 +02:00
Laurens Valk aa8c95234e doc: flake8 and doc8 2019-10-18 17:12:16 +02:00
Laurens Valk f5762447b4 doc: take sphinx workarounds out of api 2019-10-18 15:11:20 +02:00
Laurens Valk 5812333119 api: EV3Brick as class instead of module 2019-10-18 14:47:48 +02:00
Laurens Valk a728edb8ad doc: style tweaks 2019-10-18 14:43:43 +02:00
Laurens Valk b5c9e3feb7 api: add simpler method for tilt
Provides a way of basic orientation checking independently of reference frame settings.
2019-07-04 11:55:01 +02:00
Laurens Valk 240d21bcca api: split frame configuration into method
Because the __init__ for built-in IMUs won't be called
by the user.
2019-07-02 12:59:21 +02:00
Laurens Valk c722490b81 api: specify axes during setup 2019-07-02 12:13:05 +02:00
Laurens Valk e453cecb2e api: accelerometer drafts 2019-07-02 11:57:00 +02:00
Laurens Valk 0b67db897e api: generalize buttons
This makes the user code easier to read:

brick.buttons()

brick.buttons.pressed()

It also opens up possibility to add features in the future such as:
brick.buttons.released()  # return which buttons are not pressed
brick.buttons.clicked()  # return which buttons were clicked since we last checked

This follows the same style as the new light API: some devices have specific instances of a KeyPad class.

A good example that nicely demonstrates the concept is the LPF2 RemoteControl, which has instances of a ColorLight and a KeyPad. It's added in this commit.
2019-06-11 21:30:46 +02:00
Laurens Valk f6eb7674a9 conf: drop references to future work 2019-06-11 20:05:40 +02:00
Laurens Valk b92eb447b4 doc: add extra units 2019-06-08 11:57:12 +02:00
Laurens Valk bf16da463a api: update common light classes 2019-06-07 13:50:32 +02:00
Laurens Valk 8bc96822b2 api: add lights instance 2019-06-06 11:03:11 +02:00
Laurens Valk 6fb78141c5 doc: make ports specific to technology type 2019-06-06 10:51:48 +02:00
Laurens Valk 0013a74d72 drop class method identifier from docs
Same result as in 92e3735d63, but now achieved by patching the Sphinx configuration instead of patching the API.

Now it doesn't break the API for the purpose of checking and autocomplete, etc.
2019-06-05 13:57:04 +02:00
Laurens Valk 28a5329bb6 api/doc: pybricks is a package 2019-06-05 12:47:24 +02:00
Laurens Valk 727507d66d API: add light instance to ColorDistanceSensor
This is an experimental method for adding lights to some sensors.

And add workaround to make it show up correctly in the docs.

Also some doc8 formatting
2019-06-05 11:49:46 +02:00
Laurens Valk 8d37450fac api: flake8 2019-06-04 15:45:36 +02:00
Laurens Valk 0d3b682223 doc: doc8 2019-06-04 14:47:52 +02:00
Laurens Valk c54241f076 rename hub4 to cityhub 2019-06-03 15:26:50 +02:00
Laurens Valk f3c29971de api: lights on hubs are instances of generic class 2019-06-03 15:18:26 +02:00
Laurens Valk c43d296511 doc: move snippets to doc
Example snippets are platform specific.
2019-06-03 12:02:16 +02:00
David Lechner 668b7a43a9 doc: fix include path for api
fix breakage causes by 3091489843
2019-05-09 11:38:42 -05:00
Laurens Valk 1371d7fb82 move LICENSE
This applies to the docs and the api
2019-05-09 14:59:25 +02:00
Laurens Valk 3a42c8f870 Update config paths
This makes the docs build again:
cd doc
make SOURCEDIR=ev3dev html
make SOURCEDIR=lpf2 html
2019-05-09 14:40:05 +02:00
Laurens Valk c950bf1d8e import api documentation 2019-05-09 13:23:26 +02:00