mirror of
https://github.com/espressif/esp-idf.git
synced 2025-10-04 02:50:58 +02:00
docs: Move main docs to cover CMake
Add "GNU Make build system" doc with "cheat sheet" for moving to new system
This commit is contained in:
Angus Gratton
committed by
Angus Gratton
Angus Gratton
parent
8453806a8c
commit
c7f19e76d7
@@ -2,7 +2,10 @@
|
||||
Get Started
|
||||
***********
|
||||
|
||||
This document is intended to help users set up the software environment for developement of applications using hardware based on the Espressif ESP32. Through a simple example we would like to illustrate how to use ESP-IDF (Espressif IoT Development Framework), including the menu based configuration, compiling the ESP-IDF and firmware download to ESP32 boards.
|
||||
This document is intended to help users set up the software environment for developement of applications using hardware based on the Espressif ESP32. Through a simple example we would like to illustrate how to use ESP-IDF (Espressif IoT Development Framework), including the menu based configuration, compiling the ESP-IDF and firmware download to ESP32 boards.
|
||||
|
||||
.. note::
|
||||
The CMake-based build system is currently in preview release. Documentation may have missing gaps, and you may enocunter bugs (please report these). To view documentation for the older GNU Make based build system, switch versions to the 'latest' master branch or a stable release.
|
||||
|
||||
|
||||
Introduction
|
||||
@@ -99,13 +102,12 @@ The quickest way to start development with ESP32 is by installing a prebuilt too
|
||||
|
||||
.. note::
|
||||
|
||||
We are using ``~/esp`` directory to install the prebuilt toolchain, ESP-IDF and sample applications. You can use different directory, but need to adjust respective commands.
|
||||
We are an using ``esp`` subdirectory in your user's home directory (``~/esp`` on Linux and Mac OS, ``%userprofile%\esp`` on Windows) to install everything needed for ESP-IDF. You can use any different directory, but will need to adjust the respective commands.
|
||||
|
||||
Depending on your experience and preferences, instead of using a prebuilt toolchain, you may want to customize your environment. To set up the system your own way go to section :ref:`get-started-customized-setup`.
|
||||
|
||||
Once you are done with setting up the toolchain then go to section :ref:`get-started-get-esp-idf`.
|
||||
|
||||
|
||||
.. _get-started-get-esp-idf:
|
||||
|
||||
Get ESP-IDF
|
||||
@@ -115,26 +117,42 @@ Get ESP-IDF
|
||||
|
||||
Besides the toolchain (that contains programs to compile and build the application), you also need ESP32 specific API / libraries. They are provided by Espressif in `ESP-IDF repository <https://github.com/espressif/esp-idf>`_. To get it, open terminal, navigate to the directory you want to put ESP-IDF, and clone it using ``git clone`` command::
|
||||
|
||||
mkdir -p ~/esp
|
||||
cd ~/esp
|
||||
git clone --recursive https://github.com/espressif/esp-idf.git
|
||||
|
||||
ESP-IDF will be downloaded into ``~/esp/esp-idf``.
|
||||
|
||||
.. highlight:: batch
|
||||
|
||||
For Windows Command Prompt users, the equivalent commands are::
|
||||
|
||||
mkdir %userprofile%\esp
|
||||
cd %userprofile%\esp
|
||||
git clone --recursive https://github.com/espressif/esp-idf.git
|
||||
|
||||
.. highlight:: bash
|
||||
.. note::
|
||||
|
||||
Do not miss the ``--recursive`` option. If you have already cloned ESP-IDF without this option, run another command to get all the submodules::
|
||||
|
||||
cd ~/esp/esp-idf
|
||||
cd esp-idf
|
||||
git submodule update --init
|
||||
|
||||
|
||||
.. _get-started-setup-path:
|
||||
|
||||
Setup Path to ESP-IDF
|
||||
=====================
|
||||
Setup Environment Variables
|
||||
===========================
|
||||
|
||||
The toolchain programs access ESP-IDF using ``IDF_PATH`` environment variable. This variable should be set up on your PC, otherwise projects will not build. Setting may be done manually, each time PC is restarted. Another option is to set up it permanently by defining ``IDF_PATH`` in user profile. To do so, follow instructions specific to :ref:`Windows <add-idf_path-to-profile-windows>` , :ref:`Linux and MacOS <add-idf_path-to-profile-linux-macos>` in section :doc:`add-idf_path-to-profile`.
|
||||
ESP-IDF requires two environment variables to be set for normal operation:
|
||||
|
||||
- ``IDF_PATH`` should be set to the path to the ESP-IDF root directory.
|
||||
- ``PATH`` should include the path to the ``tools`` directory inside the same ``IDF_PATH`` directory.
|
||||
|
||||
These two variables should be set up on your PC, otherwise projects will not build.
|
||||
|
||||
Setting may be done manually, each time PC is restarted. Another option is to set them permanently in user profile. To do this, follow instructions specific to :ref:`Windows <add-paths-to-profile-windows>` , :ref:`Linux and MacOS <add-idf_path-to-profile-linux-macos>` in section :doc:`add-idf_path-to-profile`.
|
||||
|
||||
.. _get-started-start-project:
|
||||
|
||||
@@ -143,13 +161,24 @@ Start a Project
|
||||
|
||||
Now you are ready to prepare your application for ESP32. To start off quickly, we will use :example:`get-started/hello_world` project from :idf:`examples` directory in IDF.
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
Copy :example:`get-started/hello_world` to ``~/esp`` directory::
|
||||
|
||||
cd ~/esp
|
||||
cp -r $IDF_PATH/examples/get-started/hello_world .
|
||||
|
||||
.. highlight:: batch
|
||||
|
||||
For Windows Command Prompt users, the equivalent commands are::
|
||||
|
||||
cd %userprofile%\esp
|
||||
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world
|
||||
|
||||
You can also find a range of example projects under the :idf:`examples` directory in ESP-IDF. These example project directories can be copied in the same way as presented above, to begin your own projects.
|
||||
|
||||
It is also possible to build examples in-place, without copying them first.
|
||||
|
||||
.. important::
|
||||
|
||||
The esp-idf build system does not support spaces in paths to esp-idf or to projects.
|
||||
@@ -168,12 +197,27 @@ You are almost there. To be able to proceed further, connect ESP32 board to PC,
|
||||
Configure
|
||||
=========
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
Being in terminal window, go to directory of ``hello_world`` application by typing ``cd ~/esp/hello_world``. Then start project configuration utility ``menuconfig``::
|
||||
|
||||
cd ~/esp/hello_world
|
||||
make menuconfig
|
||||
idf.py menuconfig
|
||||
|
||||
If previous steps have been done correctly, the following menu will be displayed:
|
||||
.. highlight:: batch
|
||||
|
||||
For Windows Command Prompt users::
|
||||
|
||||
cd %userprofile%\esp
|
||||
idf.py menuconfig
|
||||
|
||||
.. note:: If you get an error about ``idf.py`` not being found, check the ``tools`` directory is part of your Path as described above in :ref:`get-started-setup-path`.
|
||||
|
||||
.. note:: Windows users, the Python 2.7 installer will try to configure Windows to associate files with a ``.py`` extension with Python 2. If a separate installed program (such as Visual Studio Python Tools) has created an association with a different version of Python, then running ``idf.py`` may not work. You can either run ``C:\Python27\python idf.py`` each time instead, or change the association that Windows uses for ``.py`` files.
|
||||
|
||||
.. note:: Linux users, if your default version of Python is 3.x then you may need to run ``python2 idf.py`` instead.
|
||||
|
||||
If previous steps have been done correctly, the following menu will be displayed:
|
||||
|
||||
.. figure:: ../../_static/project-configuration.png
|
||||
:align: center
|
||||
@@ -182,13 +226,6 @@ If previous steps have been done correctly, the following menu will be displayed
|
||||
|
||||
Project configuration - Home window
|
||||
|
||||
In the menu, navigate to ``Serial flasher config`` > ``Default serial port`` to configure the serial port, where project will be loaded to. Confirm selection by pressing enter, save configuration by selecting ``< Save >`` and then exit application by selecting ``< Exit >``.
|
||||
|
||||
.. note::
|
||||
|
||||
On Windows, serial ports have names like COM1. On MacOS, they start with ``/dev/cu.``. On Linux, they start with ``/dev/tty``.
|
||||
(See :doc:`establish-serial-connection` for full details.)
|
||||
|
||||
Here are couple of tips on navigation and use of ``menuconfig``:
|
||||
|
||||
* Use up & down arrow keys to navigate the menu.
|
||||
@@ -202,15 +239,18 @@ Here are couple of tips on navigation and use of ``menuconfig``:
|
||||
|
||||
If you are **Arch Linux** user, navigate to ``SDK tool configuration`` and change the name of ``Python 2 interpreter`` from ``python`` to ``python2``.
|
||||
|
||||
|
||||
.. _get-started-build-flash:
|
||||
|
||||
Build and Flash
|
||||
===============
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
Now you can build and flash the application. Run::
|
||||
|
||||
make flash
|
||||
idf.py -p PORT flash
|
||||
|
||||
Replace PORT with the name of your ESP32 board's serial port. On Windows, serial ports have names like ``COM1``. On MacOS, they start with ``/dev/cu.``. On Linux, they start with ``/dev/tty``. (See :doc:`establish-serial-connection` for full details.)
|
||||
|
||||
This will compile the application and all the ESP-IDF components, generate bootloader, partition table, and application binaries, and flash these binaries to your ESP32 board.
|
||||
|
||||
@@ -218,35 +258,38 @@ This will compile the application and all the ESP-IDF components, generate bootl
|
||||
|
||||
::
|
||||
|
||||
esptool.py v2.0-beta2
|
||||
Flashing binaries to serial port /dev/ttyUSB0 (app at offset 0x10000)...
|
||||
esptool.py v2.0-beta2
|
||||
Connecting........___
|
||||
Uploading stub...
|
||||
Running stub...
|
||||
Stub running...
|
||||
Changing baud rate to 921600
|
||||
Changed.
|
||||
Attaching SPI flash...
|
||||
Configuring flash size...
|
||||
Auto-detected Flash size: 4MB
|
||||
Flash params set to 0x0220
|
||||
Compressed 11616 bytes to 6695...
|
||||
Wrote 11616 bytes (6695 compressed) at 0x00001000 in 0.1 seconds (effective 920.5 kbit/s)...
|
||||
Hash of data verified.
|
||||
Compressed 408096 bytes to 171625...
|
||||
Wrote 408096 bytes (171625 compressed) at 0x00010000 in 3.9 seconds (effective 847.3 kbit/s)...
|
||||
Hash of data verified.
|
||||
Compressed 3072 bytes to 82...
|
||||
Wrote 3072 bytes (82 compressed) at 0x00008000 in 0.0 seconds (effective 8297.4 kbit/s)...
|
||||
Hash of data verified.
|
||||
Running esptool.py in directory [...]/esp/hello_world
|
||||
Executing "python [...]/esp-idf/components/esptool_py/esptool/esptool.py -b 460800 write_flash @flash_project_args"...
|
||||
esptool.py -b 460800 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x1000 bootloader/bootloader.bin 0x8000 partition_table/partition-table.bin 0x10000 hello-world.bin
|
||||
esptool.py v2.3.1
|
||||
Connecting....
|
||||
Detecting chip type... ESP32
|
||||
Chip is ESP32D0WDQ6 (revision 1)
|
||||
Features: WiFi, BT, Dual Core
|
||||
Uploading stub...
|
||||
Running stub...
|
||||
Stub running...
|
||||
Changing baud rate to 460800
|
||||
Changed.
|
||||
Configuring flash size...
|
||||
Auto-detected Flash size: 4MB
|
||||
Flash params set to 0x0220
|
||||
Compressed 22992 bytes to 13019...
|
||||
Wrote 22992 bytes (13019 compressed) at 0x00001000 in 0.3 seconds (effective 558.9 kbit/s)...
|
||||
Hash of data verified.
|
||||
Compressed 3072 bytes to 82...
|
||||
Wrote 3072 bytes (82 compressed) at 0x00008000 in 0.0 seconds (effective 5789.3 kbit/s)...
|
||||
Hash of data verified.
|
||||
Compressed 136672 bytes to 67544...
|
||||
Wrote 136672 bytes (67544 compressed) at 0x00010000 in 1.9 seconds (effective 567.5 kbit/s)...
|
||||
Hash of data verified.
|
||||
|
||||
Leaving...
|
||||
Hard resetting...
|
||||
Leaving...
|
||||
Hard resetting via RTS pin...
|
||||
|
||||
If there are no issues, at the end of build process, you should see messages describing progress of loading process. Finally, the end module will be reset and "hello_world" application will start.
|
||||
If there are no issues, at the end of build process, you should see messages describing progress of flashing the project binary image onto the ESP32. Finally, the module will be reset and "hello_world" application will be running there.
|
||||
|
||||
If you'd like to use the Eclipse IDE instead of running ``make``, check out the :doc:`Eclipse guide <eclipse-setup>`.
|
||||
If you'd like to use the Eclipse IDE instead of running ``idf.py``, check out the :doc:`Eclipse guide <eclipse-setup>`.
|
||||
|
||||
|
||||
.. _get-started-build-monitor:
|
||||
@@ -254,10 +297,11 @@ If you'd like to use the Eclipse IDE instead of running ``make``, check out the
|
||||
Monitor
|
||||
=======
|
||||
|
||||
To see if "hello_world" application is indeed running, type ``make monitor``. This command is launching :doc:`IDF Monitor <idf-monitor>` application::
|
||||
To see if "hello_world" application is indeed running, type ``idf.py monitor``. This command is launching :doc:`IDF Monitor <idf-monitor>` application::
|
||||
|
||||
$ make monitor
|
||||
MONITOR
|
||||
$ idf.py monitor
|
||||
Running idf_monitor in directory [...]/esp/hello_world/build
|
||||
Executing "python [...]/esp-idf/tools/idf_monitor.py -b 115200 [...]/esp/hello_world/build/hello-world.elf"...
|
||||
--- idf_monitor on /dev/ttyUSB0 115200 ---
|
||||
--- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
|
||||
ets Jun 8 2016 00:22:57
|
||||
@@ -276,7 +320,7 @@ Several lines below, after start up and diagnostic log, you should see "Hello wo
|
||||
Restarting in 8 seconds...
|
||||
Restarting in 7 seconds...
|
||||
|
||||
To exit the monitor use shortcut ``Ctrl+]``.
|
||||
To exit the monitor use shortcut ``Ctrl+]``.
|
||||
|
||||
.. note::
|
||||
|
||||
@@ -285,11 +329,19 @@ To exit the monitor use shortcut ``Ctrl+]``.
|
||||
e<EFBFBD><EFBFBD><EFBFBD>)(Xn@<40>y.!<21><>(<28>PW+)<29><>Hn9a/9<>!<21>t5<74><35>P<EFBFBD>~<7E>k<EFBFBD><6B>e<EFBFBD>ea<65>5<EFBFBD>jA
|
||||
~zY<7A><59>Y(1<>,1<15><> e<><65><EFBFBD>)(Xn@<40>y.!Dr<44>zY(<28>jpi<70>|<7C>+z5Ymvp
|
||||
|
||||
or monitor fails shortly after upload, your board is likely using 26MHz crystal, while the ESP-IDF assumes default of 40MHz. Exit the monitor, go back to the :ref:`menuconfig <get-started-configure>`, change :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` to 26MHz, then :ref:`build and flash <get-started-build-flash>` the application again. This is found under ``make menuconfig`` under Component config --> ESP32-specific --> Main XTAL frequency.
|
||||
or monitor fails shortly after upload, your board is likely using 26MHz crystal, while the ESP-IDF assumes default of 40MHz. Exit the monitor, go back to the :ref:`menuconfig <get-started-configure>`, change :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` to 26MHz, then :ref:`build and flash <get-started-build-flash>` the application again. This is found under ``idf.py menuconfig`` under Component config --> ESP32-specific --> Main XTAL frequency.
|
||||
|
||||
To execute ``make flash`` and ``make monitor`` in one go, type ``make flash monitor``. Check section :doc:`IDF Monitor <idf-monitor>` for handy shortcuts and more details on using this application.
|
||||
.. note::
|
||||
|
||||
That's all what you need to get started with ESP32!
|
||||
You can combine building, flashing and monitoring into one step as follows::
|
||||
|
||||
idf.py -p PORT flash monitor
|
||||
|
||||
Check the section :doc:`IDF Monitor <idf-monitor>` for handy shortcuts and more details on using the monitor.
|
||||
|
||||
Check the section :ref:`idf.py` for a full reference of ``idf.py`` commands and options.
|
||||
|
||||
That's all what you need to get started with ESP32!
|
||||
|
||||
Now you are ready to try some other :idf:`examples`, or go right to developing your own applications.
|
||||
|
||||
@@ -299,14 +351,26 @@ Updating ESP-IDF
|
||||
|
||||
After some time of using ESP-IDF, you may want to update it to take advantage of new features or bug fixes. The simplest way to do so is by deleting existing ``esp-idf`` folder and cloning it again, exactly as when doing initial installation described in sections :ref:`get-started-get-esp-idf`.
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
Another solution is to update only what has changed. This method is useful if you have a slow connection to GitHub. To do the update run the following commands::
|
||||
|
||||
cd ~/esp/esp-idf
|
||||
git pull
|
||||
git submodule update --init --recursive
|
||||
|
||||
.. highlight:: batch
|
||||
|
||||
For Windows Command Prompt users::
|
||||
|
||||
cd %userprofile%\esp
|
||||
git pull
|
||||
git submodule update --init --recursive
|
||||
|
||||
The ``git pull`` command is fetching and merging changes from ESP-IDF repository on GitHub. Then ``git submodule update --init --recursive`` is updating existing submodules or getting a fresh copy of new ones. On GitHub the submodules are represented as links to other repositories and require this additional command to get them onto your PC.
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
If you would like to use specific release of ESP-IDF, e.g. `v2.1`, run::
|
||||
|
||||
cd ~/esp
|
||||
@@ -315,8 +379,22 @@ If you would like to use specific release of ESP-IDF, e.g. `v2.1`, run::
|
||||
git checkout v2.1
|
||||
git submodule update --init --recursive
|
||||
|
||||
.. highlight:: batch
|
||||
|
||||
For Windows Command Prompt users::
|
||||
|
||||
cd %userprofile%\esp
|
||||
git clone https://github.com/espressif/esp-idf.git esp-idf-v2.1
|
||||
cd esp-idf-v2.1/
|
||||
git checkout v2.1
|
||||
git submodule update --init --recursive
|
||||
|
||||
After that remember to :doc:`add-idf_path-to-profile`, so the toolchain scripts know where to find the ESP-IDF in it's release specific location.
|
||||
|
||||
.. note::
|
||||
|
||||
Different versions of ESP-IDF may have different setup or prerequisite requirements, or require different toolchain versions. If you experience any problems, carefully check the Getting Started documentation for the version you are switching to.
|
||||
|
||||
|
||||
Related Documents
|
||||
=================
|
||||
|
||||
Reference in New Issue
Block a user