1367 Commits
Author SHA1 Message Date
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 529f8fe31c api: rename _common to builtins
Because this module describes devices that can be built into a hub or other device.

Since this design is now explicitly shown in
the docs as well, we don't need to hide this
module in the package.
2019-10-18 16:05:23 +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 be1d30c4c8 api/ev3devices: add InfraredSensor.keypad 2019-07-22 11:44:56 +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 d198c45845 api: add heading for devices with a gyro 2019-07-02 14:07:36 +02:00
Laurens Valk aa10118cfe api: add gestures 2019-07-02 13:49:52 +02:00
Laurens Valk e722451af1 api: add Axis.ALL identifier 2019-07-02 13:08:20 +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 d48bbc3b80 api: tilt 2019-07-02 12:28:11 +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 20b4307d05 api: standardize on method for light groups
Turn on all the lights at the specified brightness.
2019-06-25 14:55:38 +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 12834ffc73 api: fix relative links due to package 2019-06-11 20:13:38 +02:00
Laurens Valk f6eb7674a9 conf: drop references to future work 2019-06-11 20:05:40 +02:00
Laurens Valk a0a77896d7 api: add text and number display to grid
Also, use row + column for setting pixels instead of x, y. Then it is the same indexing as matrices.
2019-06-11 16:38:17 +02:00
Laurens Valk 8db8ace277 api: reset angle when marker present 2019-06-09 14:38:18 +02:00
Laurens Valk 1970ef273d api: percentage as brightness 2019-06-08 12:12:49 +02:00
Laurens Valk b92eb447b4 doc: add extra units 2019-06-08 11:57:12 +02:00
Laurens Valk bc6fce6406 api: add light initializers 2019-06-07 16:29:38 +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 8d4f6294d7 api: add LightArray 2019-06-05 16:03:05 +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 92e3735d63 drop class method identifier from docs
For example, this changes

classmethod sound.beeps(number)
   Description

into

sound.beeps(number)
   Description
2019-06-03 15:22:57 +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 1bf2751daf travis: add new travis CI config 2019-05-09 12:21:17 -05:00
David Lechner 125732238c setup: add options for linters 2019-05-09 12:21:17 -05:00
David Lechner 9ad550dfcb vscode: add settings are extension recommendations
this will help users get a dev environment setup more easliy
2019-05-09 12:21:17 -05:00
David Lechner 4eecb284a8 Pipenv: use pipen for depedencies
This will help ensure that everyone is working from the same version of sphinx, etc.
2019-05-09 12:21:17 -05:00
David Lechner c0b266cd73 git: update .gitattributes for managing line endings
this is so that Windows users don't have problems with line endings when they check out the repo
2019-05-09 11:43:27 -05: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 3091489843 move API 2019-05-09 17:15:52 +02: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 c916485666 Add .gitignore 2019-05-09 14:39:28 +02:00
Laurens Valk b8458cd086 add example submodule 2019-05-09 14:27:04 +02:00