Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity
454 Commits 10 Branches 125 Tags
2bdc975f8bc74ee73ab2dc90f6ac7ceaf718f1f6
Commit Graph
143 Commits
Author SHA1 Message Date
Laurens Valk 2bdc975f8b doc/ev3devices: add motor icons with directions 2020-03-27 14:16:43 +01:00
David Lechner ffb950869c Add EV3 screen examples 
This includes examples from the pybricks-projects repository
 2020-03-26 13:58:02 +01:00
Laurens Valk 95e808df9d doc/pupdevices: add sensor icons 
Only the ColorDistanceSensor is added to the docs for now. Other icons are included for future use.
 2020-03-25 20:30:34 +01:00
Laurens Valk d6b20a962c doc/media: make module level match 
ImageFile and SoundFile are located at media.ev3dev, not media.
 2020-03-25 20:30:34 +01:00
Laurens Valk 2e4274995d doc/messaging: extend introduction. 
Also drop separate, nearly empty Mailboxes page. Ultimately we may separate this page into two pieces again, but for now a single concise page is clearer than two incomplete pages.
 2020-03-25 20:30:34 +01:00
Laurens Valk 9e1134b4e9 doc/messaging: add simpler diagram 
also restyle to match examples included in the docs.
 2020-03-25 20:30:34 +01:00
Laurens Valk a308524289 doc/hubs: add hub icons to toggle menu 
Also add icons for hubs we might support one day.
 2020-03-25 20:30:33 +01:00
Laurens Valk 3b61cc81d2 doc/pupdevices: dc motors with default directions 2020-03-25 20:30:33 +01:00
Laurens Valk 73a41beeb4 doc/pupdevices: add motors with default directions 2020-03-25 20:27:51 +01:00
David Lechner 87c2b6857f api: Use leading _ to hide internals in intellisense 
Intellisense in VS Code (both jedi and ms python language server) picks
up all imported names and suggests them with equal priority for
code completion. By adding a leading underscore, intellisense lists
these with a lower priority, so they don't get in the way.

Also rename from builtins to _common while we are touching this to
better reflect the intention of the module (it contains types shared
by multiple modules, not builtin types like int).
 2020-03-25 20:24:32 +01:00
Laurens Valk ada50328bb doc/pupdevices/Motor: fix reset_angle 
The note about absolute angle support had accidentally ended up in the GyroSensor. It applies only to pupdevices.Motor.
 2020-03-24 16:25:06 +01:00
Laurens Valk 3b76bbc424 config: add link to home page and downloads 2020-03-20 16:10:33 +01:00
Laurens Valk c78f4b04f9 config: fix pybricks logo 
Use anti-aliasing
On blue backgrounds like rtd, logo is white and transparent
 2020-03-20 15:58:20 +01:00
Laurens Valk a827491b2b doc/pupdevices: doc ColorDistanceSensor.remote() 2020-03-20 11:13:52 +01:00
Laurens Valk d36b5b0ed8 doc/nxtdevices: remove note about old touch sensor 
Special treatment is no longer necessary; if no such touch sensor is detected, the port switches to analog mode.

This means that it will work for both touch sensor types, as well as custom switches.
 2020-03-20 10:26:26 +01:00
Laurens Valk aa343d017f doc/robotics: add note for when to change settings 2020-03-17 15:47:54 +01:00
Laurens Valk 1158e4e45a api/builtins/Motor: separate methods for stop 
stop(Stop.COAST)
stop(Stop.BRAKE)
stop(Stop.HOLD)

becomes

stop()
brake()
hold()

This is easier to type and remember.
 2020-03-17 15:19:55 +01:00
David Lechner abe24cf289 api/builtin: add missing DCMotor.stop() method 
This was missing. It also has a different default value
from the Motor class, so Motor overrides this method.
 2020-03-12 12:52:27 -05:00
David Lechner cab16f6af7 api/media/ev3dev: add Image/screen save method 
This was overlooked previously.
 2020-03-06 12:59:42 -06:00
Laurens Valk ffae01fd0c config: move project specifics to own conf.py 
Each target doc build can have it own parameters.
 2020-03-05 14:07:31 +01:00
Laurens Valk a1dce8e50e config: use doc agnostic paths for images 
Allow files like messaging .rst to be included without having to copy the images.
 2020-03-05 13:05:34 +01:00
Laurens Valk 3c317967af config: separate make target for diagrams 
Separate the build step and commit the output to the repository. This way the docs can be built on platforms that do not have inkscape, such as readthedocs.

pipenv run make -C doc diagrams
pipenv run make -C doc html
 2020-03-04 11:49:21 +01:00
Laurens Valk 862f881d33 config: rename _images to diagram_source 
Make it clear what it really is.
 2020-03-04 11:40:34 +01:00
Laurens Valk 95ee2fa885 doc: remove unused images 2020-03-04 11:32:37 +01:00
Laurens Valk 921fd74896 doc/messaging: fix typo in server/client diagram 2020-03-02 10:31:23 +01:00
David Lechner c76395d07f doc/media/ev3dev: sort images and sounds 
Put image and sound files in alphabetical order. Exception made for
sorting numbers by numerical order.
 2020-02-26 19:06:44 -06:00
Laurens Valk 5288a7e75d doc/iodevices/Ev3devSensor: add links and examples 2020-02-25 10:29:40 +01:00
Laurens Valk a426d412bb doc/iodevices: add preliminary warning 2020-02-20 16:29:13 +01:00
Laurens Valk a0fba6c2d1 api/builtins/Control: Move stalled to control 
This is a control status property, so move it to the control class. This way, it is hidden from the common motor methods, and DriveBases will be able to use it too.
 2020-02-17 13:55:45 +01:00
Laurens Valk 9db7e95959 api/robotics: DriveBase: rename settings args 
Make it explicit that these arguments affect only the settings for the corresponding methods.

Also rephrase a few docstrings to make them easier to read or fix typos.
 2020-02-17 13:43:48 +01:00
Laurens Valk 9c6d2267bd api/nxtdevices/ColorSensor: add rgb and light 
also, remove detection of brown color, because this is not supported
 2020-02-14 19:26:05 +01:00
Laurens Valk 0ea4c22670 api/tools: add DataLog 2020-02-14 11:47:43 +01:00
Laurens Valk 250dfc63b5 api/tools: remove print 
Going forward, we are using the builtin print function.
 2020-02-13 17:56:11 +01:00
Laurens Valk 57a44265b8 api/nxtdevices: add VernierAdapter 2020-02-12 12:49:40 +01:00
David Lechner f8ccbb7896 api/messaging: rename ev3messaging module to messaging 2020-02-12 09:55:28 +01:00
Laurens Valk 37a297cf0d doc/ev3messaging: add draft network diagram 2020-02-12 09:55:28 +01:00
Laurens Valk 627701d26a doc/ev3messaging: organize page 
Group connection related classes under a header and move it to the top.

Avoid duplicating shared methods. This reduces the page length considerably so it is easier to see the bigger picture. Add examples of data types instead.
 2020-02-12 09:55:28 +01:00
David Lechner b1382f02b0 move EV3 mailboxes to ev3messaging module 
- add separate maibox classes
- drop bluetooth module since it is not considered public API
 2020-02-12 09:55:28 +01:00
David Lechner 7acbcbd874 initial EV3 bluetooth mailbox docs 2020-02-12 09:55:28 +01:00
David Lechner f16876cca9 doc/media/ev3dev/image: use substitution to disambiguate screen/image 2020-02-11 11:49:05 -06:00
David Lechner d9089bcbae api/media/ev3dev: update for Image API changes 2020-02-11 11:43:54 -06:00
Laurens Valk 0841899394 api/builtins/Control: expose done method 
This was added but not yet exposed
 2020-02-10 15:57:23 +01:00
Laurens Valk 37de307ef0 doc/motors: add note about controller inactivity 2020-02-09 23:47:35 +01:00
Laurens Valk f5c3347ba1 doc/signaltypes: fix label 
This was left behind when grouping labels earlier
 2020-02-07 20:13:35 +01:00
Laurens Valk f1f1ceaac9 api/robotics/DriveBase: add state getter 2020-02-06 14:05:14 +01:00
Laurens Valk 7423161615 api/robotics: simplify API 
drop methods that will not be implemented for next release and simplify descriptions of methods that will be implemented.
 2020-02-05 16:55:03 +01:00
Laurens Valk 6337b6c451 api/iodevices: Separate Ev3devSensor class 
This is not just an alias for a LUMPDevice because it works differently. On ev3dev, sensor modes are set using strings.

Also, simplify the introductory text and reasons for using it.
 2020-02-03 13:54:18 +01:00
Laurens Valk 2bd149a121 doc/iodevices: reorganize TOC 
Make the heading levels match the module. No subcategories, but say which devices are available on EV3 only.
 2020-02-03 11:35:43 +01:00
Laurens Valk ab6b15f047 doc/media: toggle items by category 
Make it easier to browse the options.
 2020-01-29 14:47:03 +01:00
Laurens Valk e97423da72 doc/motors: hide status getters 
These are not yet implemented
 2020-01-29 13:38:32 +01:00