Commit Graph
415 Commits
Author SHA1 Message Date
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
Laurens Valk e0ec45b58d config: relax poetry Python version
Allow older Python versions to support older CI configs.
2020-03-05 11:26:59 +01:00
Laurens Valk ab44385275 config: make travis use poetry 2020-03-05 10:36:46 +01:00
Laurens Valk 674a7f3e9d config: switch from pipenv to poetry
RTD does not support pipenv
2020-03-05 10:36:46 +01:00
Laurens Valk 066983a5e1 LICENSE: Update year and authors
Also add SPDX-License-Identifier: MIT to API source files for clarity.
2020-03-05 10:33:48 +01:00
Laurens Valk feed562373 config: remove inkscape dependency for travis
Diagrams are no longer built on the CI.
2020-03-04 11:51:00 +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 8861be68eb config: remove diagram builder from common
This has no image targets, so remove to avoid confusion.
2020-03-04 11:43:37 +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 10731d019a doc/parameters: remove Align
This was already hidden from the docs, but not deleted.
2020-03-03 17:43:53 +01:00
Laurens Valk ef3d7206b0 pybricks-projects: include initial example project
Update the submodule as a first step towards reorganizing the doc build.
2020-03-03 13:20:25 +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 c02cc456f7 api/iodevices/Ev3devSensor: add device index
This makes it easy to find the sensor to access additional features through the ev3dev lego-sensor and lego-port classes.
2020-02-25 10:29:40 +01:00
David Lechner df6cfa30f6 api/media.ev3dev.Image: Add default args for empty()
Implementation has been changed so that omitting args gives an empty
image the same size as the screen.
2020-02-21 11:01:44 -06:00
Laurens Valk 854760feb6 api/builtins/Control: add feed_forward gain
This can be useful for motors with high internal static friction.
2020-02-20 16:34:25 +01:00
Laurens Valk a426d412bb doc/iodevices: add preliminary warning 2020-02-20 16:29:13 +01:00
Laurens Valk 0d068b17f2 api/iodevices/AnalogSensor: remove type check
This makes it consistent with the UARTDevice and I2CDevice class.

The `Ev3devSensor` class can be used instead if auto id is desired.
2020-02-20 16:23:26 +01:00
Laurens Valk b81b28d338 api/builtins/Control: add scale property 2020-02-19 19:40:44 +01:00
Laurens Valk 16e8af0f4d api/builtins/Control: add integral_rate setter 2020-02-17 14:04:50 +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
David Lechner 5231c48eda pybricks/media/ev3dev: list known font language codes
This list was obtained by running fc-list on an EV3.
2020-02-15 18:18:36 -06: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 3c2f1b8444 doc/builtins: update to remove brightness
This setting has previously been removed but the docstring was not updated.
2020-02-14 19:24:55 +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
David Lechner 279b0a2a7e dock/messaging: remove TODO about using Bluetooth address
This has been fixed, so we can remove the TODO.
2020-02-12 15:56:03 -06:00
Laurens Valk 57a44265b8 api/nxtdevices: add VernierAdapter 2020-02-12 12:49:40 +01:00
Laurens Valk d1a9d6f15f doc/messaging: drop availability
This appears to give build errors in derivatives of this repository, so we remove it for now.
2020-02-12 11:20:22 +01:00
David Lechner aded6ebfe7 doc/messaging: clarify incoming and outgoing 2020-02-12 09:55:28 +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
Laurens Valk 57c53921ec api/ev3messaging: don't encode by default
The Numeric/Text/Logic will be the convenience classes for common data types, so make the basic class general purpose for sending bytes.
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