docs/en/api-reference/peripherals/index.rst

Peripherals API
***************

:link_to_translation:`zh_CN:[中文]`

.. toctree::
    :maxdepth: 1

    ADC <adc>
    :SOC_DAC_SUPPORTED: DAC <dac>
    General Purpose Timer <timer>
    GPIO (including RTC low power I/O) <gpio>
    :SOC_DEDICATED_GPIO_SUPPORTED: Dedicated GPIO <dedic_gpio>
    :SOC_HMAC_SUPPORTED: HMAC <hmac>
    :SOC_DIG_SIGN_SUPPORTED: Digital Signature <ds>
    I2C <i2c>
    I2S <i2s>
    LED Control <ledc>
    :SOC_MCPWM_SUPPORTED: MCPWM <mcpwm>
    :SOC_PCNT_SUPPORTED: Pulse Counter <pcnt>
    Remote Control <rmt>
    :esp32 or esp32s3: SD Pull-up Requirements <sd_pullup_requirements>
    :SOC_SDMMC_HOST_SUPPORTED: SDMMC Host <sdmmc_host>
    SD SPI Host <sdspi_host>
    :SOC_SDIO_SLAVE_SUPPORTED: SDIO Slave <sdio_slave>
    Sigma-delta Modulation <sigmadelta>
    SPI Master <spi_master>
    SPI Slave <spi_slave>
    :esp32: Secure Element <secure_element>
    :esp32s2: SPI Slave Half Duplex <spi_slave_hd>
    :esp32s2: Temp sensor <temp_sensor>
    :SOC_TOUCH_SENSOR_NUM: Touch Sensor <touch_pad>
    :esp32s2: Touch Element <touch_element>
    TWAI <twai>
    UART <uart>
    :SOC_USB_SUPPORTED: USB <usb>

Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples.
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00			`Peripherals API`
			`***************`

Add Chinese translation for index.rst files and esp_wifi.rst file in api-reference following Kirill's English review, including: 2019-05-15 21:05:44 +08:00			:link_to_translation:`zh_CN:[中文]`

Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00			`.. toctree::`
docs: Alphbetically sort toctree 2019-08-13 16:01:50 +08:00			`:maxdepth: 1`
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00
docs: Alphbetically sort toctree 2019-08-13 16:01:50 +08:00			`ADC <adc>`
dac: added DAC support macro 2021-04-06 21:56:27 +08:00			`:SOC_DAC_SUPPORTED: DAC <dac>`
doc: update doc of general purpose timer 2021-02-24 14:08:41 +08:00			`General Purpose Timer <timer>`
docs: Alphbetically sort toctree 2019-08-13 16:01:50 +08:00			`GPIO (including RTC low power I/O) <gpio>`
doc: dedicated gpio api reference 2020-09-29 18:14:17 +08:00			`:SOC_DEDICATED_GPIO_SUPPORTED: Dedicated GPIO <dedic_gpio>`
docs: update api-reference chapters for C3 2021-02-23 09:31:29 +08:00			`:SOC_HMAC_SUPPORTED: HMAC <hmac>`
			`:SOC_DIG_SIGN_SUPPORTED: Digital Signature <ds>`
docs: Alphbetically sort toctree 2019-08-13 16:01:50 +08:00			`I2C <i2c>`
			`I2S <i2s>`
			`LED Control <ledc>`
doc: add generation of tags from sdkconfig and x_caps.h headers 2020-04-30 16:55:12 +08:00			`:SOC_MCPWM_SUPPORTED: MCPWM <mcpwm>`
Docs: Add C3 support to build_docs 2020-10-29 09:57:09 +08:00			`:SOC_PCNT_SUPPORTED: Pulse Counter <pcnt>`
docs: Alphbetically sort toctree 2019-08-13 16:01:50 +08:00			`Remote Control <rmt>`
build docs: enable building of S3 docs 2021-05-24 15:08:00 +08:00			`:esp32 or esp32s3: SD Pull-up Requirements <sd_pullup_requirements>`
doc: add generation of tags from sdkconfig and x_caps.h headers 2020-04-30 16:55:12 +08:00			`:SOC_SDMMC_HOST_SUPPORTED: SDMMC Host <sdmmc_host>`
docs: Alphbetically sort toctree 2019-08-13 16:01:50 +08:00			`SD SPI Host <sdspi_host>`
doc: add generation of tags from sdkconfig and x_caps.h headers 2020-04-30 16:55:12 +08:00			`:SOC_SDIO_SLAVE_SUPPORTED: SDIO Slave <sdio_slave>`
docs: Alphbetically sort toctree 2019-08-13 16:01:50 +08:00			`Sigma-delta Modulation <sigmadelta>`
			`SPI Master <spi_master>`
			`SPI Slave <spi_slave>`
secure_element: atecc608_ecdsa example 2020-04-06 20:12:52 +05:30			`:esp32: Secure Element <secure_element>`
spi_slave_hd: new driver for spi slave in half duplex mode 2020-04-29 16:20:40 +08:00			`:esp32s2: SPI Slave Half Duplex <spi_slave_hd>`
docs: Resolve doxygen & Sphinx warnings 2020-01-29 09:31:14 +11:00			`:esp32s2: Temp sensor <temp_sensor>`
Docs: Add C3 support to build_docs 2020-10-29 09:57:09 +08:00			`:SOC_TOUCH_SENSOR_NUM: Touch Sensor <touch_pad>`
touch_element: add touch element api-reference doc 2020-12-30 12:25:14 +08:00			`:esp32s2: Touch Element <touch_element>`
TWAI: Add ESP32-S2 support 2020-03-11 17:45:02 +01:00			`TWAI <twai>`
docs: Alphbetically sort toctree 2019-08-13 16:01:50 +08:00			`UART <uart>`
docs: tinyusb documentation 2020-08-18 11:51:32 +02:00			`:SOC_USB_SUPPORTED: USB <usb>`
Added links from api category TOC to example category folders 2017-01-18 21:04:11 +01:00
docs:update CN translation for fatal-errors, external-ram, and idf-monitor 2021-06-08 19:22:21 +08:00			Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples.