mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-11 17:14:41 +00:00
Laurens Valk
b40c3989aa
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.
Pybricks end-user API & Documentation ===================================== This repository documents the Pybricks end-user MicroPython API. Each `Pybricks firmware`_ comes with the `Pybricks package`_. All modules, classes, methods, and functions in that package have optimized implementations in C for high performance and reduced memory footprint. This repository provides an empty, pure Python blueprint of that package. It is used to generate the `official documentation`_. See the `contributor's guide <CONTRIBUTING.md>`_ for acceptable changes and instructions to build the documentation locally. You can use the API stubs in this repository for syntax highlighting and code completion when programming the EV3 with VS Code. To enable, remove the ``"python.languageServer"="None"`` line in the ``.vscode/settings.json`` file generated by the *LEGO® MINDSTORMS® EV3 MicroPython* extension. For general discussion, please visit the `support`_ issue tracker. .. _Pybricks package: pybricks .. _Pybricks firmware: https://github.com/pybricks/pybricks-micropython .. _official documentation: https://docs.pybricks.com/ .. _support: https://github.com/pybricks/support/issues