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
95a12a7386
pybricks.robotics: Drop note suggesting to flip motors.
...
This will still work, but it is asking for trouble when including the gyro.
So it is probably better not to mention this at all.
2023-04-21 10:42:30 +02:00
Laurens Valk
98f2bb27fe
pybricks.robotics.DriveBase: Drop positive direction.
...
This reverts commit e4650cb1c9 .
This is not needed for gyro support, so it is better to remove it
before it is ever released.
2023-04-21 10:42:30 +02:00
Laurens Valk
fdbd078388
pybricks._common.IMU: Heading is clockwise positive.
...
This is not a breaking change because heading() was never implemented until now.
2023-04-21 10:42:30 +02:00
Laurens Valk
ccd2b46819
pybricks.robotics.DriveBase: Revert gyro use via init.
...
This reverts commit dadaab6f61 .
We will introduce a separate class instead.
2023-04-21 10:42:30 +02:00
Laurens Valk
c0cb05dd74
pybricks.robotics.DriveBase: Document use of gyro.
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
c415296b71
pybricks._common.Motor: Document profile.
...
Fixes https://github.com/pybricks/support/issues/966
2023-03-20 15:12:36 +01:00
Laurens Valk
e4650cb1c9
pybricks.robotics.DriveBase: Document positive direction.
...
Fixes https://github.com/pybricks/support/issues/992
2023-03-20 14:22:25 +01:00
Laurens Valk
91154a394c
pybricks.robotics.DriveBase: Clarify settings method.
...
Fixes https://github.com/pybricks/support/issues/882
2023-03-20 14:00:42 +01:00
David Lechner
3c36010c04
pybricks.ev3devices: Fix Gyro direction parameter name.
...
The actual implemented name is `direction`, not `positive_direction`.
Fixes: https://github.com/pybricks/support/issues/509
2023-03-20 13:56:16 +01: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
428bca79ab
pybricks.common.Control: Document deadzone.
2023-02-02 14:45:34 +01: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
99d5210313
pybricks.robotics.DriveBase: Add stalled, done.
2022-12-02 12:43:24 +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
4d360d2b01
pybricks.parameters: Reduce floating warning to note.
...
This is a good case of a box. But nothing blows up if you try it, so a note suffices.
2022-12-01 16:59:08 +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
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
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
David Lechner
62f6fc85a5
jedi: fix code completion for Color and Icon
...
The pybricks.parameters.Color and Icon types were not working with Jedi
for code completion since the constants were never assigned a value.
2022-11-10 12:23:24 -06: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
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
Laurens Valk
abc00df943
pybricks.pupdevices: Avoid class-specific LightArray.
...
Let's minimize complicated hacks if we can help it.
2022-09-30 16:04:33 +02:00
The Vinh Luong (Lương Thế Vinh)
dcddf15d15
flake8: Update VSCode settings and suppress some Flake8 linting warnings.
...
* update VSCode settings to exclude __pycache__
* suppress some Flake8 linting warnings
* minor fix: SPHINX_BUILD env var may not be set
* decorate _PybricksEnumMeta.__dir__() with @classmethod
* flake8-ignore E501
2022-09-05 18:40:39 -05:00
The Vinh Luong (Lương Thế Vinh)
c64458d3b9
parameters: Fix wrong typing in pybricks.parameters.Stop.
2022-09-05 18:38:29 -05:00
David 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ý
025147680c
pybricks.hubs.EssentialHub: Added missing Hub
2022-06-29 12:08:33 -05:00
David Lechner
e95386e23e
jedi: improve signature information
...
This fixes numerous issues where jedi provided incomplete or poorly
formatted signatures and docstrings.
Issue: https://github.com/pybricks/pybricks-code/issues/932
2022-06-25 23:54:49 -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
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
6500440031
pybricks: Drop most ellipsis and pass instances.
...
See [1]: "I still prefer ... over pass. This clarifies to the readers that they are reading a stub. But if there's a docstring we need neither."
[1] https://github.com/srittau/type-stub-pep/issues/88#issuecomment-758843441
Fixes https://github.com/pybricks/pybricks-api/issues/101#issuecomment-1148780369
2022-06-10 10:46:44 +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
f67c98105a
pybricks.parameters: Add typing, part 1.
2022-06-10 10:05:13 +02:00
Laurens Valk
877391dea7
pybricks.parameters: Add typing.
2022-06-10 10:05:13 +02:00
Laurens Valk
fb3446ad0d
pybricks.robotics: Add typing.
2022-06-10 10:05:12 +02:00
Laurens Valk
31256d70c1
pybricks.tools: Add typing.
2022-06-10 10:05:12 +02:00
Laurens Valk
f87e1b48ac
pybricks.messaging: Add typing.
2022-06-10 10:05:12 +02:00
Laurens Valk
6bcf6117c3
pybricks.hubs: Add typing.
2022-06-10 10:05:11 +02:00
Laurens Valk
c77682f50d
pybricks.iodevices: Add typing.
2022-06-10 10:05:11 +02:00