2019-08-27 05:45:50 +00:00
***** ***** *
2019-06-25 01:26:53 +00:00
Get Started
***** ***** *
2019-03-13 16:10:26 +00:00
:link_to_translation:`zh_CN:[中文]`
2020-09-04 08:42:36 +00:00
.. Please keep README.md in sync with these instructions.
2021-07-22 07:54:47 +00:00
This document is intended to help you set up the software development environment for the hardware based on the {IDF_TARGET_NAME} chip by Espressif. After that, a simple example will show you how to use ESP-IDF (Espressif IoT Development Framework) for menu configuration, then for building and flashing firmware onto an {IDF_TARGET_NAME} board.
2019-03-13 16:10:26 +00:00
2019-11-13 03:46:16 +00:00
.. include-build-file :: inc/version-note.inc
2019-03-13 16:10:26 +00:00
Introduction
============
2020-03-04 21:05:23 +00:00
{IDF_TARGET_NAME} is a system on a chip that integrates the following features:
2019-12-09 03:01:09 +00:00
2020-07-09 03:37:16 +00:00
.. only :: esp32
2019-12-09 03:01:09 +00:00
* Wi-Fi (2.4 GHz band)
2020-07-09 03:37:16 +00:00
* Bluetooth
2021-01-27 02:12:58 +00:00
* Dual high performance Xtensa® 32-bit LX6 CPU cores
2019-12-09 03:01:09 +00:00
* Ultra Low Power co-processor
2020-03-03 20:58:29 +00:00
* Multiple peripherals
2020-07-09 03:37:16 +00:00
.. only :: esp32s2
* Wi-Fi (2.4 GHz band)
2021-01-27 02:12:58 +00:00
* High performance single core Xtensa® 32-bit LX7 CPU
2020-07-09 03:37:16 +00:00
* Ultra Low Power co-processor running either RISC-V or FSM core
* Multiple peripherals
* Built-in security hardware
* USB OTG interface
2019-12-09 03:01:09 +00:00
2021-06-28 08:37:03 +00:00
.. only :: esp32s3
* Wi-Fi (2.4 GHz band)
* Bluetooth Low Energy
2021-06-30 10:05:36 +00:00
* Dual high performance Xtensa® 32-bit LX7 CPU cores
2021-06-28 08:37:03 +00:00
* Ultra Low Power co-processor running either RISC-V or FSM core
* Multiple peripherals
* Built-in security hardware
* USB OTG interface
* USB Serial/JTAG Controller
2021-01-27 02:12:58 +00:00
.. only :: esp32c3
* Wi-Fi (2.4 GHz band)
* Bluetooth Low Energy
* High performance 32-bit RISC-V single-core processor
* Multiple peripherals
* Built-in security hardware
2019-12-09 03:01:09 +00:00
Powered by 40 nm technology, {IDF_TARGET_NAME} provides a robust, highly integrated platform, which helps meet the continuous demands for efficient power usage, compact design, security, high performance, and reliability.
Espressif provides basic hardware and software resources to help application developers realize their ideas using the {IDF_TARGET_NAME} series hardware. The software development framework by Espressif is intended for development of Internet-of-Things (IoT) applications with Wi-Fi, Bluetooth, power management and several other system features.
2019-03-13 16:10:26 +00:00
What You Need
=============
2022-02-14 10:17:08 +00:00
Hardware
~~~~~~~~
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
* An **{IDF_TARGET_NAME}** board.
* **USB cable** - USB A / micro USB B.
* **Computer** running Windows, Linux, or macOS.
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
.. note :: Currently, some of the development boards are using USB Type C connectors. Be sure you have the correct cable to connect your board!
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
If you have one of {IDF_TARGET_NAME} official development boards listed below, you can click on the link to learn more about the hardware.
2019-03-13 16:10:26 +00:00
2019-12-09 03:01:09 +00:00
.. only :: esp32
2019-03-13 16:10:26 +00:00
2019-12-09 03:01:09 +00:00
.. toctree ::
:maxdepth: 1
2019-12-11 07:45:30 +00:00
ESP32-DevKitC <../hw-reference/esp32/get-started-devkitc>
ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit>
2020-03-10 22:43:31 +00:00
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
2020-10-13 05:33:43 +00:00
ESP32-PICO-KIT-1 <../hw-reference/esp32/get-started-pico-kit-1>
2020-10-14 02:21:25 +00:00
ESP32-PICO-DevKitM-2 <../hw-reference/esp32/get-started-pico-devkitm-2>
2021-01-05 04:32:08 +00:00
ESP32-DevKitM-1 <../hw-reference/esp32/user-guide-devkitm-1>
2019-08-27 05:45:50 +00:00
2020-03-03 20:58:29 +00:00
.. only :: esp32s2
2020-03-26 10:40:05 +00:00
.. toctree ::
:maxdepth: 1
2021-01-27 02:12:58 +00:00
2020-03-26 10:40:05 +00:00
ESP32-S2-Saola-1 <../hw-reference/esp32s2/user-guide-saola-1-v1.2>
2020-10-12 10:03:51 +00:00
ESP32-S2-DevKitM-1(U) <../hw-reference/esp32s2/user-guide-devkitm-1-v1>
2021-07-22 11:50:53 +00:00
ESP32-S2-DevKitC-1 <../hw-reference/esp32s2/user-guide-s2-devkitc-1>
2020-05-08 12:27:34 +00:00
ESP32-S2-Kaluga-Kit <../hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit>
2020-03-03 20:58:29 +00:00
2021-01-27 02:12:58 +00:00
.. only :: esp32c3
2021-02-05 04:00:40 +00:00
.. toctree ::
:maxdepth: 1
2021-01-27 02:12:58 +00:00
2021-02-05 04:00:40 +00:00
ESP32-C3-DevKitM-1 <../hw-reference/esp32c3/user-guide-devkitm-1>
2021-03-10 11:39:55 +00:00
ESP32-C3-DevKitC-02 <../hw-reference/esp32c3/user-guide-devkitc-02>
2021-06-28 08:37:03 +00:00
2021-06-22 08:55:32 +00:00
.. only :: esp32s3
.. toctree ::
:maxdepth: 1
ESP32-S3-DevKitC-1 <../hw-reference/esp32s3/user-guide-devkitc-1>
2021-11-17 11:13:34 +00:00
ESP32-S3-DevKitM-1 <../hw-reference/esp32s3/user-guide-devkitm-1>
2021-06-22 08:55:32 +00:00
2019-06-25 01:26:53 +00:00
.. _get-started-get-prerequisites:
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
Software
~~~~~~~~
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
To start using ESP-IDF on **{IDF_TARGET_NAME}** you'll need the following software installed:
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
* **Toolchain** to compile code for {IDF_TARGET_NAME}
* **Build tools** - CMake and Ninja to build a full **Application** for {IDF_TARGET_NAME}
* **ESP-IDF** that essentially contains API (software libraries and source code) for {IDF_TARGET_NAME} and scripts to operate the **Toolchain**
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
.. figure :: ../../_static/what-you-need.png
2019-03-13 16:10:26 +00:00
:align: center
2022-02-14 10:17:08 +00:00
:alt: Development of applications for {IDF_TARGET_NAME}
2019-03-13 16:10:26 +00:00
:figclass: align-center
2022-02-14 10:17:08 +00:00
.. _get-started-step-by-step:
.. _get-started-how-to-get-esp-idf:
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
Installation
============
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
To install all the required software, we offer some different ways to facilitate this task. Choose from one of the available options.
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
IDE
~~~
2020-03-04 21:05:23 +00:00
2022-02-14 10:17:08 +00:00
.. note :: We highly recommend installing the ESP-IDF through your favorite IDE.
2020-03-04 21:05:23 +00:00
2022-02-14 10:17:08 +00:00
.. toctree ::
:maxdepth: 1
2020-03-04 21:05:23 +00:00
2022-02-14 10:17:08 +00:00
Eclipse Plugin <../get-started/eclipse-setup>
VSCode Extension <../get-started/vscode-setup>
2020-03-04 21:05:23 +00:00
2022-02-14 10:17:08 +00:00
Manual Installation
~~~~~~~~~~~~~~~~~~~
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
For the manual procedure, please select according to your operating system.
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
.. toctree ::
:maxdepth: 1
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
Windows Installer <../get-started/windows-setup>
Linux and macOS <../get-started/linux-macos-setup>
2019-06-25 01:29:49 +00:00
2022-02-14 10:17:08 +00:00
Build Your First Project
========================
2019-06-25 01:29:49 +00:00
2022-02-14 10:17:08 +00:00
If you already have the ESP-IDF installed and not using IDE, you can build your first project from the command line following :ref: `get-started-first-steps` .
2019-03-13 16:10:26 +00:00
.. toctree ::
2022-02-14 10:17:08 +00:00
:hidden:
2019-03-13 16:10:26 +00:00
2022-02-14 10:17:08 +00:00
Windows <windows-setup>
Manual <linux-macos-setup>