doc: terminology and nomenclature

- EV3 brick - MicroPython - microSD card - EV3 MicroPython microSD card image
2026-07-28 04:07:46 +00:00 · 2019-02-25 14:04:21 +01:00
parent f568e01c1f
commit 15b2aab8a5
5 changed files with 50 additions and 58 deletions
@@ -75,7 +75,7 @@
     inkscape:window-maximized="1"
     inkscape:current-layer="svg2" />
  <image
-     sodipodi:absref="/home/laurens/pybricks/git/micropython/ports/pybricks/doc/source/_images/files.png"
+     sodipodi:absref="files.png"
     xlink:href="files.png"
     width="977"
     height="643"
@@ -84,7 +84,7 @@
     x="0"
     y="0" />
  <image
-     sodipodi:absref="/home/laurens/pybricks/git/micropython/ports/pybricks/doc/source/_images/files1.png"
+     sodipodi:absref="files1.png"
     xlink:href="files1.png"
     width="173"
     height="156"
@@ -100,7 +100,7 @@
     x="502.80865"
     y="210.17946" />
  <image
-     sodipodi:absref="/home/laurens/pybricks/git/micropython/ports/pybricks/doc/source/_images/files.png"
+     sodipodi:absref="files.png"
     xlink:href="files.png"
     transform="translate(-40.656854,-304.01429)"
     clip-path="url(#clipPath883)"
@@ -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>
@@ -44,9 +44,9 @@
     inkscape:window-height="1016"
     id="namedview4"
     showgrid="false"
-     inkscape:zoom="0.834386"
-     inkscape:cx="453.11103"
-     inkscape:cy="370.06923"
+     inkscape:zoom="2.36"
+     inkscape:cx="170.96633"
+     inkscape:cy="193.22709"
     inkscape:window-x="67"
     inkscape:window-y="27"
     inkscape:window-maximized="1"
@@ -54,13 +54,13 @@
  <image
     sodipodi:absref="overview.jpg"
     xlink:href="overview.jpg"
-     style="stroke-width:0.3199999"
-     width="800"
-     height="521"
-     preserveAspectRatio="none"
-     id="image852"
+     y="0"
     x="0"
-     y="0" />
+     id="image852"
+     preserveAspectRatio="none"
+     height="521"
+     width="800"
+     style="stroke-width:0.3199999" />
  <path
     style="fill:none;stroke:#6ab0de;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
     d="M 514.53044,444.44518 H 581.7056"
@@ -112,14 +112,14 @@
     style="opacity:1;fill:none;fill-opacity:1;stroke:#6ab0de;stroke-width:4;stroke-linecap:square;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
  <rect
     y="374.04733"
-     x="27.343678"
+     x="26.49622"
     height="42.092525"
     width="228.95509"
     id="rect4629"
     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" />
  <rect
     y="374.04733"
-     x="27.343678"
+     x="26.49622"
     height="4"
     width="228.95509"
     id="rect4631"
@@ -127,44 +127,44 @@
  <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"
-     x="37.313892"
+     x="36.466434"
     y="404.63257"
     id="text4635"><tspan
       sodipodi:role="line"
       id="tspan4633"
-       x="37.313892"
+       x="36.466434"
       y="404.63257"
       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">Download and run</tspan></text>
  <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"
     id="rect4651"
-     width="271.32797"
+     width="300.14154"
     height="73.236595"
-     x="27.343678"
+     x="26.49622"
     y="374.04733" />
  <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"
     id="rect4653"
-     width="271.32797"
+     width="300.14154"
     height="4"
-     x="27.343678"
+     x="26.49622"
     y="374.04733" />
  <text
     id="text4657"
     y="404.63257"
-     x="37.313892"
+     x="36.466434"
     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"
     xml:space="preserve"><tspan
       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"
       y="404.63257"
-       x="37.313892"
+       x="36.466434"
       id="tspan4655"
-       sodipodi:role="line">Micro SD card with</tspan><tspan
+       sodipodi:role="line">MicroSD card with</tspan><tspan
       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"
       y="435.71646"
-       x="37.313892"
+       x="36.466434"
       sodipodi:role="line"
-       id="tspan915">EV3 Python Firmware</tspan></text>
+       id="tspan915">EV3 MicroPython image</tspan></text>
  <path
     style="fill:none;stroke:#6ab0de;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
     d="M 474.94723,55.976055 H 407.77207"
@@ -247,5 +247,5 @@
       y="244.96677"
       x="37.086269"
       id="tspan4615"
-       sodipodi:role="line">EV3 Brick</tspan></text>
+       sodipodi:role="line">EV3 brick</tspan></text>
 </svg>
@@ -1,27 +1,19 @@
-Using Python with LEGO\ :sup:`®` MINDSTORMS\ :sup:`®` EV3
-=========================================================
-
-
-.. rubric:: Getting started
+Using MicroPython with LEGO\ :sup:`®` MINDSTORMS\ :sup:`®` EV3
+==============================================================

 This guide shows you how to get started writing MicroPython programs for your
 LEGO® MINDSTORMS® EV3 robots. You'll learn to do so in two steps:

 - :doc:`Installation <startinstall>`: First you'll prepare your computer and
-  your EV3 by collecting and installing the required tools. You'll also learn
+  your EV3 brick by collecting and installing the required tools. You'll also learn
  how to turn the EV3 brick on and off and to navigate the menu on the screen.

 - :doc:`Creating and running programs <startrun>`: Next, you'll learn how to
  create a program and download it to the EV3 brick. You'll also learn how to
-  start that program, with or without a computer nearby.
-
-
-.. rubric:: Pybricks Modules and Demo Programs
+  start that program from your computer or from the EV3 brick.

 After you've run the first demo program, you'll be ready to try out the example
-programs, or even invent your own programs. Follow the menu on the left to
-learn how to use the EV3 brick, EV3 motors, and EV3 sensors effectively in your
-programs.
+programs and start inventing your own programs.


 .. toctree::
@@ -18,8 +18,8 @@ You'll have to follow these steps only once.
 To get started, you'll need the following items:

 - A Windows 10 or Mac OS computer.
- A micro SD card. You'll need a card with a minimum size of 4GB and a maximum size of 32GB, also known as microSDHC cards. We recommend cards with Application Performance Class A1.
- A micro SD card slot or card reader.
+- A microSD card. You'll need a card with a minimum size of 4GB and a maximum size of 32GB, also known as microSDHC cards. We recommend cards with Application Performance Class A1.
+- A microSD card slot or card reader.
 - A mini-USB cable. The EV3 kit includes such a cable.

 You'll need internet access to complete the steps on this page. When programming your robots afterwards, internet access is not required.
@@ -51,20 +51,20 @@ You'll write your MicroPython programs using Visual Studio Code. Follow the step

 .. _prepsdcard:

-Preparing the micro SD Card
+Preparing the microSD card
 -----------------------------------------------------------

-You will now follow a series of steps to download and install the EV3 Python firmware onto your micro SD card. This "firmware" consists of `ev3dev <https://www.balena.io/etcher/>`_, along with all the tools to run Pybricks MicroPython programs.
+You will now follow a series of steps to download and install EV3 MicroPython onto your microSD card. This installation consists of `ev3dev <https://www.balena.io/etcher/>`_, along with all the tools to run Pybricks MicroPython programs.

-This process erases everything on your micro SD card, including any previous MicroPython programs on it. See :ref:`managing files on the EV3 <managefiles>` to learn how to backup your previous MicroPython programs if necessary.
+This process erases everything on your microSD card, including any previous MicroPython programs on it. See :ref:`managing files on the EV3 <managefiles>` to learn how to backup your previous MicroPython programs if necessary.

-1. Download the `EV3 Python firmware <.>`_ (approximately 360 MB) and save it in a convenient location. Do **not** open or unzip the file.
-2. Download and install an micro SD card flashing tool such as `Etcher <https://www.balena.io/etcher/>`_.
-3. Insert the micro SD card into your computer or card reader.
-4. Launch the flashing tool and follow the steps on your screen to install the firmware file you have just downloaded. If you use Etcher, you can follow the instructions in the diagram below:
+1. Download the `EV3 MicroPython microSD card image <.>`_ (approximately 360 MB) and save it in a convenient location. Do **not** open or unzip the file.
+2. Download and install an microSD card flashing tool such as `Etcher <https://www.balena.io/etcher/>`_.
+3. Insert the microSD card into your computer or card reader.
+4. Launch the flashing tool and follow the steps on your screen to install the file you have just downloaded. If you use Etcher, you can follow the instructions in the diagram below:

-    a. Select the firmware file you have just downloaded.
-    b. Select your micro SD card. Make sure that the device and size correspond to your micro SD card.
+    a. Select the EV3 MicroPython microSD card image file you have just downloaded.
+    b. Select your microSD card. Make sure that the device and size correspond to your microSD card.
    c. Start the flashing process. This may take several minutes. Do not remove the card until the installation process is complete.

 .. figure:: images/etcher.png
@@ -72,21 +72,21 @@ This process erases everything on your micro SD card, including any previous Mic
   :alt: etcher
   :align: center

-   Using Etcher to flash the firmware to the micro SD card
+   Using Etcher to flash the EV3 MicroPython microSD card image

-To update the firmware to the latest version, download the latest version and repeat this process. 
+To update the installation to the latest version, download the latest version and repeat this process. 

 Using the EV3 brick
 -----------------------------------------------------------

-Make sure the EV3 brick is turned off, and insert the micro SD card you just prepared into the SD card slot on the EV3, as shown below.
+Make sure the EV3 brick is turned off, and insert the microSD card you just prepared into the microSD card slot on the EV3, as shown below.

 .. figure:: images/sd.png
   :width: 75 %
   :alt: sd
   :align: center

-   Inserting the finished micro SD card into the EV3 brick
+   Inserting the finished microSD card into the EV3 brick


 Turning the EV3 brick on and off
@@ -111,7 +111,7 @@ You can go back to the LEGO® firmware and your LEGO® programs at any time. To

 1. Turn the EV3 off as shown above.
 2. Wait for the screen and light to turn off.
-3. Remove the micro SD card.
+3. Remove the microSD card.
 4. Turn the EV3 on.

 Viewing motor and sensor values
@@ -13,7 +13,7 @@ This page shows you how to create such a project and how to transfer it to the E
   :alt: alt
   :align: center

-   A project contains a program called **main.py** and optional resources like sounds or Python modules.
+   A project contains a program called **main.py** and optional resources like sounds or MicroPython modules.


 Creating a new project
@@ -30,7 +30,7 @@ To create a new project, open the Pybricks tab and click *create a new project*.

 When you create a new project, it already includes an example *main.py* file that you can modify and extend. To see its contents and to modify it, open it from the file browser as shown below.

-If you are new to Python or MicroPython programming, we recommend that you keep the existing code in place, and write your own code below it.
+If you are new to MicroPython programming, we recommend that you keep the existing code in place, and write your own code below it.

 .. figure:: images/projectoverview.png
   :width: 100 %