espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-10-03 02:20:57 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/update_introduction_for_adc_modes' into 'master'

Browse Source 
docs: Update introduction for ADC modes

Closes DOC-12094

See merge request espressif/esp-idf!41435
This commit is contained in:
morris
2025-08-22 15:28:21 +08:00
parent 9dc7d37043 daf33186c9
commit 01cba485dd
4 changed files with 24 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -6,22 +6,19 @@ Analog to Digital Converter (ADC) Continuous Mode Driver
Introduction
------------
The Analog to Digital Converter is integrated on the chip and is capable of measuring analog signals from specific analog IO pads. Additionally, the Direct Memory Access (DMA) functionality is utilized to efficiently retrieve ADC conversion results.
This document describes the ADC continuous mode driver on {IDF_TARGET_NAME}.
{IDF_TARGET_NAME} has {IDF_TARGET_SOC_ADC_PERIPH_NUM} ADC unit(s), which can be used in scenarios like:
In continuous mode, the ADC performs automatic, high-speed sampling on one or more analog input channels, with results efficiently transferred to memory via DMA. This mode is suitable for applications that require periodic or high-frequency data acquisition.
- Generate one-shot ADC conversion result
- Generate continuous ADC conversion results
This guide introduces ADC continuous mode conversion.
To perform single, on-demand ADC conversions, check :doc:`ADC Oneshot Mode Driver <adc_oneshot>`.
Driver Concepts
^^^^^^^^^^^^^^^
---------------
ADC continuous mode conversion is made up of multiple conversion frames.
ADC continuous mode organizes data into conversion frames, which consist of multiple conversion results.
- Conversion Frame: One conversion frame contains multiple conversion results. Conversion frame size is configured in :cpp:func:`adc_continuous_new_handle` in bytes.
- Conversion Result: One conversion result contains multiple bytes, see :c:macro:`SOC_ADC_DIGI_RESULT_BYTES`. Its structure is :cpp:type:`adc_digi_output_data_t`, including ADC unit, ADC channel, and raw data.
- Conversion Frame: A frame contains multiple conversion results. Conversion frame size is configured with :cpp:func:`adc_continuous_new_handle` in bytes.
- Conversion Result: A result consists of multiple bytes, as defined by :c:macro:`SOC_ADC_DIGI_RESULT_BYTES`. Its structure is :cpp:type:`adc_digi_output_data_t`, including the ADC unit, ADC channel, and raw data.
.. image:: /../_static/diagrams/adc/adc_conversion_frame.png
:scale: 100 %

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

@@ -6,17 +6,13 @@ Analog to Digital Converter (ADC) Oneshot Mode Driver
Introduction
------------
The Analog to Digital Converter is integrated on the chip and is capable of measuring analog signals from specific analog IO pins.
This document describes the ADC oneshot mode driver on {IDF_TARGET_NAME}.
{IDF_TARGET_NAME} has {IDF_TARGET_SOC_ADC_PERIPH_NUM} ADC unit(s), which can be used in scenario(s) like:
Oneshot mode allows you to perform single, on-demand ADC conversions on selected analog input channels. It is suitable for applications that require infrequent or triggered sampling, as opposed to continuous data acquisition.
.. list::
- Generate one-shot ADC conversion result
:SOC_ADC_DMA_SUPPORTED: - Generate continuous ADC conversion results
This guide introduces ADC oneshot mode conversion.
.. only:: SOC_ADC_DMA_SUPPORTED
To perform continuous data acquisition, {IDF_TARGET_NAME} provides :doc:`ADC Continuous Mode Driver <adc_continuous>`.
Functional Overview
-------------------

21
docs/zh_CN/api-reference/peripherals/adc/adc_continuous.rst
View File

@@ -4,24 +4,21 @@
:link_to_translation:`en:[English]`
简介
------------
----
{IDF_TARGET_NAME} 芯片集成了模数转换器 (ADC)，支持测量特定模拟 IO 管脚的模拟信号。此外，ADC 还支持直接内存访问 (DMA) 功能，高效获取 ADC 转换结果。
本文档介绍了 {IDF_TARGET_NAME} 上的 ADC 连续转换模式驱动。
{IDF_TARGET_NAME} 具有 {IDF_TARGET_SOC_ADC_PERIPH_NUM} 个 ADC 单元，可应用于以下场景：
在连续模式下，ADC 可对一个或多个模拟输入通道执行自动高速采样，并通过直接内存访问 (DMA) 将结果高效传输至内存。此模式非常适合需要周期性或高频数据采集的应用场景。
- 生成单次 ADC 转换结果
- 生成连续 ADC 转换结果
如需执行按需单次 ADC 转换，请查阅 :doc:`ADC 单次转换模式驱动 <adc_oneshot>`。
本指南介绍了 ADC 连续转换模式。
驱动原理
--------
ADC 连续转换模式驱动概念
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ADC连续模式将数据组织为由多个转换结果构成的转换帧。
ADC 连续转换模式驱动由多个转换帧组成。
- 转换帧：一个转换帧包含多个转换结果。转换帧大小以字节为单位，在 :cpp:func:`adc_continuous_new_handle` 中配置。
- 转换结果：一个转换结果包含多个字节，即 :c:macro:`SOC_ADC_DIGI_RESULT_BYTES`。转换结果的数据结构由 :cpp:type:`adc_digi_output_data_t` 定义，包括 ADC 单元、ADC 通道以及原始数据。
- 转换帧：每个帧包含多个转换结果。帧大小（字节数）在 :cpp:func:`adc_continuous_new_handle` 中配置。
- 转换结果：每个结果由 :c:macro:`SOC_ADC_DIGI_RESULT_BYTES` 定义的若干字节组成，其结构体为 :cpp:type:`adc_digi_output_data_t`，包含 ADC 单元、ADC 通道以及原始数据。
.. image:: /../_static/diagrams/adc/adc_conversion_frame.png
:scale: 100 %

12
docs/zh_CN/api-reference/peripherals/adc/adc_oneshot.rst
View File

@@ -6,17 +6,13 @@
简介
----
模数转换器集成于芯片，支持测量特定模拟 IO 管脚的模拟信号。
本文档介绍了 {IDF_TARGET_NAME} 上的 ADC 单次转换模式驱动。
{IDF_TARGET_NAME} 有 {IDF_TARGET_SOC_ADC_PERIPH_NUM} 个 ADC 单元，可以在以下场景使用：
单次转换模式允许在选定的模拟输入通道上执行按需单次 ADC 转换。该模式适用于需要低频采样或触发采样的应用场景，而非持续的数据采集。
.. list::
- 生成 ADC 单次转换结果
:SOC_ADC_DMA_SUPPORTED: - 生成连续 ADC 转换结果
本指南介绍了 ADC 单次转换模式。
.. only:: SOC_ADC_DMA_SUPPORTED
如需执行连续数据采集，{IDF_TARGET_NAME} 提供了 :doc:`ADC 连续转换模式驱动 <adc_continuous>`。
功能概述
--------