forked from espressif/esp-idf
Merge branch 'docs/c2_getting_started' into 'master'
docs: update getting started guide for C2 Closes IDF-4211 See merge request espressif/esp-idf!18179
This commit is contained in:
Jiang Jiang Jian
@@ -59,7 +59,6 @@ api-guides/external-ram
|
||||
api-guides/ulp-risc-v
|
||||
api-guides/hardware-abstraction
|
||||
api-guides/wifi-security
|
||||
api-guides/index
|
||||
api-guides/openthread
|
||||
api-guides/unit-tests-legacy
|
||||
api-guides/fatal-errors
|
||||
@@ -87,11 +86,7 @@ api-reference/storage/index
|
||||
api-reference/peripherals/adc
|
||||
api-reference/peripherals/sdspi_host
|
||||
api-reference/peripherals/lcd
|
||||
api-reference/peripherals/secure_element
|
||||
api-reference/peripherals/temp_sensor
|
||||
api-reference/peripherals/spi_slave_hd
|
||||
api-reference/peripherals/i2c
|
||||
api-reference/peripherals/index
|
||||
api-reference/kconfig
|
||||
api-reference/network/esp_openthread
|
||||
api-reference/network/esp_eth
|
||||
@@ -159,7 +154,6 @@ api-reference/bluetooth/index
|
||||
api-reference/bluetooth/esp_gap_ble
|
||||
api-reference/bluetooth/classic_bt
|
||||
api-reference/error-codes
|
||||
api-reference/index
|
||||
api-reference/protocols/icmp_echo
|
||||
api-reference/protocols/esp_serial_slave_link
|
||||
api-reference/protocols/mqtt
|
||||
@@ -177,16 +171,3 @@ api-reference/protocols/mdns
|
||||
api-reference/protocols/index
|
||||
api-reference/protocols/asio
|
||||
security/flash-encryption
|
||||
security/secure-boot-v2
|
||||
get-started/establish-serial-connection
|
||||
get-started/macos-setup-scratch
|
||||
get-started/vscode-setup
|
||||
get-started/linux-setup-scratch
|
||||
get-started/eclipse-setup
|
||||
get-started/windows-setup
|
||||
get-started/toolchain-setup-scratch
|
||||
get-started/windows-setup-scratch
|
||||
get-started/linux-setup
|
||||
get-started/index
|
||||
get-started/windows-setup-update
|
||||
get-started/macos-setup
|
||||
|
||||
@@ -77,12 +77,12 @@ Make sure you re-login to enable read and write permissions for the serial port.
|
||||
Verify serial connection
|
||||
------------------------
|
||||
|
||||
Now verify that the serial connection is operational. You can do this using a serial terminal program by checking if you get any output on the terminal after reseting {IDF_TARGET_NAME}.
|
||||
Now verify that the serial connection is operational. You can do this using a serial terminal program by checking if you get any output on the terminal after resetting {IDF_TARGET_NAME}.
|
||||
|
||||
Windows and Linux
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
In this example we will use `PuTTY SSH Client <https://www.putty.org/>`_ that is available for both Windows and Linux. You can use other serial program and set communication parameters like below.
|
||||
In this example we will use `PuTTY SSH Client <https://www.putty.org/>`_ that is available for both Windows and Linux. You can use other serial programs and set communication parameters like below.
|
||||
|
||||
Run terminal, set identified serial port, baud rate = 115200, data bits = 8, stop bits = 1, and parity = N. Below are example screen shots of setting the port and such transmission parameters (in short described as 115200-8-1-N) on Windows and Linux. Remember to select exactly the same serial port you have identified in steps above.
|
||||
|
||||
@@ -136,7 +136,7 @@ To spare you the trouble of installing a serial terminal program, macOS offers t
|
||||
Example Output
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
An example log by {IDF_TARGET_NAME} is shown below. Reset the board if you do not see anything.
|
||||
An example log is shown below. Reset the board if you do not see anything.
|
||||
|
||||
.. highlight:: none
|
||||
|
||||
|
||||
@@ -51,6 +51,14 @@ Introduction
|
||||
* Multiple peripherals
|
||||
* Built-in security hardware
|
||||
|
||||
.. only:: esp32c2
|
||||
|
||||
* Wi-Fi (2.4 GHz band)
|
||||
* Bluetooth Low Energy
|
||||
* High performance 32-bit RISC-V single-core processor
|
||||
* Multiple peripherals
|
||||
* Intended for simple, high-volume IoT applications
|
||||
|
||||
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.
|
||||
@@ -110,6 +118,13 @@ If you have one of {IDF_TARGET_NAME} official development boards listed below, y
|
||||
ESP32-S3-DevKitC-1 <../hw-reference/esp32s3/user-guide-devkitc-1>
|
||||
ESP32-S3-DevKitM-1 <../hw-reference/esp32s3/user-guide-devkitm-1>
|
||||
|
||||
.. only:: esp32c2
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ESP8684-DevKitM-1 <https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp8684/esp8684-devkitm-1/index.html>
|
||||
|
||||
.. _get-started-get-prerequisites:
|
||||
|
||||
Software
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1"}
|
||||
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1", esp32c2="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", 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_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="298968", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c3="337332"}
|
||||
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332"}
|
||||
|
||||
Build the Project
|
||||
=================
|
||||
@@ -60,7 +60,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", esp32s3="GPIO0", esp32c3="GPIO9"}
|
||||
{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>`_.
|
||||
|
||||
@@ -207,6 +207,49 @@ When flashing, you will see the output log similar to the following:
|
||||
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
|
||||
|
||||
@@ -136,7 +136,7 @@ macOS 提供了 **屏幕** 命令，因此您不用安装串口终端程序。
|
||||
输出示例
|
||||
^^^^^^^^^^^
|
||||
|
||||
以下是 {IDF_TARGET_NAME} 的一个日志示例。如果没看到任何输出，请尝试重置开发板。
|
||||
以下是一个日志示例。如果没看到任何输出，请尝试重置开发板。
|
||||
|
||||
.. highlight:: none
|
||||
|
||||
|
||||
@@ -51,6 +51,14 @@
|
||||
* 多种外设
|
||||
* 内置安全硬件
|
||||
|
||||
.. only:: esp32c2
|
||||
|
||||
* 2.4 GHz Wi-Fi
|
||||
* 低功耗蓝牙
|
||||
* 高性能 32 位 RISC-V 单核处理器
|
||||
* 多种外设
|
||||
* 适用于较简单、大批量生产的物联网应用
|
||||
|
||||
{IDF_TARGET_NAME} 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用场景和不同功耗需求。
|
||||
|
||||
乐鑫为用户提供完整的软、硬件资源，进行 {IDF_TARGET_NAME} 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。
|
||||
@@ -110,6 +118,13 @@
|
||||
ESP32-S3-DevKitC-1 <../hw-reference/esp32s3/user-guide-devkitc-1>
|
||||
ESP32-S3-DevKitM-1 <../hw-reference/esp32s3/user-guide-devkitm-1>
|
||||
|
||||
.. only:: esp32c2
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ESP8684-DevKitM-1 <https://docs.espressif.com/projects/espressif-esp-dev-kits/zh_CN/latest/esp8684/esp8684-devkitm-1/index.html>
|
||||
|
||||
.. _get-started-get-prerequisites:
|
||||
|
||||
软件：
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1"}
|
||||
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1", esp32c2="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", 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_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="298968", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c3="337332"}
|
||||
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332"}
|
||||
|
||||
编译工程
|
||||
=========================
|
||||
@@ -60,7 +60,7 @@
|
||||
烧录过程中可能遇到的问题
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
{IDF_TARGET_STRAP_GPIO:default="GPIO0", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c3="GPIO9"}
|
||||
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9"}
|
||||
|
||||
如果在运行给定命令时出现如“连接失败”这样的错误，造成该错误的原因之一可能是运行 ``esptool.py`` 时出现错误。``esptool.py`` 是构建系统调用的程序，用于重置芯片、与 ROM 引导加载器交互以及烧录固件的工具。可以按照以下步骤进行手动复位，轻松解决该问题。如果问题仍未解决，请参考 `Troubleshooting <https://github.com/espressif/esptool#bootloader-wont-respond>`_. 获取更多信息。
|
||||
|
||||
@@ -207,6 +207,49 @@
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user