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
333 Commits 10 Branches 125 Tags
167cf3ad18ca5575bf57f54f0348caf00ac6fc00
Commit Graph
81 Commits
Author SHA1 Message Date
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
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 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 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 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
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
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 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