mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-07-27 19:57:02 +00:00
94 lines
1.9 KiB
ReStructuredText
94 lines
1.9 KiB
ReStructuredText
Pybricks API Documentation
|
|
==================================================================
|
|
|
|
This documentation has everything you need to install Pybricks and
|
|
run your first scripts.
|
|
|
|
|
|
**Step 1: Install Pybricks**
|
|
|
|
Pybricks scripts are the same across all hubs. The only difference is in how
|
|
you install Pybricks and how you run scripts. To get started, click one of
|
|
the platforms below.
|
|
|
|
.. list-table::
|
|
|
|
* - **MINDSTORMS EV3**
|
|
- **Powered Up (Technic/City/BOOST)**
|
|
- **SPIKE / MINDSTORMS Inventor**
|
|
|
|
* - .. image:: ../api/images/ev3brick.png
|
|
:target: https://pybricks.com/install/mindstorms-ev3/installation
|
|
|
|
- .. figure:: ../api/images/powereduphubs.png
|
|
:target: https://pybricks.com/install/technic-boost-city/
|
|
|
|
- .. figure:: ../api/images/primeinventorhub.png
|
|
:target: https://pybricks.com/install/spike-mindstorms/
|
|
|
|
|
|
**Step 2: Start coding!**
|
|
|
|
After you've followed the installation steps for your hub,
|
|
check out the Pybricks modules in the left hand menu to see what
|
|
you can do.
|
|
|
|
**Step 3: Share what you made (or ask for help!)**
|
|
|
|
Got questions or issues? Please share your
|
|
findings on our `support page`_ so we can make Pybricks even better.
|
|
*Thank you!*
|
|
|
|
|
|
.. _support page: https://github.com/pybricks/support/issues/
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Table of Contents
|
|
:hidden:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Pybricks
|
|
:hidden:
|
|
|
|
Home Page <https://pybricks.com>
|
|
Installation <https://pybricks.com/install/>
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Pybricks Modules
|
|
:hidden:
|
|
|
|
hubs/index
|
|
pupdevices/index
|
|
ev3devices
|
|
nxtdevices
|
|
iodevices/index
|
|
parameters/index
|
|
tools/index
|
|
robotics
|
|
media
|
|
messaging
|
|
geometry
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Additional Modules
|
|
:hidden:
|
|
|
|
micropython
|
|
uerrno
|
|
uio
|
|
urandom
|
|
uselect
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Engineering Extras
|
|
:hidden:
|
|
|
|
signaltypes
|
|
motors
|
|
.. frames
|