Skip to content

Commit b1b93c2

Browse files
committed
Merge branch 'docs/update_migration_guides' into 'master'
update provisioning and removed-components for migration-guides See merge request espressif/esp-idf!20830
2 parents 6f10bb3 + 90de9d4 commit b1b93c2

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

docs/en/migration-guides/release-5.x/5.0/provisioning.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Wi-Fi Provisioning
1414
------------------
1515

1616
.. list::
17-
* The ``pop`` field in the :cpp:func:`wifi_prov_mgr_start_provisioning` API is now deprecated. For backward compatibility, ``pop`` can be still passed as a string for security1. However for Security2 the ``wifi_prov_sec_params`` argument needs to be passed instead of ``pop``. This parameter should contain the structure (containing the security parameters) as required by the protocol version used. For example, when using security version 2, the ``wifi_prov_sec_params`` parameter should contain the pointer to the structure of type :cpp:type:`wifi_prov_security2_params_t`. For security 1 the behaviour and the usage of the API remains same.
17+
* The ``pop`` field in the :cpp:func:`wifi_prov_mgr_start_provisioning` API is now deprecated. For backward compatibility, ``pop`` can be still passed as a string for security version 1. However, for security version 2, the ``wifi_prov_sec_params`` argument needs to be passed instead of ``pop``. This parameter should contain the structure (containing the security parameters) as required by the protocol version used. For example, when using security version 2, the ``wifi_prov_sec_params`` parameter should contain the pointer to the structure of type :cpp:type:`wifi_prov_security2_params_t`. For security 1, the behaviour and the usage of the API remain the same.
18+
1819
* The API :cpp:func:`wifi_prov_mgr_is_provisioned` does not return :c:macro:`ESP_ERR_INVALID_STATE` error any more. This API now works without any dependency on provisioning manager initialization state.
1920

2021
ESP Local Control

docs/zh_CN/migration-guides/release-5.x/5.0/provisioning.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Wi-Fi 配置
1414
-------------
1515

1616
.. list::
17-
* :cpp:func:`wifi_prov_mgr_start_provisioning` API 中的 ``pop`` 字段现已弃用。请使用 ``wifi_prov_sec_params`` 字段来代替 ``pop``。此参数应包含所使用的协议版本所要求的结构(包括安全参数)。例如,当使用安全版本 2 时,``wifi_prov_sec_params`` 参数应包含指向 :cpp:type:`wifi_prov_security2_params_t` 结构体类型的指针。
17+
* :cpp:func:`wifi_prov_mgr_start_provisioning` API 中的 ``pop`` 字段现已弃用。为了向后兼容,在使用安全版本 1 时,``pop`` 仍可以作为字符串传递。但在使用安全版本 2 时,请使用 ``wifi_prov_sec_params`` 字段来代替 ``pop``。此参数应包含所使用的协议版本所要求的结构(包括安全参数)。例如,当使用安全版本 2 时,``wifi_prov_sec_params`` 参数应包含指向 :cpp:type:`wifi_prov_security2_params_t` 结构体类型的指针。对于安全版本 1,该 API 的行为和使用方式保持不变
1818

1919
* :cpp:func:`wifi_prov_mgr_is_provisioned` API 不再返回 :c:macro:`ESP_ERR_INVALID_STATE` 错误。此 API 现在可以在不依赖配置管理器初始化状态的情况下工作。
2020

docs/zh_CN/migration-guides/release-5.x/5.0/removed-components.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
* `esp-cryptoauthlib <https://components.espressif.com/component/espressif/esp-cryptoauthlib>`_
2424
* `qrcode <https://components.espressif.com/component/espressif/qrcode>`_
2525
* `tjpgd <https://components.espressif.com/component/espressif/esp_jpeg>`_
26+
* `esp_serial_slave_link <https://components.espressif.com/components/espressif/esp_serial_slave_link>`_
2627

2728
.. note::
2829
请注意,http 解析功能以前属于 ``nghttp`` 组件一部分,但现在属于 :component:`http_parser <http_parser>` 组件。

0 commit comments

Comments
 (0)