mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Merge branch 'docs/s3_get_started' into 'master'
docs: updated getting started for S3 Closes IDF-3281 and IDF-3282 See merge request espressif/esp-idf!14174
This commit is contained in:
Krzysztof Budzynski
commit
f0b2926d70
@ -20,5 +20,5 @@ void esp_chip_info(esp_chip_info_t *out_info)
|
||||
memset(out_info, 0, sizeof(*out_info));
|
||||
out_info->model = CHIP_ESP32S3;
|
||||
out_info->cores = 2;
|
||||
out_info->features = CHIP_FEATURE_WIFI_BGN;
|
||||
out_info->features = CHIP_FEATURE_WIFI_BGN | CHIP_FEATURE_BLE;
|
||||
}
|
||||
|
||||
@ -4,7 +4,7 @@ Copyrights and Licenses
|
||||
Software Copyrights
|
||||
===================
|
||||
|
||||
All original source code in this repository is Copyright (C) 2015-2019 Espressif Systems. This source code is licensed under the Apache License 2.0 as described in the file LICENSE.
|
||||
All original source code in this repository is Copyright (C) 2015-2021 Espressif Systems. This source code is licensed under the Apache License 2.0 as described in the file LICENSE.
|
||||
|
||||
Additional third party copyrighted code is included under the following licenses.
|
||||
|
||||
@ -65,13 +65,13 @@ These third party libraries can be included into the application (firmware) prod
|
||||
|
||||
* `cryptoauthlib`_ Microchip CryptoAuthentication Library - Copyright (c) 2015 - 2018 Microchip Technology Inc, is licensed under common Microchip software License as described in :example_file:`LICENSE file <peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib/cryptoauthlib/LICENSE>`
|
||||
|
||||
* :component_file:` TLSF allocator <heap/heap_tlsf.c>` Two Level Segregated Fit memory allocator, Copyright (c) 2006-2016, Matthew Conte, and licensed under the BSD license.
|
||||
* :component_file:`TLSF allocator <heap/heap_tlsf.c>` Two Level Segregated Fit memory allocator, Copyright (c) 2006-2016, Matthew Conte, and licensed under the BSD license.
|
||||
|
||||
* `qrcode`_ QR Code generator library Copyright (c) Project Nayuki, is licensed under MIT license.
|
||||
|
||||
* :component:`openthread`, Copyright (c) The OpenThread Authors, is licensed under Apache License 2.0 as described in :component_file:`LICENSE file<openthread/openthread/LICENSE>`.
|
||||
|
||||
* :component_file:` UBSAN runtime <esp_system/ubsan.c>` — Copyright (c) 2016, Linaro Limited and Jiří Zárevúcky, licensed under the BSD 2-clause license.
|
||||
* :component_file:`UBSAN runtime <esp_system/ubsan.c>` — Copyright (c) 2016, Linaro Limited and Jiří Zárevúcky, licensed under the BSD 2-clause license.
|
||||
|
||||
Build Tools
|
||||
-----------
|
||||
@ -90,7 +90,7 @@ Documentation
|
||||
ROM Source Code Copyrights
|
||||
==========================
|
||||
|
||||
ESP32 mask ROM hardware includes binaries compiled from portions of the following third party software:
|
||||
ESP32, ESP32-S and ESP32-C Series SoCs mask ROM hardware includes binaries compiled from portions of the following third party software:
|
||||
|
||||
* :component:`Newlib <newlib>`, licensed under the BSD License and is Copyright of various parties, as described in :component_file:`COPYING.NEWLIB<newlib/COPYING.NEWLIB>`.
|
||||
|
||||
|
||||
@ -13,13 +13,21 @@ About
|
||||
|
||||
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for {IDF_TARGET_NAME}.
|
||||
|
||||
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi module, which integrates a Xtensa® 32-bit LX7 CPU, with up to 600 DMIPS processing power.
|
||||
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi SoC, which integrates a Xtensa® 32-bit LX7 CPU.
|
||||
|
||||
|
||||
.. only:: esp32s3
|
||||
|
||||
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for {IDF_TARGET_NAME}.
|
||||
|
||||
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo SoC, which integrates a Xtensa® 32-bit LX7 CPU.
|
||||
|
||||
|
||||
.. only:: esp32c3
|
||||
|
||||
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for {IDF_TARGET_NAME}.
|
||||
|
||||
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo, which integrates a 32-bit RISC-V RV32IMC single-core processor.
|
||||
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo SoC, which integrates a 32-bit RISC-V RV32IMC single-core processor.
|
||||
|
||||
.. figure:: ../_static/about-doc.png
|
||||
:align: center
|
||||
|
||||
@ -12,7 +12,7 @@ Framework (esp-idf) ("We" or "Us").
|
||||
|
||||
The purpose of this contributor agreement ("Agreement") is to clarify
|
||||
and document the rights granted by contributors to Us. To make this
|
||||
document effective, please follow the instructions at
|
||||
document effective, please follow the instructions at
|
||||
:idf_file:`CONTRIBUTING.rst`
|
||||
|
||||
1. DEFINITIONS
|
||||
@ -27,7 +27,7 @@ Agreement or sign the Entity version of this document.
|
||||
and/or documentation) including any modifications or additions to an
|
||||
existing work, Submitted by You to Us, in which You own the Copyright.
|
||||
If You do not own the Copyright in the entire work of authorship, please
|
||||
contact Us at angus@espressif.com.
|
||||
contact Us at marius.vikhammer@espressif.com.
|
||||
|
||||
**"Copyright"** means all rights protecting works of authorship owned or
|
||||
controlled by You, including copyright, moral and neighboring rights, as
|
||||
|
||||
@ -2,11 +2,11 @@
|
||||
Get Started
|
||||
***********
|
||||
|
||||
{IDF_TARGET_CORE_NUM:default="2", esp32="2", esp32s2="1", esp32c3="1"}
|
||||
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1"}
|
||||
|
||||
{IDF_TARGET_FEATURES:default="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32s2="WiFi, silicon revision 0, 2MB external flash", esp32c3="WiFi/BLE, silicon revision 0, 2MB external flash"}
|
||||
{IDF_TARGET_FEATURES:default="WiFi/BT/BLE, silicon revision 1, 2MB external flash", 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", esp32c3="WiFi/BLE, silicon revision 0, 2MB external flash"}
|
||||
|
||||
{IDF_TARGET_HEAP_SIZE:default="298968", esp32="298968", esp32s2="253900", esp32c3="337332"}
|
||||
{IDF_TARGET_HEAP_SIZE:default="298968", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c3="337332"}
|
||||
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
@ -42,6 +42,17 @@ Introduction
|
||||
* Built-in security hardware
|
||||
* USB OTG interface
|
||||
|
||||
.. only:: esp32s3
|
||||
|
||||
* Wi-Fi (2.4 GHz band)
|
||||
* Bluetooth Low Energy
|
||||
* Dual high performance Xtensa® 32-bit LX7 CPU cores
|
||||
* 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
|
||||
|
||||
.. only:: esp32c3
|
||||
|
||||
* Wi-Fi (2.4 GHz band)
|
||||
@ -54,6 +65,7 @@ Powered by 40 nm technology, {IDF_TARGET_NAME} provides a robust, highly integra
|
||||
|
||||
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.
|
||||
|
||||
|
||||
What You Need
|
||||
=============
|
||||
|
||||
@ -119,7 +131,8 @@ If you have one of {IDF_TARGET_NAME} development boards listed below, you can cl
|
||||
|
||||
ESP32-C3-DevKitM-1 <../hw-reference/esp32c3/user-guide-devkitm-1>
|
||||
ESP32-C3-DevKitC-02 <../hw-reference/esp32c3/user-guide-devkitc-02>
|
||||
|
||||
|
||||
|
||||
.. _get-started-step-by-step:
|
||||
|
||||
Installation Step by Step
|
||||
@ -503,7 +516,7 @@ For more information on idf.py arguments, see :ref:`idf.py`.
|
||||
|
||||
Encountered Issues While Flashing?
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
{IDF_TARGET_STRAP_GPIO:default="GPIO0", esp32="GPIO0", esp32s2="GPIO0", esp32c3="GPIO9"}
|
||||
{IDF_TARGET_STRAP_GPIO:default="GPIO0", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", 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>`_.
|
||||
|
||||
@ -606,6 +619,51 @@ When flashing, you will see the output log similar to the following:
|
||||
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:: esp32c3
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
@ -13,13 +13,21 @@
|
||||
|
||||
本指南为 {IDF_TARGET_NAME} 官方应用开发框架 `ESP-IDF <https://github.com/espressif/esp-idf>`_ 的配套文档。
|
||||
|
||||
{IDF_TARGET_NAME} 是一款高集成 2.4 GHz Wi-Fi 系统级芯片，搭载 Xtensa® 32 位 LX7 单核处理器，运算能力最高可达 600 DMIPS。
|
||||
{IDF_TARGET_NAME} 是一款 2.4 GHz Wi-Fi 系统级芯片，搭载 Xtensa® 32 位 LX7 处理器。
|
||||
|
||||
|
||||
.. only:: esp32s3
|
||||
|
||||
本指南为 {IDF_TARGET_NAME} 官方应用开发框架 `ESP-IDF <https://github.com/espressif/esp-idf>`_ 的配套文档。
|
||||
|
||||
{IDF_TARGET_NAME} 是一款支持 2.4 GHz Wi-Fi 和低功耗蓝牙的芯片，搭载 Xtensa® 32 位 LX7 处理器。
|
||||
|
||||
|
||||
.. only:: esp32c3
|
||||
|
||||
本指南为 {IDF_TARGET_NAME} 官方应用开发框架 `ESP-IDF <https://github.com/espressif/esp-idf>`_ 的配套文档。
|
||||
|
||||
{IDF_TARGET_NAME} 是一款低功耗芯片，支持 2.4 GHz Wi-Fi 和蓝牙，搭载 RISC-V RV32IMC 32 位单核处理器。
|
||||
{IDF_TARGET_NAME} 是一款支持 2.4 GHz Wi-Fi 和低功耗蓝牙的芯片，搭载 RISC-V RV32IMC 32 位单核处理器。
|
||||
|
||||
.. figure:: ../_static/about-doc.png
|
||||
:align: center
|
||||
@ -29,3 +37,4 @@
|
||||
乐鑫物联网综合开发框架
|
||||
|
||||
ESP-IDF 即乐鑫物联网开发框架，可为在 Windows、Linux 和 macOS 系统平台上开发 {IDF_TARGET_NAME} 应用程序提供工具链、API、组件和工作流程的支持。
|
||||
|
||||
|
||||
@ -2,11 +2,12 @@
|
||||
快速入门
|
||||
***********
|
||||
|
||||
{IDF_TARGET_CORE_NUM:default="2", esp32="2", esp32s2="1", esp32c3="1"}
|
||||
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1"}
|
||||
|
||||
{IDF_TARGET_FEATURES:default="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32s2="WiFi, silicon revision 0, 2MB external flash", esp32c3="WiFi/BLE, silicon revision 0, 2MB external flash"}
|
||||
{IDF_TARGET_FEATURES:default="WiFi/BT/BLE, silicon revision 1, 2MB external flash", 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", esp32c3="WiFi/BLE, silicon revision 0, 2MB external flash"}
|
||||
|
||||
{IDF_TARGET_HEAP_SIZE:default="298968", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c3="337332"}
|
||||
|
||||
{IDF_TARGET_HEAP_SIZE:default="298968", esp32="298968", esp32s2="253900", esp32c3="337332"}
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
@ -40,19 +41,30 @@
|
||||
* 内置安全硬件
|
||||
* USB OTG 接口
|
||||
|
||||
.. only:: esp32s3
|
||||
|
||||
ESP32-S3 SoC 芯片支持以下功能：
|
||||
|
||||
* 2.4 GHz Wi-Fi
|
||||
* 低功耗蓝牙
|
||||
* 高性能 Xtensa® 32 位 LX7 双核处理器
|
||||
* 运行 RISC-V 或 FSM 内核的超低功耗协处理器
|
||||
* 多种外设
|
||||
* 内置安全硬件
|
||||
* USB OTG 接口
|
||||
* USB 串口/JTAG 控制器
|
||||
|
||||
.. only:: esp32c3
|
||||
|
||||
ESP32-C3 SoC 芯片支持以下功能：
|
||||
|
||||
* 2.4 GHz Wi-Fi
|
||||
* 低能耗蓝牙
|
||||
* 低功耗蓝牙
|
||||
* 高性能 32 位 RISC-V 单核处理器
|
||||
* 多种外设
|
||||
* 内置安全硬件
|
||||
|
||||
{IDF_TARGET_NAME} 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用场景和不同功耗需求。
|
||||
|
||||
乐鑫为用户提供完整的软、硬件资源，进行 {IDF_TARGET_NAME} 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。
|
||||
{IDF_TARGET_NAME} 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用场景和不同功耗需求。乐鑫为用户提供完整的软、硬件资源，进行 {IDF_TARGET_NAME} 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。
|
||||
|
||||
准备工作
|
||||
=============
|
||||
@ -120,6 +132,7 @@
|
||||
ESP32-C3-DevKitM-1 <../hw-reference/esp32c3/user-guide-devkitm-1>
|
||||
ESP32-C3-DevKitC-02 <../hw-reference/esp32c3/user-guide-devkitc-02>
|
||||
|
||||
|
||||
.. _get-started-step-by-step:
|
||||
|
||||
详细安装步骤
|
||||
@ -503,7 +516,7 @@ Windows 操作系统
|
||||
|
||||
烧录过程中可能遇到的问题
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
{IDF_TARGET_STRAP_GPIO:default="GPIO0", esp32="GPIO0", esp32s2="GPIO0", esp32c3="GPIO9"}
|
||||
{IDF_TARGET_STRAP_GPIO:default="GPIO0", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c3="GPIO9"}
|
||||
|
||||
如果在运行给定命令时出现如“连接失败”这样的错误，原因之一则可能是运行 ``esptool.py`` 出现错误。``esptool.py`` 是构建系统调用的程序，用于重置芯片、与 ROM 引导加载器交互以及烧录固件的工具。解决该问题的一个简单的方法就是按照以下步骤进行手动复位。如果问题仍未解决，请参考 `Troubleshooting <https://github.com/espressif/esptool#bootloader-wont-respond>`_ 获取更多信息。
|
||||
|
||||
@ -606,6 +619,51 @@ Windows 操作系统
|
||||
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:: esp32c3
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user