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
1,222 Commits 10 Branches 125 Tags
b97eef81521696d2cd18e206d82c62f3fa0c529c
Commit Graph
148 Commits
Author SHA1 Message Date
Laurens Valk 578abab24e signaltypes: Bare minimal async docs. 
This is nowhere near complete, but provides handles to start documenting async for the relevant methods.
 2023-10-23 16:28:50 +02:00
Laurens Valk 1a49d396d2 pybricks.robotics: Document use_gyro. 2023-10-23 15:39:52 +02:00
David Lechner 41b9ce71dd pybricks.tools: add read_input_byte() 
This adds stubs and docs for the new `pybricks.tools.read_input_byte()`
function.
 2023-06-12 11:06:20 -05:00
David Lechner 6d69f04fe5 docs/cityhub: add ble.broadcast 
A workaround has been implemented in the firmware so this is available
now.
 2023-05-23 13:37:05 -05:00
David Lechner 3274cef849 pybricks.common: Add new BLE class. 
This adds a new BLE class that is used for connectionless broadcasting/
observing on hubs with built-in Bluetooth Low Energy.

Also see https://github.com/pybricks/pybricks-micropython/pull/158.
 2023-05-16 14:46:53 -05:00
David Lechner 8e5891d9e8 all: spelling 
Misc spelling fixes.
 2023-05-10 14:16:15 -05:00
David Lechner 31d3a117d6 doc/main/conf: update copyright year 2023-04-21 17:39:28 -05:00
Laurens Valk 5bc11b185d pybricks.tools: Add versionchanged note. 2023-04-21 14:07:46 +02:00
Laurens Valk be9f99d41b pybricks.tools: Add category headings. 2023-04-21 13:59:16 +02:00
Laurens Valk 870aae83c0 pybricks.tools: Document cross product. 2023-04-21 13:39:08 +02:00
Laurens Valk 9cde749e8a pybricks.geometry: Drop module. 
See https://github.com/pybricks/pybricks-micropython/pull/160
 2023-04-21 13:33:19 +02:00
Laurens Valk 8bca5eb6e4 pybricks.robotics: Add GyroDriveBase. 2023-04-21 10:42:30 +02:00
Laurens Valk d6c78f1f39 pybricks.robotics: Drop note restricting when to change settings. 2023-04-21 10:42:30 +02:00
Laurens Valk b183e1420a pybricks.pupdevices.Motor: Document speed time window. 2023-04-21 10:42:30 +02:00
Laurens Valk b311c54261 pybricks._common.IMU: Change settings setter. 2023-04-21 10:42:30 +02:00
Laurens Valk bb37b94f5e pybricks._common.IMU: Add imu status. 2023-04-21 10:42:30 +02:00
Laurens Valk 5b25606afa pybricks._common.IMU: Add rotation and orientation. 
Also update implementation status for heading and reset_heading.
 2023-04-21 10:42:30 +02:00
Laurens Valk b40c3989aa pybricks.common.Motor: Add Model() class instance. 
This is mainly used to debug the motor model, and to quickly select the
feedback parameters. This is useful when adding or configuring new motor
types.

Reading the estimated speed can also be useful in advanced applications
where the user builds their own PID controller.

We may choose to hide this method from the documentation before the
release.
 2023-02-09 10:25:15 +01:00
Laurens Valk 0e8b6cfd97 doc/main/cad/devices: Generate motor model. 2023-02-02 14:44:50 +01:00
Laurens Valk 44c6191b2f doc/main/diagrams_source: Add labels to DFU screenshots. 2022-12-19 10:55:20 -06:00
Laurens Valk 829b0ab97a doc/main/diagrams_source: Draft DFU screenshots. 2022-12-19 10:55:20 -06:00
Laurens Valk 1c5e390e13 doc/main/index: Clarify categories. 
This is more descriptive than just repeating the module name.
 2022-12-16 22:30:09 +01:00
Laurens Valk 585b1b8ba3 pybricks.parameters.Side: Change Technic Hub orientation. 
This makes it consistent with other hubs.

See: https://github.com/pybricks/support/issues/848

The IMU section was not included in V3.1 so it is not a breaking change,
but we add a versionchanged comment just in case.
 2022-12-09 14:23:01 +01:00
Laurens Valk d9dfd0e370 doc/common/extensions: Separate checkmark from image. 
This makes it easier to see when the images are small.

Fixes: https://github.com/pybricks/support/issues/838
 2022-12-09 08:35:33 +01:00
Laurens Valk e2710157f0 doc/main/hubs: Use width to set scale. 
Fixes https://github.com/pybricks/support/issues/844
 2022-12-08 20:07:11 +01:00
Laurens Valk 96a3c04836 doc/main/index: Drop links from menu. 
Table of contents can't be hidden based on tags, so we just remove them.

Instead, add a note in the body of the standalone version.

Fixes: https://github.com/pybricks/support/issues/839
 2022-12-08 09:47:04 +01:00
David Lechner e939c14fee docs/main/{prime,essential}hub: Remove beta note. 
We are close to final release, so these are no longer considered beta.
 2022-12-07 16:31:19 -06:00
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