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
295 Commits 10 Branches 125 Tags
57e262e3f9f6d3290a1df0dcd34bb53b827f6cf4
Commit Graph
295 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
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
Laurens Valk 94f514cd20 doc/battery: not an independently usable class 
There are only the instances on hubs that support it, and they are already documented there, so delete generic copy.
 2020-01-14 17:02:30 +01:00
Laurens Valk 782ca5d424 doc/hubs: delete old display API 
This is not used anymore.
 2020-01-14 16:39:23 +01:00
David Lechner b644d37ed5 update submodule 2020-01-13 20:14:49 -06:00
David Lechner 9c024e17c4 pybricks/builtins: update speaker methods 
Update Speaker class with newly implemented methods
 2020-01-13 20:14:49 -06:00
David Lechner 0398d04af9 pybricks/resources/image: add show_image() method 2020-01-13 20:12:50 -06:00
David Lechner c3e74273d2 pybricks/builtins: update Speaker docs 2020-01-13 12:59:21 -06:00
David Lechner c008c4ca09 flake8: allow longer lines 
This increase max-line-length to 88 because somtimes it is nicer to have
just a few extra characters.
 2020-01-13 12:59:07 -06:00
David Lechner ee0819adef pybricks/builtins: remove deprecated Display class 
The Display class is from Pybricks MicroPython 1.0 and has been
replaced by the Image class.
 2020-01-13 12:59:07 -06:00
David Lechner b4cd9113b5 doc/api/hubs_ev3brick: add Image class as EV3Brick.screen 
This duplicates the Image class documentation In pybricks.ev3devices
as EV3Bricks.screen.
 2020-01-13 12:59:07 -06:00
David Lechner f694de2277 pbyricks/resources: new Image and Font classes 
This adds API and documentation for the pybricks.resources module
Image and Font classes.
 2020-01-13 12:59:07 -06:00
Laurens Valk 5991fb544b config: fix contentui css 
The contentui sets the page with to be infinite in order to add a second column.

We do not use this feature, so we set the width back to normal.  Also make sure our theme_overrides are last in conf.py to make sure they override the contentui css.
 2020-01-13 14:44:11 +01:00
Laurens Valk 220ad471b8 api/ev3devices: remove duplicate AnalogSensor 
This has previously been moved to the iodevices class
 2020-01-13 13:30:08 +01:00
Laurens Valk e244f28ddb api/builtins: drop method string override 
We had these because enums expanded to numeric values. Because we now have an alternate enum implementation, we don't need these strings anymore.
 2020-01-13 12:19:59 +01:00
David Lechner 1b426b90f7 pybricks/parameters: introduce _PybricksEnum class 
This adds a _PybricksEnum base class for all enums. In Pybricks
MicroPython, we don't have an Enum class, but rather just simple
lookup tables.

The __repr__() method prints the enum values like the Pybricks
MicroPython implementation and also causes sphinx doc to correctly
print the value when used as a default value for aguments.

The __dir__() method is overloaded for both the instance and the class
to match what is seen in Pybricks MicroPython. This should help hide
things from code Python completion that are not present in MicroPython.
 2020-01-11 21:08:24 -06:00
David Lechner 31a639f55b doc/api/conf.py: enable nitpicky 
This enables the sphinx doc nitpicky option to detect broken references.

Also fix all of the broken references.
 2020-01-11 21:08:20 -06:00
David Lechner 29b012a7d7 vscode: add conf.py path for rst extension 
This adds a setting for the VS Code lextudio.restructuredtext extension
that specifices where to find conf.py
 2020-01-11 21:06:43 -06:00
David Lechner 6463adab3c CONTRIBUTING: git clone --recursive 
we are using submodules, so we need to recursive clone the repo
 2020-01-11 21:06:43 -06:00
Laurens Valk cb9393020d api/parameters: bring Port enum back 
Move Port from hub classes back to common parameters module.

This would have had too much impact on existing users, so undo it.

Notes if we are ever bringing it back again:
- The idea behind this was to ultimately allow for unique ports in a multi-hub scenario:

ev3 = EV3Brick()
ev3.Port.A # This is port A on this particular instance

This may still be added while leaving the existing Port enum in place, which would then always be the ports of the hub on which the code runs.
 2020-01-10 16:39:27 +01:00
Laurens Valk 1bafa67979 api/iodevices: add Ev3devSensor 2020-01-09 22:21:42 +01:00
Laurens Valk 5c2df91bc4 doc/iodevices: split ev3 and pup to subfiles 
This allows us to easily exclude a platform if needed.
 2020-01-09 22:02:33 +01:00
Laurens Valk 5a2d1f5406 api/iodevices: simplify LUMPDevice API 
All these device can do is read or write values at a particular mode. There is also no need for separate mode setters.
 2020-01-06 17:48:03 +01:00
Laurens Valk 09d453480b api/robotics: add DriveBase state getters 2020-01-02 16:51:50 +01:00
Laurens Valk 3d9a6f11cc api/robotics: add DriveBase draft 
This is a concept for a DriveBase class for common robot tasks.
 2020-01-02 16:36:37 +01:00
Laurens Valk af3954989a doc/iodevices: add note about EV3 compatibility. 
Some iodevices are only available on EV3 (for now or forever).
 2020-01-02 16:02:10 +01:00
Laurens Valk f73e7f08bc api/iodevices: add LUMPDevice 
This can be used to interface with LPF2 and EV3 sensors that use the LEGO UART Messaging Protocol.
 2020-01-02 15:53:44 +01:00
Laurens Valk 21a0b8766e api: rename customdevices to iodevices 
These devices are not always custom. Rather, the classes in this module are very generic and apply to a wide range of input/output devices.
 2020-01-01 16:41:29 +01:00
Laurens Valk e74003f5d8 doc/customdevices: add DCMotor 2020-01-01 16:31:19 +01:00
Laurens Valk 46dba95342 api/builtins: add DCMotor 
This is a strict subset of Motor, covering functionality of DC motors only. This is useful for motors without encoders, such as train motors.

It is inherited by Motor, which adds functionality that requires encoders.
 2020-01-01 13:18:41 +01:00
Laurens Valk 990527c12a api/builtins/Motor: update reset_angle text 
Control+ motors have absolute encoders, but no marker on the shaft. This revises the text accordingly.
 2019-12-28 14:07:39 +01:00
Laurens Valk e183f73d4e doc/customdevices: replace example by include 
This makes examples more maintainable.
 2019-12-10 15:34:41 +01:00
Laurens Valk d975974d07 snippets: add uart example 2019-12-10 13:29:41 +01:00
Laurens Valk d78db6aefb doc/customdevices: use correct default argument 
Make it match the implementation.
 2019-12-10 13:25:06 +01:00
Laurens Valk 2e530a4b30 doc/hubs: toggle example snippet 
This shows how to add and include an example project as a snippet.
 2019-12-10 09:28:08 +01:00
Laurens Valk 613998661e config: fix contentui css 
The extension CSS does not get included correctly. Fix html context so we don't have to copy the css.
 2019-12-09 17:08:12 +01:00
Laurens Valk 61bfd359f1 doc: remove example projects 
Full project examples are not included in the API.
 2019-12-09 16:53:12 +01:00
Laurens Valk 7ca33d8b97 projects: add submodule 
This will contain the code snippets included by the docs.
 2019-12-09 16:47:40 +01:00
Laurens Valk 8acab1898a doc: delete existing inline examples 
Those should be included as working and tested Python files instead. They should be toggled on/off.
 2019-12-09 14:31:53 +01:00
Laurens Valk 893b23ce90 api/builtins/Speaker: add speech 2019-12-09 14:15:43 +01:00
Laurens Valk be1522ad04 api/builtins: Update speaker API 
- Volume is a setting.
- Remove beeps method. To do multiple beeps, users can make their own loop.
- Rename file to play.
 2019-12-09 13:13:06 +01:00
Laurens Valk 3afaa83ba0 doc/hubs: add note to say screen not implemented 
This will be unhidden/updated later.
 2019-12-09 13:00:59 +01:00
Laurens Valk 2e78033720 doc/devices: simplify motor docs, reduce detail 
Previously, we simplified the docs for initializing a motor. This commit also simplifies the docstrings for common motor methods, by leaving out details and optional arguments. Full details are still available on the dedicated motor page.
 2019-12-09 11:09:11 +01:00