esp-idf/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 17:08:35 -05:00			`Peripherals API`
			`***************`

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

Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`.. toctree::`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`:maxdepth: 1`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`ADC <adc>`
dac: added DAC support macro Remove DAC support on ESP32-S3 2021-04-06 09:56:27 -04:00			`:SOC_DAC_SUPPORTED: DAC <dac>`
doc: update doc of general purpose timer 2021-02-24 01:08:41 -05:00			`General Purpose Timer <timer>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`GPIO (including RTC low power I/O) <gpio>`
doc: dedicated gpio api reference 2020-09-29 06:14:17 -04:00			`:SOC_DEDICATED_GPIO_SUPPORTED: Dedicated GPIO <dedic_gpio>`
docs: update api-reference chapters for C3 Checked and updated the following chapters: * api-reference/network * api-reference/protocols * api-reference/provisioning * api-reference/storage * api-reference/peripherals/ds * api-reference/peripherals/hmac * api-reference/peripherals/secure_element 2021-02-22 20:31:29 -05:00			`:SOC_HMAC_SUPPORTED: HMAC <hmac>`
			`:SOC_DIG_SIGN_SUPPORTED: Digital Signature <ds>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`I2C <i2c>`
			`I2S <i2s>`
			`LED Control <ledc>`
doc: add generation of tags from sdkconfig and x_caps.h headers Also updates the way we handle exclude_patterns to use the new tags Closes IDF-1484 2020-04-30 04:55:12 -04:00			`:SOC_MCPWM_SUPPORTED: MCPWM <mcpwm>`
Docs: Add C3 support to build_docs 2020-10-28 21:57:09 -04:00			`:SOC_PCNT_SUPPORTED: Pulse Counter <pcnt>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`Remote Control <rmt>`
build docs: enable building of S3 docs * Added suport for building esp32s3 docs * Fixed all related warnings * Activated building of S3 docs for build HTML fast CI job 2021-05-24 03:08:00 -04:00			`:esp32 or esp32s3: SD Pull-up Requirements <sd_pullup_requirements>`
doc: add generation of tags from sdkconfig and x_caps.h headers Also updates the way we handle exclude_patterns to use the new tags Closes IDF-1484 2020-04-30 04:55:12 -04:00			`:SOC_SDMMC_HOST_SUPPORTED: SDMMC Host <sdmmc_host>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`SD SPI Host <sdspi_host>`
doc: add generation of tags from sdkconfig and x_caps.h headers Also updates the way we handle exclude_patterns to use the new tags Closes IDF-1484 2020-04-30 04:55:12 -04:00			`:SOC_SDIO_SLAVE_SUPPORTED: SDIO Slave <sdio_slave>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`Sigma-delta Modulation <sigmadelta>`
			`SPI Master <spi_master>`
			`SPI Slave <spi_slave>`
secure_element: atecc608_ecdsa example * Replaced crypotoauthlib with esp-cryptoauthlib * Added menuconfig option for esp-tls about using HSM * Added error codes for HSM in esp-tls, * Added support to select different type of ATECC608A chips * Added README, updated docs * tcp_transport: Added option to enable secure_element for ssl Closes https://github.com/espressif/esp-idf/issues/4432 2020-04-06 10:42:52 -04:00			`:esp32: Secure Element <secure_element>`
spi_slave_hd: new driver for spi slave in half duplex mode 2020-04-29 04:20:40 -04:00			`:esp32s2: SPI Slave Half Duplex <spi_slave_hd>`
docs: Resolve doxygen & Sphinx warnings 2020-01-28 17:31:14 -05:00			`:esp32s2: Temp sensor <temp_sensor>`
Docs: Add C3 support to build_docs 2020-10-28 21:57:09 -04:00			`:SOC_TOUCH_SENSOR_NUM: Touch Sensor <touch_pad>`
touch_element: add touch element api-reference doc 2020-12-29 23:25:14 -05:00			`:esp32s2: Touch Element <touch_element>`
TWAI: Add ESP32-S2 support This commit adds TWAI driver support for the ESP32-S2. The following features were added: - Expanded BRP support - Expanded CLKOUT Divider Support - Updated example READMEs 2020-03-11 12:45:02 -04:00			`TWAI <twai>`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`UART <uart>`
docs: tinyusb documentation 2020-08-18 05:51:32 -04:00			`:SOC_USB_SUPPORTED: USB <usb>`
Added links from api category TOC to example category folders Typo fix in bluetooth README.md 2017-01-18 15:04:11 -05:00
Review the file api-reference/peripherals/sd_pullup_requirements.rst 2019-08-09 05:58:51 -04:00
Doc/review api reference indexes 2019-04-28 22:53:42 -04:00			Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples.