From be189b1cfd96e68a3c73cdbb9a1296cdb55ec4ff Mon Sep 17 00:00:00 2001 From: Shang Zhou Date: Fri, 27 Aug 2021 15:09:35 +0800 Subject: [PATCH] updated the TOC of ESP-IDF API Reference to make it consistet with the real section title --- docs/en/api-reference/peripherals/adc.rst | 4 +- docs/en/api-reference/peripherals/dac.rst | 4 +- docs/en/api-reference/peripherals/ds.rst | 4 +- docs/en/api-reference/peripherals/hmac.rst | 4 +- docs/en/api-reference/peripherals/i2c.rst | 4 +- docs/en/api-reference/peripherals/i2s.rst | 4 +- docs/en/api-reference/peripherals/index.rst | 58 +++++++++---------- docs/en/api-reference/peripherals/ledc.rst | 4 +- docs/en/api-reference/peripherals/mcpwm.rst | 4 +- docs/en/api-reference/peripherals/pcnt.rst | 4 +- docs/en/api-reference/peripherals/rmt.rst | 4 +- .../api-reference/peripherals/temp_sensor.rst | 2 +- docs/en/api-reference/peripherals/twai.rst | 4 +- docs/en/api-reference/peripherals/uart.rst | 4 +- .../zh_CN/api-reference/peripherals/index.rst | 58 +++++++++---------- 15 files changed, 83 insertions(+), 83 deletions(-) diff --git a/docs/en/api-reference/peripherals/adc.rst b/docs/en/api-reference/peripherals/adc.rst index 1723b56d55..d9865c47ec 100644 --- a/docs/en/api-reference/peripherals/adc.rst +++ b/docs/en/api-reference/peripherals/adc.rst @@ -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_ADC2_CH7: default="GPIO 0", esp32="GPIO 27"} diff --git a/docs/en/api-reference/peripherals/dac.rst b/docs/en/api-reference/peripherals/dac.rst index 50251ca9a2..06f4005a27 100644 --- a/docs/en/api-reference/peripherals/dac.rst +++ b/docs/en/api-reference/peripherals/dac.rst @@ -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_2: default = "GPIO26", esp32 = "GPIO26", esp32s2 = "GPIO18"} diff --git a/docs/en/api-reference/peripherals/ds.rst b/docs/en/api-reference/peripherals/ds.rst index 125b9be28e..0e1b506ba8 100644 --- a/docs/en/api-reference/peripherals/ds.rst +++ b/docs/en/api-reference/peripherals/ds.rst @@ -1,5 +1,5 @@ -Digital Signature -================= +Digital Signature (DS) +====================== The Digital Signature (DS) module provides hardware acceleration of signing messages based on RSA. It uses pre-encrypted parameters to calculate a signature. diff --git a/docs/en/api-reference/peripherals/hmac.rst b/docs/en/api-reference/peripherals/hmac.rst index ae594443ef..a431158fa6 100644 --- a/docs/en/api-reference/peripherals/hmac.rst +++ b/docs/en/api-reference/peripherals/hmac.rst @@ -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. HMACs work with pre-shared secret keys and provide authenticity and integrity to a message. diff --git a/docs/en/api-reference/peripherals/i2c.rst b/docs/en/api-reference/peripherals/i2c.rst index 7e6022b37b..29e95101a3 100644 --- a/docs/en/api-reference/peripherals/i2c.rst +++ b/docs/en/api-reference/peripherals/i2c.rst @@ -1,5 +1,5 @@ -I2C Driver -========== +Inter-Integrated Circuit (I2C) +============================== :link_to_translation:`zh_CN:[中文]` diff --git a/docs/en/api-reference/peripherals/i2s.rst b/docs/en/api-reference/peripherals/i2s.rst index 6fd3bd2415..c56b732a15 100644 --- a/docs/en/api-reference/peripherals/i2s.rst +++ b/docs/en/api-reference/peripherals/i2s.rst @@ -1,5 +1,5 @@ -I2S -=== +Inter-IC Sound (I2S) +==================== {IDF_TARGET_I2S_NUM:default="two", esp32s2="one", esp32c3="one"} diff --git a/docs/en/api-reference/peripherals/index.rst b/docs/en/api-reference/peripherals/index.rst index 29a0bf94da..730983ee9d 100644 --- a/docs/en/api-reference/peripherals/index.rst +++ b/docs/en/api-reference/peripherals/index.rst @@ -6,34 +6,34 @@ Peripherals API .. toctree:: :maxdepth: 1 - ADC - :SOC_DAC_SUPPORTED: DAC - General Purpose Timer - GPIO (including RTC low power I/O) - :SOC_DEDICATED_GPIO_SUPPORTED: Dedicated GPIO - :SOC_HMAC_SUPPORTED: HMAC - :SOC_DIG_SIGN_SUPPORTED: Digital Signature - I2C - I2S - LED Control - :SOC_MCPWM_SUPPORTED: MCPWM - :SOC_PCNT_SUPPORTED: Pulse Counter - Remote Control - :esp32 or esp32s3: SD Pull-up Requirements - :SOC_SDMMC_HOST_SUPPORTED: SDMMC Host - SD SPI Host - :SOC_SDIO_SLAVE_SUPPORTED: SDIO Slave - Sigma-delta Modulation - SPI Master - SPI Slave - :esp32: Secure Element - :esp32s2: SPI Slave Half Duplex - :SOC_TEMP_SENSOR_SUPPORTED: Temp sensor - :SOC_TOUCH_SENSOR_NUM: Touch Sensor - :esp32s2: Touch Element - TWAI - UART - :SOC_USB_OTG_SUPPORTED: USB Device - :SOC_USB_OTG_SUPPORTED: USB Host + adc + :SOC_DAC_SUPPORTED: dac + timer + gpio + :SOC_DEDICATED_GPIO_SUPPORTED: dedic_gpio + :SOC_HMAC_SUPPORTED: hmac + :SOC_DIG_SIGN_SUPPORTED: ds + i2c + i2s + ledc + :SOC_MCPWM_SUPPORTED: mcpwm + :SOC_PCNT_SUPPORTED: pcnt + rmt + :esp32 or esp32s3: sd_pullup_requirements + :SOC_SDMMC_HOST_SUPPORTED: sdmmc_host + sdspi_host + :SOC_SDIO_SLAVE_SUPPORTED: sdio_slave + sigmadelta + spi_master + spi_slave + :esp32: secure_element + :esp32s2: spi_slave_hd + :SOC_TEMP_SENSOR_SUPPORTED: temp_sensor + :SOC_TOUCH_SENSOR_NUM: touch_pad + :esp32s2: touch_element + twai + uart + :SOC_USB_OTG_SUPPORTED: usb_device + :SOC_USB_OTG_SUPPORTED: usb_host Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples. \ No newline at end of file diff --git a/docs/en/api-reference/peripherals/ledc.rst b/docs/en/api-reference/peripherals/ledc.rst index dcda4b7719..6eb16f804f 100644 --- a/docs/en/api-reference/peripherals/ledc.rst +++ b/docs/en/api-reference/peripherals/ledc.rst @@ -1,5 +1,5 @@ -LED Control -=========== +LED Control (LEDC) +================== {IDF_TARGET_LEDC_CHAN_NUM:default="8", esp32="16", esp32s2="8", esp32c3="6"} :link_to_translation:`zh_CN:[中文]` diff --git a/docs/en/api-reference/peripherals/mcpwm.rst b/docs/en/api-reference/peripherals/mcpwm.rst index 7693fe1439..a9d6b94caa 100644 --- a/docs/en/api-reference/peripherals/mcpwm.rst +++ b/docs/en/api-reference/peripherals/mcpwm.rst @@ -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. diff --git a/docs/en/api-reference/peripherals/pcnt.rst b/docs/en/api-reference/peripherals/pcnt.rst index 22433e8358..6cb0e81e2e 100644 --- a/docs/en/api-reference/peripherals/pcnt.rst +++ b/docs/en/api-reference/peripherals/pcnt.rst @@ -1,5 +1,5 @@ -Pulse Counter -============= +Pulse Counter (PCNT) +==================== {IDF_TARGET_PCNT_UNIT_NUM:default="8", esp32s2="4"} {IDF_TARGET_PCNT_MAX_UNIT_NUM:default="7", esp32s2="3"} diff --git a/docs/en/api-reference/peripherals/rmt.rst b/docs/en/api-reference/peripherals/rmt.rst index 35dd8c6f13..b0758e7897 100644 --- a/docs/en/api-reference/peripherals/rmt.rst +++ b/docs/en/api-reference/peripherals/rmt.rst @@ -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. diff --git a/docs/en/api-reference/peripherals/temp_sensor.rst b/docs/en/api-reference/peripherals/temp_sensor.rst index c77de66b57..a9e9fcb1be 100644 --- a/docs/en/api-reference/peripherals/temp_sensor.rst +++ b/docs/en/api-reference/peripherals/temp_sensor.rst @@ -1,5 +1,5 @@ Temperature Sensor -================== +=================== Overview -------- diff --git a/docs/en/api-reference/peripherals/twai.rst b/docs/en/api-reference/peripherals/twai.rst index 31aed19e2a..676106dece 100644 --- a/docs/en/api-reference/peripherals/twai.rst +++ b/docs/en/api-reference/peripherals/twai.rst @@ -1,5 +1,5 @@ -TWAI -==== +Two-Wire Automotive Interface (TWAI) +==================================== .. -------------------------------- Overview ----------------------------------- diff --git a/docs/en/api-reference/peripherals/uart.rst b/docs/en/api-reference/peripherals/uart.rst index fc18adfe42..57016cedbe 100644 --- a/docs/en/api-reference/peripherals/uart.rst +++ b/docs/en/api-reference/peripherals/uart.rst @@ -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"} diff --git a/docs/zh_CN/api-reference/peripherals/index.rst b/docs/zh_CN/api-reference/peripherals/index.rst index 0232a33d4a..3089a2a45e 100644 --- a/docs/zh_CN/api-reference/peripherals/index.rst +++ b/docs/zh_CN/api-reference/peripherals/index.rst @@ -6,34 +6,34 @@ .. toctree:: :maxdepth: 1 - ADC - :SOC_DAC_SUPPORTED: DAC - 通用定时器 - GPIO (including RTC low power I/O) - :SOC_DEDICATED_GPIO_SUPPORTED: Dedicated GPIO - :SOC_HMAC_SUPPORTED: HMAC - :SOC_DIG_SIGN_SUPPORTED: Digital Signature - I2C - I2S - LED 控制器 - :SOC_MCPWM_SUPPORTED: MCPWM - :SOC_PCNT_SUPPORTED: Pulse Counter - Remote Control - :esp32 or esp32s3: SD Pull-up Requirements - :SOC_SDMMC_HOST_SUPPORTED: SDMMC Host - SD SPI Host - :SOC_SDIO_SLAVE_SUPPORTED: SDIO Slave - Sigma-delta Modulation - SPI Master - SPI Slave - :esp32: Secure Element - :esp32s2: SPI Slave Half Duplex - :SOC_TEMP_SENSOR_SUPPORTED: Temp sensor - :SOC_TOUCH_SENSOR_NUM: 触摸传感器 - :esp32s2: Touch Element - TWAI - UART - :SOC_USB_OTG_SUPPORTED: USB 设备 (Device) - :SOC_USB_OTG_SUPPORTED: USB 主机 (Host) + adc + :SOC_DAC_SUPPORTED: dac + timer + gpio + :SOC_DEDICATED_GPIO_SUPPORTED: dedic_gpio + :SOC_HMAC_SUPPORTED: hmac + :SOC_DIG_SIGN_SUPPORTED: ds + i2c + i2s + ledc + :SOC_MCPWM_SUPPORTED: mcpwm + :SOC_PCNT_SUPPORTED: pcnt + rmt + :esp32 or esp32s3: sd_pullup_requirements + :SOC_SDMMC_HOST_SUPPORTED: sdmmc_host + sdspi_host + :SOC_SDIO_SLAVE_SUPPORTED: sdio_slave + sigmadelta + spi_master + spi_slave + :esp32: secure_element + :esp32s2: spi_slave_hd + :SOC_TEMP_SENSOR_SUPPORTED: temp_sensor + :SOC_TOUCH_SENSOR_NUM: touch_pad + :esp32s2: touch_element + twai + uart + :SOC_USB_OTG_SUPPORTED: usb_device + :SOC_USB_OTG_SUPPORTED: usb_host 本部分的 API 示例代码存放在 ESP-IDF 示例项目的 :example:`peripherals` 目录下。 \ No newline at end of file