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/add_ble_feature_status_table' into 'master'

Browse Source 
docs(ble): Added BLE feature support status

See merge request espressif/esp-idf!32873
This commit is contained in:
Wei Yu Han 2024-08-16 10:47:52 +08:00
commit 782b8f0567
13 changed files with 1006 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/_static/ble/feature_status/NA.svg vendored Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="31" height="20" role="img" aria-label="N/A"><title>N/A</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="31" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="0" height="20" fill="#d8d8d8"/><rect x="0" width="31" height="20" fill="#d8d8d8"/><rect width="31" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="155" y="150" fill="#ccc" fill-opacity=".3" transform="scale(.1)" textLength="210">N/A</text><text x="155" y="140" transform="scale(.1)" fill="#333" textLength="210">N/A</text></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 897 B

1
docs/_static/ble/feature_status/developing202412.svg vendored Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="130" height="20" role="img" aria-label="In Progress: 2024/12"><title>In Progress: 2024/12</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="130" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="73" height="20" fill="#555"/><rect x="73" width="57" height="20" fill="#007ec6"/><rect width="130" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="375" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="630">In Progress</text><text x="375" y="140" transform="scale(.1)" fill="#fff" textLength="630">In Progress</text><text aria-hidden="true" x="1005" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="470">2024/12</text><text x="1005" y="140" transform="scale(.1)" fill="#fff" textLength="470">2024/12</text></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

1
docs/_static/ble/feature_status/developingYYYYMM.svg vendored Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="134" height="20" role="img" aria-label="In Progress: YYYY/MM"><title>In Progress: YYYY/MM</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="134" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="73" height="20" fill="#555"/><rect x="73" width="61" height="20" fill="#007ec6"/><rect width="134" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="375" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="630">In Progress</text><text x="375" y="140" transform="scale(.1)" fill="#fff" textLength="630">In Progress</text><text aria-hidden="true" x="1025" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">YYYY/MM</text><text x="1025" y="140" transform="scale(.1)" fill="#fff" textLength="510">YYYY/MM</text></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

1
docs/_static/ble/feature_status/experimental.svg vendored Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="83" height="20" role="img" aria-label="experimental"><title>experimental</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="83" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="0" height="20" fill="#fe7d37"/><rect x="0" width="83" height="20" fill="#fe7d37"/><rect width="83" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="415" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="730">experimental</text><text x="415" y="140" transform="scale(.1)" fill="#fff" textLength="730">experimental</text></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 936 B

1
docs/_static/ble/feature_status/supported.svg vendored Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="65" height="20" role="img" aria-label="supported"><title>supported</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="65" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="0" height="20" fill="#97ca00"/><rect x="0" width="65" height="20" fill="#97ca00"/><rect width="65" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="325" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="550">supported</text><text x="325" y="140" transform="scale(.1)" fill="#fff" textLength="550">supported</text></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 924 B

1
docs/_static/ble/feature_status/unsupported.svg vendored Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="79" height="20" role="img" aria-label="unsupported"><title>unsupported</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="79" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="0" height="20" fill="#d8d8d8"/><rect x="0" width="79" height="20" fill="#d8d8d8"/><rect width="79" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="395" y="150" fill="#ccc" fill-opacity=".3" transform="scale(.1)" textLength="690">unsupported</text><text x="395" y="140" transform="scale(.1)" fill="#333" textLength="690">unsupported</text></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 929 B

6
docs/conf_common.py
View File

@ -23,9 +23,11 @@ BT_DOCS = ['api-reference/bluetooth/esp_bt_defs.rst',
'api-reference/bluetooth/controller_vhci.rst',
'api-reference/bluetooth/index.rst']
BLE_DOCS = ['api-reference/bluetooth/bt_le.rst',
'api-guides/ble/index.rst',
BLE_DOCS = ['api-guides/ble/index.rst',
'api-guides/ble/overview.rst',
'api-guides/ble/ble-feature-support-status.rst',
'api-guides/ble/host-feature-support-status.rst',
'api-reference/bluetooth/bt_le.rst',
'api-reference/bluetooth/esp_gap_ble.rst',
'api-reference/bluetooth/esp_gatt_defs.rst',
'api-reference/bluetooth/esp_gatts.rst',

338
docs/en/api-guides/ble/ble-feature-support-status.rst Normal file
View File

@ -0,0 +1,338 @@
Major Feature Support Status
================================
:link_to_translation:`zh_CN:[中文]`
The table below shows the support status of Bluetooth Low Energy major features on {IDF_TARGET_NAME}.
|supported_def| **This feature has completed development and internal testing.** [1]_
|experimental_def| **This feature has been developed and is currently undergoing internal testing.**
You can explore these features for evaluation and feedback purposes but should be cautious of potential issues.
|developing_def| **The feature is currently being actively developed, and expected to be supported by the end of YYYY/MM.**
You should anticipate future updates regarding the progress and availability of these features.
If you do have an urgent need, please contact our `customer support team <https://www.espressif.com/en/contact-us/sales-questions>`__ for a possible feature trial.
|unsupported_def| **This feature is not supported on this chip series.** If you have related requirements, please prioritize selecting other Espressif chip series that support this feature.
If none of our chip series meet your needs, please contact `customer support team <https://www.espressif.com/en/contact-us/sales-questions>`__, and our R&D team will conduct an internal feasibility assessment for you.
|NA_def| The feature with this label could be the following two types:
- **Host-only Feature**: The feature exists only above HCI, such as GATT Caching. It does not require the support from the Controller.
- **Controller-only Feature**: The feature exists only below HCI, and cannot be configured/enabled via Host API, such as Advertising Channel Index. It does not require the support from the Host.
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
* - .. centered:: Core Spec
- .. centered:: Major Features
- .. centered:: ESP Controller
- .. centered:: ESP-Bluedroid Host
- .. centered:: ESP-NimBLE Host
* - .. centered:: |4.2|
- LE Data Packet Length Extension
- |supported|
- |supported|
- |supported|
* -
- LE Secure Connections
- |supported|
- |supported|
- |supported|
* -
- Link Layer Privacy
- |supported|
- |supported|
- |supported|
* -
- Link Layer Extended Filter Policies
- |supported|
- |supported|
- |supported|
* - .. centered:: |5.0|
- 2 Msym/s PHY for LE
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* -
- LE Long Range (Coded PHY S=2/S=8)
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* -
- High Duty Cycle Non-Connectable Advertising
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* -
- LE Advertising Extensions
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* -
- LE Channel Selection Algorithm #2
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* - .. centered:: |5.1|
- Angle of Arrival (AoA)/Angle of Departure (AoD)
- |unsupported|
- |unsupported|
- |unsupported|
* -
- GATT Caching
- |NA|
- |experimental|
- |experimental|
* -
- Advertising Channel Index
- |unsupported|
- |NA|
- |NA|
* -
- Periodic Advertising Sync Transfer
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5
|experimental|
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5
|experimental|
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5
|experimental|
* - .. centered:: |5.2|
- LE Isochronous Channels (BIS/CIS)
- |unsupported|
- |unsupported|
- |unsupported|
* -
- Enhanced Attribute Protocol
- |NA|
- |unsupported|
- |developing202412|
* -
- LE Power Control
- .. only:: esp32 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5
|experimental|
- |unsupported|
- .. only:: esp32 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5
|developing202412|
* - .. centered:: |5.3|
- AdvDataInfo in Periodic Advertising
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5
|supported|
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5
|supported|
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5
|supported|
* -
- LE Enhanced Connection Update (Connection Subrating)
- .. only:: esp32 or esp32c6 or esp32c2 or esp32h2 or esp32c5
|unsupported|
.. only:: esp32c3 or esp32s3
|experimental|
- |unsupported|
- .. only:: esp32 or esp32c6 or esp32c2 or esp32h2 or esp32c5
|unsupported|
.. only:: esp32c3 or esp32s3
|experimental|
* -
- LE Channel Classification
- .. only:: esp32 or esp32c3 or esp32s3 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c5
|experimental|
- .. only:: esp32 or esp32c3 or esp32s3 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c5
|experimental|
- .. only:: esp32 or esp32c3 or esp32s3 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c5
|experimental|
* - .. centered:: |5.4|
- Advertising Coding Selection
- .. only:: esp32 or esp32c6 or esp32c2 or esp32h2 or esp32c5
|unsupported|
.. only:: esp32c3 or esp32s3
|experimental|
- |unsupported|
- .. only:: esp32 or esp32c6 or esp32c2 or esp32h2 or esp32c5
|unsupported|
.. only:: esp32c3 or esp32s3
|experimental|
* -
- Encrypted Advertising Data
- |NA|
- |unsupported|
- |developing202412|
* -
- LE GATT Security Levels Characteristic
- |NA|
- |unsupported|
- |developing202412|
* -
- Periodic Advertising with Responses
- |unsupported|
- |unsupported|
- |unsupported|
.. [1]
If you would like to know the Bluetooth SIG certification information for supported features,
please consult `SIG Bluetooth Product Database <https://qualification.bluetooth.com/Listings/Search>`__.
For certain features, if the majority of the development is completed on the Controller, the Host's support status will be limited by the Controller's support status.
If you want BLE Controller and Host to run on different Espressif chips, the functionality of the Host will not be limited by the Controller's support status on the chip running the Host,
please check the :doc:`ESP Host Feature Support Status Table <host-feature-support-status>` .
It is important to clarify that this document is not a binding commitment to our customers.
The above feature support status information is for general informational purposes only and is subject to change without notice.
You are encouraged to consult with our `customer support team <https://www.espressif.com/en/contact-us/sales-questions>`__ for the most up-to-date information and to verify the suitability of features for your specific needs.
.. |supported| image:: ../../../_static/ble/feature_status/supported.svg
:class: align-center
:width: 65px
.. |developing202412| image:: ../../../_static/ble/feature_status/developing202412.svg
:class: align-center
:width: 120px
.. |unsupported| image:: ../../../_static/ble/feature_status/unsupported.svg
:class: align-center
:width: 75px
.. |experimental| image:: ../../../_static/ble/feature_status/experimental.svg
:class: align-center
:width: 75px
.. |NA| image:: ../../../_static/ble/feature_status/NA.svg
:class: align-center
:width: 25px
.. |supported_def| image:: ../../../_static/ble/feature_status/supported.svg
.. |developing_def| image:: ../../../_static/ble/feature_status/developingYYYYMM.svg
.. |unsupported_def| image:: ../../../_static/ble/feature_status/unsupported.svg
.. |experimental_def| image:: ../../../_static/ble/feature_status/experimental.svg
.. |NA_def| image:: ../../../_static/ble/feature_status/NA.svg
.. |4.2| replace:: `4.2 <https://www.bluetooth.com/specifications/specs/core-specification-4-2/>`__
.. |5.0| replace:: `5.0 <https://www.bluetooth.com/specifications/specs/core-specification-5-0/>`__
.. |5.1| replace:: `5.1 <https://www.bluetooth.com/specifications/specs/core-specification-5-1/>`__
.. |5.2| replace:: `5.2 <https://www.bluetooth.com/specifications/specs/core-specification-5-2/>`__
.. |5.3| replace:: `5.3 <https://www.bluetooth.com/specifications/specs/core-specification-5-3/>`__
.. |5.4| replace:: `5.4 <https://www.bluetooth.com/specifications/specs/core-specification-5-4/>`__

159
docs/en/api-guides/ble/host-feature-support-status.rst Normal file
View File

@ -0,0 +1,159 @@
:orphan:
ESP Host Major Feature Support Status
=======================================
:link_to_translation:`zh_CN:[中文]`
The table below shows the support status of major features on ESP-Bluedroid and ESP-NimBLE Host.
If you plan to run the BLE Controller and Host on {IDF_TARGET_NAME} together, the functionality of the Host may be limited by the support status of the Controller,
please check the :doc:`{IDF_TARGET_NAME} Major Feature Support Status Table <ble-feature-support-status>` .
|supported_def| **This feature has completed development and internal testing.** [1]_
|experimental_def| **This feature has been developed and is currently undergoing internal testing.**
You can explore these features for evaluation and feedback purposes but should be cautious of potential issues.
|developing_def| **The feature is currently being actively developed, and expected to be supported by the end of YYYY/MM.**
You should anticipate future updates regarding the progress and availability of these features.
If you do have an urgent need, please contact our `customer support team <https://www.espressif.com/en/contact-us/sales-questions>`__ for a possible feature trial.
|unsupported_def| **This feature is not supported on this Host.** If you have related requirements, please prioritize selecting other Espressif Bluetooth Host that support this feature.
If none of our chip series meet your needs, please contact `customer support team <https://www.espressif.com/en/contact-us/sales-questions>`__, and our R&D team will conduct an internal feasibility assessment for you.
|NA_def| The feature with this label could be the following type:
- **Controller-only Feature**: The feature exists only below HCI, and cannot be configured/enabled via Host API, such as Advertising Channel Index.
It does not require the support from the Host.
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
* - .. centered:: Core Spec
- .. centered:: Major Features
- .. centered:: ESP-Bluedroid Host
- .. centered:: ESP-NimBLE Host
* - .. centered:: |4.2|
- LE Data Packet Length Extension
- |supported|
- |supported|
* -
- LE Secure Connections
- |supported|
- |supported|
* -
- Link Layer Privacy
- |supported|
- |supported|
* -
- Link Layer Extended Filter Policies
- |supported|
- |supported|
* - .. centered:: |5.0|
- 2 Msym/s PHY for LE
- |supported|
- |supported|
* -
- LE Long Range (Coded PHY S=2/S=8)
- |supported|
- |supported|
* -
- High Duty Cycle Non-Connectable Advertising
- |supported|
- |supported|
* -
- LE Advertising Extensions
- |supported|
- |supported|
* -
- LE Channel Selection Algorithm #2
- |supported|
- |supported|
* - .. centered:: |5.1|
- Angle of Arrival (AoA)/Angle of Departure (AoD)
- |unsupported|
- |developing202412|
* -
- GATT Caching
- |experimental|
- |experimental|
* -
- Advertising Channel Index
- |NA|
- |NA|
* -
- Periodic Advertising Sync Transfer
- |supported|
- |supported|
* - .. centered:: |5.2|
- LE Isochronous Channels (BIS/CIS)
- |unsupported|
- |developing202412|
* -
- Enhanced Attribute Protocol
- |unsupported|
- |developing202412|
* -
- LE Power Control
- |unsupported|
- |developing202412|
* - .. centered:: |5.3|
- AdvDataInfo in Periodic Advertising
- |supported|
- |supported|
* -
- LE Enhanced Connection Update (Connection Subrating)
- |unsupported|
- |supported|
* -
- LE Channel Classification
- |supported|
- |supported|
* - .. centered:: |5.4|
- Advertising Coding Selection
- |unsupported|
- |supported|
* -
- Encrypted Advertising Data
- |unsupported|
- |experimental|
* -
- LE GATT Security Levels Characteristic
- |unsupported|
- |developing202412|
* -
- Periodic Advertising with Responses
- |unsupported|
- |developing202412|
.. [1]
If you would like to know the Bluetooth SIG certification information for supported features,
please consult `SIG Bluetooth Product Database <https://qualification.bluetooth.com/Listings/Search>`__.
It is important to clarify that this document is not a binding commitment to our customers.
The above feature support status information is for general informational purposes only and is subject to change without notice.
You are encouraged to consult with our `customer support team <https://www.espressif.com/en/contact-us/sales-questions>`__ for the most up-to-date information and to verify the suitability of features for your specific needs.
.. |supported| image:: ../../../_static/ble/feature_status/supported.svg
:class: align-center
.. |developing202412| image:: ../../../_static/ble/feature_status/developing202412.svg
:class: align-center
.. |unsupported| image:: ../../../_static/ble/feature_status/unsupported.svg
:class: align-center
.. |experimental| image:: ../../../_static/ble/feature_status/experimental.svg
:class: align-center
.. |NA| image:: ../../../_static/ble/feature_status/NA.svg
:class: align-center
.. |supported_def| image:: ../../../_static/ble/feature_status/supported.svg
.. |developing_def| image:: ../../../_static/ble/feature_status/developingYYYYMM.svg
.. |unsupported_def| image:: ../../../_static/ble/feature_status/unsupported.svg
.. |experimental_def| image:: ../../../_static/ble/feature_status/experimental.svg
.. |NA_def| image:: ../../../_static/ble/feature_status/NA.svg
.. |4.2| replace:: `4.2 <https://www.bluetooth.com/specifications/specs/core-specification-4-2/>`__
.. |5.0| replace:: `5.0 <https://www.bluetooth.com/specifications/specs/core-specification-5-0/>`__
.. |5.1| replace:: `5.1 <https://www.bluetooth.com/specifications/specs/core-specification-5-1/>`__
.. |5.2| replace:: `5.2 <https://www.bluetooth.com/specifications/specs/core-specification-5-2/>`__
.. |5.3| replace:: `5.3 <https://www.bluetooth.com/specifications/specs/core-specification-5-3/>`__
.. |5.4| replace:: `5.4 <https://www.bluetooth.com/specifications/specs/core-specification-5-4/>`__

1
docs/en/api-guides/ble/index.rst
View File

@ -11,6 +11,7 @@ Overview
:maxdepth: 1
overview
ble-feature-support-status
**********
Profile

338
docs/zh_CN/api-guides/ble/ble-feature-support-status.rst Normal file
View File

@ -0,0 +1,338 @@
主要功能支持状态
================
:link_to_translation:`en:[English]`
本文档介绍了乐鑫低功耗蓝牙模块主要功能在 {IDF_TARGET_NAME} 上的支持状态。
|supported_def| **该功能已完成开发和内部测试。** [1]_
|experimental_def| **该功能已完成开发，正在进行内部测试。**
你可以探索这些功能以进行评估和反馈，但应注意可能出现的问题。
|developing_def| **该功能目前正在积极开发中， 预计在 YYYY/MM 月底之前支持。**
请关注此表以获得该功能的最新进展。
如果确实有紧急的开发需求，请联系 `乐鑫客户支持团队 <https://www.espressif.com/zh-hans/contact-us/sales-questions>`__ 以了解是否可以进行功能试用。
|unsupported_def| **该功能在此芯片上不支持。** 如果你有相关需求，请优先选择其他支持该功能的乐鑫芯片系列。
如果当前的乐鑫产品都不支持此功能，请联系 `乐鑫客户支持团队 <https://www.espressif.com/zh-hans/contact-us/sales-questions>`__ ，我们的研发团队会对你的需求进行内部可行性评估。
|NA_def| 具有此标签的功能可能为以下两种类型：
- **Host-only 功能**：该功能仅存在于 HCI 层之上，例如 GATT Caching。此类功能不需要蓝牙控制器的支持。
- **Controller-only 功能**：该功能仅存在于 HCI 层之下，且无法通过主机API配置或启用，例如 Advertising Channel Index 。此类功能不需要蓝牙主机的支持。
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
* - .. centered:: 核心协议
- .. centered:: 主要功能
- .. centered:: ESP 控制器
- .. centered:: ESP-Bluedroid 主机
- .. centered:: ESP-NimBLE 主机
* - .. centered:: |4.2|
- LE Data Packet Length Extension
- |supported|
- |supported|
- |supported|
* -
- LE Secure Connections
- |supported|
- |supported|
- |supported|
* -
- Link Layer Privacy
- |supported|
- |supported|
- |supported|
* -
- Link Layer Extended Filter Policies
- |supported|
- |supported|
- |supported|
* - .. centered:: |5.0|
- 2 Msym/s PHY for LE
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* -
- LE Long Range (Coded PHY S=2/S=8)
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* -
- High Duty Cycle Non-Connectable Advertising
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* -
- LE Advertising Extensions
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* -
- LE Channel Selection Algorithm #2
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
- .. only:: esp32
|unsupported|
.. only:: not esp32
|supported|
* - .. centered:: |5.1|
- Angle of Arrival (AoA)/Angle of Departure (AoD)
- |unsupported|
- |unsupported|
- |unsupported|
* -
- GATT Caching
- |NA|
- |experimental|
- |experimental|
* -
- Advertising Channel Index
- |unsupported|
- |NA|
- |NA|
* -
- Periodic Advertising Sync Transfer
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5
|experimental|
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5
|experimental|
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5
|experimental|
* - .. centered:: |5.2|
- LE Isochronous Channels (BIS/CIS)
- |unsupported|
- |unsupported|
- |unsupported|
* -
- Enhanced Attribute Protocol
- |NA|
- |unsupported|
- |developing202412|
* -
- LE Power Control
- .. only:: esp32 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5
|experimental|
- |unsupported|
- .. only:: esp32 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5
|developing202412|
* - .. centered:: |5.3|
- AdvDataInfo in Periodic Advertising
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5
|supported|
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5
|supported|
- .. only:: esp32 or esp32c3 or esp32s3
|unsupported|
.. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5
|supported|
* -
- LE Enhanced Connection Update (Connection Subrating)
- .. only:: esp32 or esp32c6 or esp32c2 or esp32h2 or esp32c5
|unsupported|
.. only:: esp32c3 or esp32s3
|experimental|
- |unsupported|
- .. only:: esp32 or esp32c6 or esp32c2 or esp32h2 or esp32c5
|unsupported|
.. only:: esp32c3 or esp32s3
|experimental|
* -
- LE Channel Classification
- .. only:: esp32 or esp32c3 or esp32s3 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c5
|experimental|
- .. only:: esp32 or esp32c3 or esp32s3 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c5
|experimental|
- .. only:: esp32 or esp32c3 or esp32s3 or esp32c2
|unsupported|
.. only:: esp32c6 or esp32h2 or esp32c5
|experimental|
* - .. centered:: |5.4|
- Advertising Coding Selection
- .. only:: esp32 or esp32c6 or esp32c2 or esp32h2 or esp32c5
|unsupported|
.. only:: esp32c3 or esp32s3
|experimental|
- |unsupported|
- .. only:: esp32 or esp32c6 or esp32c2 or esp32h2 or esp32c5
|unsupported|
.. only:: esp32c3 or esp32s3
|experimental|
* -
- Encrypted Advertising Data
- |NA|
- |unsupported|
- |developing202412|
* -
- LE GATT Security Levels Characteristic
- |NA|
- |unsupported|
- |developing202412|
* -
- Periodic Advertising with Responses
- |unsupported|
- |unsupported|
- |unsupported|
.. [1]
如果想了解支持功能的 Bluetooth SIG 认证状态，
请查阅 `SIG 蓝牙产品数据库 <https://qualification.bluetooth.com/Listings/Search>`__ 。
对于大部分开发需要在控制器 (Controller) 完成的功能，其主机层 (Host) 的支持状态将会受限于控制器层的支持状态。
如果你计划将乐鑫低功耗蓝牙控制器和主机跑在不同的乐鑫芯片上，则主机的功能将不再受限于这颗跑主机的芯片上的控制器的功能支持状态，
请参阅 :doc:`ESP 主机主要功能支持状态 <host-feature-support-status>` 。
请注意，本文档不构成对客户的约束性承诺。
以上所列出来的功能支持状态信息仅供参考，可能会在不通知的情况下发生更改。
建议联系 `乐鑫客户支持团队 <https://www.espressif.com/zh-hans/contact-us/sales-questions>`__ 以获取最新信息，并确认功能是否适合你的特定需求。
.. |supported| image:: ../../../_static/ble/feature_status/supported.svg
:class: align-center
:width: 65px
.. |developing202412| image:: ../../../_static/ble/feature_status/developing202412.svg
:class: align-center
:width: 120px
.. |unsupported| image:: ../../../_static/ble/feature_status/unsupported.svg
:class: align-center
:width: 75px
.. |experimental| image:: ../../../_static/ble/feature_status/experimental.svg
:class: align-center
:width: 75px
.. |NA| image:: ../../../_static/ble/feature_status/NA.svg
:class: align-center
:width: 25px
.. |supported_def| image:: ../../../_static/ble/feature_status/supported.svg
.. |developing_def| image:: ../../../_static/ble/feature_status/developingYYYYMM.svg
.. |unsupported_def| image:: ../../../_static/ble/feature_status/unsupported.svg
.. |experimental_def| image:: ../../../_static/ble/feature_status/experimental.svg
.. |NA_def| image:: ../../../_static/ble/feature_status/NA.svg
.. |4.2| replace:: `4.2 <https://www.bluetooth.com/specifications/specs/core-specification-4-2/>`__
.. |5.0| replace:: `5.0 <https://www.bluetooth.com/specifications/specs/core-specification-5-0/>`__
.. |5.1| replace:: `5.1 <https://www.bluetooth.com/specifications/specs/core-specification-5-1/>`__
.. |5.2| replace:: `5.2 <https://www.bluetooth.com/specifications/specs/core-specification-5-2/>`__
.. |5.3| replace:: `5.3 <https://www.bluetooth.com/specifications/specs/core-specification-5-3/>`__
.. |5.4| replace:: `5.4 <https://www.bluetooth.com/specifications/specs/core-specification-5-4/>`__

159
docs/zh_CN/api-guides/ble/host-feature-support-status.rst Normal file
View File

@ -0,0 +1,159 @@
:orphan:
ESP 主机主要功能支持状态
========================
:link_to_translation:`en:[English]`
本文档介绍了乐鑫低功耗蓝牙主机 ESP-Bluedroid 和 ESP-NimBLE 主要功能的支持状态。
如果你计划将低功耗蓝牙控制器和主机跑在 {IDF_TARGET_NAME} 上，主机的功能支持可能会受限于控制器的功能支持状态，
请参阅 :doc:`{IDF_TARGET_NAME} 主要功能支持状态 <ble-feature-support-status>` 。
|supported_def| **该功能已完成开发和内部测试。** [1]_
|experimental_def| **该功能已完成开发，正在进行内部测试。**
你可以探索这些功能以进行评估和反馈，但应注意可能出现的问题。
|developing_def| **该功能目前正在积极开发中， 预计在 YYYY/MM 月底之前支持。**
请关注此表以获得该功能的最新进展。
如果确实有紧急的开发需求，请联系 `乐鑫客户支持团队 <https://www.espressif.com/zh-hans/contact-us/sales-questions>`__ 以了解是否可以进行功能试用。
|unsupported_def| **该功能在该蓝牙主机上不支持。** 如果你有相关需求，请优先选择其他支持该功能的乐鑫蓝牙主机。
如果当前的乐鑫产品都不支持此功能，请联系 `乐鑫客户支持团队 <https://www.espressif.com/zh-hans/contact-us/sales-questions>`__ ，我们的研发团队会对你的需求进行内部可行性评估。
|NA_def| 具有此标签的功能可能为以下类型：
- **Controller-only 功能**：该功能仅存在于 HCI 层之下，且无法通过主机API配置或启用，例如 Advertising Channel Index 。
此类功能不需要蓝牙主机的支持。
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
* - .. centered:: 核心协议
- .. centered:: 主要功能
- .. centered:: ESP-Bluedroid 主机
- .. centered:: ESP-NimBLE 主机
* - .. centered:: |4.2|
- LE Data Packet Length Extension
- |supported|
- |supported|
* -
- LE Secure Connections
- |supported|
- |supported|
* -
- Link Layer Privacy
- |supported|
- |supported|
* -
- Link Layer Extended Filter Policies
- |supported|
- |supported|
* - .. centered:: |5.0|
- 2 Msym/s PHY for LE
- |supported|
- |supported|
* -
- LE Long Range (Coded PHY S=2/S=8)
- |supported|
- |supported|
* -
- High Duty Cycle Non-Connectable Advertising
- |supported|
- |supported|
* -
- LE Advertising Extensions
- |supported|
- |supported|
* -
- LE Channel Selection Algorithm #2
- |supported|
- |supported|
* - .. centered:: |5.1|
- Angle of Arrival (AoA)/Angle of Departure (AoD)
- |unsupported|
- |developing202412|
* -
- GATT Caching
- |experimental|
- |experimental|
* -
- Advertising Channel Index
- |NA|
- |NA|
* -
- Periodic Advertising Sync Transfer
- |supported|
- |supported|
* - .. centered:: |5.2|
- LE Isochronous Channels (BIS/CIS)
- |unsupported|
- |developing202412|
* -
- Enhanced Attribute Protocol
- |unsupported|
- |developing202412|
* -
- LE Power Control
- |unsupported|
- |developing202412|
* - .. centered:: |5.3|
- AdvDataInfo in Periodic Advertising
- |supported|
- |supported|
* -
- LE Enhanced Connection Update (Connection Subrating)
- |unsupported|
- |supported|
* -
- LE Channel Classification
- |supported|
- |supported|
* - .. centered:: |5.4|
- Advertising Coding Selection
- |unsupported|
- |supported|
* -
- Encrypted Advertising Data
- |unsupported|
- |experimental|
* -
- LE GATT Security Levels Characteristic
- |unsupported|
- |developing202412|
* -
- Periodic Advertising with Responses
- |unsupported|
- |developing202412|
.. [1]
如果想了解支持功能的 Bluetooth SIG 认证状态，
请查阅 `SIG 蓝牙产品数据库 <https://qualification.bluetooth.com/Listings/Search>`__ 。
请注意，本文档不构成对客户的约束性承诺。
以上所列出来的功能支持状态信息仅供参考，可能会在不通知的情况下发生更改。
建议联系 `乐鑫客户支持团队 <https://www.espressif.com/zh-hans/contact-us/sales-questions>`__ 以获取最新信息，并确认功能是否适合你的特定需求。
.. |supported| image:: ../../../_static/ble/feature_status/supported.svg
:class: align-center
.. |developing202412| image:: ../../../_static/ble/feature_status/developing202412.svg
:class: align-center
.. |unsupported| image:: ../../../_static/ble/feature_status/unsupported.svg
:class: align-center
.. |experimental| image:: ../../../_static/ble/feature_status/experimental.svg
:class: align-center
.. |NA| image:: ../../../_static/ble/feature_status/NA.svg
:class: align-center
.. |supported_def| image:: ../../../_static/ble/feature_status/supported.svg
.. |developing_def| image:: ../../../_static/ble/feature_status/developingYYYYMM.svg
.. |unsupported_def| image:: ../../../_static/ble/feature_status/unsupported.svg
.. |experimental_def| image:: ../../../_static/ble/feature_status/experimental.svg
.. |NA_def| image:: ../../../_static/ble/feature_status/NA.svg
.. |4.2| replace:: `4.2 <https://www.bluetooth.com/specifications/specs/core-specification-4-2/>`__
.. |5.0| replace:: `5.0 <https://www.bluetooth.com/specifications/specs/core-specification-5-0/>`__
.. |5.1| replace:: `5.1 <https://www.bluetooth.com/specifications/specs/core-specification-5-1/>`__
.. |5.2| replace:: `5.2 <https://www.bluetooth.com/specifications/specs/core-specification-5-2/>`__
.. |5.3| replace:: `5.3 <https://www.bluetooth.com/specifications/specs/core-specification-5-3/>`__
.. |5.4| replace:: `5.4 <https://www.bluetooth.com/specifications/specs/core-specification-5-4/>`__

1
docs/zh_CN/api-guides/ble/index.rst
View File

@ -11,6 +11,7 @@
:maxdepth: 1
overview
ble-feature-support-status
**********
蓝牙规范