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

docs: added CN translation for bluetooth-low-enery and bluetooth-classic

Browse Source
This commit is contained in:
daiziyan 2022-08-23 17:09:09 +08:00
parent 949ddc3501
commit 27ea222bb5
6 changed files with 127 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/en/migration-guides/release-5.x/bluetooth-classic.rst
View File

@ -1,6 +1,8 @@
Bluetooth Classic
=================
:link_to_translation:`zh_CN:[中文]`
Bluedroid
---------
@ -11,16 +13,15 @@ Bluedroid
- ``ESP_HF_CME_MEMEORY_FULL`` renamed to ``ESP_HF_CME_MEMORY_FULL``
- ``ESP_HF_CME_MEMEORY_FAILURE`` renamed to ``ESP_HF_CME_MEMORY_FAILURE``
- :component_file:`bt/host/bluedroid/api/include/api/esp_hf_ag_api.h`
- ``esp_bt_hf_init(esp_bd_addr_t remote_addr)`` changes into ``esp_hf_ag_init(void)``.
- ``esp_bt_hf_init(esp_bd_addr_t remote_addr)`` changes into ``esp_hf_ag_init(void)``
- ``esp_bt_hf_deinit(esp_bd_addr_t remote_addr)`` changes into ``esp_hf_ag_deinit(void)``
Along with this change, the `bt_bdaddr_t init` and `bt_bdaddr_t deinit` has been removed from `union btc_arg_t`.
- ``esp_bt_hf_register_callback`` is now changed into ``esp_hf_ag_register_callback``.
- ``esp_bt_hf_register_callback`` changes into ``esp_hf_ag_register_callback``
- ``esp_bt_hf_connect`` changes into ``esp_hf_ag_slc_connect``
@ -61,4 +62,3 @@ Bluedroid
- ``esp_bt_hf_register_data_callback`` changes into ``esp_hf_ag_register_data_callback``
- ``esp_hf_outgoing_data_ready`` changes into ``esp_hf_ag_outgoing_data_ready``

10
docs/en/migration-guides/release-5.x/bluetooth-low-energy.rst
View File

@ -1,6 +1,8 @@
Bluetooth Low Energy
====================
:link_to_translation:`zh_CN:[中文]`
Bluedroid
---------
@ -8,7 +10,7 @@ Bluedroid
- :component_file:`bt/host/bluedroid/api/include/api/esp_gap_ble_api.h`
- In :cpp:enum:`esp_gap_ble_cb_event_t`
- In :cpp:enum:`esp_gap_ble_cb_event_t`:
- ``ESP_GAP_BLE_SET_PREFERED_DEFAULT_PHY_COMPLETE_EVT`` renamed to ``ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT``
- ``ESP_GAP_BLE_SET_PREFERED_PHY_COMPLETE_EVT`` renamed to ``ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT``
@ -22,7 +24,7 @@ Bluedroid
- :component_file:`bt/host/bluedroid/api/include/api/esp_gatt_defs.h`
- In :cpp:enum:`esp_gatt_status_t`
- In :cpp:enum:`esp_gatt_status_t`:
- ``ESP_GATT_ENCRYPED_MITM`` renamed to ``ESP_GATT_ENCRYPTED_MITM``
- ``ESP_GATT_ENCRYPED_NO_MITM`` renamed to ``ESP_GATT_ENCRYPTED_NO_MITM``
@ -34,10 +36,10 @@ Nimble
- :component_file:`bt/host/nimble/esp-hci/include/esp_nimble_hci.h`
- Remove : esp_err_t esp_nimble_hci_and_controller_init(void);
- Remove ``esp_err_t esp_nimble_hci_and_controller_init(void)``
- Controller initialization, enable and HCI initialization calls have been moved to `nimble_port_init`. This function can be deleted directly.
- Remove : esp_err_t esp_nimble_hci_and_controller_deinit(void);
- Remove ``esp_err_t esp_nimble_hci_and_controller_deinit(void)``
- Controller deinitialization, disable and HCI deinitialization calls have been moved to `nimble_port_deinit`. This function can be deleted directly.

2
docs/en/migration-guides/release-5.x/removed-components.rst
View File

@ -1,6 +1,8 @@
Removed or Deprecated Components
================================
:link_to_translation:`zh_CN:[中文]`
Components Moved to IDF Component Registry
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

65
docs/zh_CN/migration-guides/release-5.x/bluetooth-classic.rst
View File

@ -1 +1,64 @@
.. include:: ../../../en/migration-guides/release-5.x/bluetooth-classic.rst
经典蓝牙
=================
:link_to_translation:`en:[English]`
Bluedroid
---------
- :component_file:`bt/host/bluedroid/api/include/api/esp_hf_defs.h`
- 在 :cpp:enum:`esp_hf_cme_err_t` 中
- ``ESP_HF_CME_MEMEORY_FULL`` 改名为 ``ESP_HF_CME_MEMORY_FULL``
- ``ESP_HF_CME_MEMEORY_FAILURE`` 改名为 ``ESP_HF_CME_MEMORY_FAILURE``
- :component_file:`bt/host/bluedroid/api/include/api/esp_hf_ag_api.h`
- ``esp_bt_hf_init(esp_bd_addr_t remote_addr)`` 改为 ``esp_hf_ag_init(void)``
- ``esp_bt_hf_deinit(esp_bd_addr_t remote_addr)`` 改为 ``esp_hf_ag_deinit(void)``
除此之外，`bt_bdaddr_t init` 和 `bt_bdaddr_t deinit` 已经从 `union btc_arg_t` 中移除。
- ``esp_bt_hf_register_callback`` 改为 ``esp_hf_ag_register_callback``
- ``esp_bt_hf_connect`` 改为 ``esp_hf_ag_slc_connect``
- ``esp_bt_hf_disconnect`` 改为 ``esp_hf_ag_slc_disconnect``
- ``esp_bt_hf_connect_audio`` 改为 ``esp_hf_ag_audio_connect``
- ``esp_bt_hf_disconnect_audio`` 改为 ``esp_hf_ag_audio_disconnect``
- ``esp_bt_hf_vra`` 改为 ``esp_hf_ag_vra_control``
- ``esp_bt_hf_volume_control`` 改为 ``esp_hf_ag_volume_control``
- ``esp_hf_unat_response`` 改为 ``esp_hf_ag_unknown_at_send``
- ``esp_bt_hf_cmee_response`` 改为 ``esp_hf_ag_cmee_send``
- ``esp_bt_hf_indchange_notification`` 改为 ``esp_hf_ag_devices_status_indchange``
- ``esp_bt_hf_cind_response`` 改为 ``esp_hf_ag_cind_response``
- ``esp_bt_hf_cops_response`` 改为 ``esp_hf_ag_cops_response``
- ``esp_bt_hf_clcc_response`` 改为 ``esp_hf_ag_clcc_response``
- ``esp_bt_hf_cnum_response`` 改为 ``esp_hf_ag_cnum_response``
- ``esp_bt_hf_bsir`` 改为 ``esp_hf_ag_bsir``
- ``esp_bt_hf_answer_call`` 改为 ``esp_hf_ag_answer_call``
- ``esp_bt_hf_reject_call`` 改为 ``esp_hf_ag_reject_call``
- ``esp_bt_hf_out_call`` 改为 ``esp_hf_ag_out_call``
- ``esp_bt_hf_end_call`` 改为 ``esp_hf_ag_end_call``
- ``esp_bt_hf_register_data_callback`` 改为 ``esp_hf_ag_register_data_callback``
- ``esp_hf_outgoing_data_ready`` 改为 ``esp_hf_ag_outgoing_data_ready``

46
docs/zh_CN/migration-guides/release-5.x/bluetooth-low-energy.rst
View File

@ -1 +1,45 @@
.. include:: ../../../en/migration-guides/release-5.x/bluetooth-low-energy.rst
低功耗蓝牙
====================
:link_to_translation:`en:[English]`
Bluedroid
---------
以下 Bluedroid 宏、类型和函数已被重命名：
- :component_file:`bt/host/bluedroid/api/include/api/esp_gap_ble_api.h`
- :cpp:enum:`esp_gap_ble_cb_event_t` 中：
- ``ESP_GAP_BLE_SET_PREFERED_DEFAULT_PHY_COMPLETE_EVT`` 改名为 ``ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT``
- ``ESP_GAP_BLE_SET_PREFERED_PHY_COMPLETE_EVT`` 改名为 ``ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT``
- ``ESP_GAP_BLE_CHANNEL_SELETE_ALGORITHM_EVT`` 改名为 ``ESP_GAP_BLE_CHANNEL_SELECT_ALGORITHM_EVT``
- ``esp_ble_wl_opration_t`` 改名为 :cpp:enum:`esp_ble_wl_operation_t`
- ``esp_ble_gap_cb_param_t.pkt_data_lenth_cmpl`` 改名为 ``pkt_data_length_cmpl``
- ``esp_ble_gap_cb_param_t.update_whitelist_cmpl.wl_opration`` 改名为 ``wl_operation``
- ``esp_ble_gap_set_prefered_default_phy`` 改名为 :cpp:func:`esp_ble_gap_set_preferred_default_phy`
- ``esp_ble_gap_set_prefered_phy`` 改名为 :cpp:func:`esp_ble_gap_set_preferred_phy`
- :component_file:`bt/host/bluedroid/api/include/api/esp_gatt_defs.h`
- :cpp:enum:`esp_gatt_status_t` 中：
- ``ESP_GATT_ENCRYPED_MITM`` 改名为 ``ESP_GATT_ENCRYPTED_MITM``
- ``ESP_GATT_ENCRYPED_NO_MITM`` 改名为 ``ESP_GATT_ENCRYPTED_NO_MITM``
Nimble
--------
以下 Nimble API 已被移除：
- :component_file:`bt/host/nimble/esp-hci/include/esp_nimble_hci.h`
- 移除 ``esp_err_t esp_nimble_hci_and_controller_init(void)``
- 控制器初始化、使能以及 HCI 初始化的调用已经被移到 `nimble_port_init` 中。可直接删除该函数。
- 移除 ``esp_err_t esp_nimble_hci_and_controller_deinit(void)``
- 控制器去初始化、禁用以及 HCI 去初始化的调用已经被移到 `nimble_port_deinit` 中。可直接删除该函数。

4
docs/zh_CN/migration-guides/release-5.x/removed-components.rst
View File

@ -1,6 +1,8 @@
从 ESP-IDF 中移出或弃用的组件
================================
:link_to_translation:`en:[English]`
移至 IDF Component Registry 的组件
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -18,6 +20,8 @@
* `sh2lib <https://components.espressif.com/component/espressif/sh2lib>`_
* `expat <https://components.espressif.com/component/espressif/expat>`_
* `coap <https://components.espressif.com/component/espressif/coap>`_
* `esp-cryptoauthlib <https://components.espressif.com/component/espressif/esp-cryptoauthlib>`_
* `qrcode <https://components.espressif.com/component/espressif/qrcode>`_
* `tjpgd <https://components.espressif.com/component/espressif/esp_jpeg>`_
.. note::