Skip to content

Commit f60b142

Browse files
committed
docs(ble): Replaced BLE with Bluetooth LE
1 parent 9f07b80 commit f60b142

File tree

8 files changed

+44
-44
lines changed

8 files changed

+44
-44
lines changed

docs/en/api-guides/ble/ble-feature-support-status.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ If none of our chip series meet your needs, please contact `customer support tea
407407
please consult `SIG Bluetooth Product Database <https://qualification.bluetooth.com/Listings/Search>`__.
408408
409409
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.
410-
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,
410+
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,
411411
please check the :doc:`ESP Host Feature Support Status Table <host-feature-support-status>` .
412412

413413
It is important to clarify that this document is not a binding commitment to our customers.

docs/en/api-guides/ble/get-started/ble-data-exchange.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ If you have not completed the ESP-IDF development environment setup, please refe
296296
Try It Out
297297
^^^^^^^^^^^^^^^^^^
298298

299-
Please refer to :ref:`BLE Introduction Try It Out <nimble_gatt_server_practice>` 。
299+
Please refer to :ref:`Bluetooth LE Introduction Try It Out <nimble_gatt_server_practice>` 。
300300

301301

302302
Code Explanation

docs/en/api-guides/ble/host-feature-support-status.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ESP Host Major Feature Support Status
66
:link_to_translation:`zh_CN:[中文]`
77

88
The table below shows the support status of major features on ESP-Bluedroid and ESP-NimBLE Host.
9-
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,
9+
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,
1010
please check the :doc:`{IDF_TARGET_NAME} Major Feature Support Status Table <ble-feature-support-status>` .
1111

1212
|supported_def| **This feature has completed development and internal testing.** [1]_

docs/en/api-guides/low-power-mode/low-power-mode-ble.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@ Introduction to Low Power Mode in Bluetooth\ :sup:`®` Low Energy Scenarios
33

44
:link_to_translation:`zh_CN:[中文]`
55

6-
This section introduces clock source selection in low power modes for Bluetooth Low Energy (BLE), along with common related issues.
6+
This section introduces clock source selection in low power modes for Bluetooth Low Energy (Bluetooth LE), along with common related issues.
77

88
Clock Source Selection in Low Power Mode
99
--------------------------------------------
1010

11-
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.
11+
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.
1212

1313

1414
Selecting Main XTAL
1515
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1616

17-
To select the main XTAL as the BLE internal clock source, configure the following option:
17+
To select the main XTAL as the Bluetooth LE internal clock source, configure the following option:
1818

1919
.. only:: esp32 or esp32c3 or esp32s3
2020

@@ -42,7 +42,7 @@ Please refer :example_file:`Power Save README <bluetooth/nimble/power_save/READM
4242
Selecting 32kHz External Crystal
4343
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4444

45-
To use a 32kHz external crystal as the BLE internal clock source, configure the following options:
45+
To use a 32kHz external crystal as the Bluetooth LE internal clock source, configure the following options:
4646

4747
.. only:: esp32 or esp32c3 or esp32s3
4848

@@ -72,15 +72,15 @@ To use a 32kHz external crystal as the BLE internal clock source, configure the
7272

7373
- \ (X) External 32 kHz crystal
7474

75-
**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.
75+
**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.
7676

7777

7878
Selecting 136 kHz RC Oscillator
7979
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8080

8181
.. only:: esp32c3 or esp32s3
8282

83-
To use a 136 kHz internal RC oscillator as the BLE internal clock source, configure the following option:
83+
To use a 136 kHz internal RC oscillator as the Bluetooth LE internal clock source, configure the following option:
8484

8585
**Configuration Path:** `
8686

@@ -90,15 +90,15 @@ Selecting 136 kHz RC Oscillator
9090

9191
- \ (X) Internal 136kHz RC oscillator
9292

93-
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.
93+
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.
9494

9595
.. only:: esp32
9696

97-
**Note:** ESP32 does not support using 136 kHz RC oscillator as the BLE clock source.
97+
**Note:** ESP32 does not support using 136 kHz RC oscillator as the Bluetooth LE clock source.
9898

9999
.. only:: esp32c2 or esp32c6 or esp32h2 or esp32c5 or esp32c61
100100

101-
To use a 136 kHz internal RC oscillator as the BLE internal clock source, configure the following options:
101+
To use a 136 kHz internal RC oscillator as the Bluetooth LE internal clock source, configure the following options:
102102

103103
**Configuration Path 1:**
104104

@@ -116,7 +116,7 @@ Selecting 136 kHz RC Oscillator
116116

117117
- \ (X) Internal 136 kHz RC oscillator
118118

119-
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:
119+
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:
120120

121121
1. Central role of Connection
122122
2. Advertiser of Periodic Advertising
@@ -135,12 +135,12 @@ Selecting 136 kHz RC Oscillator
135135
**Note:** Using the 136 kHz RC oscillator may cause rare issues like connection establishment failure or connection timeout.
136136

137137

138-
**How to Check the Current Clock Source Used by BLE**
139-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
138+
**How to Check the Current Clock Source Used by Bluetooth LE**
139+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
140140

141-
You can determine the BLE clock source from the logs during BLE initialization:
141+
You can determine the Bluetooth LE clock source from the logs during Bluetooth LE initialization:
142142

143-
.. list-table:: BLE Initialization Log Messages and Clock Source Correspondence
143+
.. list-table:: Bluetooth LE Initialization Log Messages and Clock Source Correspondence
144144
:widths: 50 50
145145
:header-rows: 1
146146

@@ -159,22 +159,22 @@ You can determine the BLE clock source from the logs during BLE initialization:
159159
FAQ
160160
--------------------------------------
161161

162-
**1. BLE ACL Connection Fails or Disconnects in Low Power Mode**
163-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
162+
**1. Bluetooth LE ACL Connection Fails or Disconnects in Low Power Mode**
163+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
164164

165-
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.
165+
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.
166166

167167

168168
**2. Measured light-sleep Current Is Higher Than Expected**
169-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
169+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
170170

171171
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.
172172

173-
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.
173+
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.
174174

175175
**3. Unable to Enter light-sleep Mode**
176176
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
177177

178178
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.
179179

180-
This could be caused by excessive logging or BLE configuration that prevents sufficient IDLE time, such as continuous scan mode.
180+
This could be caused by excessive logging or Bluetooth LE configuration that prevents sufficient IDLE time, such as continuous scan mode.

docs/zh_CN/api-guides/ble/blufi.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -435,9 +435,9 @@ ACK 帧格式 (8 bit):
435435
-
436436

437437
* - 0x8 (b’001000)
438-
- 断开 BLE GATT 连接。
438+
- 断开低功耗蓝牙 GATT 连接。
439439
-
440-
- ESP 设备收到该指令后主动断开 BLE GATT 连接。
440+
- ESP 设备收到该指令后主动断开低功耗蓝牙 GATT 连接。
441441

442442
* - 0x9 (b’001001)
443443
- 获取 Wi-Fi 列表。

docs/zh_CN/api-guides/ble/get-started/ble-data-exchange.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ GATT 数据操作
296296
动手试试
297297
^^^^^^^^^^^^^^^^^^
298298

299-
请参考 :ref:`BLE 介绍 动手试试 <nimble_gatt_server_practice>` 。
299+
请参考 :ref:`低功耗蓝牙介绍 动手试试 <nimble_gatt_server_practice>` 。
300300

301301

302302
代码详解

docs/zh_CN/api-guides/low-power-mode/low-power-mode-ble.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
低功耗模式下的时钟源选择
99
--------------------------------------------
1010

11-
在低功耗蓝牙应用场景中,由于协议要求休眠时钟精度需在 500 PPM 以内,light-sleep 和 modem-sleep 模式下所用的时钟源必须满足该要求。如果时钟精度不足,可能会出现 ACL 连接失败或超时断开等问题。**因此在使用前请确保所选时钟源及其精度满足 BLE 要求。**
11+
在低功耗蓝牙应用场景中,由于协议要求休眠时钟精度需在 500 PPM 以内,light-sleep 和 modem-sleep 模式下所用的时钟源必须满足该要求。如果时钟精度不足,可能会出现 ACL 连接失败或超时断开等问题。**因此在使用前请确保所选时钟源及其精度满 要求。**
1212

1313

1414
选择主晶振
1515
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1616

17-
要选择主晶振作为 BLE 内部时钟源,请配置以下选项:
17+
要选择主晶振作为低功耗蓝牙内部时钟源,请配置以下选项:
1818

1919
.. only:: esp32 or esp32c3 or esp32s3
2020

@@ -42,7 +42,7 @@
4242
选择 32kHz 外部晶振
4343
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4444

45-
要使用 32kHz 外部晶振作为 BLE 内部时钟源,请配置以下选项:
45+
要使用 32kHz 外部晶振作为低功耗蓝牙内部时钟源,请配置以下选项:
4646

4747
.. only:: esp32 or esp32c3 or esp32s3
4848

@@ -72,15 +72,15 @@
7272

7373
- \ (X) External 32 kHz crystal
7474

75-
**注意:** 即使在 menuconfig 中选择了 32kHz 外部晶振,如果 BLE 初始化时未检测到外部晶振,系统会自动切换为主晶振,可能导致 light-sleep 电流高于预期。
75+
**注意:** 即使在 menuconfig 中选择了 32kHz 外部晶振,如果低功耗蓝牙初始化时未检测到外部晶振,系统会自动切换为主晶振,可能导致 light-sleep 电流高于预期。
7676

7777

7878
选择 136 kHz RC 振荡器
7979
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8080

8181
.. only:: esp32c3 or esp32s3
8282

83-
要使用 136 kHz 内部 RC 振荡器作为 BLE 内部时钟源,请配置以下选项:
83+
要使用 136 kHz 内部 RC 振荡器作为低功耗蓝牙内部时钟源,请配置以下选项:
8484

8585
**配置路径:**
8686

@@ -90,15 +90,15 @@
9090

9191
- \ (X) Internal 136kHz RC oscillator
9292

93-
一般来说,136 kHz RC 振荡器难以满足 BLE 的精度要求,仅适用于对时钟精度要求不高的场景,如传统广播 (ADV) 或扫描 (SCAN)。它不支持以中心角色或外设角色建立连接。
93+
一般来说,136 kHz RC 振荡器难以满足低功耗蓝牙的精度要求,仅适用于对时钟精度要求不高的场景,如传统广播 (ADV) 或扫描 (SCAN)。它不支持以中心角色或外设角色建立连接。
9494

9595
.. only:: esp32
9696

97-
**注意:** ESP32 不支持 136 kHz RC 振荡器作为 BLE 时钟源
97+
**注意:** ESP32 不支持 136 kHz RC 振荡器作为低功耗蓝牙时钟源
9898

9999
.. only:: esp32c2 or esp32c6 or esp32h2 or esp32c5 or esp32c61
100100

101-
要使用 136 kHz 内部 RC 振荡器作为 BLE 内部时钟源,请配置以下选项:
101+
要使用 136 kHz 内部 RC 振荡器作为低功耗蓝牙内部时钟源,请配置以下选项:
102102

103103
**配置路径 1:**
104104

@@ -116,7 +116,7 @@
116116

117117
- \ (X) Internal 136 kHz RC oscillator
118118

119-
对于需要低功耗且没有 32kHz 外部晶振的场景下,可以选择 136 kHz R C振荡器。然而这个时钟无法满足 BLE 的 500PPM 的休眠时钟精度需求。不过如果对端设备使用的是 ESP 芯片,仍能支持 BLE 行为。但是如果对端设备并非使用 ESP 芯片,则使用下面 BLE 行为将无法支持
119+
对于需要低功耗且没有 32kHz 外部晶振的场景下,可以选择 136 kHz R C振荡器。然而这个时钟无法满足低功耗蓝牙的 500PPM 的休眠时钟精度需求。不过如果对端设备使用的是 ESP 芯片,仍能支持低功耗蓝牙行为。但是如果对端设备并非使用 ESP 芯片,则使用下面低功耗蓝牙行为将无法支持
120120

121121
1. 作为连接的 Central 方
122122
2. 作为 Periodic Advertising 的广播方
@@ -135,12 +135,12 @@
135135
**注意:** 使用 136 kHz RC 振荡器可能偶发连接断开或连接失败。
136136

137137

138-
**如何确认当前 BLE 使用的时钟源**
138+
**如何确认当前低功耗蓝牙使用的时钟源**
139139
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
140140

141-
可通过 BLE 初始化时的日志判断当前时钟源
141+
可通过低功耗蓝牙初始化时的日志判断当前时钟源
142142

143-
.. list-table:: BLE 初始化日志与时钟源对应关系
143+
.. list-table:: 低功耗蓝牙初始化日志与时钟源对应关系
144144
:widths: 50 50
145145
:header-rows: 1
146146

@@ -159,22 +159,22 @@
159159
常见问题
160160
--------------------------------------
161161

162-
**1. BLE ACL 连接在低功耗模式下建立失败或断开**
162+
**1. 低功耗蓝牙 ACL 连接在低功耗模式下建立失败或断开**
163163
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
164164

165-
如时钟源选择部分所述,ACL 连接建立失败或断开时,请首先检查当前时钟源是否满足 BLE 精度要求
165+
如时钟源选择部分所述,ACL 连接建立失败或断开时,请首先检查当前时钟源是否满足低功耗蓝牙精度要求
166166

167167

168168
**2. 实测 light-sleep 电流高于预期**
169169
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
170170

171171
如时钟源选择部分所述,若主晶振为时钟源,light-sleep 模式下主晶振持续供电,电流消耗高于其他时钟源。
172172

173-
平均电流可能会因具体应用而异,并取决于 BLE 的配置以及处于 light-sleep 模式的时间周期。某些应用的平均电流可能会更大,这是因为 BLE 在其中花费了更高比例的时间进行发射和接收
173+
平均电流可能会因具体应用而异,并取决于低功耗蓝牙的配置以及处于 light-sleep 模式的时间周期。某些应用的平均电流可能会更大,这是因为低功耗蓝牙在其中花费了更高比例的时间进行发射和接收
174174

175175
**3. 无法进入 light-sleep 模式**
176176
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
177177

178178
启用 Auto light-sleep 后,若设备无法进入 light-sleep,通常是 IDLE 时间不足,未满足自动进入条件。
179179

180-
这可能由日志过多或 BLE 配置导致 IDLE 时间过短(如连续扫描)引起。
180+
这可能由日志过多或低功耗蓝牙配置导致 IDLE 时间过短(如连续扫描)引起。

docs/zh_CN/api-reference/bluetooth/esp_gap_ble.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ GAP API
66
应用示例
77
-------------------
88

9-
- :example:`bluetooth/bluedroid/ble/gatt_security_client` 演示使用 ESP BLE security API,{IDF_TARGET_NAME} 作为 GATT 客户端时如何建立安全连接并加密与对等设备的通信。
9+
- :example:`bluetooth/bluedroid/ble/gatt_security_client` 演示使用 ESP 低功耗蓝牙 security API,{IDF_TARGET_NAME} 作为 GATT 客户端时如何建立安全连接并加密与对等设备的通信。
1010

11-
- :example:`bluetooth/bluedroid/ble/gatt_security_server` 演示使用 ESP BLE security API,{IDF_TARGET_NAME} 作为 GATT 服务器时如何建立安全连接并加密与对等设备的通信。
11+
- :example:`bluetooth/bluedroid/ble/gatt_security_server` 演示使用 ESP 低功耗蓝牙 security API,{IDF_TARGET_NAME} 作为 GATT 服务器时如何建立安全连接并加密与对等设备的通信。
1212

1313
API 参考
1414
-------------

0 commit comments

Comments
 (0)