Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 09:37:25 +00:00
Code Issues Releases Activity
245 Commits 10 Branches 125 Tags
709659ffbfdb1b200a955158dd3ddf69c9fb7062
Commit Graph
245 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Laurens Valk 709659ffbf doc/hubs: remove builtins section 
This will not be used in the next release.
 2019-12-09 10:43:28 +01:00
Laurens Valk be667caa7b doc/signaltypes: move scalars and vectors 
This makes it possible to exclude this information from releases that do not use it.
 2019-12-09 10:31:22 +01:00
Laurens Valk e7c63533b0 doc/parameters: remove unused parameters 
Ports are accessed through hub instance.

The Axis and Side parameters will not be implemented for the next release, so we remove them for now.
 2019-12-09 10:21:36 +01:00
Laurens Valk 184763e81a Revert "add option to enable/disable encoders" 
Encoderless motors are more an exception than the rule, so they will get a separate class.

This reverts commit 6f68c60d3b.
 2019-12-06 15:19:18 +01:00
Laurens Valk 22bbca3e24 doc/customdevices: simplify I2C docs 
remove smbus information, point to source code instead.
 2019-12-06 15:16:06 +01:00
Laurens Valk 1187f059fa api/customdevices: add UARTDevice 2019-12-06 14:57:43 +01:00
Laurens Valk 3143b28be1 doc/customdevices: remove custom init string 
We only need this if the string is different from the auto-generated default, such as when we want to prevent expansion of an enum to a number.
 2019-12-06 14:35:16 +01:00
Laurens Valk 4086ee67ac api/customdevices: use bytes for I2C 
This is a more natural data type than tuples or ints for this class.
 2019-12-06 14:31:53 +01:00
Laurens Valk e6a1ae78ca doc+api/customdevices: add I2CDevice 2019-11-14 12:56:53 +01:00
Laurens Valk 653aa669b2 doc+api/customdevices: move AnalogSensor 
Generic and custom devices like the AnalogSensor will live in a dedicated module.
 2019-11-14 08:47:30 +01:00
Laurens Valk 6f68c60d3b api/builtins/Motor: add option to enable/disable encoders 2019-11-11 15:51:25 +01:00
Laurens Valk 63992c7ad0 doc/ev3devices/AnalogSensor: add passive/active methods 2019-11-11 15:29:39 +01:00
Laurens Valk 1be5beb54e doc/ev3devices/AnalogSensor: update type check 
We no longer have to tell people to reboot the brick after changing the port mode. This is all done automatically now.
 2019-11-11 15:22:41 +01:00
Laurens Valk f03970a77e doc/motors: rename direction to positive_direction 
While being longer, this reflects more accurately what this setting does.
 2019-11-11 15:19:25 +01:00
Laurens Valk 69216abc8a api/pupdevices: fix line break 
This caused the init arguments to be displayed incorrectly.

Also, fix whitespaces and line ends.
 2019-11-11 15:13:13 +01:00
Laurens Valk d172780508 doc/motors: add stalled section 
By moving some of the technical details to dedicated sections of the docs, we can add more (or simplified, less technical) information without cluttering the API commands.
 2019-11-11 15:08:08 +01:00
Laurens Valk d6f25acce8 doc/motors: add gears section 
Explain the setting using an example.
 2019-11-11 14:50:30 +01:00
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 8f4468880b api: move sounds, images to media submodule 
These media are platform specific and do not belong in the generic parameters module.
 2019-10-31 11:11:06 +01:00
Laurens Valk 6f173f3488 api: drop hub modules 2019-10-21 14:51:55 +02: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 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