Skip to content

Commit

Permalink
Merge branch 'docs/fix_typo_adc_oneshot_v5.1' into 'release/v5.1'
Browse files Browse the repository at this point in the history
docs: fix a typo in adc_oneshot (v5.1)

See merge request espressif/esp-idf!33008
  • Loading branch information
jack0c committed Aug 22, 2024
2 parents 7ba5cbf + b0c5075 commit e026fd1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/en/api-reference/peripherals/adc_oneshot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ where:
* - Vmax
- Maximum measurable input analog voltage, this is related to the ADC attenuation, please refer to `TRM <{IDF_TARGET_TRM_EN_URL}>`__ > ``On-Chip Sensor and Analog Signal Processing``.
* - Dmax
- Maximum of the output ADC raw digital reading result, which is 2^bitwidth, where bitwidth is the :cpp:member::`adc_oneshot_chan_cfg_t:bitwidth` configured before.
- Maximum of the output ADC raw digital reading result, which is 2^bitwidth, where bitwidth is the :cpp:member:`adc_oneshot_chan_cfg_t::bitwidth` configured before.

To do further calibration to convert the ADC raw result to voltage in mV, please refer to calibration doc :doc:`adc_calibration`.

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/api-reference/peripherals/adc_oneshot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ ADC 单次转换模式驱动基于 {IDF_TARGET_NAME} SAR ADC 模块实现,不
* - Vmax
- 可测量的最大模拟输入电压,与 ADC 衰减相关,请参考 `技术参考手册 <{IDF_TARGET_TRM_CN_URL}>`__ > ``片上传感器与模拟信号处理``。
* - Dmax
- 输出 ADC 原始数字读取结果的最大值,即 2^位宽,位宽即之前配置的 :cpp:member:`adc_digi_pattern_config_t::bit_width`。
- 输出 ADC 原始数字读取结果的最大值,即 2^位宽,位宽即之前配置的 :cpp:member:`adc_oneshot_chan_cfg_t::bitwidth`。

若需进一步校准,将 ADC 原始结果转换为以 mV 为单位的电压数据,请参考校准文档 :doc:`adc_calibration`。

Expand Down

0 comments on commit e026fd1

Please sign in to comment.