kopia lustrzana https://github.com/espressif/esp-idf
431 wiersze
19 KiB
ReStructuredText
431 wiersze
19 KiB
ReStructuredText
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1", esp32c2="1"}
|
|
|
|
{IDF_TARGET_FEATURES:default="[NEEDS TO BE UPDATED]", esp32="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32s2="WiFi, silicon revision 0, 2MB external flash", esp32s3="This is esp32s3 chip with 2 CPU core(s), WiFi/BLE, silicon revision 0, 2MB external flash", esp32c2="WiFi/BLE, silicon revision 0, 2MB external flash", esp32c3="WiFi/BLE, silicon revision 0, 2MB external flash"}
|
|
|
|
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332"}
|
|
|
|
Build the Project
|
|
=================
|
|
|
|
Build the project by running:
|
|
|
|
.. code-block:: batch
|
|
|
|
idf.py build
|
|
|
|
This command will compile the application and all ESP-IDF components, then it will generate the bootloader, partition table, and application binaries.
|
|
|
|
.. code-block:: none
|
|
|
|
$ idf.py build
|
|
Running cmake in directory /path/to/hello_world/build
|
|
Executing "cmake -G Ninja --warn-uninitialized /path/to/hello_world"...
|
|
Warn about uninitialized values.
|
|
-- Found Git: /usr/bin/git (found version "2.17.0")
|
|
-- Building empty aws_iot component due to configuration
|
|
-- Component names: ...
|
|
-- Component paths: ...
|
|
|
|
... (more lines of build system output)
|
|
|
|
[527/527] Generating hello_world.bin
|
|
esptool.py v2.3.1
|
|
|
|
Project build complete. To flash, run this command:
|
|
../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello_world.bin build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
|
|
or run 'idf.py -p PORT flash'
|
|
|
|
If there are no errors, the build will finish by generating the firmware binary .bin files.
|
|
|
|
|
|
Flash onto the Device
|
|
=====================
|
|
|
|
Flash the binaries that you just built (bootloader.bin, partition-table.bin and hello_world.bin) onto your {IDF_TARGET_NAME} board by running:
|
|
|
|
.. code-block:: bash
|
|
|
|
idf.py -p PORT [-b BAUD] flash
|
|
|
|
Replace PORT with your {IDF_TARGET_NAME} board's serial port name.
|
|
|
|
You can also change the flasher baud rate by replacing BAUD with the baud rate you need. The default baud rate is ``460800``.
|
|
|
|
For more information on idf.py arguments, see :ref:`idf.py`.
|
|
|
|
.. note::
|
|
|
|
The option ``flash`` automatically builds and flashes the project, so running ``idf.py build`` is not necessary.
|
|
|
|
Encountered Issues While Flashing?
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9"}
|
|
|
|
If you run the given command and see errors such as "Failed to connect", there might be several reasons for this. One of the reasons might be issues encountered by ``esptool.py``, the utility that is called by the build system to reset the chip, interact with the ROM bootloader, and flash firmware. One simple solution to try is manual reset described below, and if it does not help you can find more details about possible issues in `Troubleshooting <https://github.com/espressif/esptool#bootloader-wont-respond>`_.
|
|
|
|
``esptool.py`` resets {IDF_TARGET_NAME} automatically by asserting DTR and RTS control lines of the USB to serial converter chip, i.e., FTDI or CP210x (for more information, see :doc:`establish-serial-connection`). The DTR and RTS control lines are in turn connected to ``{IDF_TARGET_STRAP_GPIO}`` and ``CHIP_PU`` (EN) pins of {IDF_TARGET_NAME}, thus changes in the voltage levels of DTR and RTS will boot {IDF_TARGET_NAME} into Firmware Download mode. As an example, check the `schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf>`_ for the ESP32 DevKitC development board.
|
|
|
|
In general, you should have no problems with the `official esp-idf development boards <https://www.espressif.com/en/products/devkits>`_. However, ``esptool.py`` is not able to reset your hardware automatically in the following cases:
|
|
|
|
- Your hardware does not have the DTR and RTS lines connected to ``{IDF_TARGET_STRAP_GPIO}`` and ``CHIP_PU``
|
|
- The DTR and RTS lines are configured differently
|
|
- There are no such serial control lines at all
|
|
|
|
Depending on the kind of hardware you have, it may also be possible to manually put your {IDF_TARGET_NAME} board into Firmware Download mode (reset).
|
|
|
|
- For development boards produced by Espressif, this information can be found in the respective getting started guides or user guides. For example, to manually reset an ESP-IDF development board, hold down the **Boot** button (``{IDF_TARGET_STRAP_GPIO}``) and press the **EN** button (``CHIP_PU``).
|
|
- For other types of hardware, try pulling ``{IDF_TARGET_STRAP_GPIO}`` down.
|
|
|
|
Normal Operation
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
When flashing, you will see the output log similar to the following:
|
|
|
|
.. only:: esp32
|
|
|
|
.. code-block:: none
|
|
|
|
...
|
|
esptool.py --chip esp32 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello_world.bin
|
|
esptool.py v3.0-dev
|
|
Serial port /dev/ttyUSB0
|
|
Connecting........_
|
|
Chip is ESP32D0WDQ6 (revision 0)
|
|
Features: WiFi, BT, Dual Core, Coding Scheme None
|
|
Crystal is 40MHz
|
|
MAC: 24:0a:c4:05:b9:14
|
|
Uploading stub...
|
|
Running stub...
|
|
Stub running...
|
|
Changing baud rate to 460800
|
|
Changed.
|
|
Configuring flash size...
|
|
Compressed 3072 bytes to 103...
|
|
Writing at 0x00008000... (100 %)
|
|
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 5962.8 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 26096 bytes to 15408...
|
|
Writing at 0x00001000... (100 %)
|
|
Wrote 26096 bytes (15408 compressed) at 0x00001000 in 0.4 seconds (effective 546.7 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 147104 bytes to 77364...
|
|
Writing at 0x00010000... (20 %)
|
|
Writing at 0x00014000... (40 %)
|
|
Writing at 0x00018000... (60 %)
|
|
Writing at 0x0001c000... (80 %)
|
|
Writing at 0x00020000... (100 %)
|
|
Wrote 147104 bytes (77364 compressed) at 0x00010000 in 1.9 seconds (effective 615.5 kbit/s)...
|
|
Hash of data verified.
|
|
|
|
Leaving...
|
|
Hard resetting via RTS pin...
|
|
Done
|
|
|
|
.. only:: esp32s2
|
|
|
|
.. code-block:: none
|
|
|
|
...
|
|
esptool.py --chip esp32s2 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello_world.bin
|
|
esptool.py v3.0-dev
|
|
Serial port /dev/ttyUSB0
|
|
Connecting....
|
|
Chip is ESP32-S2
|
|
Features: WiFi
|
|
Crystal is 40MHz
|
|
MAC: 18:fe:34:72:50:e3
|
|
Uploading stub...
|
|
Running stub...
|
|
Stub running...
|
|
Changing baud rate to 460800
|
|
Changed.
|
|
Configuring flash size...
|
|
Compressed 3072 bytes to 103...
|
|
Writing at 0x00008000... (100 %)
|
|
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 3851.6 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 22592 bytes to 13483...
|
|
Writing at 0x00001000... (100 %)
|
|
Wrote 22592 bytes (13483 compressed) at 0x00001000 in 0.3 seconds (effective 595.1 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 140048 bytes to 70298...
|
|
Writing at 0x00010000... (20 %)
|
|
Writing at 0x00014000... (40 %)
|
|
Writing at 0x00018000... (60 %)
|
|
Writing at 0x0001c000... (80 %)
|
|
Writing at 0x00020000... (100 %)
|
|
Wrote 140048 bytes (70298 compressed) at 0x00010000 in 1.7 seconds (effective 662.5 kbit/s)...
|
|
Hash of data verified.
|
|
|
|
Leaving...
|
|
Hard resetting via RTS pin...
|
|
Done
|
|
|
|
.. only:: esp32s3
|
|
|
|
.. code-block:: none
|
|
|
|
...
|
|
esptool.py esp32s3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin 0x8000 partition_table/partition-table.bin
|
|
esptool.py v3.2-dev
|
|
Serial port /dev/ttyUSB0
|
|
Connecting....
|
|
Chip is ESP32-S3
|
|
Features: WiFi, BLE
|
|
Crystal is 40MHz
|
|
MAC: 7c:df:a1:e0:00:64
|
|
Uploading stub...
|
|
Running stub...
|
|
Stub running...
|
|
Changing baud rate to 460800
|
|
Changed.
|
|
Configuring flash size...
|
|
Flash will be erased from 0x00000000 to 0x00004fff...
|
|
Flash will be erased from 0x00010000 to 0x00039fff...
|
|
Flash will be erased from 0x00008000 to 0x00008fff...
|
|
Compressed 18896 bytes to 11758...
|
|
Writing at 0x00000000... (100 %)
|
|
Wrote 18896 bytes (11758 compressed) at 0x00000000 in 0.5 seconds (effective 279.9 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 168208 bytes to 88178...
|
|
Writing at 0x00010000... (16 %)
|
|
Writing at 0x0001a80f... (33 %)
|
|
Writing at 0x000201f1... (50 %)
|
|
Writing at 0x00025dcf... (66 %)
|
|
Writing at 0x0002d0be... (83 %)
|
|
Writing at 0x00036c07... (100 %)
|
|
Wrote 168208 bytes (88178 compressed) at 0x00010000 in 2.4 seconds (effective 569.2 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 3072 bytes to 103...
|
|
Writing at 0x00008000... (100 %)
|
|
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.1 seconds (effective 478.9 kbit/s)...
|
|
Hash of data verified.
|
|
|
|
Leaving...
|
|
Hard resetting via RTS pin...
|
|
Done
|
|
|
|
|
|
.. only:: esp32c2
|
|
|
|
.. code-block:: none
|
|
|
|
...
|
|
esptool.py esp32c2 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 60m --flash_size 2MB 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin 0x8000 partition_table/partition-table.bin
|
|
esptool.py v3.3.1
|
|
Serial port /dev/ttyUSB0
|
|
Connecting....
|
|
Chip is ESP32-C2 (revision 1)
|
|
Features: Wi-Fi
|
|
Crystal is 40MHz
|
|
MAC: 10:97:bd:f0:e5:0c
|
|
Uploading stub...
|
|
Running stub...
|
|
Stub running...
|
|
Changing baud rate to 460800
|
|
Changed.
|
|
Configuring flash size...
|
|
Flash will be erased from 0x00000000 to 0x00004fff...
|
|
Flash will be erased from 0x00010000 to 0x0002ffff...
|
|
Flash will be erased from 0x00008000 to 0x00008fff...
|
|
Compressed 18192 bytes to 10989...
|
|
Writing at 0x00000000... (100 %)
|
|
Wrote 18192 bytes (10989 compressed) at 0x00000000 in 0.6 seconds (effective 248.5 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 128640 bytes to 65895...
|
|
Writing at 0x00010000... (20 %)
|
|
Writing at 0x00019539... (40 %)
|
|
Writing at 0x00020bf2... (60 %)
|
|
Writing at 0x00027de1... (80 %)
|
|
Writing at 0x0002f480... (100 %)
|
|
Wrote 128640 bytes (65895 compressed) at 0x00010000 in 1.7 seconds (effective 603.0 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 3072 bytes to 103...
|
|
Writing at 0x00008000... (100 %)
|
|
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.1 seconds (effective 360.1 kbit/s)...
|
|
Hash of data verified.
|
|
|
|
Leaving...
|
|
Hard resetting via RTS pin...
|
|
|
|
|
|
.. only:: esp32c3
|
|
|
|
.. code-block:: none
|
|
|
|
...
|
|
esptool.py --chip esp32c3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin
|
|
esptool.py v3.0
|
|
Serial port /dev/ttyUSB0
|
|
Connecting....
|
|
Chip is ESP32-C3
|
|
Features: Wi-Fi
|
|
Crystal is 40MHz
|
|
MAC: 7c:df:a1:40:02:a4
|
|
Uploading stub...
|
|
Running stub...
|
|
Stub running...
|
|
Changing baud rate to 460800
|
|
Changed.
|
|
Configuring flash size...
|
|
Compressed 3072 bytes to 103...
|
|
Writing at 0x00008000... (100 %)
|
|
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 4238.1 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 18960 bytes to 11311...
|
|
Writing at 0x00000000... (100 %)
|
|
Wrote 18960 bytes (11311 compressed) at 0x00000000 in 0.3 seconds (effective 584.9 kbit/s)...
|
|
Hash of data verified.
|
|
Compressed 145520 bytes to 71984...
|
|
Writing at 0x00010000... (20 %)
|
|
Writing at 0x00014000... (40 %)
|
|
Writing at 0x00018000... (60 %)
|
|
Writing at 0x0001c000... (80 %)
|
|
Writing at 0x00020000... (100 %)
|
|
Wrote 145520 bytes (71984 compressed) at 0x00010000 in 2.3 seconds (effective 504.4 kbit/s)...
|
|
Hash of data verified.
|
|
|
|
Leaving...
|
|
Hard resetting via RTS pin...
|
|
Done
|
|
|
|
|
|
If there are no issues by the end of the flash process, the board will reboot and start up the “hello_world” application.
|
|
|
|
If you'd like to use the Eclipse or VS Code IDE instead of running ``idf.py``, check out `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_, `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_.
|
|
|
|
Monitor the Output
|
|
==================
|
|
|
|
To check if "hello_world" is indeed running, type ``idf.py -p PORT monitor`` (Do not forget to replace PORT with your serial port name).
|
|
|
|
This command launches the :doc:`IDF Monitor <../api-guides/tools/idf-monitor>` application::
|
|
|
|
$ idf.py -p <PORT> 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 <PORT> 115200 ---
|
|
--- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
|
|
ets Jun 8 2016 00:22:57
|
|
|
|
rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)
|
|
ets Jun 8 2016 00:22:57
|
|
...
|
|
|
|
After startup and diagnostic logs scroll up, you should see "Hello world!" printed out by the application.
|
|
|
|
.. code-block:: none
|
|
|
|
...
|
|
Hello world!
|
|
Restarting in 10 seconds...
|
|
This is {IDF_TARGET_PATH_NAME} chip with {IDF_TARGET_CORE_NUM} CPU core(s), {IDF_TARGET_FEATURES}
|
|
Minimum free heap size: {IDF_TARGET_HEAP_SIZE} bytes
|
|
Restarting in 9 seconds...
|
|
Restarting in 8 seconds...
|
|
Restarting in 7 seconds...
|
|
|
|
To exit IDF monitor use the shortcut ``Ctrl+]``.
|
|
|
|
.. only:: esp32 or esp32c2
|
|
|
|
If IDF monitor fails shortly after the upload, or, if instead of the messages above, you see random garbage similar to what is given below, your board is likely using a 26 MHz crystal. Most development board designs use 40 MHz, so ESP-IDF uses this frequency as a default value.
|
|
|
|
.. figure:: ../../_static/get-started-garbled-output.png
|
|
:align: center
|
|
:alt: Garbled output
|
|
:figclass: align-center
|
|
|
|
If you have such a problem, do the following:
|
|
|
|
1. Exit the monitor.
|
|
2. Go back to ``menuconfig``.
|
|
3. Go to ``Component config`` --> ``Hardware Settings`` --> ``Main XTAL Config`` --> ``Main XTAL frequency``, then change :ref:`CONFIG_XTAL_FREQ_SEL` to 26 MHz.
|
|
4. After that, ``build and flash`` the application again.
|
|
|
|
In the current version of ESP-IDF, main XTAL frequencies supported by {IDF_TARGET_NAME} are as follows:
|
|
|
|
.. list::
|
|
|
|
:SOC_XTAL_SUPPORT_24M: - 24 MHz
|
|
:SOC_XTAL_SUPPORT_26M: - 26 MHz
|
|
:SOC_XTAL_SUPPORT_32M: - 32 MHz
|
|
:SOC_XTAL_SUPPORT_40M: - 40 MHz
|
|
|
|
.. note::
|
|
|
|
You can combine building, flashing and monitoring into one step by running::
|
|
|
|
idf.py -p PORT flash monitor
|
|
|
|
See also:
|
|
|
|
- :doc:`IDF Monitor <../api-guides/tools/idf-monitor>` for handy shortcuts and more details on using IDF monitor.
|
|
- :ref:`idf.py` for a full reference of ``idf.py`` commands and options.
|
|
|
|
**That's all that you need to get started with {IDF_TARGET_NAME}!**
|
|
|
|
Now you are ready to try some other :idf:`examples`, or go straight to developing your own applications.
|
|
|
|
.. important::
|
|
|
|
Some of examples do not support {IDF_TARGET_NAME} because required hardware is not included in {IDF_TARGET_NAME} so it cannot be supported.
|
|
|
|
If building an example, please check the README file for the ``Supported Targets`` table. If this is present including {IDF_TARGET_NAME} target, or the table does not exist at all, the example will work on {IDF_TARGET_NAME}.
|
|
|
|
|
|
Additional Tips
|
|
===============
|
|
|
|
Permission issues /dev/ttyUSB0
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
With some Linux distributions, you may get the ``Failed to open port /dev/ttyUSB0`` error message when flashing the {IDF_TARGET_NAME}. :ref:`This can be solved by adding the current user to the dialout group<linux-dialout-group>`.
|
|
|
|
Python compatibility
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
ESP-IDF supports Python 3.7 or newer. It is recommended to upgrade your operating system to a recent version satisfying this requirement. Other options include the installation of Python from `sources <https://www.python.org/downloads/>`_ or the use of a Python version management system such as `pyenv <https://github.com/pyenv/pyenv>`_.
|
|
|
|
.. only:: esp32 or esp32s2 or esp32s3
|
|
|
|
..
|
|
When adding new targets to the line above, please update this list in windows-start-project.rst and linux-macos-start-project.rst
|
|
|
|
|
|
Start with Board Support Package
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
To speed up prototyping on some development boards, you can use `Board Support Packages (BSPs) <https://github.com/espressif/esp-bsp>`_, which makes initialization of a particular board as easy as few function calls.
|
|
|
|
A BSP typically supports all of the hardware components provided on development board. Apart from the pinout definition and initialization functions, a BSP ships with drivers for the external components such as sensors, displays, audio codecs etc.
|
|
|
|
The BSPs are distributed via `IDF Component Manager <../api-guides/tools/idf-component-manager>`_, so they can be found in `IDF Component Registry <https://components.espressif.com>`_.
|
|
|
|
.. only:: esp32
|
|
|
|
**Here's an example of how to add ESP-WROVER-KIT BSP to your project:**
|
|
|
|
.. code-block:: bash
|
|
|
|
idf.py add-dependency esp_wrover_kit
|
|
|
|
.. only:: esp32s2
|
|
|
|
**Here's an example of how to add ESP32-S2-Kaluga-Kit BSP to your project:**
|
|
|
|
.. code-block:: bash
|
|
|
|
idf.py add-dependency esp32_s2_kaluga_kit
|
|
|
|
.. only:: esp32s3
|
|
|
|
**Here's an example of how to add ESP-BOX BSP to your project:**
|
|
|
|
.. code-block:: bash
|
|
|
|
idf.py add-dependency esp-box
|
|
|
|
More examples of BSP usage can be found in `BSP examples folder <https://github.com/espressif/esp-bsp/tree/master/examples>`_.
|