mirror of
https://github.com/espressif/esp-idf.git
synced 2026-10-01 18:50:34 +03:00
docs(ble): Replaced BLE with Bluetooth LE
This commit is contained in:
Wei Yuhan
@@ -407,7 +407,7 @@ If none of our chip series meet your needs, please contact `customer support tea
|
||||
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,
|
||||
If you want Bluetooth LE 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.
|
||||
|
||||
@@ -296,7 +296,7 @@ If you have not completed the ESP-IDF development environment setup, please refe
|
||||
Try It Out
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Please refer to :ref:`BLE Introduction Try It Out <nimble_gatt_server_practice>` 。
|
||||
Please refer to :ref:`Bluetooth LE Introduction Try It Out <nimble_gatt_server_practice>` 。
|
||||
|
||||
|
||||
Code Explanation
|
||||
|
||||
@@ -6,7 +6,7 @@ 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,
|
||||
If you plan to run the Bluetooth LE 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]_
|
||||
|
||||
@@ -3,18 +3,18 @@ Introduction to Low Power Mode in Bluetooth\ :sup:`®` Low Energy Scenarios
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This section introduces clock source selection in low power modes for Bluetooth Low Energy (BLE), along with common related issues.
|
||||
This section introduces clock source selection in low power modes for Bluetooth Low Energy (Bluetooth LE), along with common related issues.
|
||||
|
||||
Clock Source Selection in Low Power Mode
|
||||
--------------------------------------------
|
||||
|
||||
According to the Bluetooth specification, the sleep clock accuracy must be within 500 PPM, so make sure the clock source selected for BLE low power mode should meet that requirement. Otherwise BLE may not perform normally and cause a series of problem such as ACL connection establishment failure or ACL connection timeout, etc.
|
||||
According to the Bluetooth specification, the sleep clock accuracy must be within 500 PPM, so make sure the clock source selected for Bluetooth LE low power mode should meet that requirement. Otherwise Bluetooth LE may not perform normally and cause a series of problem such as ACL connection establishment failure or ACL connection timeout, etc.
|
||||
|
||||
|
||||
Selecting Main XTAL
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To select the main XTAL as the BLE internal clock source, configure the following option:
|
||||
To select the main XTAL as the Bluetooth LE internal clock source, configure the following option:
|
||||
|
||||
.. only:: esp32 or esp32c3 or esp32s3
|
||||
|
||||
@@ -42,7 +42,7 @@ Please refer :example_file:`Power Save README <bluetooth/nimble/power_save/READM
|
||||
Selecting 32kHz External Crystal
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To use a 32kHz external crystal as the BLE internal clock source, configure the following options:
|
||||
To use a 32kHz external crystal as the Bluetooth LE internal clock source, configure the following options:
|
||||
|
||||
.. only:: esp32 or esp32c3 or esp32s3
|
||||
|
||||
@@ -72,7 +72,7 @@ To use a 32kHz external crystal as the BLE internal clock source, configure the
|
||||
|
||||
- \ (X) External 32 kHz crystal
|
||||
|
||||
**Note:** Even if 32kHz is selected in menuconfig, the system will fall back to the main XTAL if the external crystal is not detected during BLE initialization. This may lead to unexpected current consumption in light-sleep mode.
|
||||
**Note:** Even if 32kHz is selected in menuconfig, the system will fall back to the main XTAL if the external crystal is not detected during Bluetooth LE initialization. This may lead to unexpected current consumption in light-sleep mode.
|
||||
|
||||
|
||||
Selecting 136 kHz RC Oscillator
|
||||
@@ -80,7 +80,7 @@ Selecting 136 kHz RC Oscillator
|
||||
|
||||
.. only:: esp32c3 or esp32s3
|
||||
|
||||
To use a 136 kHz internal RC oscillator as the BLE internal clock source, configure the following option:
|
||||
To use a 136 kHz internal RC oscillator as the Bluetooth LE internal clock source, configure the following option:
|
||||
|
||||
**Configuration Path:** `
|
||||
|
||||
@@ -90,15 +90,15 @@ Selecting 136 kHz RC Oscillator
|
||||
|
||||
- \ (X) Internal 136kHz RC oscillator
|
||||
|
||||
Generally, the 136 kHz RC oscillator cannot meet the accuracy requirement of BLE. It is only suitable for scenarios with low clock accuracy requirements, such as legacy advertising (ADV) or scanning. It does not support connections in central or peripheral roles.
|
||||
Generally, the 136 kHz RC oscillator cannot meet the accuracy requirement of Bluetooth LE. It is only suitable for scenarios with low clock accuracy requirements, such as legacy advertising (ADV) or scanning. It does not support connections in central or peripheral roles.
|
||||
|
||||
.. only:: esp32
|
||||
|
||||
**Note:** ESP32 does not support using 136 kHz RC oscillator as the BLE clock source.
|
||||
**Note:** ESP32 does not support using 136 kHz RC oscillator as the Bluetooth LE clock source.
|
||||
|
||||
.. only:: esp32c2 or esp32c6 or esp32h2 or esp32c5 or esp32c61
|
||||
|
||||
To use a 136 kHz internal RC oscillator as the BLE internal clock source, configure the following options:
|
||||
To use a 136 kHz internal RC oscillator as the Bluetooth LE internal clock source, configure the following options:
|
||||
|
||||
**Configuration Path 1:**
|
||||
|
||||
@@ -116,12 +116,7 @@ Selecting 136 kHz RC Oscillator
|
||||
|
||||
- \ (X) Internal 136 kHz RC oscillator
|
||||
|
||||
<<<<<<< HEAD
|
||||
Generally, the 136 kHz RC oscillator cannot meet the accuracy requirement of BLE. It is only suitable for scenarios with low clock accuracy requirements, such as legacy advertising (ADV) or scanning.
|
||||
|
||||
=======
|
||||
>>>>>>> 41b9cadc10b (docs(ble): Revisied BLE Low Power Giude)
|
||||
If low current consumption is required but have no access to the External 32kHz Crystal, then this clock source is recommended. However, selecting this clock source will have the sleep clock accuracy larger than 500 PPM, which is supported if the peer device is also an ESP chip. If the peer device is not an ESP chip, here's some BLE event not supported:
|
||||
If low current consumption is required but have no access to the External 32kHz Crystal, then this clock source is recommended. However, selecting this clock source will have the sleep clock accuracy larger than 500 PPM, which is supported if the peer device is also an ESP chip. If the peer device is not an ESP chip, here's some Bluetooth LE event not supported:
|
||||
|
||||
1. Central role of Connection
|
||||
2. Advertiser of Periodic Advertising
|
||||
@@ -140,12 +135,12 @@ Selecting 136 kHz RC Oscillator
|
||||
**Note:** Using the 136 kHz RC oscillator may cause rare issues like connection establishment failure or connection timeout.
|
||||
|
||||
|
||||
**How to Check the Current Clock Source Used by BLE**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
**How to Check the Current Clock Source Used by Bluetooth LE**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You can determine the BLE clock source from the logs during BLE initialization:
|
||||
You can determine the Bluetooth LE clock source from the logs during Bluetooth LE initialization:
|
||||
|
||||
.. list-table:: BLE Initialization Log Messages and Clock Source Correspondence
|
||||
.. list-table:: Bluetooth LE Initialization Log Messages and Clock Source Correspondence
|
||||
:widths: 50 50
|
||||
:header-rows: 1
|
||||
|
||||
@@ -164,29 +159,23 @@ You can determine the BLE clock source from the logs during BLE initialization:
|
||||
FAQ
|
||||
--------------------------------------
|
||||
|
||||
**1. BLE ACL Connection Fails or Disconnects in Low Power Mode**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
**1. Bluetooth LE ACL Connection Fails or Disconnects in Low Power Mode**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
As explained in the clock source selection section above, when ACL connections fail to establish or unexpectedly disconnect in low power mode, first verify whether the current clock source meets BLE accuracy requirements.
|
||||
As explained in the clock source selection section above, when ACL connections fail to establish or unexpectedly disconnect in low power mode, first verify whether the current clock source meets Bluetooth LE accuracy requirements.
|
||||
|
||||
|
||||
**2. Measured light-sleep Current Is Higher Than Expected**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
As introduced in the clock source selection section above, if the main XTAL is used as the clock source, it will remain powered on during light-sleep, resulting in higher current consumption than other clock sources.
|
||||
|
||||
<<<<<<< HEAD
|
||||
Also, BLE operates in Auto Light-sleep mode, meaning the system decides whether to enter sleep after entering IDLE. During advertising or scanning, current will be significantly higher than during light-sleep.
|
||||
The average current can be application specific, and depends on the Bluetooth LE configuration and the period of time in light-sleep mode. Some application may have larger average current because it has Bluetooth LE taking a larger ratio of time transmitting and receiving.
|
||||
|
||||
Thus, the average current in low power mode is somewhere between light-sleep current and peak current (usually TX current).
|
||||
|
||||
=======
|
||||
>>>>>>> 41b9cadc10b (docs(ble): Revisied BLE Low Power Giude)
|
||||
The average current can be application specific, and depends on the BLE configuration and the period of time in light-sleep mode. Some application may have larger average current because it has BLE taking a larger ratio of time transmitting and receiving.
|
||||
|
||||
**3. Unable to Enter light-sleep Mode**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
When Auto light-sleep is enabled but the device fails to enter light-sleep, it's often due to insufficient IDLE duration, which prevents meeting the automatic light-sleep entry conditions.
|
||||
|
||||
This could be caused by excessive logging or BLE configuration that prevents sufficient IDLE time, such as continuous scan mode.
|
||||
This could be caused by excessive logging or Bluetooth LE configuration that prevents sufficient IDLE time, such as continuous scan mode.
|
||||
|
||||
Reference in New Issue
Block a user