alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/adc_filter_migration_guide_v5.0' into 'release/v5.0'

Browse Source 
adc: added adc filter migration guide (v5.0)

See merge request espressif/esp-idf!22349
This commit is contained in:
morris 2023-02-18 15:05:22 +08:00
commit e892fa8cc5
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en/migration-guides/release-5.x/peripherals.rst
View File

@ -70,6 +70,7 @@ API Changes
- API ``hall_sensor_read`` on ESP32 has been removed. Hall sensor is no longer supported on ESP32.
- API ``adc_set_i2s_data_source`` and ``adc_i2s_mode_init`` have been deprecated. Related enum ``adc_i2s_source_t`` has been deprecated. Please migrate to use ``esp_adc/adc_continuous.h``.
- API ``adc_digi_filter_reset``, ``adc_digi_filter_set_config``, ``adc_digi_filter_get_config`` and ``adc_digi_filter_enable`` have been removed. These APIs behaviours are not guaranteed. Enum ``adc_digi_filter_idx_t``, ``adc_digi_filter_mode_t`` and structure ``adc_digi_iir_filter_t`` have been removed as well.
GPIO
----
@ -545,4 +546,4 @@ To store the value which would have been written into the register, split the op
To get the value of the register after modification (which may be different from the value written), add an explicit read::
REG_SET_BITS(reg, mask);
uint32_t new_val = REG_READ(reg);
uint32_t new_val = REG_READ(reg);

3
docs/zh_CN/migration-guides/release-5.x/peripherals.rst
View File

@ -70,6 +70,7 @@ API 更新
- ESP32 中的 API ``hall_sensor_read`` 已被删除，因此 ESP32 不再支持霍尔传感器。
- API ``adc_set_i2s_data_source`` 和 ``adc_i2s_mode_init`` 已被弃用，相关的枚举 ``adc_i2s_source_t`` 也已被弃用，请使用 ``esp_adc/adc_continuous.h`` 进行迁移。
- API ``adc_digi_filter_reset`` ， ``adc_digi_filter_set_config`` ， ``adc_digi_filter_get_config`` 和 ``adc_digi_filter_enable`` 已被移除. 这些接口的行为不被保证。 枚举 ``adc_digi_filter_idx_t`` ， ``adc_digi_filter_mode_t`` 和结构体 ``adc_digi_iir_filter_t`` 已被移除。
GPIO
----------
@ -545,4 +546,4 @@ LCD
要获得修改后的寄存器的值（该值可能与写入的值不同），要增加一个显示的读取命令::
REG_SET_BITS(reg, mask);
uint32_t new_val = REG_READ(reg);
uint32_t new_val = REG_READ(reg);