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
452 Commits 10 Branches 125 Tags
ffb950869ce05bc758a52a6d6db808aeb75a4d6e
Commit Graph
452 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
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 6ada01315d doc: add external link decoration to sidebar 
External link decorations are already enabled in the documentation
content, but the RTD theme doesn't extend this to the sidebar. This
copies the css from the RTD theme and adds it to the sidebar.

This makes it less of a surprise when you click on a link and find
yourself on a completely different website.
 2020-03-25 20:25:35 +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 43c006d836 doc/builtins/Motor: return from run_until_stalled 
The return argument was not documented.
 2020-03-25 09:32:46 +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 0bee7ef984 doc: fix and clarify verbs 2020-03-24 12:12:49 +01:00
David Lechner 166ce2109f doc: Use verbs ending in s for functions/methods 
The documentation currently has a mix of with and without the `s`.
Adding an `s` is consistent with most API documentation in general,
especially more modern documentation.
 2020-03-24 12:11:53 +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 661de5f0fe doc/*devices: improve rgb() docstring 2020-03-20 10:42: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
David Lechner 65deb297dd api: remove Port subclass from hubs 
This was removed in the pybricks-micropython implementation.
 2020-03-18 18:10:18 -05:00
David Lechner bea9a6216e config: update windows make.bat to match Makefile 2020-03-18 17:30:42 -05:00
David Lechner 21b747dce0 travis: drop redundant make arg 
The makefile already uses SOURCEDIR=api as the default so we don't
need to set it.
 2020-03-18 17:30:42 -05:00
David Lechner e3d0d51c9f config: drop versioneer 
This removes versioneer for versioning. The version depends on the
pybricks-micropython version targeted so it doesn't make sense to use
automatic versioning here.
 2020-03-18 17:30:42 -05:00
David Lechner 21cef2f8c8 api: remove __init__.py 
pybricks is a namespace, not a module, so it cannot have __init__.py. Otherwise there can be no other packages installed that use the pybricks namespace.
 2020-03-18 17:19:48 -05:00
David Lechner 3e8f311860 config: drop setup.py 
poetry is used for build system, so setup.py is no longer needed
 2020-03-18 17:19:48 -05:00
David Lechner 803c57aa8e config: html_context is no longer dependant on ON_RTD 
This refactors duplicated code.
 2020-03-18 14:03:50 -05:00
David Lechner e4d1547f83 doc: move css overrides to template 
Hopefully this should fix small fonts when docs are published on RDT.org.
 2020-03-18 13:51:24 -05:00
Laurens Valk aa343d017f doc/robotics: add note for when to change settings 2020-03-17 15:47:54 +01:00
Laurens Valk 9c8df9941f config: let doc8 ignore egg info 2020-03-17 15:37:20 +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
Laurens Valk 1c576d5b11 api/builtins/Motor: rename stop_type kwarg 
All point-to-point maneuvers come to a controlled stop before the stop
mode kicks in. Therefore it is more accurate to rename stop_type to
then, as this argument controls what happens after stopping,
so it reads: then=Stop.HOLD.
 2020-03-17 15:19:27 +01:00
Laurens Valk 65888a825d api/robotics: revert stop type for stop() 
Partially reverts b25227ec5b

This stays coast by default. This way, stop() remains the best way to release all torque from a motor. Also, it ensures that stopping a running motor or drivebase is smooth by default.
 2020-03-15 20:44:21 +01:00
Laurens Valk d282d38836 doc/builtins/DCMotor: a DCMotor cannot hold 2020-03-15 20:36:38 +01:00
Laurens Valk 9dd1f45ccd doc: drop default argument in docstring 
This is visible in the function definition, so no need to repeat it.
 2020-03-15 20:35:36 +01:00
David Lechner 0c611fabab doc/conf.py: add contentui css when building on readthedocs.org 2020-03-13 13:07:08 -05:00
David Lechner 61b58e1886 rtd-requirements: new file for readthedocs.org 
readthedocs.org needs to know which packages to install to build the
docs.
 2020-03-13 11:35:21 -05:00
David Lechner b3e8728f69 update pybricks-projects submoudle 2020-03-13 10:10:01 -05:00
David Lechner 96fe4f59e0 CONTRIBUTING: new contributor guide 2020-03-13 09:45:29 -05:00
David Lechner 8b986525f7 New AUTHORS.md file 
This file lists specific copyright holders and project maintainers.
It will also include any future contributors.
 2020-03-13 09:45:29 -05: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 6ed6ec0378 api: remove empty () on class declarations 
Python allows this syntax and some even consider it good style.
 2020-03-12 12:46:09 -05:00
David Lechner b25227ec5b api/Motor,DriveBase: change default stop to HOLD 
This reflects a change in the implmentation
 2020-03-07 16:24:42 -06:00
David Lechner 13845c9c08 vscode: associate .inc files with ReST 2020-03-06 13:05:06 -06:00
David Lechner cab16f6af7 api/media/ev3dev: add Image/screen save method 
This was overlooked previously.
 2020-03-06 12:59:42 -06:00
David Lechner d97b15c23d poetry: move dev dependencies 
Development depedencies should be categoriezed as such, otherwise users who install the stubs package will also get these depedencies.
 2020-03-06 11:39:49 -06:00
David Lechner be9623dc9f Update PyPI info 2020-03-06 11:34:55 -06:00
David Lechner 46c9fca6e9 poetry: install venv in project driectory 
This way, the venv is not hidden away in some cache directory somewhere hard to find.
 2020-03-06 11:29:04 -06:00
Laurens Valk 86890adc18 pybricks-projects: update snippets and projects 2020-03-05 16:54:02 +01: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