Files
pybricks-api/doc/api/start_ev3_run.inc
T

167 lines
5.1 KiB
HTML

Creating and running programs
=============================
Now that you've set up your computer and EV3 Brick, you're ready to start
writing programs.
To make it easier to create and manage your programs, let's first have a quick
look at how MicroPython projects and programs for your EV3 robots are
organized.
Programs are organized into *project folders*, as shown in
:numref:`fig_projectstructure`. A project folder is a directory on your
computer that contains the main program (**main.py**) and other optional
scripts or files. This project folder and all of its contents will be copied
to the EV3 Brick, where the main program will be run.
This page shows you how to create such a project and how to transfer it to the
EV3 Brick.
.. _fig_projectstructure:
.. figure:: ../api/images/projectstructure_label.png
:width: 100 %
:alt: projectstructure
:align: center
A project contains a program called **main.py** and optional resources like
sounds or MicroPython modules.
Creating a new project
-----------------------------------------------------------
To create a new project, open the EV3 MicroPython tab and
click *create a new project*, as shown in :numref:`fig_newproject`. Enter a
project name in the text field that appears and press *Enter*. When prompted,
choose a location for this program and confirm by clicking *choose folder*.
.. _fig_newproject:
.. figure:: ../api/images/newproject_label.png
:width: 100 %
:alt: newproject
:align: center
Creating a new project. This example is called *getting_started*, but you
can choose any name.
When you create a new project, it already includes a file called *main.py*. To
see its contents and to modify it, open it from the file browser as shown in
:numref:`fig_projectoverview`. This is where you'll write your programs.
If you are new to MicroPython programming, we recommend that you keep the
existing code in place and add your code to it.
.. _fig_projectoverview:
.. figure:: ../api/images/projectoverview_label.png
:width: 100 %
:alt: projectoverview
:align: center
Opening the default *main.py* program.
Opening an existing project
-----------------------------------------------------------
To open a project you created previously, click *File* and click
*Open Folder*, as shown in :numref:`fig_existingproject`. Next, navigate to
your previously created project folder and click *OK*. You can also open your
recently used projects using the *Open Recent* menu option.
.. _fig_existingproject:
.. figure:: ../api/images/existingproject_label.png
:width: 75 %
:alt: existingproject
:align: center
Opening a previously created project.
Connecting to the EV3 Brick with Visual Studio Code
-----------------------------------------------------------
To be able to transfer your code to the EV3 Brick, you'll first need to
connect the EV3 Brick to your computer with the mini-USB cable and configure
the connection with Visual Studio Code. To do so:
- Turn the EV3 Brick on
- Connect the EV3 Brick to your computer with the mini-USB cable
- Configure the USB connection as shown in :numref:`fig_connecting`.
.. _fig_connecting:
.. figure:: ../api/images/connecting_label.png
:width: 100 %
:alt: connecting
:align: center
Configuring the USB connection between the computer and the EV3 Brick
Downloading and running a program
-----------------------------------------------------------
You can press the F5 key to run the program. Alternatively, you can start it
manually by going to the *debug* tab and clicking the green start arrow, as
shown in :numref:`fig_running`.
When the program starts, a pop-up toolbar allows you to stop the program if
necessary. You can also stop the program at any time using the back button on
the EV3 Brick.
If your program produces any output with the ``print`` command, this is shown
in the output window.
.. _fig_running:
.. figure:: ../api/images/running_label.png
:width: 100 %
:alt: running
:align: center
Running a program
Expanding the example program
-----------------------------------------------------------
Now that you've run the basic code template, you can expand the program to
make a motor move. First, attach a Large Motor to Port B on the EV3 Brick,
as shown in :numref:`fig_firstprogram`.
.. _fig_firstprogram:
.. figure:: ../api/images/firstprogram_label.png
:width: 100 %
:alt: firstprogram
:align: center
The EV3 Brick with a Large Motor attached to port B.
Next, edit *main.py* to make it look like this:
.. literalinclude::
../../examples/ev3/getting_started/main.py
This program makes your robot beep, rotate the motor, and beep again with a
higher pitched tone. Run the program to make sure that it works as expected.
.. _managefiles:
Managing files on the EV3 Brick
-----------------------------------------------------------
After you've downloaded a project to the EV3 Brick, you can run, delete, or
back up programs stored on it using the device browser as shown in
:numref:`fig_files`.
.. _fig_files:
.. figure:: ../api/images/files_label.png
:width: 100 %
:alt: files
:align: center
Using the EV3 device browser to manage files on your EV3 Brick