From 25648c6890ba1ad94dc863e956e644a29e8853c8 Mon Sep 17 00:00:00 2001 From: gaoxu Date: Mon, 6 Jan 2025 11:19:50 +0800 Subject: [PATCH] docs(adc): add ADC calibration docs on ESP32P4 --- docs/docs_not_updated/esp32p4.txt | 1 - docs/en/api-reference/peripherals/adc_calibration.rst | 4 ++-- docs/zh_CN/api-reference/peripherals/adc_calibration.rst | 4 ++-- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/docs_not_updated/esp32p4.txt b/docs/docs_not_updated/esp32p4.txt index f4553fef4d..3590b90523 100644 --- a/docs/docs_not_updated/esp32p4.txt +++ b/docs/docs_not_updated/esp32p4.txt @@ -1,5 +1,4 @@ api-guides/partition-tables.rst api-guides/usb-otg-console.rst -api-reference/peripherals/adc_calibration.rst api-reference/peripherals/parlio.rst api-reference/peripherals/sd_pullup_requirements.rst diff --git a/docs/en/api-reference/peripherals/adc_calibration.rst b/docs/en/api-reference/peripherals/adc_calibration.rst index cbb6e1bc23..ad7de24887 100644 --- a/docs/en/api-reference/peripherals/adc_calibration.rst +++ b/docs/en/api-reference/peripherals/adc_calibration.rst @@ -82,7 +82,7 @@ If you use your custom ADC calibration schemes, you could either modify this fun ESP_ERROR_CHECK(adc_cali_delete_scheme_line_fitting(handle)); -.. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 or esp32c5 +.. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 or esp32c5 or esp32p4 ADC Calibration Curve Fitting Scheme ```````````````````````````````````` @@ -97,7 +97,7 @@ If you use your custom ADC calibration schemes, you could either modify this fun - :cpp:member:`adc_cali_curve_fitting_config_t::atten`, ADC attenuation that your ADC raw results use. - :cpp:member:`adc_cali_curve_fitting_config_t::bitwidth`, bit width of ADC raw result. - .. only:: esp32c6 or esp32h2 or esp32c5 + .. only:: esp32c6 or esp32h2 or esp32c5 or esp32p4 - :cpp:member:`adc_cali_curve_fitting_config_t::unit_id`, the ADC that your ADC raw results are from. - :cpp:member:`adc_cali_curve_fitting_config_t::chan`, the ADC channel that your ADC raw results are from. The calibration scheme not only differs by attenuation but is also related to the channels. diff --git a/docs/zh_CN/api-reference/peripherals/adc_calibration.rst b/docs/zh_CN/api-reference/peripherals/adc_calibration.rst index 5adca51d1a..98ef6e6392 100644 --- a/docs/zh_CN/api-reference/peripherals/adc_calibration.rst +++ b/docs/zh_CN/api-reference/peripherals/adc_calibration.rst @@ -82,7 +82,7 @@ ADC 校准驱动程序会提供 ADC 校准方案。对于驱动程序来说， ESP_ERROR_CHECK(adc_cali_delete_scheme_line_fitting(handle)); -.. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 +.. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 or esp32c5 or esp32p4 ADC 校准曲线拟合方案 ```````````````````````````````````` @@ -97,7 +97,7 @@ ADC 校准驱动程序会提供 ADC 校准方案。对于驱动程序来说， - :cpp:member:`adc_cali_curve_fitting_config_t::atten`，表示 ADC 原始结果的衰减程度。 - :cpp:member:`adc_cali_curve_fitting_config_t::bitwidth`，表示 ADC 原始结果的位宽。 - .. only:: esp32c6 or esp32h2 + .. only:: esp32c6 or esp32h2 or esp32c5 or esp32p4 - :cpp:member:`adc_cali_curve_fitting_config_t::unit_id`，表示 ADC 原始结果来自哪个 ADC 单元。 - :cpp:member:`adc_cali_curve_fitting_config_t::chan`，表示获取 ADC 原始结果的 ADC 通道。校准方案不仅因衰减程度而异，还与通道选择有关。