espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-06 14:14:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'doc/add_Chinese_translation_for_index_in_get-started_folder' into 'master'

Browse Source 
Update the TOC of ESP-IDF API Reference to make it consistent with the real section title

See merge request espressif/esp-idf!14979
This commit is contained in:
Shang Zhou
2021-09-06 03:36:08 +00:00
parent 3f71917af1 be189b1cfd
commit 2ab2e3571a
15 changed files with 83 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/api-reference/peripherals/adc.rst
View File

@@ -1,5 +1,5 @@
Analog to Digital Converter Analog to Digital Converter (ADC)
=========================== =================================
{IDF_TARGET_ADC1_CH0: default="GPIO 0", esp32="GPIO 36"} {IDF_TARGET_ADC1_CH0: default="GPIO 0", esp32="GPIO 36"}
{IDF_TARGET_ADC2_CH7: default="GPIO 0", esp32="GPIO 27"} {IDF_TARGET_ADC2_CH7: default="GPIO 0", esp32="GPIO 27"}

4
docs/en/api-reference/peripherals/dac.rst
View File

@@ -1,5 +1,5 @@
Digital To Analog Converter Digital To Analog Converter (DAC)
=========================== =================================
{IDF_TARGET_DAC_CH_1: default = "GPIO25", esp32 = "GPIO25", esp32s2 = "GPIO17"} {IDF_TARGET_DAC_CH_1: default = "GPIO25", esp32 = "GPIO25", esp32s2 = "GPIO17"}
{IDF_TARGET_DAC_CH_2: default = "GPIO26", esp32 = "GPIO26", esp32s2 = "GPIO18"} {IDF_TARGET_DAC_CH_2: default = "GPIO26", esp32 = "GPIO26", esp32s2 = "GPIO18"}

4
docs/en/api-reference/peripherals/ds.rst
View File

@@ -1,5 +1,5 @@
Digital Signature Digital Signature (DS)
================= ======================
The Digital Signature (DS) module provides hardware acceleration of signing messages based on RSA. The Digital Signature (DS) module provides hardware acceleration of signing messages based on RSA.
It uses pre-encrypted parameters to calculate a signature. It uses pre-encrypted parameters to calculate a signature.

4
docs/en/api-reference/peripherals/hmac.rst
View File

@@ -1,5 +1,5 @@
HMAC Hash-based Message Authentication Code (HMAC)
==== =============================================
The HMAC (Hash-based Message Authentication Code) module provides hardware acceleration for SHA256-HMAC generation using a key burned into an eFuse block. The HMAC (Hash-based Message Authentication Code) module provides hardware acceleration for SHA256-HMAC generation using a key burned into an eFuse block.
HMACs work with pre-shared secret keys and provide authenticity and integrity to a message. HMACs work with pre-shared secret keys and provide authenticity and integrity to a message.

4
docs/en/api-reference/peripherals/i2c.rst
View File

@@ -1,5 +1,5 @@
I2C Driver Inter-Integrated Circuit (I2C)
========== ==============================
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`

4
docs/en/api-reference/peripherals/i2s.rst
View File

@@ -1,5 +1,5 @@
I2S Inter-IC Sound (I2S)
=== ====================
{IDF_TARGET_I2S_NUM:default="two", esp32s2="one", esp32c3="one"} {IDF_TARGET_I2S_NUM:default="two", esp32s2="one", esp32c3="one"}

58
docs/en/api-reference/peripherals/index.rst
View File

@@ -6,34 +6,34 @@ Peripherals API
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
ADC <adc> adc
:SOC_DAC_SUPPORTED: DAC <dac> :SOC_DAC_SUPPORTED: dac
General Purpose Timer <timer> timer
GPIO (including RTC low power I/O) <gpio> gpio
:SOC_DEDICATED_GPIO_SUPPORTED: Dedicated GPIO <dedic_gpio> :SOC_DEDICATED_GPIO_SUPPORTED: dedic_gpio
:SOC_HMAC_SUPPORTED: HMAC <hmac> :SOC_HMAC_SUPPORTED: hmac
:SOC_DIG_SIGN_SUPPORTED: Digital Signature <ds> :SOC_DIG_SIGN_SUPPORTED: ds
I2C <i2c> i2c
I2S <i2s> i2s
LED Control <ledc> ledc
:SOC_MCPWM_SUPPORTED: MCPWM <mcpwm> :SOC_MCPWM_SUPPORTED: mcpwm
:SOC_PCNT_SUPPORTED: Pulse Counter <pcnt> :SOC_PCNT_SUPPORTED: pcnt
Remote Control <rmt> rmt
:esp32 or esp32s3: SD Pull-up Requirements <sd_pullup_requirements> :esp32 or esp32s3: sd_pullup_requirements
:SOC_SDMMC_HOST_SUPPORTED: SDMMC Host <sdmmc_host> :SOC_SDMMC_HOST_SUPPORTED: sdmmc_host
SD SPI Host <sdspi_host> sdspi_host
:SOC_SDIO_SLAVE_SUPPORTED: SDIO Slave <sdio_slave> :SOC_SDIO_SLAVE_SUPPORTED: sdio_slave
Sigma-delta Modulation <sigmadelta> sigmadelta
SPI Master <spi_master> spi_master
SPI Slave <spi_slave> spi_slave
:esp32: Secure Element <secure_element> :esp32: secure_element
:esp32s2: SPI Slave Half Duplex <spi_slave_hd> :esp32s2: spi_slave_hd
:SOC_TEMP_SENSOR_SUPPORTED: Temp sensor <temp_sensor> :SOC_TEMP_SENSOR_SUPPORTED: temp_sensor
:SOC_TOUCH_SENSOR_NUM: Touch Sensor <touch_pad> :SOC_TOUCH_SENSOR_NUM: touch_pad
:esp32s2: Touch Element <touch_element> :esp32s2: touch_element
TWAI <twai> twai
UART <uart> uart
:SOC_USB_OTG_SUPPORTED: USB Device <usb_device> :SOC_USB_OTG_SUPPORTED: usb_device
:SOC_USB_OTG_SUPPORTED: USB Host <usb_host> :SOC_USB_OTG_SUPPORTED: usb_host
Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples. Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples.

4
docs/en/api-reference/peripherals/ledc.rst
View File

@@ -1,5 +1,5 @@
LED Control LED Control (LEDC)
=========== ==================
{IDF_TARGET_LEDC_CHAN_NUM:default="8", esp32="16", esp32s2="8", esp32c3="6"} {IDF_TARGET_LEDC_CHAN_NUM:default="8", esp32="16", esp32s2="8", esp32c3="6"}
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`

4
docs/en/api-reference/peripherals/mcpwm.rst
View File

@@ -1,5 +1,5 @@
MCPWM Motor Control Pulse Width Modulator (MCPWM)
===== ===========================================
{IDF_TARGET_NAME} has two MCPWM units which can be used to control different types of motors. Each unit has three pairs of PWM outputs. {IDF_TARGET_NAME} has two MCPWM units which can be used to control different types of motors. Each unit has three pairs of PWM outputs.

4
docs/en/api-reference/peripherals/pcnt.rst
View File

@@ -1,5 +1,5 @@
Pulse Counter Pulse Counter (PCNT)
============= ====================
{IDF_TARGET_PCNT_UNIT_NUM:default="8", esp32s2="4"} {IDF_TARGET_PCNT_UNIT_NUM:default="8", esp32s2="4"}
{IDF_TARGET_PCNT_MAX_UNIT_NUM:default="7", esp32s2="3"} {IDF_TARGET_PCNT_MAX_UNIT_NUM:default="7", esp32s2="3"}

4
docs/en/api-reference/peripherals/rmt.rst
View File

@@ -1,5 +1,5 @@
RMT Remote Control (RMT)
=== ====================
The RMT (Remote Control) module driver can be used to send and receive infrared remote control signals. Due to flexibility of RMT module, the driver can also be used to generate or receive many other types of signals. The RMT (Remote Control) module driver can be used to send and receive infrared remote control signals. Due to flexibility of RMT module, the driver can also be used to generate or receive many other types of signals.

2
docs/en/api-reference/peripherals/temp_sensor.rst
View File

@@ -1,5 +1,5 @@
Temperature Sensor Temperature Sensor
================== ===================
Overview Overview
-------- --------

4
docs/en/api-reference/peripherals/twai.rst
View File

@@ -1,5 +1,5 @@
TWAI Two-Wire Automotive Interface (TWAI)
==== ====================================
.. -------------------------------- Overview ----------------------------------- .. -------------------------------- Overview -----------------------------------

4
docs/en/api-reference/peripherals/uart.rst
View File

@@ -1,5 +1,5 @@
UART Universal Asynchronous Receiver/Transmitter (UART)
==== ==================================================
{IDF_TARGET_UART_NUM:default = "UART_NUM_1", esp32 = "UART_NUM_2", esp32s3 = "UART_NUM_2"} {IDF_TARGET_UART_NUM:default = "UART_NUM_1", esp32 = "UART_NUM_2", esp32s3 = "UART_NUM_2"}

58
docs/zh_CN/api-reference/peripherals/index.rst
View File

@@ -6,34 +6,34 @@
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
ADC <adc> adc
:SOC_DAC_SUPPORTED: DAC <dac> :SOC_DAC_SUPPORTED: dac
通用定时器 <timer> timer
GPIO (including RTC low power I/O) <gpio> gpio
:SOC_DEDICATED_GPIO_SUPPORTED: Dedicated GPIO <dedic_gpio> :SOC_DEDICATED_GPIO_SUPPORTED: dedic_gpio
:SOC_HMAC_SUPPORTED: HMAC <hmac> :SOC_HMAC_SUPPORTED: hmac
:SOC_DIG_SIGN_SUPPORTED: Digital Signature <ds> :SOC_DIG_SIGN_SUPPORTED: ds
I2C <i2c> i2c
I2S <i2s> i2s
LED 控制器 <ledc> ledc
:SOC_MCPWM_SUPPORTED: MCPWM <mcpwm> :SOC_MCPWM_SUPPORTED: mcpwm
:SOC_PCNT_SUPPORTED: Pulse Counter <pcnt> :SOC_PCNT_SUPPORTED: pcnt
Remote Control <rmt> rmt
:esp32 or esp32s3: SD Pull-up Requirements <sd_pullup_requirements> :esp32 or esp32s3: sd_pullup_requirements
:SOC_SDMMC_HOST_SUPPORTED: SDMMC Host <sdmmc_host> :SOC_SDMMC_HOST_SUPPORTED: sdmmc_host
SD SPI Host <sdspi_host> sdspi_host
:SOC_SDIO_SLAVE_SUPPORTED: SDIO Slave <sdio_slave> :SOC_SDIO_SLAVE_SUPPORTED: sdio_slave
Sigma-delta Modulation <sigmadelta> sigmadelta
SPI Master <spi_master> spi_master
SPI Slave <spi_slave> spi_slave
:esp32: Secure Element <secure_element> :esp32: secure_element
:esp32s2: SPI Slave Half Duplex <spi_slave_hd> :esp32s2: spi_slave_hd
:SOC_TEMP_SENSOR_SUPPORTED: Temp sensor <temp_sensor> :SOC_TEMP_SENSOR_SUPPORTED: temp_sensor
:SOC_TOUCH_SENSOR_NUM: 触摸传感器 <touch_pad> :SOC_TOUCH_SENSOR_NUM: touch_pad
:esp32s2: Touch Element <touch_element> :esp32s2: touch_element
TWAI <twai> twai
UART <uart> uart
:SOC_USB_OTG_SUPPORTED: USB 设备 (Device) <usb_device> :SOC_USB_OTG_SUPPORTED: usb_device
:SOC_USB_OTG_SUPPORTED: USB 主机 (Host) <usb_host> :SOC_USB_OTG_SUPPORTED: usb_host
本部分的 API 示例代码存放在 ESP-IDF 示例项目的 :example:`peripherals` 目录下。 本部分的 API 示例代码存放在 ESP-IDF 示例项目的 :example:`peripherals` 目录下。