mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 01:24:17 +00:00
doc: languages and terminology
This commit is contained in:
Laurens Valk
@@ -25,7 +25,7 @@
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
<dc:title></dc:title>
|
||||
<dc:title />
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
@@ -67,9 +67,9 @@
|
||||
inkscape:window-height="1043"
|
||||
id="namedview4"
|
||||
showgrid="false"
|
||||
inkscape:zoom="0.75"
|
||||
inkscape:cx="208.63819"
|
||||
inkscape:cy="324.28105"
|
||||
inkscape:zoom="0.75000002"
|
||||
inkscape:cx="430.67066"
|
||||
inkscape:cy="226.10152"
|
||||
inkscape:window-x="1920"
|
||||
inkscape:window-y="0"
|
||||
inkscape:window-maximized="1"
|
||||
@@ -199,16 +199,16 @@
|
||||
y="292.53476"
|
||||
x="257.90811"
|
||||
height="42.092525"
|
||||
width="274.44144"
|
||||
width="313.44144"
|
||||
id="rect946"
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.27988029;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<rect
|
||||
y="292.53476"
|
||||
x="257.90811"
|
||||
height="4"
|
||||
width="274.44144"
|
||||
width="313.44144"
|
||||
id="rect948"
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.27988029;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-style:normal;font-weight:normal;font-size:24.19441986px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#404140;fill-opacity:1;stroke:none;stroke-width:0.60486054"
|
||||
@@ -252,16 +252,16 @@
|
||||
d="m 227.46478,350.23507 h 67.17514"
|
||||
style="fill:none;stroke:#6ab0de;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
|
||||
<rect
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.27988029;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect962"
|
||||
width="274.44144"
|
||||
width="313.44144"
|
||||
height="42.092525"
|
||||
x="257.90811"
|
||||
y="340.80838" />
|
||||
<rect
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.27988029;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect964"
|
||||
width="274.44144"
|
||||
width="313.44144"
|
||||
height="4"
|
||||
x="257.90811"
|
||||
y="340.80838" />
|
||||
@@ -275,7 +275,7 @@
|
||||
y="371.39371"
|
||||
x="267.87827"
|
||||
id="tspan966"
|
||||
sodipodi:role="line">Search for your EV3</tspan></text>
|
||||
sodipodi:role="line">Search for your EV3 brick</tspan></text>
|
||||
<circle
|
||||
r="19.024944"
|
||||
cy="389.61261"
|
||||
@@ -308,16 +308,16 @@
|
||||
id="path1022"
|
||||
inkscape:connector-curvature="0" />
|
||||
<rect
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.45158863;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect872"
|
||||
width="199.95952"
|
||||
width="264.07053"
|
||||
height="42.092525"
|
||||
x="497.38162"
|
||||
y="57.1996" />
|
||||
<rect
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.45158863;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect874"
|
||||
width="199.95952"
|
||||
width="264.07053"
|
||||
height="4"
|
||||
x="497.38162"
|
||||
y="57.1996" />
|
||||
@@ -331,7 +331,7 @@
|
||||
y="87.784927"
|
||||
x="507.35178"
|
||||
id="tspan876"
|
||||
sodipodi:role="line">Select your EV3</tspan></text>
|
||||
sodipodi:role="line">Select your EV3 brick</tspan></text>
|
||||
<circle
|
||||
r="19.024944"
|
||||
cy="49.884659"
|
||||
@@ -362,16 +362,16 @@
|
||||
y="179.10568"
|
||||
x="257.90811"
|
||||
height="42.092525"
|
||||
width="453.77478"
|
||||
width="515.76447"
|
||||
id="rect1010"
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.27438617;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<rect
|
||||
y="179.10568"
|
||||
x="257.90811"
|
||||
height="4"
|
||||
width="453.77478"
|
||||
width="515.76447"
|
||||
id="rect1012"
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.27438617;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-style:normal;font-weight:normal;font-size:24.19441986px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#404140;fill-opacity:1;stroke:none;stroke-width:0.60486054"
|
||||
@@ -382,7 +382,7 @@
|
||||
id="tspan1014"
|
||||
x="267.87827"
|
||||
y="209.69101"
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054">Connect your EV3 with the USB cable</tspan></text>
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054">Connect your EV3 brick with the USB cable</tspan></text>
|
||||
<text
|
||||
id="text1020"
|
||||
y="183.34192"
|
||||
|
||||
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
@@ -200,7 +200,7 @@
|
||||
id="tspan925"
|
||||
x="450.8334"
|
||||
y="61.294502"
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054">Mini USB cable</tspan></text>
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054">Mini-USB cable</tspan></text>
|
||||
<path
|
||||
style="fill:none;stroke:#838383;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
|
||||
d="m 321.14228,303.04679 3.39982,17.75063"
|
||||
|
||||
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
@@ -3,9 +3,10 @@ Color Sorter
|
||||
|
||||
This example program for the color sorter lets you scan colored Technic beams using the Color Sensor.
|
||||
|
||||
Scan the colored beams one by one and add them to tray. A beep confirms that it has registered the color. When the tray is full or when you press the center button, the robot will start distributing the Technic bricks by color.
|
||||
Scan the colored beams one by one and add them to the tray. A beep confirms that it has registered the color. When the tray is full or when you press the center button, the robot will start distributing the Technic bricks by color.
|
||||
|
||||
You can find building instructions for the color sorter on the `LEGO Education website <https://le-www-live-s.legocdn.com/sc/media/lessons/mindstorms-ev3/building-instructions/ev3-model-core-set-color-sorter-c778563f88c986841453574495cb5ff1.pdf>`_.
|
||||
|
||||
You can find building instructions on the `LEGO Education website <https://le-www-live-s.legocdn.com/sc/media/lessons/mindstorms-ev3/building-instructions/ev3-model-core-set-color-sorter-c778563f88c986841453574495cb5ff1.pdf>`_.
|
||||
|
||||
.. figure:: ../images/color_sorter.jpg
|
||||
:width: 90 %
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
Robot Arm H25
|
||||
=====================
|
||||
|
||||
This example program makes the robot move the black wheel hub stacks around forever. Start the program with the black hubs positioned as show in the picture. The robot arm will first initialize and then start moving the hubs around.
|
||||
|
||||
You can find building instructions on the `LEGO Education website <https://le-www-live-s.legocdn.com/sc/media/lessons/mindstorms-ev3/building-instructions/ev3-model-core-set-robot-arm-h25-56cdb22c1e3a02f1770bda72862ce2bd.pdf>`_.
|
||||
This example program makes the robot move the black wheel hub stacks around forever. The robot arm will first initialize and then start moving the hubs around.
|
||||
|
||||
You can find building instructions for the robot on the `LEGO Education website <https://le-www-live-s.legocdn.com/sc/media/lessons/mindstorms-ev3/building-instructions/ev3-model-core-set-robot-arm-h25-56cdb22c1e3a02f1770bda72862ce2bd.pdf>`_.
|
||||
|
||||
Tip: When building the robot, reverse the orientation of the EV3 brick such that the microSD card is easily accessible.
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
Robot Educator
|
||||
=====================
|
||||
|
||||
This example makes the Robot Educator drive until it sees an obstacle. Then it backs up, turns around, and starts driving again.
|
||||
This example makes the Robot Educator drive until it sees an obstacle. It then backs up, turns around, and starts driving again.
|
||||
|
||||
You can find building instructions on the `LEGO Education website <https://education.lego.com/en-us/support/mindstorms-ev3/building-instructions#robot>`_.
|
||||
You can find building instructions for the Robot Educator on the `LEGO Education website <https://education.lego.com/en-us/support/mindstorms-ev3/building-instructions#robot>`_.
|
||||
|
||||
.. figure:: ../images/ultrasonic_sensor_driving_base.jpg
|
||||
:width: 50 %
|
||||
|
||||
@@ -28,7 +28,7 @@ Rotational speed, or *angular velocity* describes how fast something rotates, ex
|
||||
|
||||
For example, the rotational speed values of a :meth:`Motor <.ev3devices.Motor.speed>` or the :meth:`GyroSensor <.ev3devices.GyroSensor.speed>` are expressed in degrees per second.
|
||||
|
||||
While we recommend to work with degrees per second in your programs, you can use the following table to convert between commonly used units.
|
||||
While we recommend working with degrees per second in your programs, you can use the following table to convert between commonly used units.
|
||||
|
||||
+-----------+-------+-----------+
|
||||
| | deg/s | rpm |
|
||||
@@ -46,7 +46,7 @@ Distances are expressed in millimeters (mm) whenever possible.
|
||||
|
||||
For example, the distance value of the :meth:`UltrasonicSensor <.ev3devices.UltrasonicSensor.distance>` is measured in millimeters.
|
||||
|
||||
While we recommend to work with millimeters in your programs, you can use the following table to convert between commonly used units.
|
||||
While we recommend working with millimeters in your programs, you can use the following table to convert between commonly used units.
|
||||
|
||||
+---------+------+-----+--------+
|
||||
| | mm | cm | inch |
|
||||
@@ -93,7 +93,7 @@ rotational acceleration: deg/s/s
|
||||
--------------------------------
|
||||
Rotational acceleration, or *angular acceleration* describes how fast the rotational speed changes. This is expressed as the change of the number of degrees per second, during one second (deg/s/s). This is also commonly written as :math:`deg/s^2`.
|
||||
|
||||
For example, you can adjust the rotational acceleration setting of a :meth:`Motor <.ev3devices.Motor.set_run_settings>` to change how smoothly or how quickly a motor reaches the constant speed set point.
|
||||
For example, you can adjust the rotational acceleration setting of a :meth:`Motor <.ev3devices.Motor.set_run_settings>` to change how smoothly or how quickly it reaches the constant speed set point.
|
||||
|
||||
|
||||
.. _percentage:
|
||||
@@ -102,12 +102,12 @@ percentage: %
|
||||
--------------
|
||||
Some signals do not have specific units but range from a minimum (0%) to a maximum (100%). A specific type of percentages are :ref:`relative distances <relativedistance>`.
|
||||
|
||||
For example, the sound :meth:`volume <.ev3brick.sound.beep>` range from 0% to 100%.
|
||||
For example, the sound :meth:`volume <.ev3brick.sound.beep>` ranges from 0% to 100%.
|
||||
|
||||
.. _frequency:
|
||||
|
||||
frequency: Hz
|
||||
--------------
|
||||
Sound frequencies are expressed in Herz (Hz).
|
||||
Sound frequencies are expressed in Hertz (Hz).
|
||||
|
||||
For example, you can choose the frequency of a :meth:`beep <.ev3brick.sound.beep>` to change the pitch.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
Installation
|
||||
===================
|
||||
|
||||
This page guides you through the steps to collect and install everything you need to get started programming.
|
||||
This page guides you through the steps to collect and install everything you need to start programming.
|
||||
|
||||
What do you need?
|
||||
-----------------------------------------------------------
|
||||
@@ -15,13 +15,13 @@ To get started, you'll need:
|
||||
|
||||
- A microSD card
|
||||
|
||||
You'll need a card with a minimum size of 4GB and a maximum size of 32GB. This type of microSD cards is also known as microSDHC. We recommend cards with Application Performance Class A1.
|
||||
You'll need a card with a minimum capacity of 4GB and a maximum capacity of 32GB. This type of microSD cards is also known as microSDHC. We recommend cards with Application Performance Class A1.
|
||||
|
||||
- A microSD card slot or card reader in your computer
|
||||
|
||||
If your computer does not have a (micro)SD card slot, you can use an external USB (micro)SD card reader.
|
||||
|
||||
- A mini-USB cable, like the one included included with your EV3 set
|
||||
- A mini-USB cable, like the one included with your EV3 set
|
||||
|
||||
The typical configuration of this equipment is summarized in the figure below.
|
||||
|
||||
@@ -95,7 +95,7 @@ Make sure the EV3 brick is turned off. Insert the microSD card you prepared into
|
||||
:alt: sd
|
||||
:align: center
|
||||
|
||||
Inserting the finished microSD card into the EV3 brick
|
||||
Inserting the flashed microSD card into the EV3 brick
|
||||
|
||||
|
||||
Turning the EV3 brick on and off
|
||||
@@ -129,7 +129,7 @@ When you're not running a program, you can view motor and sensor values using th
|
||||
Going back to the original firmware
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You can go back to the LEGO® firmware and your LEGO® programs at any time. To do so:
|
||||
You can go back to the LEGO® firmware and your LEGO programs at any time. To do so:
|
||||
|
||||
1. Turn the EV3 brick off as shown above.
|
||||
2. Wait for the screen and brick status light to turn off.
|
||||
|
||||
+11
-11
@@ -1,13 +1,13 @@
|
||||
Creating and running programs
|
||||
=============================
|
||||
|
||||
Now that you've set up your computer and your EV3 brick, you're ready to start writing 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 below. 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, where the main program will be run.
|
||||
Programs are organized into *project folders*, as shown below. 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.
|
||||
This page shows you how to create such a project and how to transfer it to the EV3 brick.
|
||||
|
||||
|
||||
.. figure:: images/projectstructure.png
|
||||
@@ -46,7 +46,7 @@ If you are new to MicroPython programming, we recommend that you keep the existi
|
||||
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 this connection with Visual Studio Code. To do so:
|
||||
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
|
||||
@@ -62,9 +62,9 @@ To be able to transfer your code to the EV3 brick, you'll first need to connect
|
||||
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 below.
|
||||
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 below.
|
||||
|
||||
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.
|
||||
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 :mod:`print <.tools>` command, this is shown in the output window.
|
||||
|
||||
@@ -96,25 +96,25 @@ This program makes your robot beep, rotate the motor, and beep again with a high
|
||||
|
||||
.. _managefiles:
|
||||
|
||||
Managing files on the EV3
|
||||
Managing files on the EV3 brick
|
||||
-----------------------------------------------------------
|
||||
|
||||
After you've downloaded a project to the EV3, you can run, delete, or back up programs stored on the EV3 using the device browser:
|
||||
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:
|
||||
|
||||
.. figure:: images/files.png
|
||||
:width: 100 %
|
||||
:alt: alt
|
||||
:align: center
|
||||
|
||||
Using the EV3 device browser to manage files on your EV3
|
||||
Using the device browser to manage files on your EV3 brick
|
||||
|
||||
|
||||
Running a program without a computer
|
||||
-----------------------------------------------------------
|
||||
|
||||
You can run previously downloaded programs directly from the brick.
|
||||
You can run previously downloaded programs directly from the EV3 brick.
|
||||
|
||||
To do so, find the program using the *file browser* on the EV3 screen and use the center button key to start the program.
|
||||
To do so, find the program using the *file browser* on the EV3 screen and press the center button key to start the program.
|
||||
|
||||
.. figure:: images/manualrun.png
|
||||
:width: 100 %
|
||||
|
||||
Reference in New Issue
Block a user