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

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

:link_to_translation:`zh_CN:[中文]`

.. toctree::
    :maxdepth: 1

    :SOC_ADC_SUPPORTED: adc_oneshot
    :SOC_ADC_DMA_SUPPORTED: adc_continuous
    :SOC_ADC_SUPPORTED: adc_calibration
    :SOC_ANA_CMPR_SUPPORTED: ana_cmpr
    :SOC_MIPI_CSI_SUPPORTED: camera_driver
    :SOC_CLK_TREE_SUPPORTED: clk_tree
    :SOC_DAC_SUPPORTED: dac
    :SOC_ECDSA_SUPPORTED: ecdsa
    :SOC_ETM_SUPPORTED: etm
    gpio
    gptimer
    :SOC_DEDICATED_GPIO_SUPPORTED: dedic_gpio
    :SOC_HMAC_SUPPORTED: hmac
    :SOC_DIG_SIGN_SUPPORTED: ds
    :SOC_I2C_SUPPORTED: i2c
    :SOC_I2S_SUPPORTED: i2s
    :SOC_ISP_SUPPORTED: isp
    :SOC_JPEG_CODEC_SUPPORTED: jpeg
    lcd/index
    :SOC_GP_LDO_SUPPORTED: ldo_regulator
    ledc
    :SOC_MCPWM_SUPPORTED: mcpwm
    :SOC_PARLIO_SUPPORTED: parlio
    :SOC_PCNT_SUPPORTED: pcnt
    :SOC_PPA_SUPPORTED: ppa
    :SOC_RMT_SUPPORTED: rmt
    :SOC_SDMMC_HOST_SUPPORTED or SOC_SDIO_SLAVE_SUPPORTED: sd_pullup_requirements
    :SOC_SDMMC_HOST_SUPPORTED: sdmmc_host
    :SOC_GPSPI_SUPPORTED: sdspi_host
    :SOC_SDIO_SLAVE_SUPPORTED: sdio_slave
    :SOC_SDM_SUPPORTED: sdm
    :SOC_SPI_FLASH_SUPPORTED: spi_flash/index
    :SOC_GPSPI_SUPPORTED: spi_master
    :SOC_GPSPI_SUPPORTED: spi_slave
    :SOC_SPI_SUPPORT_SLAVE_HD_VER2: spi_slave_hd
    :SOC_TEMP_SENSOR_SUPPORTED: temp_sensor
    :SOC_TOUCH_SENSOR_SUPPORTED and not esp32p4: touch_pad
    :esp32p4: cap_touch_sens
    :esp32s2: touch_element
    :SOC_TWAI_SUPPORTED: 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.
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`Peripherals API`
docs: update CN for index/spi_slave/system_time 2023-02-15 01:56:18 -05:00			`****************`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00
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: add support for building C6 docs 2022-08-23 03:25:03 -04:00			`:SOC_ADC_SUPPORTED: adc_oneshot`
esp_adc: new esp_adc component and adc drivers 2022-07-15 00:52:44 -04:00			`:SOC_ADC_DMA_SUPPORTED: adc_continuous`
docs: add support for building C6 docs 2022-08-23 03:25:03 -04:00			`:SOC_ADC_SUPPORTED: adc_calibration`
ana_cmpr: add programming guide 2023-03-13 00:34:53 -04:00			`:SOC_ANA_CMPR_SUPPORTED: ana_cmpr`
change(jpeg): Clean up some mess code in jpeg encoder 2024-04-07 05:11:41 -04:00			`:SOC_MIPI_CSI_SUPPORTED: camera_driver`
change(doxyfile): move soc files to target specific doxygen soc files relies on target variable, which not correct while there are multiple versions for one target 2024-02-20 05:37:38 -05:00			`:SOC_CLK_TREE_SUPPORTED: clk_tree`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`:SOC_DAC_SUPPORTED: dac`
docs: add ECDSA peripheral chapter for H2/P4 - Add ECDSA peripheral chapter and instructions to program efuse key block - Update security guide for ECDSA peripheral mention for device identity - Link with ESP-TLS guide about using ECDSA peripheral in TLS connection 2023-11-07 07:55:12 -05:00			`:SOC_ECDSA_SUPPORTED: ecdsa`
doc: add api reference for etm driver 2022-09-20 02:23:15 -04:00			`:SOC_ETM_SUPPORTED: etm`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`gpio`
doc: API reference for GPTimer 2022-01-02 03:14:57 -05:00			`gptimer`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`:SOC_DEDICATED_GPIO_SUPPORTED: dedic_gpio`
			`:SOC_HMAC_SUPPORTED: hmac`
			`:SOC_DIG_SIGN_SUPPORTED: ds`
ci(doc): enable doc build for esp32c5 2024-04-18 03:13:55 -04:00			`:SOC_I2C_SUPPORTED: i2c`
docs: remove peripherals that are not supported from C2 docs 2022-02-15 21:22:46 -05:00			`:SOC_I2S_SUPPORTED: i2s`
doc(isp): added isp programming guide 2024-03-20 23:29:06 -04:00			`:SOC_ISP_SUPPORTED: isp`
change(jpeg): Clean up some mess code in jpeg encoder 2024-04-07 05:11:41 -04:00			`:SOC_JPEG_CODEC_SUPPORTED: jpeg`
docs(lcd): add api reference for mipi dsi lcd docs(lcd): add api reference for mipi dsi lcd 2024-03-20 06:42:45 -04:00			`lcd/index`
docs(ldo): add api reference for ldo regulator driver 2024-03-18 02:30:59 -04:00			`:SOC_GP_LDO_SUPPORTED: ldo_regulator`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`ledc`
			`:SOC_MCPWM_SUPPORTED: mcpwm`
doc: initial parallel IO programming guide Also correct the GPIO information on esp32h2. 2023-02-22 00:29:31 -05:00			`:SOC_PARLIO_SUPPORTED: parlio`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`:SOC_PCNT_SUPPORTED: pcnt`
feat(ppa): add PPA driver support for ESP32P4 2024-02-05 09:04:37 -05:00			`:SOC_PPA_SUPPORTED: ppa`
docs: update docs to be able to build with esp8684 2021-11-09 04:11:01 -05:00			`:SOC_RMT_SUPPORTED: rmt`
feat(sdmmc): supported sd2.0 on esp32p4 2023-08-29 07:50:27 -04:00			`:SOC_SDMMC_HOST_SUPPORTED or SOC_SDIO_SLAVE_SUPPORTED: sd_pullup_requirements`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`:SOC_SDMMC_HOST_SUPPORTED: sdmmc_host`
ci(doc): enable doc build for esp32c5 2024-04-18 03:13:55 -04:00			`:SOC_GPSPI_SUPPORTED: sdspi_host`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`:SOC_SDIO_SLAVE_SUPPORTED: sdio_slave`
doc: update sdm api reference 2022-06-22 04:29:35 -04:00			`:SOC_SDM_SUPPORTED: sdm`
ci(doc): enable doc build for esp32c5 2024-04-18 03:13:55 -04:00			`:SOC_SPI_FLASH_SUPPORTED: spi_flash/index`
			`:SOC_GPSPI_SUPPORTED: spi_master`
			`:SOC_GPSPI_SUPPORTED: spi_slave`
docs: updated misc C6 programming guide docs with minor changes. 2023-05-29 04:37:47 -04:00			`:SOC_SPI_SUPPORT_SLAVE_HD_VER2: spi_slave_hd`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`:SOC_TEMP_SENSOR_SUPPORTED: temp_sensor`
docs(touch): add doc for cap touch sens driver 2024-06-07 05:26:31 -04:00			`:SOC_TOUCH_SENSOR_SUPPORTED and not esp32p4: touch_pad`
			`:esp32p4: cap_touch_sens`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`:esp32s2: touch_element`
docs: remove peripherals that are not supported from C2 docs 2022-02-15 21:22:46 -05:00			`:SOC_TWAI_SUPPORTED: twai`
updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-08-27 03:09:35 -04:00			`uart`
			`:SOC_USB_OTG_SUPPORTED: usb_device`
			`:SOC_USB_OTG_SUPPORTED: usb_host`
Added links from api category TOC to example category folders Typo fix in bluetooth README.md 2017-01-18 15:04:11 -05:00
esp_adc: new esp_adc component and adc drivers 2022-07-15 00:52:44 -04:00			Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples.