docs: update getting started and frontpage docs for C6

This commit is contained in:
Marius Vikhammer 2022-11-14 14:04:36 +08:00
parent 6cbedbfa57
commit 0244c81fd2
12 changed files with 164 additions and 84 deletions

View File

@ -1,13 +1,3 @@
languages
contribute
contribute/esp-idf-tests-with-pytest
contribute/contributor-agreement
contribute/documenting-code
contribute/creating-examples
contribute/style-guide
contribute/copyright-guide
contribute/install-pre-commit-hook
contribute/index
api-guides
api-guides/core_dump_internals
api-guides/event-handling
@ -79,15 +69,6 @@ api-guides/openthread
api-guides/fatal-errors
api-guides/memory-types
api-guides/general-notes
third-party-tools
third-party-tools/platformio
COPYRIGHT
libraries-and-frameworks
libraries-and-frameworks/libs-frameworks
libraries-and-frameworks/index
libraries-and-frameworks/cloud-frameworks
conf.py
versions
api-reference
api-reference/api-conventions
api-reference/template
@ -237,35 +218,3 @@ security
security/flash-encryption
security/secure-boot-v2
security/secure-boot-v1
about
resources
migration-guides
migration-guides/release-5.x
migration-guides/release-5.x/bluetooth-classic
migration-guides/release-5.x/gcc
migration-guides/release-5.x/bluetooth-low-energy
migration-guides/release-5.x/removed-components
migration-guides/release-5.x/protocols
migration-guides/release-5.x/networking
migration-guides/release-5.x/provisioning
migration-guides/release-5.x/build-system
migration-guides/release-5.x/storage
migration-guides/release-5.x/index
migration-guides/release-5.x/system
migration-guides/release-5.x/tools
migration-guides/release-5.x/peripherals
migration-guides/index
_templates
_templates/layout.html
get-started
get-started/establish-serial-connection
get-started/linux-macos-setup
get-started/linux-macos-start-project
get-started/windows-setup
get-started/start-project
get-started/flashing-troubleshooting
get-started/windows-start-project
get-started/index
get-started/windows-setup-update
404
index

View File

@ -29,6 +29,12 @@ About
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.
.. only:: esp32c6
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, and 802.15.4 Thread/Zigbee combo SoC, which integrates a 32-bit RISC-V RV32IMAC single-core processor.
.. figure:: ../_static/about-doc.png
:align: center
:alt: Espressif IoT Integrated Development Framework

View File

@ -183,7 +183,7 @@ or for specific target and language with::
build-docs -t esp32 -l en build
For more in-depth documentation about `esp-docs` features please see the documentation in the `esp-docs repository <https://github.com/espressif/esp-docs/blob/master/docs/building-documention.md>`_.
For more in-depth documentation about `esp-docs` features please see the documentation at `esp-docs <https://docs.espressif.com/projects/esp-docs/en/latest/>`_.
Wrap up
-------

View File

@ -5,7 +5,7 @@ Establish Serial Connection with {IDF_TARGET_NAME}
.. only:: not SOC_USB_OTG_SUPPORTED and not SOC_USB_SERIAL_JTAG_SUPPORTED
Establishing a serial connection with the {IDF_TARGET_NAME} target device could be done using a USB-to-UART bridge.
Establishing a serial connection with the {IDF_TARGET_NAME} target device could be done using a USB-to-UART bridge.
.. only:: SOC_USB_OTG_SUPPORTED or SOC_USB_SERIAL_JTAG_SUPPORTED
@ -33,7 +33,7 @@ Some development boards have the USB-to-UART bridge installed. If a board does n
default_fontsize = 16
# labels of diagram nodes
PC [label="Personal\n Computer"];
PC [label="Personal\n Computer"];
CHIP [label="{IDF_TARGET_NAME}", width=120];
DUMMY [shape=none, width=1]
@ -71,8 +71,8 @@ For boards with an installed USB-to-UART bridge, the connection between the pers
default_fontsize = 16
# labels of diagram nodes
PC [label="Personal\nComputer"];
BRIDGE [label="USB-to-UART\n Bridge"];
PC [label="Personal\nComputer"];
BRIDGE [label="USB-to-UART\n Bridge"];
CHIP [label="{IDF_TARGET_NAME}", width=120];
# node connections
@ -106,8 +106,8 @@ Sometimes the USB-to-UART bridge is external. This is often used in small develo
default_fontsize = 16
# labels of diagram nodes
PC [label="Personal\n Computer"];
BRIDGE [label="USB-to-UART\n Bridge", width=180];
PC [label="Personal\n Computer"];
BRIDGE [label="USB-to-UART\n Bridge", width=180];
CHIP [label="{IDF_TARGET_NAME}", width=120];
DUMMY [shape=none, width=1]
@ -132,18 +132,18 @@ Sometimes the USB-to-UART bridge is external. This is often used in small develo
CHIP; DUMMY;
}
}
.. only:: SOC_USB_OTG_SUPPORTED or SOC_USB_SERIAL_JTAG_SUPPORTED
Flash using USB
---------------
For the {IDF_TARGET_NAME}, the USB peripheral is available, allowing you to flash the binaries without the need for an external USB-to-UART bridge.
{IDF_TARGET_USB_PIN_DM:default="Not Updated!", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19"}
{IDF_TARGET_USB_PIN_DP:default="Not Updated!", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20"}
{IDF_TARGET_USB_PIN_DM:default="Not Updated!", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19", esp32c6="GPIO12"}
{IDF_TARGET_USB_PIN_DP:default="Not Updated!", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20", esp32c6="GPIO13"}
The USB on the {IDF_TARGET_NAME} uses the **{IDF_TARGET_USB_PIN_DP}** for **D+** and **{IDF_TARGET_USB_PIN_DM}** for **D-**.
.. only:: SOC_USB_SERIAL_JTAG_SUPPORTED
@ -182,7 +182,7 @@ For devices downloaded using a USB-to-UART bridge, you can run the following com
You can change the flasher baud rate by replacing ``BAUD`` with the baud rate you need. The default baud rate is ``460800``.
.. note::
If the device does not support the auto download mode, you need to get into the download mode manually. To do so, press and hold the ``BOOT`` button and then press the ``RESET`` button once. After that release the ``BOOT`` button.
Check port on Windows

View File

@ -6,7 +6,7 @@ Flashing Troubleshooting
Failed to Connect
-----------------
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9"}
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="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 to manually reset as described below. If it does not help, you can find more details about possible issues in the `esptool troubleshooting <https://docs.espressif.com/projects/esptool/en/latest/esp32/troubleshooting.html>`_ page.

View File

@ -59,6 +59,15 @@ Introduction
* Multiple peripherals
* Intended for simple, high-volume IoT applications
.. only:: esp32c6
* Wi-Fi 6 (2.4 GHz band)
* Bluetooth Low Energy
* 802.15.4 Thread/Zigbee
* High performance 32-bit RISC-V single-core processor
* Multiple peripherals
* Built-in security hardware
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.

View File

@ -1,8 +1,8 @@
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1", esp32c2="1"}
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1", esp32c2="1", esp32c6="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_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 embedded flash", esp32c3="WiFi/BLE, silicon revision 0, 2MB external flash", esp32c6="WiFi/BLE, silicon revision v0.0, 2MB external flash"}
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332"}
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332", esp32c6="337332"}
Build the Project
=================
@ -271,6 +271,57 @@ When flashing, you will see the output log similar to the following:
Done
.. only:: esp32c6
.. code-block:: none
...
esptool esp32c6 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset --no-stub 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 v4.3
Serial port /dev/ttyUSB0
Connecting....
Chip is ESP32-C6 (revision v0.0)
Features: WiFi 6, BT 5
Crystal is 40MHz
MAC: 60:55:f9:f6:01:38
Changing baud rate to 460800
Changed.
Enabling default SPI flash mode...
Configuring flash size...
Flash will be erased from 0x00000000 to 0x00004fff...
Flash will be erased from 0x00010000 to 0x00028fff...
Flash will be erased from 0x00008000 to 0x00008fff...
Erasing flash...
Took 0.17s to erase flash block
Writing at 0x00000000... (5 %)
Writing at 0x00000c00... (23 %)
Writing at 0x00001c00... (47 %)
Writing at 0x00003000... (76 %)
Writing at 0x00004000... (100 %)
Wrote 17408 bytes at 0x00000000 in 0.5 seconds (254.6 kbit/s)...
Hash of data verified.
Erasing flash...
Took 0.85s to erase flash block
Writing at 0x00010000... (1 %)
Writing at 0x00014c00... (20 %)
Writing at 0x00019c00... (40 %)
Writing at 0x0001ec00... (60 %)
Writing at 0x00023c00... (80 %)
Writing at 0x00028c00... (100 %)
Wrote 102400 bytes at 0x00010000 in 3.2 seconds (253.5 kbit/s)...
Hash of data verified.
Erasing flash...
Took 0.04s to erase flash block
Writing at 0x00008000... (33 %)
Writing at 0x00008400... (66 %)
Writing at 0x00008800... (100 %)
Wrote 3072 bytes at 0x00008000 in 0.1 seconds (269.0 kbit/s)...
Hash of data verified.
Leaving...
Hard resetting via RTS pin...
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>`_.

View File

@ -27,7 +27,13 @@
本指南为 {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 RV32IMAC 32 位单核处理器。
.. only:: esp32c6
本指南为 {IDF_TARGET_NAME} 官方应用开发框架 `ESP-IDF <https://github.com/espressif/esp-idf>`_ 的配套文档。
{IDF_TARGET_NAME} 是一款支持 2.4 GHz Wi-Fi, 802.15.4 Thread/Zigbee 和低功耗蓝牙的芯片,搭载 RISC-V RV32IMAC 32 位单核处理器。
.. figure:: ../_static/about-doc.png
:align: center

View File

@ -33,7 +33,7 @@
default_fontsize = 16
# labels of diagram nodes
PC [label="Personal\n Computer"];
PC [label="Personal\n Computer"];
CHIP [label="{IDF_TARGET_NAME}", width=120];
DUMMY [shape=none, width=1]
@ -71,8 +71,8 @@
default_fontsize = 16
# labels of diagram nodes
PC [label="Personal\nComputer"];
BRIDGE [label="USB-to-UART\n Bridge"];
PC [label="Personal\nComputer"];
BRIDGE [label="USB-to-UART\n Bridge"];
CHIP [label="{IDF_TARGET_NAME}", width=120];
# node connections
@ -106,8 +106,8 @@
default_fontsize = 16
# labels of diagram nodes
PC [label="Personal\n Computer"];
BRIDGE [label="USB-to-UART\n Bridge", width=180];
PC [label="Personal\n Computer"];
BRIDGE [label="USB-to-UART\n Bridge", width=180];
CHIP [label="{IDF_TARGET_NAME}", width=120];
DUMMY [shape=none, width=1]
@ -132,18 +132,18 @@
CHIP; DUMMY;
}
}
.. only:: SOC_USB_OTG_SUPPORTED or SOC_USB_SERIAL_JTAG_SUPPORTED
使用 USB 进行烧录
------------------
{IDF_TARGET_NAME} 支持 USB 外设,无需外部 USB 至 UART 桥,即可烧录二进制文件。
{IDF_TARGET_USB_PIN_DM:default="尚未更新!", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19"}
{IDF_TARGET_USB_PIN_DP:default="尚未更新!", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20"}
{IDF_TARGET_USB_PIN_DM:default="尚未更新!", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19", esp32c6="GPIO12"}
{IDF_TARGET_USB_PIN_DP:default="尚未更新!", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20", esp32c6="GPIO13"}
{IDF_TARGET_NAME} 上的 USB 使用 **{IDF_TARGET_USB_PIN_DP}** 作为 **D+** **{IDF_TARGET_USB_PIN_DM}** 作为 **D-**
.. only:: SOC_USB_SERIAL_JTAG_SUPPORTED
@ -182,7 +182,7 @@
如需改变烧录器的波特率,请用需要的波特率代替 ``BAUD``。默认的波特率为 ``460800``
.. note::
如果设备不支持自动下载模式,则需要手动进入下载模式。请按住 ``BOOT`` 按钮,同时按一下 ``RESET`` 按钮。之后,松开 ``BOOT`` 按钮。
在 Windows 上查看端口

View File

@ -6,7 +6,7 @@
连接失败
-----------------
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9"}
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9"}
如果在运行给定命令时出现如“连接失败”这样的错误,造成该错误的原因之一可能是运行 ``esptool.py`` 时出现错误。 ``esptool.py`` 是构建系统调用的程序,用于重置芯片、与 ROM 引导加载器交互以及烧录固件的工具。可以按照以下步骤进行手动复位,轻松解决该问题。如果问题仍未解决,请参考 `esptool 故障排除 <https://docs.espressif.com/projects/esptool/en/latest/esp32/troubleshooting.html>`_ 获取更多信息。

View File

@ -59,6 +59,15 @@
* 多种外设
* 适用于较简单、大批量生产的物联网应用
.. only:: esp32c6
* 2.4 GHz Wi-Fi 6
* 低功耗蓝牙
* 802.15.4,支持 Thread 和 Zigbee 协议
* 高性能 32 位 RISC-V 单核处理器
* 多种外设
* 内置安全硬件
{IDF_TARGET_NAME} 采用 40 nm 工艺制成,具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性,适用于各种应用场景和不同功耗需求。
乐鑫为用户提供完整的软、硬件资源,进行 {IDF_TARGET_NAME} 硬件设备的开发。其中,乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用,可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。

View File

@ -1,8 +1,8 @@
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1", esp32c2="1"}
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1", esp32c2="1", esp32c6="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_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 embedded flash", esp32c3="WiFi/BLE, silicon revision 0, 2MB external flash", esp32c6="WiFi/BLE, silicon revision v0.0, 2MB external flash"}
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332"}
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332", esp32c6="337332"}
编译工程
=========================
@ -270,6 +270,56 @@
Hard resetting via RTS pin...
Done
.. only:: esp32c6
.. code-block:: none
...
esptool esp32c6 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset --no-stub 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 v4.3
Serial port /dev/ttyUSB0
Connecting....
Chip is ESP32-C6 (revision v0.0)
Features: WiFi 6, BT 5
Crystal is 40MHz
MAC: 60:55:f9:f6:01:38
Changing baud rate to 460800
Changed.
Enabling default SPI flash mode...
Configuring flash size...
Flash will be erased from 0x00000000 to 0x00004fff...
Flash will be erased from 0x00010000 to 0x00028fff...
Flash will be erased from 0x00008000 to 0x00008fff...
Erasing flash...
Took 0.17s to erase flash block
Writing at 0x00000000... (5 %)
Writing at 0x00000c00... (23 %)
Writing at 0x00001c00... (47 %)
Writing at 0x00003000... (76 %)
Writing at 0x00004000... (100 %)
Wrote 17408 bytes at 0x00000000 in 0.5 seconds (254.6 kbit/s)...
Hash of data verified.
Erasing flash...
Took 0.85s to erase flash block
Writing at 0x00010000... (1 %)
Writing at 0x00014c00... (20 %)
Writing at 0x00019c00... (40 %)
Writing at 0x0001ec00... (60 %)
Writing at 0x00023c00... (80 %)
Writing at 0x00028c00... (100 %)
Wrote 102400 bytes at 0x00010000 in 3.2 seconds (253.5 kbit/s)...
Hash of data verified.
Erasing flash...
Took 0.04s to erase flash block
Writing at 0x00008000... (33 %)
Writing at 0x00008400... (66 %)
Writing at 0x00008800... (100 %)
Wrote 3072 bytes at 0x00008000 in 0.1 seconds (269.0 kbit/s)...
Hash of data verified.
Leaving...
Hard resetting via RTS pin...
如果一切顺利,烧录完成后,开发板将会复位,应用程序 "hello_world" 开始运行。