diff --git a/docs/conf_common.py b/docs/conf_common.py index 0bcba01012..32a4d6daed 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -25,23 +25,26 @@ BT_DOCS = ['api-reference/bluetooth/esp_bt_defs.rst', 'api-reference/bluetooth/index.rst', 'migration-guides/release-5.x/5.4/bt_common.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-guides/ble/ble-qualification.rst', - 'api-guides/ble/get-started/ble-introduction.rst', - 'api-guides/ble/get-started/ble-device-discovery.rst', - 'api-guides/ble/get-started/ble-connection.rst', - 'api-guides/ble/get-started/ble-data-exchange.rst', - 'api-guides/low-power-mode/low-power-mode-ble.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', - 'api-reference/bluetooth/esp_gattc.rst', - 'api-reference/bluetooth/nimble/index.rst', - 'migration-guides/release-5.x/5.0/bluetooth-low-energy.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-guides/ble/ble-qualification.rst', + 'api-guides/ble/ble-multiconnection-guide.rst', + 'api-guides/ble/get-started/ble-introduction.rst', + 'api-guides/ble/get-started/ble-device-discovery.rst', + 'api-guides/ble/get-started/ble-connection.rst', + 'api-guides/ble/get-started/ble-data-exchange.rst', + 'api-guides/low-power-mode/low-power-mode-ble.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', + 'api-reference/bluetooth/esp_gattc.rst', + 'api-reference/bluetooth/nimble/index.rst', + 'migration-guides/release-5.x/5.0/bluetooth-low-energy.rst', +] BLE_MESH_DOCS = ['api-guides/esp-ble-mesh/ble-mesh-index.rst', diff --git a/docs/en/api-guides/ble/ble-feature-support-status.rst b/docs/en/api-guides/ble/ble-feature-support-status.rst index 706d1bb04a..fde8d3dcac 100644 --- a/docs/en/api-guides/ble/ble-feature-support-status.rst +++ b/docs/en/api-guides/ble/ble-feature-support-status.rst @@ -153,19 +153,19 @@ If none of our chip series meet your needs, please contact `customer support tea |supported| * - .. centered:: |5.1| - Angle of Arrival (AoA)/Angle of Departure (AoD) - - .. only:: esp32h2 or esp32c5 or esp32c61 + - .. only:: esp32h2 |experimental| .. only:: esp32 or esp32c3 or esp32s3 or esp32c6 or esp32c2 |unsupported| - - .. only:: esp32h2 or esp32c5 or esp32c61 + - .. only:: esp32h2 |experimental| - .. only:: esp32 or esp32c3 or esp32s3 or esp32c6 or esp32c2 + .. only:: esp32 or esp32c3 or esp32s3 or esp32c6 or esp32c2 |unsupported| - - .. only:: esp32h2 or esp32c5 or esp32c61 + - .. only:: esp32h2 |experimental| .. only:: esp32 or esp32c3 or esp32s3 or esp32c6 or esp32c2 @@ -178,27 +178,42 @@ If none of our chip series meet your needs, please contact `customer support tea - |experimental| * - - Randomized Advertising Channel Indexing - - |developing202603| - - |NA| - - |NA| + - .. only:: esp32c2 + + |unsupported| + .. only:: not esp32c2 + + |developing202603| + - .. only:: esp32c2 + + |unsupported| + .. only:: not esp32c2 + + |NA| + - .. only:: esp32c2 + + |unsupported| + .. only:: not esp32c2 + + |NA| * - - Periodic Advertising Sync Transfer - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c2 |supported| - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c2 |supported| - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c2 |supported| * - .. centered:: |5.2| @@ -216,19 +231,19 @@ If none of our chip series meet your needs, please contact `customer support tea - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 |experimental| - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5 or esp31c61 + .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 |experimental| - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 |experimental| * - .. centered:: |5.3| @@ -236,39 +251,39 @@ If none of our chip series meet your needs, please contact `customer support tea - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32c2 or esp32h2 |supported| - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32c2 or esp32h2 |supported| - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32c2 or esp32h2 |supported| * - - LE Enhanced Connection Update (Connection Subrating) - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| * - @@ -276,45 +291,45 @@ If none of our chip series meet your needs, please contact `customer support tea - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| * - .. centered:: |5.4| - Advertising Coding Selection - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| * - - Encrypted Advertising Data - |NA| - - |developing202512| + - |experimental| - |experimental| * - - LE GATT Security Levels Characteristic @@ -323,22 +338,22 @@ If none of our chip series meet your needs, please contact `customer support tea - |experimental| * - - Periodic Advertising with Responses - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| * - .. centered:: |6.0| @@ -348,22 +363,22 @@ If none of our chip series meet your needs, please contact `customer support tea - |unsupported| * - - LL Extended Feature Set - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| * - @@ -378,22 +393,22 @@ If none of our chip series meet your needs, please contact `customer support tea - |unsupported| * - - Monitoring Advertisers - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| * - diff --git a/docs/en/api-guides/ble/ble-multiconnection-guide.rst b/docs/en/api-guides/ble/ble-multiconnection-guide.rst new file mode 100644 index 0000000000..38f0c1cb43 --- /dev/null +++ b/docs/en/api-guides/ble/ble-multiconnection-guide.rst @@ -0,0 +1,63 @@ +Multi-Connection Guide +========================================== + +:link_to_translation:`zh_CN:[中文]` + +Introduction +-------------- + +The following table provides an overview of the maximum number of concurrent connections supported for each ESP Bluetooth LE Host. In multi-connection scenarios, connection parameters must be configured appropriately. In general, as the number of connections increases, the connection interval should be increased accordingly. For detailed parameter configuration recommendations and SDK configuration details, please refer to the corresponding example code in the following table. + +In this document, the maximum number of connections refers to the maximum number of simultaneous active connections that the device can maintain, whether operating as a central or peripheral. + +.. table:: Maximum Concurrent Connections by ESP Bluetooth LE Host + + +---------------+-----------------------------+------------------------------+---------------------+ + | Host | Max Connections | SDKconfig | Example | + +===============+=============================+==============================+=====================+ + | | | |bluedroid_enable_config| | | + | ESP-Bluedroid | |max_bluedroid_connections| | | |bluedroid_example| | + | | | |bluedroid_connection_num| | | + +---------------+-----------------------------+------------------------------+---------------------+ + | ESP-NimBLE | |max_nimble_connections| | |nimble_connection_num| | |nimble_example| | + +---------------+-----------------------------+------------------------------+---------------------+ + + +Note +---- + +1. The ability to support multiple connections highly depends on the application’s overall memory usage. It is recommended to disable unnecessary features to optimize multi-connection performance. + +2. When the device operates in the peripheral role, connection stability and overall performance will be influenced by the central device and the negotiated connection parameters. + +.. only:: not esp32 and not esp32c3 and not esp32s3 and not esp32c2 + + 3. Due to the relatively higher memory usage of ESP-Bluedroid, it supports fewer concurrent connections compared to ESP-Nimble. + + 4. If your application requires more simultaneous connections than the values listed above, please contact our `customer support team `__ for further assistance. + +.. |bluedroid_enable_config| replace:: :ref:`BT_MULTI_CONNECTION_ENBALE ` +.. |bluedroid_connection_num| replace:: :ref:`BT_ACL_CONNECTIONS ` +.. |bluedroid_example| replace:: :example:`multi_conn ` +.. |nimble_connection_num| replace:: :ref:`BT_NIMBLE_MAX_CONNECTIONS ` +.. |nimble_example| replace:: :example:`multi_conn` + +.. only:: esp32 or esp32c3 or esp32s3 + + .. |max_bluedroid_connections| replace:: 9 + .. |max_nimble_connections| replace:: 9 + +.. only:: esp32c2 + + .. |max_bluedroid_connections| replace:: 2 + .. |max_nimble_connections| replace:: 2 + +.. only:: esp32h2 + + .. |max_bluedroid_connections| replace:: 15 + .. |max_nimble_connections| replace:: 70 + +.. only:: esp32c6 or esp32c5 or esp32c61 + + .. |max_bluedroid_connections| replace:: 50 + .. |max_nimble_connections| replace:: 70 diff --git a/docs/en/api-guides/ble/host-feature-support-status.rst b/docs/en/api-guides/ble/host-feature-support-status.rst index d17a95bbf9..0cfc52919c 100644 --- a/docs/en/api-guides/ble/host-feature-support-status.rst +++ b/docs/en/api-guides/ble/host-feature-support-status.rst @@ -89,7 +89,7 @@ If none of our chip series meet your needs, please contact `customer support tea * - .. centered:: |5.2| - LE Isochronous Channels (BIS/CIS) - |experimental| - - |developing202512| + - |experimental| * - - Enhanced Attribute Protocol - |unsupported| @@ -116,7 +116,7 @@ If none of our chip series meet your needs, please contact `customer support tea - |supported| * - - Encrypted Advertising Data - - |developing202512| + - |experimental| - |experimental| * - - LE GATT Security Levels Characteristic diff --git a/docs/en/api-guides/ble/index.rst b/docs/en/api-guides/ble/index.rst index 6f203b767e..049ab0321a 100644 --- a/docs/en/api-guides/ble/index.rst +++ b/docs/en/api-guides/ble/index.rst @@ -14,6 +14,7 @@ Overview ble-feature-support-status ble-qualification Low Power Mode Introduction <../low-power-mode/low-power-mode-ble> + ble-multiconnection-guide *************** Get Started diff --git a/docs/en/api-guides/ble/overview.rst b/docs/en/api-guides/ble/overview.rst index 9058f82c8a..e360d210cd 100644 --- a/docs/en/api-guides/ble/overview.rst +++ b/docs/en/api-guides/ble/overview.rst @@ -13,13 +13,13 @@ This document provides an architecture overview of the Bluetooth Low Energy (Blu {IDF_TARGET_NAME} supports Bluetooth 5.0 (LE) and is certified for Bluetooth LE 5.4. -.. only:: esp32c2 or esp32c6 or esp32h2 or esp32c5 or esp32c61 +.. only:: esp32c2 or esp32c6 or esp32h2 {IDF_TARGET_NAME} supports Bluetooth 5.0 (LE) and is certified for Bluetooth LE 5.3. The Bluetooth LE stack in ESP-IDF is a layered architecture that enables Bluetooth functionality on {IDF_TARGET_NAME} chip series. The table below shows its architecture. -.. only:: esp32 or esp32s3 or esp32c3 or esp32c6 or esp32c5 or esp32c61 +.. only:: esp32 or esp32s3 or esp32c3 or esp32c6 .. figure:: ../../../_static/bluetooth-architecture.png :align: center diff --git a/docs/zh_CN/api-guides/ble/ble-feature-support-status.rst b/docs/zh_CN/api-guides/ble/ble-feature-support-status.rst index 3b34fee215..7763c4d66a 100644 --- a/docs/zh_CN/api-guides/ble/ble-feature-support-status.rst +++ b/docs/zh_CN/api-guides/ble/ble-feature-support-status.rst @@ -153,19 +153,19 @@ |supported| * - .. centered:: |5.1| - Angle of Arrival (AoA)/Angle of Departure (AoD) - - .. only:: esp32h2 or esp32c5 or esp32c61 + - .. only:: esp32h2 |experimental| .. only:: esp32 or esp32c3 or esp32s3 or esp32c6 or esp32c2 |unsupported| - - .. only:: esp32h2 or esp32c5 or esp32c61 + - .. only:: esp32h2 |experimental| - .. only:: esp32 or esp32c3 or esp32s3 or esp32c6 or esp32c2 + .. only:: esp32 or esp32c3 or esp32s3 or esp32c6 or esp32c2 |unsupported| - - .. only:: esp32h2 or esp32c5 or esp32c61 + - .. only:: esp32h2 |experimental| .. only:: esp32 or esp32c3 or esp32s3 or esp32c6 or esp32c2 @@ -175,30 +175,45 @@ - GATT Caching - |NA| - |experimental| - - |developing202512| + - |experimental| * - - Randomized Advertising Channel Indexing - - |developing202603| - - |NA| - - |NA| + - .. only:: esp32c2 + + |unsupported| + .. only:: not esp32c2 + + |developing202603| + - .. only:: esp32c2 + + |unsupported| + .. only:: not esp32c2 + + |NA| + - .. only:: esp32c2 + + |unsupported| + .. only:: not esp32c2 + + |NA| * - - Periodic Advertising Sync Transfer - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c2 |supported| - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c2 |supported| - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c2 |supported| * - .. centered:: |5.2| @@ -216,19 +231,19 @@ - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 |experimental| - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 |experimental| - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 or esp32c3 or esp32s3 |experimental| * - .. centered:: |5.3| @@ -236,39 +251,39 @@ - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32c2 or esp32h2 |supported| - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32c2 or esp32h2 |supported| - .. only:: esp32 or esp32c3 or esp32s3 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32c2 or esp32h2 |supported| * - - LE Enhanced Connection Update (Connection Subrating) - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| * - @@ -276,45 +291,45 @@ - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| * - .. centered:: |5.4| - Advertising Coding Selection - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| - - .. only:: esp32 + - .. only:: esp32 or esp32c2 |unsupported| - .. only:: esp32c3 or esp32s3 or esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c3 or esp32s3 or esp32c6 or esp32h2 |experimental| * - - Encrypted Advertising Data - |NA| - - |developing202512| + - |experimental| - |experimental| * - - LE GATT Security Levels Characteristic @@ -323,22 +338,22 @@ - |experimental| * - - Periodic Advertising with Responses - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |experimental| * - .. centered:: |6.0| @@ -348,22 +363,22 @@ - |unsupported| * - - LL Extended Feature Set - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| * - @@ -378,22 +393,22 @@ - |unsupported| * - - Monitoring Advertisers - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| - - .. only:: esp32 or esp32c3 or esp32s3 + - .. only:: esp32 or esp32c3 or esp32s3 or esp32c2 |unsupported| - .. only:: esp32c6 or esp32c2 or esp32h2 or esp32c5 or esp32c61 + .. only:: esp32c6 or esp32h2 |developing202606| * - diff --git a/docs/zh_CN/api-guides/ble/ble-multiconnection-guide.rst b/docs/zh_CN/api-guides/ble/ble-multiconnection-guide.rst new file mode 100644 index 0000000000..504e5ade46 --- /dev/null +++ b/docs/zh_CN/api-guides/ble/ble-multiconnection-guide.rst @@ -0,0 +1,63 @@ +多连接指南 +============================= + +:link_to_translation:`en:[English]` + +介绍 +---- + +下表展示了每个 ESP 低功耗蓝牙主机所支持的最大多连接个数。在多连接场景下，需要对连接参数进行合理配置。通常情况下，随着连接数量的增加，连接间隔（Connection Interval）也应相应增大。具体的参数配置建议和 sdkconfig 详细信息，请参阅下表中的相应示例代码。 + +在本文档中，最大连接数指设备作为中心设备或外围设备时，能够同时维持的最大连接数量。 + +.. table:: ESP 低功耗蓝牙主机支持的最大连接数 + + +---------------+-----------------------------+------------------------------+---------------------+ + | 主机（Host） | 最大连接个数 | SDKconfig | 示例 | + +===============+=============================+==============================+=====================+ + | | | |bluedroid_enable_config| | | + | ESP-Bluedroid | |max_bluedroid_connections| | | |bluedroid_example| | + | | | |bluedroid_connection_num| | | + +---------------+-----------------------------+------------------------------+---------------------+ + | ESP-NimBLE | |max_nimble_connections| | |nimble_connection_num| | |nimble_example| | + +---------------+-----------------------------+------------------------------+---------------------+ + + +注意 +---- + +1. 应用能够支持的最大连接数在很大程度上取决于整体内存使用情况。建议禁用不必要的功能，以优化多连接性能。 + +2. 当设备处于外围角色时，连接稳定性和整体性能将受到中心设备和协商连接参数的影响。 + +.. only:: not esp32 and not esp32c3 and not esp32s3 and not esp32c2 + + 3. 由于 ESP-Bluedroid 的内存占用相对更高，其支持的最大连接数会少于 ESP-Nimble。 + + 4. 如果您的应用需要的同时连接数量超过上述数值，请联系 `乐鑫客户支持团队 `__ 以获取进一步的协助。 + +.. |bluedroid_enable_config| replace:: :ref:`BT_MULTI_CONNECTION_ENBALE ` +.. |bluedroid_connection_num| replace:: :ref:`BT_ACL_CONNECTIONS ` +.. |bluedroid_example| replace:: :example:`multi_conn ` +.. |nimble_connection_num| replace:: :ref:`BT_NIMBLE_MAX_CONNECTIONS ` +.. |nimble_example| replace:: :example:`multi_conn` + +.. only:: esp32 or esp32c3 or esp32s3 + + .. |max_bluedroid_connections| replace:: 9 + .. |max_nimble_connections| replace:: 9 + +.. only:: esp32c2 + + .. |max_bluedroid_connections| replace:: 2 + .. |max_nimble_connections| replace:: 2 + +.. only:: esp32h2 + + .. |max_bluedroid_connections| replace:: 15 + .. |max_nimble_connections| replace:: 70 + +.. only:: esp32c6 or esp32c5 or esp32c61 + + .. |max_bluedroid_connections| replace:: 50 + .. |max_nimble_connections| replace:: 70 diff --git a/docs/zh_CN/api-guides/ble/host-feature-support-status.rst b/docs/zh_CN/api-guides/ble/host-feature-support-status.rst index 94cc3c55e3..c4cf24831f 100644 --- a/docs/zh_CN/api-guides/ble/host-feature-support-status.rst +++ b/docs/zh_CN/api-guides/ble/host-feature-support-status.rst @@ -89,7 +89,7 @@ ESP 主机主要功能支持状态 * - .. centered:: |5.2| - LE Isochronous Channels (BIS/CIS) - |experimental| - - |developing202512| + - |experimental| * - - Enhanced Attribute Protocol - |unsupported| @@ -116,7 +116,7 @@ ESP 主机主要功能支持状态 - |supported| * - - Encrypted Advertising Data - - |developing202512| + - |experimental| - |experimental| * - - LE GATT Security Levels Characteristic diff --git a/docs/zh_CN/api-guides/ble/index.rst b/docs/zh_CN/api-guides/ble/index.rst index 05b87f9d14..a7ced69193 100644 --- a/docs/zh_CN/api-guides/ble/index.rst +++ b/docs/zh_CN/api-guides/ble/index.rst @@ -14,6 +14,7 @@ ble-feature-support-status ble-qualification 低功耗模式介绍 <../low-power-mode/low-power-mode-ble> + ble-multiconnection-guide ********** 快速入门 diff --git a/docs/zh_CN/api-guides/ble/overview.rst b/docs/zh_CN/api-guides/ble/overview.rst index d9997eef48..62dbc36db0 100644 --- a/docs/zh_CN/api-guides/ble/overview.rst +++ b/docs/zh_CN/api-guides/ble/overview.rst @@ -13,13 +13,13 @@ {IDF_TARGET_NAME} 支持蓝牙 5.0 (LE)，并且已经获得蓝牙 LE 5.4 认证。 -.. only:: esp32c2 or esp32c6 or esp32h2 or esp32c5 or esp32c61 +.. only:: esp32c2 or esp32c6 or esp32h2 {IDF_TARGET_NAME} 支持蓝牙 5.0 (LE)，并且已经获得蓝牙 LE 5.3 认证。 ESP-IDF 中的低功耗蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NAME} 系列芯片上实现低功耗蓝牙功能，详见下。 -.. only:: esp32 or esp32s3 or esp32c3 or esp32c6 or esp32c5 or esp32c61 +.. only:: esp32 or esp32s3 or esp32c3 or esp32c6 .. figure:: ../../../_static/bluetooth-architecture.png :align: center