Skip to content

Commit

Permalink
Merge branch 'docs/add-ble-feature-support-status' into 'master'
Browse files Browse the repository at this point in the history 
docs(ble): Added BLE feature support status

See merge request espressif/esp-idf!32408
  • Loading branch information
@Isl2017
Isl2017 committed Aug 9, 2024
2 parents f08926b + 3bd599e commit 9dba818
Show file tree
Hide file tree
Showing 7 changed files with 1,040 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/conf_common.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@
'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',
Expand Down
356 changes: 356 additions & 0 deletions docs/en/api-guides/ble/ble-feature-support-status.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,356 @@
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|
- .. only:: esp32

|unsupported|
.. only:: not esp32

|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|
- .. only:: esp32

|unsupported|
.. only:: not esp32

|developing202412|
* -
- LE GATT Security Levels Characteristic
- |NA|
- |unsupported|
- .. only:: esp32

|unsupported|
.. only:: not esp32

|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:: https://img.shields.io/badge/supported-green
:class: align-center
:width: 65px
.. |developing| image:: https://img.shields.io/badge/in_progress-YYYY/MM-blue
:class: align-center
:width: 80px
.. |developing202412| image:: https://img.shields.io/badge/In_Progress-2024/12-blue
:class: align-center
:width: 120px
.. |unsupported| image:: https://img.shields.io/badge/unsupported-D8D8D8
:class: align-center
:width: 75px
.. |experimental| image:: https://img.shields.io/badge/experimental-orange
:class: align-center
:width: 75px
.. |NA| image:: https://img.shields.io/badge/N%2FA-D8D8D8
:class: align-center
:width: 30px
.. |supported_def| image:: https://img.shields.io/badge/supported-green
.. |developing_def| image:: https://img.shields.io/badge/In_Progress-YYYY/MM-blue
.. |unsupported_def| image:: https://img.shields.io/badge/unsupported-D8D8D8
.. |experimental_def| image:: https://img.shields.io/badge/experimental-orange
.. |NA_def| image:: https://img.shields.io/badge/N%2FA-D8D8D8
.. |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/>`__
Loading

0 comments on commit 9dba818

Please sign in to comment.