From f1f3ed86ccb49336332f9d8ad1c1ad12f67e20be Mon Sep 17 00:00:00 2001 From: Wei Yu Han Date: Thu, 26 Sep 2024 09:38:11 +0800 Subject: [PATCH] docs(ble): Added BLE Get Started documentation link to README.md (cherry picked from commit 5f008828d31149303d92cc269dbd9f45ca745e04) Co-authored-by: Yuhan Wei --- .../ble_get_started/nimble/NimBLE_Beacon/README.md | 6 ++++-- .../ble_get_started/nimble/NimBLE_Connection/README.md | 7 ++++--- .../ble_get_started/nimble/NimBLE_GATT_Server/README.md | 5 +++-- .../ble_get_started/nimble/NimBLE_Security/README.md | 3 +-- 4 files changed, 12 insertions(+), 9 deletions(-) diff --git a/examples/bluetooth/ble_get_started/nimble/NimBLE_Beacon/README.md b/examples/bluetooth/ble_get_started/nimble/NimBLE_Beacon/README.md index 98bb709c07..f64d29d5cf 100644 --- a/examples/bluetooth/ble_get_started/nimble/NimBLE_Beacon/README.md +++ b/examples/bluetooth/ble_get_started/nimble/NimBLE_Beacon/README.md @@ -11,9 +11,11 @@ This is a pretty simple example, aiming to introduce 2. How to configure advertisement and scan response data 3. How to start advertising as a non-connectable beacon -It uses ESP32's Bluetooth controller and NimBLE host stack. -To test this demo, any BLE scanner application can be used. +To test this demo, install *nRF Connect for Mobile* on your phone. + +Please refer to [BLE Device Discovery](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/ble/get-started/ble-device-discovery.html#:~:text=%E4%BE%8B%E7%A8%8B%E5%AE%9E%E8%B7%B5) +for detailed example introduction and code explanation. ## Try It Yourself diff --git a/examples/bluetooth/ble_get_started/nimble/NimBLE_Connection/README.md b/examples/bluetooth/ble_get_started/nimble/NimBLE_Connection/README.md index 065de9dd21..d213c3ef36 100644 --- a/examples/bluetooth/ble_get_started/nimble/NimBLE_Connection/README.md +++ b/examples/bluetooth/ble_get_started/nimble/NimBLE_Connection/README.md @@ -11,9 +11,11 @@ This example is extended from NimBLE Beacon Example, and further introduces 2. How to capture GAP events and handle them 3. How to update connection parameters -It uses ESP32's Bluetooth controller and NimBLE host stack. -To test this demo, any BLE scanner application can be used. +To test this demo, install *nRF Connect for Mobile* on your phone. + +Please refer to [BLE Connection](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/ble/get-started/ble-connection.html#:~:text=%E4%BE%8B%E7%A8%8B%E5%AE%9E%E8%B7%B5) +for detailed example introduction and code explanation. ## Try It Yourself @@ -266,4 +268,3 @@ If everything goes well, except for what we have seen in NimBLE Beacon example, ## Troubleshooting For any technical queries, please file an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon. - diff --git a/examples/bluetooth/ble_get_started/nimble/NimBLE_GATT_Server/README.md b/examples/bluetooth/ble_get_started/nimble/NimBLE_GATT_Server/README.md index 2c4ea30990..4d1312c67a 100644 --- a/examples/bluetooth/ble_get_started/nimble/NimBLE_GATT_Server/README.md +++ b/examples/bluetooth/ble_get_started/nimble/NimBLE_GATT_Server/README.md @@ -12,9 +12,10 @@ This example is extended from NimBLE Connection Example, and further introduces 1. Write access demonstrated by LED control 2. Read and indicate access demonstrated by heart rate measurement(mocked) -It uses ESP32's Bluetooth controller and NimBLE host stack. +To test this demo, install *nRF Connect for Mobile* on your phone. -To test this demo, any BLE scanner application can be used. +Please refer to [BLE Introduction](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/ble/get-started/ble-introduction.html#:~:text=%E4%BE%8B%E7%A8%8B%E5%AE%9E%E8%B7%B5) +for detailed example introduction and code explanation. ## Try It Yourself diff --git a/examples/bluetooth/ble_get_started/nimble/NimBLE_Security/README.md b/examples/bluetooth/ble_get_started/nimble/NimBLE_Security/README.md index 5c7d982a7e..85724c5101 100644 --- a/examples/bluetooth/ble_get_started/nimble/NimBLE_Security/README.md +++ b/examples/bluetooth/ble_get_started/nimble/NimBLE_Security/README.md @@ -11,9 +11,8 @@ This example is extended from NimBLE GATT Server Example, and further introduces 2. How to ask for connection encryption from peripheral side on characteristic access 3. How to bond with peer device using a random generated 6-digit passkey -It uses ESP32's Bluetooth controller and NimBLE host stack. -To test this demo, any BLE scanner application can be used. +To test this demo, install *nRF Connect for Mobile* on your phone. ## Try It Yourself