Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-07-28 04:07:46 +00:00
Code Issues Releases Activity
1,135 Commits 10 Branches 124 Tags
4da4ce8f7c5da75be396cdf961635cde58542e48
Commit Graph
590 Commits
Author SHA1 Message Date
Laurens Valk 4da4ce8f7c pybricks.robotics.DriveBase: Add clarifying comments. 
Fixes https://github.com/pybricks/support/issues/698
 2022-12-06 16:38:31 +01:00
Laurens Valk ab4d4cc848 pybricks.pupdevices.Motor: Add versionchanged. 
Document moving stalled, load, done.
 2022-12-02 14:20:51 +01:00
Laurens Valk 14a4fc0d74 pybricks.robotics: Document behavior on shared resources. 
Fixes https://github.com/pybricks/pybricks-api/issues/105.
 2022-12-02 12:43:24 +01:00
Laurens Valk 99d5210313 pybricks.robotics.DriveBase: Add stalled, done. 2022-12-02 12:43:24 +01:00
Laurens Valk c3802d38c2 pybricks.ev3devices: Keep motor class in sync. 
Let's make sure we keep EV3 pages building.
 2022-12-02 12:43:24 +01:00
Laurens Valk ac23a9bb59 pybricks.common.Motor: Document compatibility. 
Control methods are not available on Move Hub.

Fixes: https://github.com/pybricks/pybricks-api/issues/106
 2022-12-02 12:15:25 +01:00
Laurens Valk 631cf31a07 pybricks.common.Motor: Document when settings take effect. 
This updates how and when settings take effect. In this release, you can
change them even while the motor is moving. Some settings do not
take effect right away, as now indicated in the relevant methods.

See also https://github.com/pybricks/pybricks-api/issues/105
 2022-12-02 12:10:31 +01:00
Laurens Valk 115ae0d856 pybricks.common.Motor: Add done, stalled, load. 
These used to be implemented as part of the Control object,
but now they are available directly on the motor.

This way they:
- Also give useful values when control is passive, via dc().
- Can be supported on Move Hub
- Give useful values for drive bases (see next commits).

Fixes https://github.com/pybricks/pybricks-api/issues/115
 2022-12-02 12:02:22 +01:00
Laurens Valk eec6d2ff85 pybricks.parameters: Delete TODO on hue. 
This should be an issue, not a mark in the released docs.
 2022-12-01 16:59:54 +01:00
Laurens Valk 961cebe48b ustruct: Document modules. 2022-12-01 16:48:20 +01:00
Laurens Valk 3c0aaea207 usys: Add version info. 
Fixes https://github.com/pybricks/pybricks-api/issues/119
 2022-12-01 15:02:25 +01:00
Laurens Valk 553490874b usys: Add examples. 2022-12-01 14:21:12 +01:00
Laurens Valk 31d3872405 uselect: Rewrite the docs. 2022-12-01 14:11:41 +01:00
Laurens Valk 6f55e90365 urandom: Update remaining functions. 
Also modify the categories given implicitly in the Python
file and make them explicit in the docs.

Most users are going to want to use `randint` or `random`, so
that basic category comes first.
 2022-12-01 11:19:42 +01:00
Laurens Valk d4d7971a56 pybricks.hubs: Update storage documentation. 
This moves the per-hub storage size to the respective page.

This also clarifies that data is cleared when updating Powered Up hubs.

Also flip docstring signatures around to work around https://github.com/pybricks/pybricks-api/issues/117
 2022-12-01 10:17:41 +01:00
Laurens Valk 64b0489a73 urandom: Move example to Move Hub. 
Move it do a dedicated example instead of hardcoding it in the module docstring.

Also update changelog for missing previous changes while we are at it.
 2022-12-01 09:55:40 +01:00
Laurens Valk 87ed7353b4 ujson, urandom, uselect: Document compatibility. 2022-11-29 20:32:53 +01:00
Laurens Valk aca23197a1 micropython: Document compatibility. 
Fixes https://github.com/pybricks/pybricks-api/issues/118
 2022-11-29 20:32:09 +01:00
Laurens Valk 71ce165a46 uio: Update style. 
Also fix compatibility information.
 2022-11-29 20:23:23 +01:00
Laurens Valk 56ab509630 ujson: Document module. 2022-11-29 16:00:00 +01:00
Laurens Valk 9608a16d95 micropython: Update style. 
This makes it consistent with our other modules.

Follows https://github.com/pybricks/pybricks-api/issues/82
 2022-11-29 15:59:32 +01:00
Laurens Valk 9b314777e0 micropython: Document heap_lock, heap_unlock. 
Fixes https://github.com/pybricks/pybricks-api/issues/116
 2022-11-29 13:51:34 +01:00
Laurens Valk 1ae0a9005f pybricks.parameters.Stop: Document NONE. 
Fixes https://github.com/pybricks/pybricks-api/issues/104
 2022-11-28 17:10:53 +01:00
Laurens Valk 1d5956a58a pybricks.parameters.Stop: Document COAST_SMART. 
See https://github.com/pybricks/pybricks-api/issues/104
 2022-11-28 17:01:06 +01:00
Laurens Valk ef57dbf4a1 pybricks.common.LightMatrix: Rename image() to icon(). 
Fixes https://github.com/pybricks/support/issues/409
 2022-11-22 14:26:15 +01:00
Laurens Valk d2b1b2183b pybricks.parameters.Icon: Document it. 
Fixes https://github.com/pybricks/pybricks-api/issues/107
 2022-11-10 16:38:44 +01:00
Laurens Valk 6c893c136e doc/main/diagrams: Fix City Hub position. 
It was accidentally moved to a non-integer position. This causes the PNG to re-render. This increases the file size and makes it looks less crisp.
 2022-11-08 19:55:48 +01:00
Laurens Valk f4212f232e doc/main/diagrams: Adjust Move Hub icon scale. 
Fixes https://github.com/pybricks/support/issues/773
 2022-11-08 19:52:51 +01:00
Laurens Valk c52627cc8f doc/main/diagrams: Add hub icon variants. 
This re-exports all hub images in a square format for use as icons while getting correct relative scaling.
 2022-11-03 17:07:41 +01:00
Barry-Williamsandlaurensvalk 492d6cd2d4 pybricks.robotics.DriveBase: Add basic example. 2022-10-28 08:23:14 +02:00
Laurens Valk be3558167e doc/common/extensions: Fix compatibility labels. 
Fixes https://github.com/pybricks/support/issues/754
 2022-10-27 15:41:42 +02:00
David Lechner 40fc2588f9 pybricks._common.System: add storage method 
This adds stubs, docs and code completion tests for the System.storage()
method.

This was added to Pybricks MicroPython in:
https://github.com/pybricks/pybricks-micropython/commit/246ebea25d25d5a3e4a4e62ebd031491a409c923
 2022-10-21 12:35:34 -05:00
David Lechnerandlaurensvalk 96be47f21b doc/main/pupdevices/motor: Fix center example. 
This fixes the include for the centering example to link it to the correct source file.

Fixes: https://github.com/pybricks/support/issues/734#issuecomment-1272329217
 2022-10-10 09:20:00 +02:00
Laurens Valk e1be50181a doc/main: Revisit and automate all renders and diagrams. 
Previously, all renders were created and added manually when a newly
supported device was added to the documentation.

This commit revisits all diagrams by creating them using a single
LDRAW multi-file part model and LPUB3D building instructions file.

This makes perspective and resolution consistent across all images, and
we could update them all at once if needed.

It also removes the background from all images so they can be used
with different documentation themes.
 2022-10-10 09:19:49 +02:00
Laurens Valk 6df509b66e pybricks.hubs.EssentialHub: Fix duplicate example. 
Also delete reference image with the light consistent with other small hubs.
 2022-07-04 15:00:41 +02:00
Laurens Valk 0982d5d65b ubuiltins: Document int. 2022-07-04 14:33:17 +02:00
Laurens Valk 1b51d71061 examples: Generate hub examples while building. 
This way we don't have to commit the generated scripts.

While we do this, rename ExampleHub to ThisHub so that the common scripts can actually run.
 2022-07-04 14:29:33 +02:00
David LechnerandDavid Lechner 7c62a2833a doc/main/images: add temporary essentialhub images 
We don't have proper images yet, so we are adding copies of the Prime
hub images for now to not take up space in git history with temporary
images and to at least have something so the docs will build.
 2022-06-29 12:08:33 -05:00
David LechnerandDavid Lechner 03ee7f74e8 doc/pup/essentialhub: fix bit rot 
This fixes bitrot for PR #96. Also fixes a few minor issues where
changes were missed.
 2022-06-29 12:08:33 -05:00
Pavel LobodinskýandDavid Lechner 025147680c pybricks.hubs.EssentialHub: Added missing Hub 2022-06-29 12:08:33 -05:00
David Lechner a2d9c33eb5 jedi: add new pybricks_jedi package 
This package will be used in Pybricks Code to provide some intellesense
operations.
 2022-06-24 14:52:45 -05:00
Laurens Valk 6d0de1effa doc/main: Drop beta tag. 
Less variants is better. Now we'll just have to add beta support for SPIKE in the next release.

Fixes https://github.com/pybricks/pybricks-api/issues/102
 2022-06-10 11:31:08 +02:00
Laurens Valk 8e7fc53974 doc/main: Disable NXT and EV3 pages again. 
Now that all typehints have been added, we can
revert commit 4c583a9d4e again.
 2022-06-10 11:20:32 +02:00
Laurens Valk e456c8ef91 pybricks: Drop underscores on imports. 
Fixes https://github.com/pybricks/pybricks-api/issues/101
 2022-06-10 11:10:20 +02:00
Laurens Valk 8ec1b18629 pybricks.parameters: Add typing, part 2. 2022-06-10 10:33:33 +02:00
Laurens Valk 26908040eb pybricks.common: Add CommonColorSensor class. 
Fixes https://github.com/pybricks/pybricks-api/issues/103
 2022-06-10 10:05:13 +02:00
Laurens Valk c77682f50d pybricks.iodevices: Add typing. 2022-06-10 10:05:11 +02:00
Laurens Valk 4c583a9d4e doc/main: Enable NXT and EV3 pages. 
This will help us review the pages as we add typing to the documentation. Then they will be hidden again.

This commit can be cherry-picked later on if we ever enable NXT and EV3 content again.
 2022-06-10 10:05:10 +02:00
Laurens Valk 0688b8dded doc/common/conf.py: Add missing units. 
These are used for NXT sensors.
 2022-06-10 10:05:10 +02:00
Laurens Valk dbc5d327e3 doc/common/conf: Display s^2 units correctly. 
Now that we no longer use these in hyperlinks, we can use the right
unicode to display this unit correctly.
 2022-05-30 17:29:30 +02:00